log4net.xml 1.4 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>log4net</name>
  5. </assembly>
  6. <members>
  7. <member name="T:log4net.Appender.AdoNetAppender">
  8. <summary>
  9. Appender that logs to a database.
  10. </summary>
  11. <remarks>
  12. <para>
  13. <see cref="T:log4net.Appender.AdoNetAppender"/> appends logging events to a table within a
  14. database. The appender can be configured to specify the connection
  15. string by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionString"/> property.
  16. The connection type (provider) can be specified by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/>
  17. property. For more information on database connection strings for
  18. your specific database see <a href="http://www.connectionstrings.com/">http://www.connectionstrings.com/</a>.
  19. </para>
  20. <para>
  21. Records are written into the database either using a prepared
  22. statement or a stored procedure. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property
  23. is set to <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify a prepared statement
  24. or to <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify a stored
  25. procedure.
  26. </para>
  27. <para>
  28. The prepared statement text or the name of the stored procedure
  29. must be set in the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property.
  30. </para>
  31. <para>
  32. The prepared statement or stored procedure can take a number
  33. of parameters. Parameters are added using the <see cref="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"/>
  34. method. This adds a single <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> to the
  35. ordered list of parameters. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/>
  36. type may be subclassed if required to provide database specific
  37. functionality. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> specifies
  38. the parameter name, database type, size, and how the value should
  39. be generated using a <see cref="T:log4net.Layout.ILayout"/>.
  40. </para>
  41. </remarks>
  42. <example>
  43. An example of a SQL Server table that could be logged to:
  44. <code lang="SQL">
  45. CREATE TABLE [dbo].[Log] (
  46. [ID] [int] IDENTITY (1, 1) NOT NULL ,
  47. [Date] [datetime] NOT NULL ,
  48. [Thread] [varchar] (255) NOT NULL ,
  49. [Level] [varchar] (20) NOT NULL ,
  50. [Logger] [varchar] (255) NOT NULL ,
  51. [Message] [varchar] (4000) NOT NULL
  52. ) ON [PRIMARY]
  53. </code>
  54. </example>
  55. <example>
  56. An example configuration to log to the above table:
  57. <code lang="XML" escaped="true">
  58. <appender name="AdoNetAppender_SqlServer" type="log4net.Appender.AdoNetAppender">
  59. <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
  60. <connectionString value="data source=SQLSVR;initial catalog=test_log4net;integrated security=false;persist security info=True;User ID=sa;Password=sa"/>
  61. <commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)"/>
  62. <parameter>
  63. <parameterName value="@log_date"/>
  64. <dbType value="DateTime"/>
  65. <layout type="log4net.Layout.PatternLayout" value="%date{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}"/>
  66. </parameter>
  67. <parameter>
  68. <parameterName value="@thread"/>
  69. <dbType value="String"/>
  70. <size value="255"/>
  71. <layout type="log4net.Layout.PatternLayout" value="%thread"/>
  72. </parameter>
  73. <parameter>
  74. <parameterName value="@log_level"/>
  75. <dbType value="String"/>
  76. <size value="50"/>
  77. <layout type="log4net.Layout.PatternLayout" value="%level"/>
  78. </parameter>
  79. <parameter>
  80. <parameterName value="@logger"/>
  81. <dbType value="String"/>
  82. <size value="255"/>
  83. <layout type="log4net.Layout.PatternLayout" value="%logger"/>
  84. </parameter>
  85. <parameter>
  86. <parameterName value="@message"/>
  87. <dbType value="String"/>
  88. <size value="4000"/>
  89. <layout type="log4net.Layout.PatternLayout" value="%message"/>
  90. </parameter>
  91. </appender>
  92. </code>
  93. </example>
  94. <author>Julian Biddle</author>
  95. <author>Nicko Cadell</author>
  96. <author>Gert Driesen</author>
  97. <author>Lance Nehring</author>
  98. </member>
  99. <member name="T:log4net.Appender.BufferingAppenderSkeleton">
  100. <summary>
  101. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that
  102. buffers events in a fixed size buffer.
  103. </summary>
  104. <remarks>
  105. <para>
  106. This base class should be used by appenders that need to buffer a
  107. number of events before logging them. For example the <see cref="T:log4net.Appender.AdoNetAppender"/>
  108. buffers events and then submits the entire contents of the buffer to
  109. the underlying database in one go.
  110. </para>
  111. <para>
  112. Subclasses should override the <see cref="M:SendBuffer(LoggingEvent[])"/>
  113. method to deliver the buffered events.
  114. </para>
  115. <para>The BufferingAppenderSkeleton maintains a fixed size cyclic
  116. buffer of events. The size of the buffer is set using
  117. the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property.
  118. </para>
  119. <para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect
  120. each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  121. triggers, then the current buffer is sent immediately
  122. (see <see cref="M:SendBuffer(LoggingEvent[])"/>). Otherwise the event
  123. is stored in the buffer. For example, an evaluator can be used to
  124. deliver the events immediately when an ERROR event arrives.
  125. </para>
  126. <para>
  127. The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode.
  128. By default the appender is NOT lossy. When the buffer is full all
  129. the buffered events are sent with <see cref="M:SendBuffer(LoggingEvent[])"/>.
  130. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the
  131. buffer will not be sent when it is full, and new events arriving
  132. in the appender will overwrite the oldest event in the buffer.
  133. In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  134. triggers. This can be useful behavior when you need to know about
  135. ERROR events but not about events with a lower level, configure an
  136. evaluator that will trigger when an ERROR event arrives, the whole
  137. buffer will be sent which gives a history of events leading up to
  138. the ERROR event.
  139. </para>
  140. </remarks>
  141. <author>Nicko Cadell</author>
  142. <author>Gert Driesen</author>
  143. </member>
  144. <member name="T:log4net.Appender.AppenderSkeleton">
  145. <summary>
  146. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>.
  147. </summary>
  148. <remarks>
  149. <para>
  150. This class provides the code for common functionality, such
  151. as support for threshold filtering and support for general filters.
  152. </para>
  153. <para>
  154. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  155. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  156. be called after the appenders properties have been configured.
  157. </para>
  158. </remarks>
  159. <author>Nicko Cadell</author>
  160. <author>Gert Driesen</author>
  161. </member>
  162. <member name="T:log4net.Appender.IAppender">
  163. <summary>
  164. Implement this interface for your own strategies for printing log statements.
  165. </summary>
  166. <remarks>
  167. <para>
  168. Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/>
  169. class which provides a default implementation of this interface.
  170. </para>
  171. <para>
  172. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  173. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  174. be called after the appenders properties have been configured.
  175. </para>
  176. </remarks>
  177. <author>Nicko Cadell</author>
  178. <author>Gert Driesen</author>
  179. </member>
  180. <member name="M:log4net.Appender.IAppender.Close">
  181. <summary>
  182. Closes the appender and releases resources.
  183. </summary>
  184. <remarks>
  185. <para>
  186. Releases any resources allocated within the appender such as file handles,
  187. network connections, etc.
  188. </para>
  189. <para>
  190. It is a programming error to append to a closed appender.
  191. </para>
  192. </remarks>
  193. </member>
  194. <member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)">
  195. <summary>
  196. Log the logging event in Appender specific way.
  197. </summary>
  198. <param name="loggingEvent">The event to log</param>
  199. <remarks>
  200. <para>
  201. This method is called to log a message into this appender.
  202. </para>
  203. </remarks>
  204. </member>
  205. <member name="P:log4net.Appender.IAppender.Name">
  206. <summary>
  207. Gets or sets the name of this appender.
  208. </summary>
  209. <value>The name of the appender.</value>
  210. <remarks>
  211. <para>The name uniquely identifies the appender.</para>
  212. </remarks>
  213. </member>
  214. <member name="T:log4net.Appender.IBulkAppender">
  215. <summary>
  216. Interface for appenders that support bulk logging.
  217. </summary>
  218. <remarks>
  219. <para>
  220. This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to
  221. support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders
  222. should only implement this interface if they can bulk log efficiently.
  223. </para>
  224. </remarks>
  225. <author>Nicko Cadell</author>
  226. </member>
  227. <member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])">
  228. <summary>
  229. Log the array of logging events in Appender specific way.
  230. </summary>
  231. <param name="loggingEvents">The events to log</param>
  232. <remarks>
  233. <para>
  234. This method is called to log an array of events into this appender.
  235. </para>
  236. </remarks>
  237. </member>
  238. <member name="T:log4net.Core.IOptionHandler">
  239. <summary>
  240. Interface used to delay activate a configured object.
  241. </summary>
  242. <remarks>
  243. <para>
  244. This allows an object to defer activation of its options until all
  245. options have been set. This is required for components which have
  246. related options that remain ambiguous until all are set.
  247. </para>
  248. <para>
  249. If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method
  250. must be called by the container after its all the configured properties have been set
  251. and before the component can be used.
  252. </para>
  253. </remarks>
  254. <author>Nicko Cadell</author>
  255. </member>
  256. <member name="M:log4net.Core.IOptionHandler.ActivateOptions">
  257. <summary>
  258. Activate the options that were previously set with calls to properties.
  259. </summary>
  260. <remarks>
  261. <para>
  262. This allows an object to defer activation of its options until all
  263. options have been set. This is required for components which have
  264. related options that remain ambiguous until all are set.
  265. </para>
  266. <para>
  267. If a component implements this interface then this method must be called
  268. after its properties have been set before the component can be used.
  269. </para>
  270. </remarks>
  271. </member>
  272. <member name="T:log4net.Appender.IFlushable">
  273. <summary>
  274. Interface that can be implemented by Appenders that buffer logging data and expose a <see cref="M:log4net.Appender.IFlushable.Flush(System.Int32)"/> method.
  275. </summary>
  276. </member>
  277. <member name="M:log4net.Appender.IFlushable.Flush(System.Int32)">
  278. <summary>
  279. Flushes any buffered log data.
  280. </summary>
  281. <remarks>
  282. 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
  283. the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  284. <para>
  285. Typically this is done by locking on the Appender instance, e.g.:
  286. <code>
  287. <![CDATA[
  288. public bool Flush(int millisecondsTimeout)
  289. {
  290. lock(this)
  291. {
  292. // Flush buffered logging data
  293. ...
  294. }
  295. }
  296. ]]>
  297. </code>
  298. </para>
  299. <para>
  300. The <paramref name="millisecondsTimeout"/> parameter is only relevant for appenders that process logging events asynchronously,
  301. such as <see cref="T:log4net.Appender.RemotingAppender"/>.
  302. </para>
  303. </remarks>
  304. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  305. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  306. </member>
  307. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize">
  308. <summary>
  309. Initial buffer size
  310. </summary>
  311. </member>
  312. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity">
  313. <summary>
  314. Maximum buffer size before it is recycled
  315. </summary>
  316. </member>
  317. <member name="M:log4net.Appender.AppenderSkeleton.#ctor">
  318. <summary>
  319. Default constructor
  320. </summary>
  321. <remarks>
  322. <para>Empty default constructor</para>
  323. </remarks>
  324. </member>
  325. <member name="M:log4net.Appender.AppenderSkeleton.Finalize">
  326. <summary>
  327. Finalizes this appender by calling the implementation's
  328. <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
  329. </summary>
  330. <remarks>
  331. <para>
  332. If this appender has not been closed then the <c>Finalize</c> method
  333. will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>.
  334. </para>
  335. </remarks>
  336. </member>
  337. <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
  338. <summary>
  339. Initialize the appender based on the options set
  340. </summary>
  341. <remarks>
  342. <para>
  343. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  344. activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must
  345. be called on this object after the configuration properties have
  346. been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this
  347. object is in an undefined state and must not be used.
  348. </para>
  349. <para>
  350. If any of the configuration properties are modified then
  351. <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again.
  352. </para>
  353. </remarks>
  354. </member>
  355. <member name="M:log4net.Appender.AppenderSkeleton.Close">
  356. <summary>
  357. Closes the appender and release resources.
  358. </summary>
  359. <remarks>
  360. <para>
  361. Release any resources allocated within the appender such as file handles,
  362. network connections, etc.
  363. </para>
  364. <para>
  365. It is a programming error to append to a closed appender.
  366. </para>
  367. <para>
  368. This method cannot be overridden by subclasses. This method
  369. delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
  370. method which must be overridden in the subclass.
  371. </para>
  372. </remarks>
  373. </member>
  374. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)">
  375. <summary>
  376. Performs threshold checks and invokes filters before
  377. delegating actual logging to the subclasses specific
  378. <see cref="M:Append(LoggingEvent)"/> method.
  379. </summary>
  380. <param name="loggingEvent">The event to log.</param>
  381. <remarks>
  382. <para>
  383. This method cannot be overridden by derived classes. A
  384. derived class should override the <see cref="M:Append(LoggingEvent)"/> method
  385. which is called by this method.
  386. </para>
  387. <para>
  388. The implementation of this method is as follows:
  389. </para>
  390. <para>
  391. <list type="bullet">
  392. <item>
  393. <description>
  394. Checks that the severity of the <paramref name="loggingEvent"/>
  395. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  396. appender.</description>
  397. </item>
  398. <item>
  399. <description>
  400. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  401. <paramref name="loggingEvent"/>.
  402. </description>
  403. </item>
  404. <item>
  405. <description>
  406. Calls <see cref="M:PreAppendCheck()"/> and checks that
  407. it returns <c>true</c>.</description>
  408. </item>
  409. </list>
  410. </para>
  411. <para>
  412. If all of the above steps succeed then the <paramref name="loggingEvent"/>
  413. will be passed to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  414. </para>
  415. </remarks>
  416. </member>
  417. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
  418. <summary>
  419. Performs threshold checks and invokes filters before
  420. delegating actual logging to the subclasses specific
  421. <see cref="M:Append(LoggingEvent[])"/> method.
  422. </summary>
  423. <param name="loggingEvents">The array of events to log.</param>
  424. <remarks>
  425. <para>
  426. This method cannot be overridden by derived classes. A
  427. derived class should override the <see cref="M:Append(LoggingEvent[])"/> method
  428. which is called by this method.
  429. </para>
  430. <para>
  431. The implementation of this method is as follows:
  432. </para>
  433. <para>
  434. <list type="bullet">
  435. <item>
  436. <description>
  437. Checks that the severity of the <paramref name="loggingEvents"/>
  438. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  439. appender.</description>
  440. </item>
  441. <item>
  442. <description>
  443. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  444. <paramref name="loggingEvents"/>.
  445. </description>
  446. </item>
  447. <item>
  448. <description>
  449. Calls <see cref="M:PreAppendCheck()"/> and checks that
  450. it returns <c>true</c>.</description>
  451. </item>
  452. </list>
  453. </para>
  454. <para>
  455. If all of the above steps succeed then the <paramref name="loggingEvents"/>
  456. will be passed to the <see cref="M:Append(LoggingEvent[])"/> method.
  457. </para>
  458. </remarks>
  459. </member>
  460. <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
  461. <summary>
  462. Test if the logging event should we output by this appender
  463. </summary>
  464. <param name="loggingEvent">the event to test</param>
  465. <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
  466. <remarks>
  467. <para>
  468. This method checks the logging event against the threshold level set
  469. on this appender and also against the filters specified on this
  470. appender.
  471. </para>
  472. <para>
  473. The implementation of this method is as follows:
  474. </para>
  475. <para>
  476. <list type="bullet">
  477. <item>
  478. <description>
  479. Checks that the severity of the <paramref name="loggingEvent"/>
  480. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  481. appender.</description>
  482. </item>
  483. <item>
  484. <description>
  485. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  486. <paramref name="loggingEvent"/>.
  487. </description>
  488. </item>
  489. </list>
  490. </para>
  491. </remarks>
  492. </member>
  493. <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
  494. <summary>
  495. Adds a filter to the end of the filter chain.
  496. </summary>
  497. <param name="filter">the filter to add to this appender</param>
  498. <remarks>
  499. <para>
  500. The Filters are organized in a linked list.
  501. </para>
  502. <para>
  503. Setting this property causes the new filter to be pushed onto the
  504. back of the filter chain.
  505. </para>
  506. </remarks>
  507. </member>
  508. <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
  509. <summary>
  510. Clears the filter list for this appender.
  511. </summary>
  512. <remarks>
  513. <para>
  514. Clears the filter list for this appender.
  515. </para>
  516. </remarks>
  517. </member>
  518. <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)">
  519. <summary>
  520. Checks if the message level is below this appender's threshold.
  521. </summary>
  522. <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param>
  523. <remarks>
  524. <para>
  525. If there is no threshold set, then the return value is always <c>true</c>.
  526. </para>
  527. </remarks>
  528. <returns>
  529. <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
  530. requirements of this appender.
  531. </returns>
  532. </member>
  533. <member name="M:log4net.Appender.AppenderSkeleton.OnClose">
  534. <summary>
  535. Is called when the appender is closed. Derived classes should override
  536. this method if resources need to be released.
  537. </summary>
  538. <remarks>
  539. <para>
  540. Releases any resources allocated within the appender such as file handles,
  541. network connections, etc.
  542. </para>
  543. <para>
  544. It is a programming error to append to a closed appender.
  545. </para>
  546. </remarks>
  547. </member>
  548. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  549. <summary>
  550. Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
  551. to perform actual logging.
  552. </summary>
  553. <param name="loggingEvent">The event to append.</param>
  554. <remarks>
  555. <para>
  556. A subclass must implement this method to perform
  557. logging of the <paramref name="loggingEvent"/>.
  558. </para>
  559. <para>This method will be called by <see cref="M:DoAppend(LoggingEvent)"/>
  560. if all the conditions listed for that method are met.
  561. </para>
  562. <para>
  563. To restrict the logging of events in the appender
  564. override the <see cref="M:PreAppendCheck()"/> method.
  565. </para>
  566. </remarks>
  567. </member>
  568. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
  569. <summary>
  570. Append a bulk array of logging events.
  571. </summary>
  572. <param name="loggingEvents">the array of logging events</param>
  573. <remarks>
  574. <para>
  575. This base class implementation calls the <see cref="M:Append(LoggingEvent)"/>
  576. method for each element in the bulk array.
  577. </para>
  578. <para>
  579. A sub class that can better process a bulk array of events should
  580. override this method in addition to <see cref="M:Append(LoggingEvent)"/>.
  581. </para>
  582. </remarks>
  583. </member>
  584. <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
  585. <summary>
  586. Called before <see cref="M:Append(LoggingEvent)"/> as a precondition.
  587. </summary>
  588. <remarks>
  589. <para>
  590. This method is called by <see cref="M:DoAppend(LoggingEvent)"/>
  591. before the call to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  592. </para>
  593. <para>
  594. This method can be overridden in a subclass to extend the checks
  595. made before the event is passed to the <see cref="M:Append(LoggingEvent)"/> method.
  596. </para>
  597. <para>
  598. A subclass should ensure that they delegate this call to
  599. this base class if it is overridden.
  600. </para>
  601. </remarks>
  602. <returns><c>true</c> if the call to <see cref="M:Append(LoggingEvent)"/> should proceed.</returns>
  603. </member>
  604. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)">
  605. <summary>
  606. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  607. </summary>
  608. <param name="loggingEvent">The event to render.</param>
  609. <returns>The event rendered as a string.</returns>
  610. <remarks>
  611. <para>
  612. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  613. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  614. set to render the <paramref name="loggingEvent"/> to
  615. a string.
  616. </para>
  617. <para>If there is exception data in the logging event and
  618. the layout does not process the exception, this method
  619. will append the exception text to the rendered string.
  620. </para>
  621. <para>
  622. Where possible use the alternative version of this method
  623. <see cref="M:RenderLoggingEvent(TextWriter,LoggingEvent)"/>.
  624. That method streams the rendering onto an existing Writer
  625. which can give better performance if the caller already has
  626. a <see cref="T:System.IO.TextWriter"/> open and ready for writing.
  627. </para>
  628. </remarks>
  629. </member>
  630. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  631. <summary>
  632. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  633. </summary>
  634. <param name="loggingEvent">The event to render.</param>
  635. <param name="writer">The TextWriter to write the formatted event to</param>
  636. <remarks>
  637. <para>
  638. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  639. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  640. set to render the <paramref name="loggingEvent"/> to
  641. a string.
  642. </para>
  643. <para>If there is exception data in the logging event and
  644. the layout does not process the exception, this method
  645. will append the exception text to the rendered string.
  646. </para>
  647. <para>
  648. Use this method in preference to <see cref="M:RenderLoggingEvent(LoggingEvent)"/>
  649. where possible. If, however, the caller needs to render the event
  650. to a string then <see cref="M:RenderLoggingEvent(LoggingEvent)"/> does
  651. provide an efficient mechanism for doing so.
  652. </para>
  653. </remarks>
  654. </member>
  655. <member name="M:log4net.Appender.AppenderSkeleton.Flush(System.Int32)">
  656. <summary>
  657. Flushes any buffered log data.
  658. </summary>
  659. <remarks>
  660. This implementation doesn't flush anything and always returns true
  661. </remarks>
  662. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  663. </member>
  664. <member name="F:log4net.Appender.AppenderSkeleton.m_layout">
  665. <summary>
  666. The layout of this appender.
  667. </summary>
  668. <remarks>
  669. See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
  670. </remarks>
  671. </member>
  672. <member name="F:log4net.Appender.AppenderSkeleton.m_name">
  673. <summary>
  674. The name of this appender.
  675. </summary>
  676. <remarks>
  677. See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
  678. </remarks>
  679. </member>
  680. <member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
  681. <summary>
  682. The level threshold of this appender.
  683. </summary>
  684. <remarks>
  685. <para>
  686. There is no level threshold filtering by default.
  687. </para>
  688. <para>
  689. See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
  690. </para>
  691. </remarks>
  692. </member>
  693. <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
  694. <summary>
  695. It is assumed and enforced that errorHandler is never null.
  696. </summary>
  697. <remarks>
  698. <para>
  699. It is assumed and enforced that errorHandler is never null.
  700. </para>
  701. <para>
  702. See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
  703. </para>
  704. </remarks>
  705. </member>
  706. <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
  707. <summary>
  708. The first filter in the filter chain.
  709. </summary>
  710. <remarks>
  711. <para>
  712. Set to <c>null</c> initially.
  713. </para>
  714. <para>
  715. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  716. </para>
  717. </remarks>
  718. </member>
  719. <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
  720. <summary>
  721. The last filter in the filter chain.
  722. </summary>
  723. <remarks>
  724. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  725. </remarks>
  726. </member>
  727. <member name="F:log4net.Appender.AppenderSkeleton.m_closed">
  728. <summary>
  729. Flag indicating if this appender is closed.
  730. </summary>
  731. <remarks>
  732. See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
  733. </remarks>
  734. </member>
  735. <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
  736. <summary>
  737. The guard prevents an appender from repeatedly calling its own DoAppend method
  738. </summary>
  739. </member>
  740. <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter">
  741. <summary>
  742. StringWriter used to render events
  743. </summary>
  744. </member>
  745. <member name="F:log4net.Appender.AppenderSkeleton.declaringType">
  746. <summary>
  747. The fully qualified type of the AppenderSkeleton class.
  748. </summary>
  749. <remarks>
  750. Used by the internal logger to record the Type of the
  751. log message.
  752. </remarks>
  753. </member>
  754. <member name="P:log4net.Appender.AppenderSkeleton.Threshold">
  755. <summary>
  756. Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender.
  757. </summary>
  758. <value>
  759. The threshold <see cref="T:log4net.Core.Level"/> of the appender.
  760. </value>
  761. <remarks>
  762. <para>
  763. All log events with lower level than the threshold level are ignored
  764. by the appender.
  765. </para>
  766. <para>
  767. In configuration files this option is specified by setting the
  768. value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
  769. string, such as "DEBUG", "INFO" and so on.
  770. </para>
  771. </remarks>
  772. </member>
  773. <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
  774. <summary>
  775. Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  776. </summary>
  777. <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value>
  778. <remarks>
  779. <para>
  780. The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
  781. implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
  782. </para>
  783. </remarks>
  784. </member>
  785. <member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
  786. <summary>
  787. The filter chain.
  788. </summary>
  789. <value>The head of the filter chain filter chain.</value>
  790. <remarks>
  791. <para>
  792. Returns the head Filter. The Filters are organized in a linked list
  793. and so all Filters on this Appender are available through the result.
  794. </para>
  795. </remarks>
  796. </member>
  797. <member name="P:log4net.Appender.AppenderSkeleton.Layout">
  798. <summary>
  799. Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
  800. </summary>
  801. <value>The layout of the appender.</value>
  802. <remarks>
  803. <para>
  804. See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
  805. </para>
  806. </remarks>
  807. <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
  808. </member>
  809. <member name="P:log4net.Appender.AppenderSkeleton.Name">
  810. <summary>
  811. Gets or sets the name of this appender.
  812. </summary>
  813. <value>The name of the appender.</value>
  814. <remarks>
  815. <para>
  816. The name uniquely identifies the appender.
  817. </para>
  818. </remarks>
  819. </member>
  820. <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
  821. <summary>
  822. Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  823. </summary>
  824. <remarks>
  825. <para>
  826. In the rather exceptional case, where the appender
  827. implementation admits a layout but can also work without it,
  828. then the appender should return <c>true</c>.
  829. </para>
  830. <para>
  831. This default implementation always returns <c>false</c>.
  832. </para>
  833. </remarks>
  834. <returns>
  835. <c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
  836. </returns>
  837. </member>
  838. <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
  839. <summary>
  840. The default buffer size.
  841. </summary>
  842. <remarks>
  843. The default size of the cyclic buffer used to store events.
  844. This is set to 512 by default.
  845. </remarks>
  846. </member>
  847. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
  848. <summary>
  849. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
  850. </summary>
  851. <remarks>
  852. <para>
  853. Protected default constructor to allow subclassing.
  854. </para>
  855. </remarks>
  856. </member>
  857. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
  858. <summary>
  859. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
  860. </summary>
  861. <param name="eventMustBeFixed">the events passed through this appender must be
  862. fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param>
  863. <remarks>
  864. <para>
  865. Protected constructor to allow subclassing.
  866. </para>
  867. <para>
  868. The <paramref name="eventMustBeFixed"/> should be set if the subclass
  869. expects the events delivered to be fixed even if the
  870. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs.
  871. </para>
  872. </remarks>
  873. </member>
  874. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Int32)">
  875. <summary>
  876. Flushes any buffered log data.
  877. </summary>
  878. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  879. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  880. </member>
  881. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
  882. <summary>
  883. Flush the currently buffered events
  884. </summary>
  885. <remarks>
  886. <para>
  887. Flushes any events that have been buffered.
  888. </para>
  889. <para>
  890. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  891. of the buffer will NOT be flushed to the appender.
  892. </para>
  893. </remarks>
  894. </member>
  895. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
  896. <summary>
  897. Flush the currently buffered events
  898. </summary>
  899. <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
  900. <remarks>
  901. <para>
  902. Flushes events that have been buffered. If <paramref name="flushLossyBuffer"/> is
  903. <c>false</c> then events will only be flushed if this buffer is non-lossy mode.
  904. </para>
  905. <para>
  906. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  907. of the buffer will only be flushed if <paramref name="flushLossyBuffer"/> is <c>true</c>.
  908. In this case the contents of the buffer will be tested against the
  909. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
  910. events will be discarded.
  911. </para>
  912. <para>
  913. If <paramref name="flushLossyBuffer"/> is <c>true</c> then the buffer will always
  914. be emptied by calling this method.
  915. </para>
  916. </remarks>
  917. </member>
  918. <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
  919. <summary>
  920. Initialize the appender based on the options set
  921. </summary>
  922. <remarks>
  923. <para>
  924. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  925. activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must
  926. be called on this object after the configuration properties have
  927. been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this
  928. object is in an undefined state and must not be used.
  929. </para>
  930. <para>
  931. If any of the configuration properties are modified then
  932. <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again.
  933. </para>
  934. </remarks>
  935. </member>
  936. <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
  937. <summary>
  938. Close this appender instance.
  939. </summary>
  940. <remarks>
  941. <para>
  942. Close this appender instance. If this appender is marked
  943. as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
  944. the buffer must be sent when the appender is closed.
  945. </para>
  946. </remarks>
  947. </member>
  948. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  949. <summary>
  950. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  951. </summary>
  952. <param name="loggingEvent">the event to log</param>
  953. <remarks>
  954. <para>
  955. Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
  956. </para>
  957. <para>
  958. The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
  959. method) if one of the following conditions is met:
  960. </para>
  961. <list type="bullet">
  962. <item>
  963. <description>The cyclic buffer is full and this appender is
  964. marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
  965. </item>
  966. <item>
  967. <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
  968. it is triggered for the <paramref name="loggingEvent"/>
  969. specified.</description>
  970. </item>
  971. </list>
  972. <para>
  973. Before the event is stored in the buffer it is fixed
  974. (see <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/>) to ensure that
  975. any data referenced by the event will be valid when the buffer
  976. is processed.
  977. </para>
  978. </remarks>
  979. </member>
  980. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
  981. <summary>
  982. Sends the contents of the buffer.
  983. </summary>
  984. <param name="firstLoggingEvent">The first logging event.</param>
  985. <param name="buffer">The buffer containing the events that need to be send.</param>
  986. <remarks>
  987. <para>
  988. The subclass must override <see cref="M:SendBuffer(LoggingEvent[])"/>.
  989. </para>
  990. </remarks>
  991. </member>
  992. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
  993. <summary>
  994. Sends the events.
  995. </summary>
  996. <param name="events">The events that need to be send.</param>
  997. <remarks>
  998. <para>
  999. The subclass must override this method to process the buffered events.
  1000. </para>
  1001. </remarks>
  1002. </member>
  1003. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
  1004. <summary>
  1005. The size of the cyclic buffer used to hold the logging events.
  1006. </summary>
  1007. <remarks>
  1008. Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
  1009. </remarks>
  1010. </member>
  1011. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
  1012. <summary>
  1013. The cyclic buffer used to store the logging events.
  1014. </summary>
  1015. </member>
  1016. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
  1017. <summary>
  1018. The triggering event evaluator that causes the buffer to be sent immediately.
  1019. </summary>
  1020. <remarks>
  1021. The object that is used to determine if an event causes the entire
  1022. buffer to be sent immediately. This field can be <c>null</c>, which
  1023. indicates that event triggering is not to be done. The evaluator
  1024. can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
  1025. has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
  1026. <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
  1027. </remarks>
  1028. </member>
  1029. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
  1030. <summary>
  1031. Indicates if the appender should overwrite events in the cyclic buffer
  1032. when it becomes full, or if the buffer should be flushed when the
  1033. buffer is full.
  1034. </summary>
  1035. <remarks>
  1036. If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
  1037. be set.
  1038. </remarks>
  1039. </member>
  1040. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
  1041. <summary>
  1042. The triggering event evaluator filters discarded events.
  1043. </summary>
  1044. <remarks>
  1045. The object that is used to determine if an event that is discarded should
  1046. really be discarded or if it should be sent to the appenders.
  1047. This field can be <c>null</c>, which indicates that all discarded events will
  1048. be discarded.
  1049. </remarks>
  1050. </member>
  1051. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
  1052. <summary>
  1053. Value indicating which fields in the event should be fixed
  1054. </summary>
  1055. <remarks>
  1056. By default all fields are fixed
  1057. </remarks>
  1058. </member>
  1059. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
  1060. <summary>
  1061. The events delivered to the subclass must be fixed.
  1062. </summary>
  1063. </member>
  1064. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
  1065. <summary>
  1066. Gets or sets a value that indicates whether the appender is lossy.
  1067. </summary>
  1068. <value>
  1069. <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
  1070. </value>
  1071. <remarks>
  1072. <para>
  1073. This appender uses a buffer to store logging events before
  1074. delivering them. A triggering event causes the whole buffer
  1075. to be send to the remote sink. If the buffer overruns before
  1076. a triggering event then logging events could be lost. Set
  1077. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
  1078. from being lost.
  1079. </para>
  1080. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  1081. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  1082. </remarks>
  1083. </member>
  1084. <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
  1085. <summary>
  1086. Gets or sets the size of the cyclic buffer used to hold the
  1087. logging events.
  1088. </summary>
  1089. <value>
  1090. The size of the cyclic buffer used to hold the logging events.
  1091. </value>
  1092. <remarks>
  1093. <para>
  1094. The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
  1095. representing the maximum number of logging events to collect in
  1096. a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
  1097. oldest events are deleted as new events are added to the
  1098. buffer. By default the size of the cyclic buffer is 512 events.
  1099. </para>
  1100. <para>
  1101. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than
  1102. or equal to 1 then no buffering will occur. The logging event
  1103. will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>
  1104. and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will
  1105. be buffered.
  1106. </para>
  1107. </remarks>
  1108. </member>
  1109. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
  1110. <summary>
  1111. Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the
  1112. buffer to be sent immediately.
  1113. </summary>
  1114. <value>
  1115. The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be
  1116. sent immediately.
  1117. </value>
  1118. <remarks>
  1119. <para>
  1120. The evaluator will be called for each event that is appended to this
  1121. appender. If the evaluator triggers then the current buffer will
  1122. immediately be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  1123. </para>
  1124. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  1125. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  1126. </remarks>
  1127. </member>
  1128. <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
  1129. <summary>
  1130. Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  1131. </summary>
  1132. <value>
  1133. The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  1134. </value>
  1135. <remarks>
  1136. <para>
  1137. The evaluator will be called for each event that is discarded from this
  1138. appender. If the evaluator triggers then the current buffer will immediately
  1139. be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  1140. </para>
  1141. </remarks>
  1142. </member>
  1143. <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
  1144. <summary>
  1145. Gets or sets a value indicating if only part of the logging event data
  1146. should be fixed.
  1147. </summary>
  1148. <value>
  1149. <c>true</c> if the appender should only fix part of the logging event
  1150. data, otherwise <c>false</c>. The default is <c>false</c>.
  1151. </value>
  1152. <remarks>
  1153. <para>
  1154. Setting this property to <c>true</c> will cause only part of the
  1155. event data to be fixed and serialized. This will improve performance.
  1156. </para>
  1157. <para>
  1158. See <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/> for more information.
  1159. </para>
  1160. </remarks>
  1161. </member>
  1162. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
  1163. <summary>
  1164. Gets or sets a the fields that will be fixed in the event
  1165. </summary>
  1166. <value>
  1167. The event fields that will be fixed before the event is buffered
  1168. </value>
  1169. <remarks>
  1170. <para>
  1171. The logging event needs to have certain thread specific values
  1172. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  1173. for details.
  1174. </para>
  1175. </remarks>
  1176. <seealso cref="P:log4net.Core.LoggingEvent.Fix"/>
  1177. </member>
  1178. <member name="M:log4net.Appender.AdoNetAppender.#ctor">
  1179. <summary>
  1180. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender"/> class.
  1181. </summary>
  1182. <remarks>
  1183. Public default constructor to initialize a new instance of this class.
  1184. </remarks>
  1185. </member>
  1186. <member name="M:log4net.Appender.AdoNetAppender.ActivateOptions">
  1187. <summary>
  1188. Initialize the appender based on the options set
  1189. </summary>
  1190. <remarks>
  1191. <para>
  1192. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  1193. activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must
  1194. be called on this object after the configuration properties have
  1195. been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this
  1196. object is in an undefined state and must not be used.
  1197. </para>
  1198. <para>
  1199. If any of the configuration properties are modified then
  1200. <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again.
  1201. </para>
  1202. </remarks>
  1203. </member>
  1204. <member name="M:log4net.Appender.AdoNetAppender.OnClose">
  1205. <summary>
  1206. Override the parent method to close the database
  1207. </summary>
  1208. <remarks>
  1209. <para>
  1210. Closes the database command and database connection.
  1211. </para>
  1212. </remarks>
  1213. </member>
  1214. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  1215. <summary>
  1216. Inserts the events into the database.
  1217. </summary>
  1218. <param name="events">The events to insert into the database.</param>
  1219. <remarks>
  1220. <para>
  1221. Insert all the events specified in the <paramref name="events"/>
  1222. array into the database.
  1223. </para>
  1224. </remarks>
  1225. </member>
  1226. <member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)">
  1227. <summary>
  1228. Adds a parameter to the command.
  1229. </summary>
  1230. <param name="parameter">The parameter to add to the command.</param>
  1231. <remarks>
  1232. <para>
  1233. Adds a parameter to the ordered list of command parameters.
  1234. </para>
  1235. </remarks>
  1236. </member>
  1237. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])">
  1238. <summary>
  1239. Writes the events to the database using the transaction specified.
  1240. </summary>
  1241. <param name="dbTran">The transaction that the events will be executed under.</param>
  1242. <param name="events">The array of events to insert into the database.</param>
  1243. <remarks>
  1244. <para>
  1245. The transaction argument can be <c>null</c> if the appender has been
  1246. configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/>
  1247. property for more information.
  1248. </para>
  1249. </remarks>
  1250. </member>
  1251. <member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)">
  1252. <summary>
  1253. Formats the log message into database statement text.
  1254. </summary>
  1255. <param name="logEvent">The event being logged.</param>
  1256. <remarks>
  1257. This method can be overridden by subclasses to provide
  1258. more control over the format of the database statement.
  1259. </remarks>
  1260. <returns>
  1261. Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
  1262. </returns>
  1263. </member>
  1264. <member name="M:log4net.Appender.AdoNetAppender.CreateConnection(System.Type,System.String)">
  1265. <summary>
  1266. Creates an <see cref="T:System.Data.IDbConnection"/> instance used to connect to the database.
  1267. </summary>
  1268. <remarks>
  1269. This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary).
  1270. </remarks>
  1271. <param name="connectionType">The <see cref="T:System.Type"/> of the <see cref="T:System.Data.IDbConnection"/> object.</param>
  1272. <param name="connectionString">The connectionString output from the ResolveConnectionString method.</param>
  1273. <returns>An <see cref="T:System.Data.IDbConnection"/> instance with a valid connection string.</returns>
  1274. </member>
  1275. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionString(System.String@)">
  1276. <summary>
  1277. Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey
  1278. property.
  1279. </summary>
  1280. <remarks>
  1281. ConnectiongStringName is only supported on .NET 2.0 and higher.
  1282. </remarks>
  1283. <param name="connectionStringContext">Additional information describing the connection string.</param>
  1284. <returns>A connection string used to connect to the database.</returns>
  1285. </member>
  1286. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType">
  1287. <summary>
  1288. Retrieves the class type of the ADO.NET provider.
  1289. </summary>
  1290. <remarks>
  1291. <para>
  1292. Gets the Type of the ADO.NET provider to use to connect to the
  1293. database. This method resolves the type specified in the
  1294. <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property.
  1295. </para>
  1296. <para>
  1297. Subclasses can override this method to return a different type
  1298. if necessary.
  1299. </para>
  1300. </remarks>
  1301. <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns>
  1302. </member>
  1303. <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection">
  1304. <summary>
  1305. Connects to the database.
  1306. </summary>
  1307. </member>
  1308. <member name="M:log4net.Appender.AdoNetAppender.DiposeConnection">
  1309. <summary>
  1310. Cleanup the existing connection.
  1311. </summary>
  1312. <remarks>
  1313. Calls the IDbConnection's <see cref="M:System.Data.IDbConnection.Close"/> method.
  1314. </remarks>
  1315. </member>
  1316. <member name="F:log4net.Appender.AdoNetAppender.m_parameters">
  1317. <summary>
  1318. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  1319. </summary>
  1320. <remarks>
  1321. <para>
  1322. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  1323. </para>
  1324. </remarks>
  1325. </member>
  1326. <member name="F:log4net.Appender.AdoNetAppender.m_securityContext">
  1327. <summary>
  1328. The security context to use for privileged calls
  1329. </summary>
  1330. </member>
  1331. <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection">
  1332. <summary>
  1333. The <see cref="T:System.Data.IDbConnection"/> that will be used
  1334. to insert logging events into a database.
  1335. </summary>
  1336. </member>
  1337. <member name="F:log4net.Appender.AdoNetAppender.m_connectionString">
  1338. <summary>
  1339. Database connection string.
  1340. </summary>
  1341. </member>
  1342. <member name="F:log4net.Appender.AdoNetAppender.m_appSettingsKey">
  1343. <summary>
  1344. The appSettings key from App.Config that contains the connection string.
  1345. </summary>
  1346. </member>
  1347. <member name="F:log4net.Appender.AdoNetAppender.m_connectionStringName">
  1348. <summary>
  1349. The connectionStrings key from App.Config that contains the connection string.
  1350. </summary>
  1351. </member>
  1352. <member name="F:log4net.Appender.AdoNetAppender.m_connectionType">
  1353. <summary>
  1354. String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
  1355. </summary>
  1356. </member>
  1357. <member name="F:log4net.Appender.AdoNetAppender.m_commandText">
  1358. <summary>
  1359. The text of the command.
  1360. </summary>
  1361. </member>
  1362. <member name="F:log4net.Appender.AdoNetAppender.m_commandType">
  1363. <summary>
  1364. The command type.
  1365. </summary>
  1366. </member>
  1367. <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions">
  1368. <summary>
  1369. Indicates whether to use transactions when writing to the database.
  1370. </summary>
  1371. </member>
  1372. <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError">
  1373. <summary>
  1374. Indicates whether to reconnect when a connection is lost.
  1375. </summary>
  1376. </member>
  1377. <member name="F:log4net.Appender.AdoNetAppender.declaringType">
  1378. <summary>
  1379. The fully qualified type of the AdoNetAppender class.
  1380. </summary>
  1381. <remarks>
  1382. Used by the internal logger to record the Type of the
  1383. log message.
  1384. </remarks>
  1385. </member>
  1386. <member name="P:log4net.Appender.AdoNetAppender.ConnectionString">
  1387. <summary>
  1388. Gets or sets the database connection string that is used to connect to
  1389. the database.
  1390. </summary>
  1391. <value>
  1392. The database connection string used to connect to the database.
  1393. </value>
  1394. <remarks>
  1395. <para>
  1396. The connections string is specific to the connection type.
  1397. See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information.
  1398. </para>
  1399. </remarks>
  1400. <example>Connection string for MS Access via ODBC:
  1401. <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>
  1402. </example>
  1403. <example>Another connection string for MS Access via ODBC:
  1404. <code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code>
  1405. </example>
  1406. <example>Connection string for MS Access via OLE DB:
  1407. <code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code>
  1408. </example>
  1409. </member>
  1410. <member name="P:log4net.Appender.AdoNetAppender.AppSettingsKey">
  1411. <summary>
  1412. The appSettings key from App.Config that contains the connection string.
  1413. </summary>
  1414. </member>
  1415. <member name="P:log4net.Appender.AdoNetAppender.ConnectionStringName">
  1416. <summary>
  1417. The connectionStrings key from App.Config that contains the connection string.
  1418. </summary>
  1419. <remarks>
  1420. This property requires at least .NET 2.0.
  1421. </remarks>
  1422. </member>
  1423. <member name="P:log4net.Appender.AdoNetAppender.ConnectionType">
  1424. <summary>
  1425. Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection
  1426. that should be created.
  1427. </summary>
  1428. <value>
  1429. The type name of the <see cref="T:System.Data.IDbConnection"/> connection.
  1430. </value>
  1431. <remarks>
  1432. <para>
  1433. The type name of the ADO.NET provider to use.
  1434. </para>
  1435. <para>
  1436. The default is to use the OLE DB provider.
  1437. </para>
  1438. </remarks>
  1439. <example>Use the OLE DB Provider. This is the default value.
  1440. <code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1441. </example>
  1442. <example>Use the MS SQL Server Provider.
  1443. <code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1444. </example>
  1445. <example>Use the ODBC Provider.
  1446. <code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code>
  1447. This is an optional package that you can download from
  1448. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  1449. search for <b>ODBC .NET Data Provider</b>.
  1450. </example>
  1451. <example>Use the Oracle Provider.
  1452. <code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1453. This is an optional package that you can download from
  1454. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  1455. search for <b>.NET Managed Provider for Oracle</b>.
  1456. </example>
  1457. </member>
  1458. <member name="P:log4net.Appender.AdoNetAppender.CommandText">
  1459. <summary>
  1460. Gets or sets the command text that is used to insert logging events
  1461. into the database.
  1462. </summary>
  1463. <value>
  1464. The command text used to insert logging events into the database.
  1465. </value>
  1466. <remarks>
  1467. <para>
  1468. Either the text of the prepared statement or the
  1469. name of the stored procedure to execute to write into
  1470. the database.
  1471. </para>
  1472. <para>
  1473. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if
  1474. this text is a prepared statement or a stored procedure.
  1475. </para>
  1476. <para>
  1477. If this property is not set, the command text is retrieved by invoking
  1478. <see cref="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)"/>.
  1479. </para>
  1480. </remarks>
  1481. </member>
  1482. <member name="P:log4net.Appender.AdoNetAppender.CommandType">
  1483. <summary>
  1484. Gets or sets the command type to execute.
  1485. </summary>
  1486. <value>
  1487. The command type to execute.
  1488. </value>
  1489. <remarks>
  1490. <para>
  1491. This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify
  1492. that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute,
  1493. or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the
  1494. <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure
  1495. to execute.
  1496. </para>
  1497. <para>
  1498. The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>).
  1499. </para>
  1500. </remarks>
  1501. </member>
  1502. <member name="P:log4net.Appender.AdoNetAppender.UseTransactions">
  1503. <summary>
  1504. Should transactions be used to insert logging events in the database.
  1505. </summary>
  1506. <value>
  1507. <c>true</c> if transactions should be used to insert logging events in
  1508. the database, otherwise <c>false</c>. The default value is <c>true</c>.
  1509. </value>
  1510. <remarks>
  1511. <para>
  1512. Gets or sets a value that indicates whether transactions should be used
  1513. to insert logging events in the database.
  1514. </para>
  1515. <para>
  1516. When set a single transaction will be used to insert the buffered events
  1517. into the database. Otherwise each event will be inserted without using
  1518. an explicit transaction.
  1519. </para>
  1520. </remarks>
  1521. </member>
  1522. <member name="P:log4net.Appender.AdoNetAppender.SecurityContext">
  1523. <summary>
  1524. Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  1525. </summary>
  1526. <value>
  1527. The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  1528. </value>
  1529. <remarks>
  1530. <para>
  1531. Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender
  1532. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  1533. security context to use. The default behavior is to use the security context
  1534. of the current thread.
  1535. </para>
  1536. </remarks>
  1537. </member>
  1538. <member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError">
  1539. <summary>
  1540. Should this appender try to reconnect to the database on error.
  1541. </summary>
  1542. <value>
  1543. <c>true</c> if the appender should try to reconnect to the database after an
  1544. error has occurred, otherwise <c>false</c>. The default value is <c>false</c>,
  1545. i.e. not to try to reconnect.
  1546. </value>
  1547. <remarks>
  1548. <para>
  1549. The default behaviour is for the appender not to try to reconnect to the
  1550. database if an error occurs. Subsequent logging events are discarded.
  1551. </para>
  1552. <para>
  1553. To force the appender to attempt to reconnect to the database set this
  1554. property to <c>true</c>.
  1555. </para>
  1556. <note>
  1557. When the appender attempts to connect to the database there may be a
  1558. delay of up to the connection timeout specified in the connection string.
  1559. This delay will block the calling application's thread.
  1560. Until the connection can be reestablished this potential delay may occur multiple times.
  1561. </note>
  1562. </remarks>
  1563. </member>
  1564. <member name="P:log4net.Appender.AdoNetAppender.Connection">
  1565. <summary>
  1566. Gets or sets the underlying <see cref="T:System.Data.IDbConnection"/>.
  1567. </summary>
  1568. <value>
  1569. The underlying <see cref="T:System.Data.IDbConnection"/>.
  1570. </value>
  1571. <remarks>
  1572. <see cref="T:log4net.Appender.AdoNetAppender"/> creates a <see cref="T:System.Data.IDbConnection"/> to insert
  1573. logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender"/>
  1574. can use this property to get or set this <see cref="T:System.Data.IDbConnection"/>. Use the
  1575. underlying <see cref="T:System.Data.IDbConnection"/> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection"/> if
  1576. you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender"/> provides.
  1577. </remarks>
  1578. </member>
  1579. <member name="T:log4net.Appender.AdoNetAppenderParameter">
  1580. <summary>
  1581. Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>.
  1582. </summary>
  1583. <remarks>
  1584. <para>
  1585. This class provides the basic database parameter properties
  1586. as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface.
  1587. </para>
  1588. <para>This type can be subclassed to provide database specific
  1589. functionality. The two methods that are called externally are
  1590. <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>.
  1591. </para>
  1592. </remarks>
  1593. </member>
  1594. <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor">
  1595. <summary>
  1596. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> class.
  1597. </summary>
  1598. <remarks>
  1599. Default constructor for the AdoNetAppenderParameter class.
  1600. </remarks>
  1601. </member>
  1602. <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)">
  1603. <summary>
  1604. Prepare the specified database command object.
  1605. </summary>
  1606. <param name="command">The command to prepare.</param>
  1607. <remarks>
  1608. <para>
  1609. Prepares the database command object by adding
  1610. this parameter to its collection of parameters.
  1611. </para>
  1612. </remarks>
  1613. </member>
  1614. <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)">
  1615. <summary>
  1616. Renders the logging event and set the parameter value in the command.
  1617. </summary>
  1618. <param name="command">The command containing the parameter.</param>
  1619. <param name="loggingEvent">The event to be rendered.</param>
  1620. <remarks>
  1621. <para>
  1622. Renders the logging event using this parameters layout
  1623. object. Sets the value of the parameter on the command object.
  1624. </para>
  1625. </remarks>
  1626. </member>
  1627. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName">
  1628. <summary>
  1629. The name of this parameter.
  1630. </summary>
  1631. </member>
  1632. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType">
  1633. <summary>
  1634. The database type for this parameter.
  1635. </summary>
  1636. </member>
  1637. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType">
  1638. <summary>
  1639. Flag to infer type rather than use the DbType
  1640. </summary>
  1641. </member>
  1642. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision">
  1643. <summary>
  1644. The precision for this parameter.
  1645. </summary>
  1646. </member>
  1647. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale">
  1648. <summary>
  1649. The scale for this parameter.
  1650. </summary>
  1651. </member>
  1652. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size">
  1653. <summary>
  1654. The size for this parameter.
  1655. </summary>
  1656. </member>
  1657. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout">
  1658. <summary>
  1659. The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the
  1660. logging event into an object for this parameter.
  1661. </summary>
  1662. </member>
  1663. <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName">
  1664. <summary>
  1665. Gets or sets the name of this parameter.
  1666. </summary>
  1667. <value>
  1668. The name of this parameter.
  1669. </value>
  1670. <remarks>
  1671. <para>
  1672. The name of this parameter. The parameter name
  1673. must match up to a named parameter to the SQL stored procedure
  1674. or prepared statement.
  1675. </para>
  1676. </remarks>
  1677. </member>
  1678. <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType">
  1679. <summary>
  1680. Gets or sets the database type for this parameter.
  1681. </summary>
  1682. <value>
  1683. The database type for this parameter.
  1684. </value>
  1685. <remarks>
  1686. <para>
  1687. The database type for this parameter. This property should
  1688. be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/>
  1689. enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>.
  1690. </para>
  1691. <para>
  1692. This property is optional. If not specified the ADO.NET provider
  1693. will attempt to infer the type from the value.
  1694. </para>
  1695. </remarks>
  1696. <seealso cref="P:System.Data.IDataParameter.DbType"/>
  1697. </member>
  1698. <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision">
  1699. <summary>
  1700. Gets or sets the precision for this parameter.
  1701. </summary>
  1702. <value>
  1703. The precision for this parameter.
  1704. </value>
  1705. <remarks>
  1706. <para>
  1707. The maximum number of digits used to represent the Value.
  1708. </para>
  1709. <para>
  1710. This property is optional. If not specified the ADO.NET provider
  1711. will attempt to infer the precision from the value.
  1712. </para>
  1713. </remarks>
  1714. <seealso cref="P:System.Data.IDbDataParameter.Precision"/>
  1715. </member>
  1716. <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale">
  1717. <summary>
  1718. Gets or sets the scale for this parameter.
  1719. </summary>
  1720. <value>
  1721. The scale for this parameter.
  1722. </value>
  1723. <remarks>
  1724. <para>
  1725. The number of decimal places to which Value is resolved.
  1726. </para>
  1727. <para>
  1728. This property is optional. If not specified the ADO.NET provider
  1729. will attempt to infer the scale from the value.
  1730. </para>
  1731. </remarks>
  1732. <seealso cref="P:System.Data.IDbDataParameter.Scale"/>
  1733. </member>
  1734. <member name="P:log4net.Appender.AdoNetAppenderParameter.Size">
  1735. <summary>
  1736. Gets or sets the size for this parameter.
  1737. </summary>
  1738. <value>
  1739. The size for this parameter.
  1740. </value>
  1741. <remarks>
  1742. <para>
  1743. The maximum size, in bytes, of the data within the column.
  1744. </para>
  1745. <para>
  1746. This property is optional. If not specified the ADO.NET provider
  1747. will attempt to infer the size from the value.
  1748. </para>
  1749. <para>
  1750. For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case.
  1751. </para>
  1752. </remarks>
  1753. <seealso cref="P:System.Data.IDbDataParameter.Size"/>
  1754. </member>
  1755. <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout">
  1756. <summary>
  1757. Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to
  1758. render the logging event into an object for this
  1759. parameter.
  1760. </summary>
  1761. <value>
  1762. The <see cref="T:log4net.Layout.IRawLayout"/> used to render the
  1763. logging event into an object for this parameter.
  1764. </value>
  1765. <remarks>
  1766. <para>
  1767. The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this
  1768. parameter.
  1769. </para>
  1770. <para>
  1771. The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt
  1772. any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/>
  1773. for use in the property.
  1774. </para>
  1775. </remarks>
  1776. </member>
  1777. <member name="T:log4net.Appender.AnsiColorTerminalAppender">
  1778. <summary>
  1779. Appends logging events to the terminal using ANSI color escape sequences.
  1780. </summary>
  1781. <remarks>
  1782. <para>
  1783. AnsiColorTerminalAppender appends log events to the standard output stream
  1784. or the error output stream using a layout specified by the
  1785. user. It also allows the color of a specific level of message to be set.
  1786. </para>
  1787. <note>
  1788. This appender expects the terminal to understand the VT100 control set
  1789. in order to interpret the color codes. If the terminal or console does not
  1790. understand the control codes the behavior is not defined.
  1791. </note>
  1792. <para>
  1793. By default, all output is written to the console's standard output stream.
  1794. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the
  1795. error stream.
  1796. </para>
  1797. <para>
  1798. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  1799. <c>System.Console.Error</c> that is set at the time the event is appended.
  1800. Therefore it is possible to programmatically redirect the output of this appender
  1801. (for example NUnit does this to capture program output). While this is the desired
  1802. behavior of this appender it may have security implications in your application.
  1803. </para>
  1804. <para>
  1805. When configuring the ANSI colored terminal appender, a mapping should be
  1806. specified to map a logging level to a color. For example:
  1807. </para>
  1808. <code lang="XML" escaped="true">
  1809. <mapping>
  1810. <level value="ERROR"/>
  1811. <foreColor value="White"/>
  1812. <backColor value="Red"/>
  1813. <attributes value="Bright,Underscore"/>
  1814. </mapping>
  1815. <mapping>
  1816. <level value="DEBUG"/>
  1817. <backColor value="Green"/>
  1818. </mapping>
  1819. </code>
  1820. <para>
  1821. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  1822. of the following values:
  1823. <list type="bullet">
  1824. <item><term>Blue</term><description></description></item>
  1825. <item><term>Green</term><description></description></item>
  1826. <item><term>Red</term><description></description></item>
  1827. <item><term>White</term><description></description></item>
  1828. <item><term>Yellow</term><description></description></item>
  1829. <item><term>Purple</term><description></description></item>
  1830. <item><term>Cyan</term><description></description></item>
  1831. </list>
  1832. These color values cannot be combined together to make new colors.
  1833. </para>
  1834. <para>
  1835. The attributes can be any combination of the following:
  1836. <list type="bullet">
  1837. <item><term>Bright</term><description>foreground is brighter</description></item>
  1838. <item><term>Dim</term><description>foreground is dimmer</description></item>
  1839. <item><term>Underscore</term><description>message is underlined</description></item>
  1840. <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item>
  1841. <item><term>Reverse</term><description>foreground and background are reversed</description></item>
  1842. <item><term>Hidden</term><description>output is hidden</description></item>
  1843. <item><term>Strikethrough</term><description>message has a line through it</description></item>
  1844. </list>
  1845. While any of these attributes may be combined together not all combinations
  1846. work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes
  1847. no sense.
  1848. </para>
  1849. </remarks>
  1850. <author>Patrick Wagstrom</author>
  1851. <author>Nicko Cadell</author>
  1852. </member>
  1853. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut">
  1854. <summary>
  1855. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1856. standard output stream.
  1857. </summary>
  1858. <remarks>
  1859. <para>
  1860. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1861. standard output stream.
  1862. </para>
  1863. </remarks>
  1864. </member>
  1865. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError">
  1866. <summary>
  1867. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1868. standard error output stream.
  1869. </summary>
  1870. <remarks>
  1871. <para>
  1872. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1873. standard error output stream.
  1874. </para>
  1875. </remarks>
  1876. </member>
  1877. <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes">
  1878. <summary>
  1879. Ansi code to reset terminal
  1880. </summary>
  1881. </member>
  1882. <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor">
  1883. <summary>
  1884. Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class.
  1885. </summary>
  1886. <remarks>
  1887. The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class is set up to write
  1888. to the standard output stream.
  1889. </remarks>
  1890. </member>
  1891. <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)">
  1892. <summary>
  1893. Add a mapping of level to color
  1894. </summary>
  1895. <param name="mapping">The mapping to add</param>
  1896. <remarks>
  1897. <para>
  1898. Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender.
  1899. Each mapping defines the foreground and background colours
  1900. for a level.
  1901. </para>
  1902. </remarks>
  1903. </member>
  1904. <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)">
  1905. <summary>
  1906. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  1907. </summary>
  1908. <param name="loggingEvent">The event to log.</param>
  1909. <remarks>
  1910. <para>
  1911. Writes the event to the console.
  1912. </para>
  1913. <para>
  1914. The format of the output will depend on the appender's layout.
  1915. </para>
  1916. </remarks>
  1917. </member>
  1918. <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions">
  1919. <summary>
  1920. Initialize the options for this appender
  1921. </summary>
  1922. <remarks>
  1923. <para>
  1924. Initialize the level to color mappings set on this appender.
  1925. </para>
  1926. </remarks>
  1927. </member>
  1928. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream">
  1929. <summary>
  1930. Flag to write output to the error stream rather than the standard output stream
  1931. </summary>
  1932. </member>
  1933. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping">
  1934. <summary>
  1935. Mapping from level object to color value
  1936. </summary>
  1937. </member>
  1938. <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target">
  1939. <summary>
  1940. Target is the value of the console output stream.
  1941. </summary>
  1942. <value>
  1943. Target is the value of the console output stream.
  1944. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  1945. </value>
  1946. <remarks>
  1947. <para>
  1948. Target is the value of the console output stream.
  1949. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  1950. </para>
  1951. </remarks>
  1952. </member>
  1953. <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout">
  1954. <summary>
  1955. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  1956. </summary>
  1957. <value><c>true</c></value>
  1958. <remarks>
  1959. <para>
  1960. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  1961. </para>
  1962. </remarks>
  1963. </member>
  1964. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes">
  1965. <summary>
  1966. The enum of possible display attributes
  1967. </summary>
  1968. <remarks>
  1969. <para>
  1970. The following flags can be combined together to
  1971. form the ANSI color attributes.
  1972. </para>
  1973. </remarks>
  1974. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
  1975. </member>
  1976. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright">
  1977. <summary>
  1978. text is bright
  1979. </summary>
  1980. </member>
  1981. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim">
  1982. <summary>
  1983. text is dim
  1984. </summary>
  1985. </member>
  1986. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore">
  1987. <summary>
  1988. text is underlined
  1989. </summary>
  1990. </member>
  1991. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink">
  1992. <summary>
  1993. text is blinking
  1994. </summary>
  1995. <remarks>
  1996. Not all terminals support this attribute
  1997. </remarks>
  1998. </member>
  1999. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse">
  2000. <summary>
  2001. text and background colors are reversed
  2002. </summary>
  2003. </member>
  2004. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden">
  2005. <summary>
  2006. text is hidden
  2007. </summary>
  2008. </member>
  2009. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough">
  2010. <summary>
  2011. text is displayed with a strikethrough
  2012. </summary>
  2013. </member>
  2014. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Light">
  2015. <summary>
  2016. text color is light
  2017. </summary>
  2018. </member>
  2019. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor">
  2020. <summary>
  2021. The enum of possible foreground or background color values for
  2022. use with the color mapping method
  2023. </summary>
  2024. <remarks>
  2025. <para>
  2026. The output can be in one for the following ANSI colors.
  2027. </para>
  2028. </remarks>
  2029. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
  2030. </member>
  2031. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black">
  2032. <summary>
  2033. color is black
  2034. </summary>
  2035. </member>
  2036. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red">
  2037. <summary>
  2038. color is red
  2039. </summary>
  2040. </member>
  2041. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green">
  2042. <summary>
  2043. color is green
  2044. </summary>
  2045. </member>
  2046. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow">
  2047. <summary>
  2048. color is yellow
  2049. </summary>
  2050. </member>
  2051. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue">
  2052. <summary>
  2053. color is blue
  2054. </summary>
  2055. </member>
  2056. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta">
  2057. <summary>
  2058. color is magenta
  2059. </summary>
  2060. </member>
  2061. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan">
  2062. <summary>
  2063. color is cyan
  2064. </summary>
  2065. </member>
  2066. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White">
  2067. <summary>
  2068. color is white
  2069. </summary>
  2070. </member>
  2071. <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors">
  2072. <summary>
  2073. A class to act as a mapping between the level that a logging call is made at and
  2074. the color it should be displayed as.
  2075. </summary>
  2076. <remarks>
  2077. <para>
  2078. Defines the mapping between a level and the color it should be displayed in.
  2079. </para>
  2080. </remarks>
  2081. </member>
  2082. <member name="T:log4net.Util.LevelMappingEntry">
  2083. <summary>
  2084. An entry in the <see cref="T:log4net.Util.LevelMapping"/>
  2085. </summary>
  2086. <remarks>
  2087. <para>
  2088. This is an abstract base class for types that are stored in the
  2089. <see cref="T:log4net.Util.LevelMapping"/> object.
  2090. </para>
  2091. </remarks>
  2092. <author>Nicko Cadell</author>
  2093. </member>
  2094. <member name="M:log4net.Util.LevelMappingEntry.#ctor">
  2095. <summary>
  2096. Default protected constructor
  2097. </summary>
  2098. <remarks>
  2099. <para>
  2100. Default protected constructor
  2101. </para>
  2102. </remarks>
  2103. </member>
  2104. <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions">
  2105. <summary>
  2106. Initialize any options defined on this entry
  2107. </summary>
  2108. <remarks>
  2109. <para>
  2110. Should be overridden by any classes that need to initialise based on their options
  2111. </para>
  2112. </remarks>
  2113. </member>
  2114. <member name="P:log4net.Util.LevelMappingEntry.Level">
  2115. <summary>
  2116. The level that is the key for this mapping
  2117. </summary>
  2118. <value>
  2119. The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping
  2120. </value>
  2121. <remarks>
  2122. <para>
  2123. Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this
  2124. mapping subclass.
  2125. </para>
  2126. </remarks>
  2127. </member>
  2128. <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions">
  2129. <summary>
  2130. Initialize the options for the object
  2131. </summary>
  2132. <remarks>
  2133. <para>
  2134. Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together
  2135. and append the attributes.
  2136. </para>
  2137. </remarks>
  2138. </member>
  2139. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor">
  2140. <summary>
  2141. The mapped foreground color for the specified level
  2142. </summary>
  2143. <remarks>
  2144. <para>
  2145. Required property.
  2146. The mapped foreground color for the specified level
  2147. </para>
  2148. </remarks>
  2149. </member>
  2150. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor">
  2151. <summary>
  2152. The mapped background color for the specified level
  2153. </summary>
  2154. <remarks>
  2155. <para>
  2156. Required property.
  2157. The mapped background color for the specified level
  2158. </para>
  2159. </remarks>
  2160. </member>
  2161. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes">
  2162. <summary>
  2163. The color attributes for the specified level
  2164. </summary>
  2165. <remarks>
  2166. <para>
  2167. Required property.
  2168. The color attributes for the specified level
  2169. </para>
  2170. </remarks>
  2171. </member>
  2172. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor">
  2173. <summary>
  2174. The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and
  2175. <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color.
  2176. </summary>
  2177. </member>
  2178. <member name="T:log4net.Appender.AppenderCollection">
  2179. <summary>
  2180. A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects.
  2181. </summary>
  2182. <author>Nicko Cadell</author>
  2183. </member>
  2184. <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)">
  2185. <summary>
  2186. Creates a read-only wrapper for a <c>AppenderCollection</c> instance.
  2187. </summary>
  2188. <param name="list">list to create a readonly wrapper arround</param>
  2189. <returns>
  2190. An <c>AppenderCollection</c> wrapper that is read-only.
  2191. </returns>
  2192. </member>
  2193. <member name="F:log4net.Appender.AppenderCollection.EmptyCollection">
  2194. <summary>
  2195. An empty readonly static AppenderCollection
  2196. </summary>
  2197. </member>
  2198. <member name="M:log4net.Appender.AppenderCollection.#ctor">
  2199. <summary>
  2200. Initializes a new instance of the <c>AppenderCollection</c> class
  2201. that is empty and has the default initial capacity.
  2202. </summary>
  2203. </member>
  2204. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)">
  2205. <summary>
  2206. Initializes a new instance of the <c>AppenderCollection</c> class
  2207. that has the specified initial capacity.
  2208. </summary>
  2209. <param name="capacity">
  2210. The number of elements that the new <c>AppenderCollection</c> is initially capable of storing.
  2211. </param>
  2212. </member>
  2213. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)">
  2214. <summary>
  2215. Initializes a new instance of the <c>AppenderCollection</c> class
  2216. that contains elements copied from the specified <c>AppenderCollection</c>.
  2217. </summary>
  2218. <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param>
  2219. </member>
  2220. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])">
  2221. <summary>
  2222. Initializes a new instance of the <c>AppenderCollection</c> class
  2223. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array.
  2224. </summary>
  2225. <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param>
  2226. </member>
  2227. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)">
  2228. <summary>
  2229. Initializes a new instance of the <c>AppenderCollection</c> class
  2230. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection.
  2231. </summary>
  2232. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param>
  2233. </member>
  2234. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)">
  2235. <summary>
  2236. Allow subclasses to avoid our default constructors
  2237. </summary>
  2238. <param name="tag"></param>
  2239. <exclude/>
  2240. </member>
  2241. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])">
  2242. <summary>
  2243. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  2244. <see cref="T:log4net.Appender.IAppender"/> array.
  2245. </summary>
  2246. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  2247. </member>
  2248. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)">
  2249. <summary>
  2250. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  2251. <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array.
  2252. </summary>
  2253. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  2254. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  2255. </member>
  2256. <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)">
  2257. <summary>
  2258. Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>.
  2259. </summary>
  2260. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param>
  2261. <returns>The index at which the value has been added.</returns>
  2262. </member>
  2263. <member name="M:log4net.Appender.AppenderCollection.Clear">
  2264. <summary>
  2265. Removes all elements from the <c>AppenderCollection</c>.
  2266. </summary>
  2267. </member>
  2268. <member name="M:log4net.Appender.AppenderCollection.Clone">
  2269. <summary>
  2270. Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>.
  2271. </summary>
  2272. <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns>
  2273. </member>
  2274. <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)">
  2275. <summary>
  2276. Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>.
  2277. </summary>
  2278. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param>
  2279. <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns>
  2280. </member>
  2281. <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)">
  2282. <summary>
  2283. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/>
  2284. in the <c>AppenderCollection</c>.
  2285. </summary>
  2286. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param>
  2287. <returns>
  2288. The zero-based index of the first occurrence of <paramref name="item"/>
  2289. in the entire <c>AppenderCollection</c>, if found; otherwise, -1.
  2290. </returns>
  2291. </member>
  2292. <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)">
  2293. <summary>
  2294. Inserts an element into the <c>AppenderCollection</c> at the specified index.
  2295. </summary>
  2296. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  2297. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param>
  2298. <exception cref="T:System.ArgumentOutOfRangeException">
  2299. <para><paramref name="index"/> is less than zero</para>
  2300. <para>-or-</para>
  2301. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2302. </exception>
  2303. </member>
  2304. <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)">
  2305. <summary>
  2306. Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>.
  2307. </summary>
  2308. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param>
  2309. <exception cref="T:System.ArgumentException">
  2310. The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>.
  2311. </exception>
  2312. </member>
  2313. <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)">
  2314. <summary>
  2315. Removes the element at the specified index of the <c>AppenderCollection</c>.
  2316. </summary>
  2317. <param name="index">The zero-based index of the element to remove.</param>
  2318. <exception cref="T:System.ArgumentOutOfRangeException">
  2319. <para><paramref name="index"/> is less than zero</para>
  2320. <para>-or-</para>
  2321. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2322. </exception>
  2323. </member>
  2324. <member name="M:log4net.Appender.AppenderCollection.GetEnumerator">
  2325. <summary>
  2326. Returns an enumerator that can iterate through the <c>AppenderCollection</c>.
  2327. </summary>
  2328. <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns>
  2329. </member>
  2330. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)">
  2331. <summary>
  2332. Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>.
  2333. </summary>
  2334. <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param>
  2335. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2336. </member>
  2337. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])">
  2338. <summary>
  2339. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>.
  2340. </summary>
  2341. <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>
  2342. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2343. </member>
  2344. <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)">
  2345. <summary>
  2346. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>.
  2347. </summary>
  2348. <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>
  2349. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2350. </member>
  2351. <member name="M:log4net.Appender.AppenderCollection.TrimToSize">
  2352. <summary>
  2353. Sets the capacity to the actual number of elements.
  2354. </summary>
  2355. </member>
  2356. <member name="M:log4net.Appender.AppenderCollection.ToArray">
  2357. <summary>
  2358. Return the collection elements as an array
  2359. </summary>
  2360. <returns>the array</returns>
  2361. </member>
  2362. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)">
  2363. <exception cref="T:System.ArgumentOutOfRangeException">
  2364. <para><paramref name="i"/> is less than zero</para>
  2365. <para>-or-</para>
  2366. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2367. </exception>
  2368. </member>
  2369. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)">
  2370. <exception cref="T:System.ArgumentOutOfRangeException">
  2371. <para><paramref name="i"/> is less than zero</para>
  2372. <para>-or-</para>
  2373. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2374. </exception>
  2375. </member>
  2376. <member name="P:log4net.Appender.AppenderCollection.Count">
  2377. <summary>
  2378. Gets the number of elements actually contained in the <c>AppenderCollection</c>.
  2379. </summary>
  2380. </member>
  2381. <member name="P:log4net.Appender.AppenderCollection.IsSynchronized">
  2382. <summary>
  2383. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  2384. </summary>
  2385. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  2386. </member>
  2387. <member name="P:log4net.Appender.AppenderCollection.SyncRoot">
  2388. <summary>
  2389. Gets an object that can be used to synchronize access to the collection.
  2390. </summary>
  2391. </member>
  2392. <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)">
  2393. <summary>
  2394. Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index.
  2395. </summary>
  2396. <param name="index">The zero-based index of the element to get or set.</param>
  2397. <exception cref="T:System.ArgumentOutOfRangeException">
  2398. <para><paramref name="index"/> is less than zero</para>
  2399. <para>-or-</para>
  2400. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2401. </exception>
  2402. </member>
  2403. <member name="P:log4net.Appender.AppenderCollection.IsFixedSize">
  2404. <summary>
  2405. Gets a value indicating whether the collection has a fixed size.
  2406. </summary>
  2407. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  2408. </member>
  2409. <member name="P:log4net.Appender.AppenderCollection.IsReadOnly">
  2410. <summary>
  2411. Gets a value indicating whether the IList is read-only.
  2412. </summary>
  2413. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  2414. </member>
  2415. <member name="P:log4net.Appender.AppenderCollection.Capacity">
  2416. <summary>
  2417. Gets or sets the number of elements the <c>AppenderCollection</c> can contain.
  2418. </summary>
  2419. </member>
  2420. <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator">
  2421. <summary>
  2422. Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  2423. </summary>
  2424. <exclude/>
  2425. </member>
  2426. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext">
  2427. <summary>
  2428. Advances the enumerator to the next element in the collection.
  2429. </summary>
  2430. <returns>
  2431. <c>true</c> if the enumerator was successfully advanced to the next element;
  2432. <c>false</c> if the enumerator has passed the end of the collection.
  2433. </returns>
  2434. <exception cref="T:System.InvalidOperationException">
  2435. The collection was modified after the enumerator was created.
  2436. </exception>
  2437. </member>
  2438. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset">
  2439. <summary>
  2440. Sets the enumerator to its initial position, before the first element in the collection.
  2441. </summary>
  2442. </member>
  2443. <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current">
  2444. <summary>
  2445. Gets the current element in the collection.
  2446. </summary>
  2447. </member>
  2448. <member name="T:log4net.Appender.AppenderCollection.Tag">
  2449. <summary>
  2450. Type visible only to our subclasses
  2451. Used to access protected constructor
  2452. </summary>
  2453. <exclude/>
  2454. </member>
  2455. <member name="F:log4net.Appender.AppenderCollection.Tag.Default">
  2456. <summary>
  2457. A value
  2458. </summary>
  2459. </member>
  2460. <member name="T:log4net.Appender.AppenderCollection.Enumerator">
  2461. <summary>
  2462. Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  2463. </summary>
  2464. <exclude/>
  2465. </member>
  2466. <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)">
  2467. <summary>
  2468. Initializes a new instance of the <c>Enumerator</c> class.
  2469. </summary>
  2470. <param name="tc"></param>
  2471. </member>
  2472. <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext">
  2473. <summary>
  2474. Advances the enumerator to the next element in the collection.
  2475. </summary>
  2476. <returns>
  2477. <c>true</c> if the enumerator was successfully advanced to the next element;
  2478. <c>false</c> if the enumerator has passed the end of the collection.
  2479. </returns>
  2480. <exception cref="T:System.InvalidOperationException">
  2481. The collection was modified after the enumerator was created.
  2482. </exception>
  2483. </member>
  2484. <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset">
  2485. <summary>
  2486. Sets the enumerator to its initial position, before the first element in the collection.
  2487. </summary>
  2488. </member>
  2489. <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current">
  2490. <summary>
  2491. Gets the current element in the collection.
  2492. </summary>
  2493. </member>
  2494. <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection">
  2495. <exclude/>
  2496. </member>
  2497. <member name="T:log4net.Appender.BufferingForwardingAppender">
  2498. <summary>
  2499. Buffers events and then forwards them to attached appenders.
  2500. </summary>
  2501. <remarks>
  2502. <para>
  2503. The events are buffered in this appender until conditions are
  2504. met to allow the appender to deliver the events to the attached
  2505. appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the
  2506. conditions that cause the buffer to be sent.
  2507. </para>
  2508. <para>The forwarding appender can be used to specify different
  2509. thresholds and filters for the same appender at different locations
  2510. within the hierarchy.
  2511. </para>
  2512. </remarks>
  2513. <author>Nicko Cadell</author>
  2514. <author>Gert Driesen</author>
  2515. </member>
  2516. <member name="T:log4net.Core.IAppenderAttachable">
  2517. <summary>
  2518. Interface for attaching appenders to objects.
  2519. </summary>
  2520. <remarks>
  2521. <para>
  2522. Interface for attaching, removing and retrieving appenders.
  2523. </para>
  2524. </remarks>
  2525. <author>Nicko Cadell</author>
  2526. <author>Gert Driesen</author>
  2527. </member>
  2528. <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)">
  2529. <summary>
  2530. Attaches an appender.
  2531. </summary>
  2532. <param name="appender">The appender to add.</param>
  2533. <remarks>
  2534. <para>
  2535. Add the specified appender. The implementation may
  2536. choose to allow or deny duplicate appenders.
  2537. </para>
  2538. </remarks>
  2539. </member>
  2540. <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)">
  2541. <summary>
  2542. Gets an attached appender with the specified name.
  2543. </summary>
  2544. <param name="name">The name of the appender to get.</param>
  2545. <returns>
  2546. The appender with the name specified, or <c>null</c> if no appender with the
  2547. specified name is found.
  2548. </returns>
  2549. <remarks>
  2550. <para>
  2551. Returns an attached appender with the <paramref name="name"/> specified.
  2552. If no appender with the specified name is found <c>null</c> will be
  2553. returned.
  2554. </para>
  2555. </remarks>
  2556. </member>
  2557. <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders">
  2558. <summary>
  2559. Removes all attached appenders.
  2560. </summary>
  2561. <remarks>
  2562. <para>
  2563. Removes and closes all attached appenders
  2564. </para>
  2565. </remarks>
  2566. </member>
  2567. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)">
  2568. <summary>
  2569. Removes the specified appender from the list of attached appenders.
  2570. </summary>
  2571. <param name="appender">The appender to remove.</param>
  2572. <returns>The appender removed from the list</returns>
  2573. <remarks>
  2574. <para>
  2575. The appender removed is not closed.
  2576. If you are discarding the appender you must call
  2577. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2578. </para>
  2579. </remarks>
  2580. </member>
  2581. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)">
  2582. <summary>
  2583. Removes the appender with the specified name from the list of appenders.
  2584. </summary>
  2585. <param name="name">The name of the appender to remove.</param>
  2586. <returns>The appender removed from the list</returns>
  2587. <remarks>
  2588. <para>
  2589. The appender removed is not closed.
  2590. If you are discarding the appender you must call
  2591. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2592. </para>
  2593. </remarks>
  2594. </member>
  2595. <member name="P:log4net.Core.IAppenderAttachable.Appenders">
  2596. <summary>
  2597. Gets all attached appenders.
  2598. </summary>
  2599. <value>
  2600. A collection of attached appenders.
  2601. </value>
  2602. <remarks>
  2603. <para>
  2604. Gets a collection of attached appenders.
  2605. If there are no attached appenders the
  2606. implementation should return an empty
  2607. collection rather than <c>null</c>.
  2608. </para>
  2609. </remarks>
  2610. </member>
  2611. <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor">
  2612. <summary>
  2613. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender"/> class.
  2614. </summary>
  2615. <remarks>
  2616. <para>
  2617. Default constructor.
  2618. </para>
  2619. </remarks>
  2620. </member>
  2621. <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose">
  2622. <summary>
  2623. Closes the appender and releases resources.
  2624. </summary>
  2625. <remarks>
  2626. <para>
  2627. Releases any resources allocated within the appender such as file handles,
  2628. network connections, etc.
  2629. </para>
  2630. <para>
  2631. It is a programming error to append to a closed appender.
  2632. </para>
  2633. </remarks>
  2634. </member>
  2635. <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  2636. <summary>
  2637. Send the events.
  2638. </summary>
  2639. <param name="events">The events that need to be send.</param>
  2640. <remarks>
  2641. <para>
  2642. Forwards the events to the attached appenders.
  2643. </para>
  2644. </remarks>
  2645. </member>
  2646. <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  2647. <summary>
  2648. Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
  2649. instance.
  2650. </summary>
  2651. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
  2652. <remarks>
  2653. <para>
  2654. If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
  2655. appenders, then it won't be added again.
  2656. </para>
  2657. </remarks>
  2658. </member>
  2659. <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)">
  2660. <summary>
  2661. Looks for the appender with the specified name.
  2662. </summary>
  2663. <param name="name">The name of the appender to lookup.</param>
  2664. <returns>
  2665. The appender with the specified name, or <c>null</c>.
  2666. </returns>
  2667. <remarks>
  2668. <para>
  2669. Get the named appender attached to this buffering appender.
  2670. </para>
  2671. </remarks>
  2672. </member>
  2673. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders">
  2674. <summary>
  2675. Removes all previously added appenders from this appender.
  2676. </summary>
  2677. <remarks>
  2678. <para>
  2679. This is useful when re-reading configuration information.
  2680. </para>
  2681. </remarks>
  2682. </member>
  2683. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  2684. <summary>
  2685. Removes the specified appender from the list of appenders.
  2686. </summary>
  2687. <param name="appender">The appender to remove.</param>
  2688. <returns>The appender removed from the list</returns>
  2689. <remarks>
  2690. The appender removed is not closed.
  2691. If you are discarding the appender you must call
  2692. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2693. </remarks>
  2694. </member>
  2695. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)">
  2696. <summary>
  2697. Removes the appender with the specified name from the list of appenders.
  2698. </summary>
  2699. <param name="name">The name of the appender to remove.</param>
  2700. <returns>The appender removed from the list</returns>
  2701. <remarks>
  2702. The appender removed is not closed.
  2703. If you are discarding the appender you must call
  2704. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2705. </remarks>
  2706. </member>
  2707. <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl">
  2708. <summary>
  2709. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  2710. </summary>
  2711. </member>
  2712. <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders">
  2713. <summary>
  2714. Gets the appenders contained in this appender as an
  2715. <see cref="T:System.Collections.ICollection"/>.
  2716. </summary>
  2717. <remarks>
  2718. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  2719. is returned.
  2720. </remarks>
  2721. <returns>
  2722. A collection of the appenders in this appender.
  2723. </returns>
  2724. </member>
  2725. <member name="T:log4net.Appender.ColoredConsoleAppender">
  2726. <summary>
  2727. Appends logging events to the console.
  2728. </summary>
  2729. <remarks>
  2730. <para>
  2731. ColoredConsoleAppender appends log events to the standard output stream
  2732. or the error output stream using a layout specified by the
  2733. user. It also allows the color of a specific type of message to be set.
  2734. </para>
  2735. <para>
  2736. By default, all output is written to the console's standard output stream.
  2737. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> property can be set to direct the output to the
  2738. error stream.
  2739. </para>
  2740. <para>
  2741. NOTE: This appender writes directly to the application's attached console
  2742. not to the <c>System.Console.Out</c> or <c>System.Console.Error</c> <c>TextWriter</c>.
  2743. The <c>System.Console.Out</c> and <c>System.Console.Error</c> streams can be
  2744. programmatically redirected (for example NUnit does this to capture program output).
  2745. This appender will ignore these redirections because it needs to use Win32
  2746. API calls to colorize the output. To respect these redirections the <see cref="T:log4net.Appender.ConsoleAppender"/>
  2747. must be used.
  2748. </para>
  2749. <para>
  2750. When configuring the colored console appender, mapping should be
  2751. specified to map a logging level to a color. For example:
  2752. </para>
  2753. <code lang="XML" escaped="true">
  2754. <mapping>
  2755. <level value="ERROR"/>
  2756. <foreColor value="White"/>
  2757. <backColor value="Red, HighIntensity"/>
  2758. </mapping>
  2759. <mapping>
  2760. <level value="DEBUG"/>
  2761. <backColor value="Green"/>
  2762. </mapping>
  2763. </code>
  2764. <para>
  2765. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  2766. combination of the following values:
  2767. <list type="bullet">
  2768. <item><term>Blue</term><description></description></item>
  2769. <item><term>Green</term><description></description></item>
  2770. <item><term>Red</term><description></description></item>
  2771. <item><term>White</term><description></description></item>
  2772. <item><term>Yellow</term><description></description></item>
  2773. <item><term>Purple</term><description></description></item>
  2774. <item><term>Cyan</term><description></description></item>
  2775. <item><term>HighIntensity</term><description></description></item>
  2776. </list>
  2777. </para>
  2778. </remarks>
  2779. <author>Rick Hobbs</author>
  2780. <author>Nicko Cadell</author>
  2781. </member>
  2782. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleOut">
  2783. <summary>
  2784. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2785. standard output stream.
  2786. </summary>
  2787. <remarks>
  2788. <para>
  2789. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2790. standard output stream.
  2791. </para>
  2792. </remarks>
  2793. </member>
  2794. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleError">
  2795. <summary>
  2796. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2797. standard error output stream.
  2798. </summary>
  2799. <remarks>
  2800. <para>
  2801. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2802. standard error output stream.
  2803. </para>
  2804. </remarks>
  2805. </member>
  2806. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor">
  2807. <summary>
  2808. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class.
  2809. </summary>
  2810. <remarks>
  2811. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
  2812. to the standard output stream.
  2813. </remarks>
  2814. </member>
  2815. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout)">
  2816. <summary>
  2817. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
  2818. with the specified layout.
  2819. </summary>
  2820. <param name="layout">the layout to use for this appender</param>
  2821. <remarks>
  2822. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
  2823. to the standard output stream.
  2824. </remarks>
  2825. </member>
  2826. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  2827. <summary>
  2828. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
  2829. with the specified layout.
  2830. </summary>
  2831. <param name="layout">the layout to use for this appender</param>
  2832. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  2833. <remarks>
  2834. When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
  2835. the standard error output stream. Otherwise, output is written to the standard
  2836. output stream.
  2837. </remarks>
  2838. </member>
  2839. <member name="M:log4net.Appender.ColoredConsoleAppender.AddMapping(log4net.Appender.ColoredConsoleAppender.LevelColors)">
  2840. <summary>
  2841. Add a mapping of level to color - done by the config file
  2842. </summary>
  2843. <param name="mapping">The mapping to add</param>
  2844. <remarks>
  2845. <para>
  2846. Add a <see cref="T:log4net.Appender.ColoredConsoleAppender.LevelColors"/> mapping to this appender.
  2847. Each mapping defines the foreground and background colors
  2848. for a level.
  2849. </para>
  2850. </remarks>
  2851. </member>
  2852. <member name="M:log4net.Appender.ColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  2853. <summary>
  2854. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  2855. </summary>
  2856. <param name="loggingEvent">The event to log.</param>
  2857. <remarks>
  2858. <para>
  2859. Writes the event to the console.
  2860. </para>
  2861. <para>
  2862. The format of the output will depend on the appender's layout.
  2863. </para>
  2864. </remarks>
  2865. </member>
  2866. <member name="M:log4net.Appender.ColoredConsoleAppender.ActivateOptions">
  2867. <summary>
  2868. Initialize the options for this appender
  2869. </summary>
  2870. <remarks>
  2871. <para>
  2872. Initialize the level to color mappings set on this appender.
  2873. </para>
  2874. </remarks>
  2875. </member>
  2876. <member name="F:log4net.Appender.ColoredConsoleAppender.m_writeToErrorStream">
  2877. <summary>
  2878. Flag to write output to the error stream rather than the standard output stream
  2879. </summary>
  2880. </member>
  2881. <member name="F:log4net.Appender.ColoredConsoleAppender.m_levelMapping">
  2882. <summary>
  2883. Mapping from level object to color value
  2884. </summary>
  2885. </member>
  2886. <member name="F:log4net.Appender.ColoredConsoleAppender.m_consoleOutputWriter">
  2887. <summary>
  2888. The console output stream writer to write to
  2889. </summary>
  2890. <remarks>
  2891. <para>
  2892. This writer is not thread safe.
  2893. </para>
  2894. </remarks>
  2895. </member>
  2896. <member name="P:log4net.Appender.ColoredConsoleAppender.Target">
  2897. <summary>
  2898. Target is the value of the console output stream.
  2899. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2900. </summary>
  2901. <value>
  2902. Target is the value of the console output stream.
  2903. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2904. </value>
  2905. <remarks>
  2906. <para>
  2907. Target is the value of the console output stream.
  2908. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2909. </para>
  2910. </remarks>
  2911. </member>
  2912. <member name="P:log4net.Appender.ColoredConsoleAppender.RequiresLayout">
  2913. <summary>
  2914. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2915. </summary>
  2916. <value><c>true</c></value>
  2917. <remarks>
  2918. <para>
  2919. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2920. </para>
  2921. </remarks>
  2922. </member>
  2923. <member name="T:log4net.Appender.ColoredConsoleAppender.Colors">
  2924. <summary>
  2925. The enum of possible color values for use with the color mapping method
  2926. </summary>
  2927. <remarks>
  2928. <para>
  2929. The following flags can be combined together to
  2930. form the colors.
  2931. </para>
  2932. </remarks>
  2933. <seealso cref="T:log4net.Appender.ColoredConsoleAppender"/>
  2934. </member>
  2935. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Blue">
  2936. <summary>
  2937. color is blue
  2938. </summary>
  2939. </member>
  2940. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Green">
  2941. <summary>
  2942. color is green
  2943. </summary>
  2944. </member>
  2945. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Red">
  2946. <summary>
  2947. color is red
  2948. </summary>
  2949. </member>
  2950. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.White">
  2951. <summary>
  2952. color is white
  2953. </summary>
  2954. </member>
  2955. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Yellow">
  2956. <summary>
  2957. color is yellow
  2958. </summary>
  2959. </member>
  2960. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Purple">
  2961. <summary>
  2962. color is purple
  2963. </summary>
  2964. </member>
  2965. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Cyan">
  2966. <summary>
  2967. color is cyan
  2968. </summary>
  2969. </member>
  2970. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.HighIntensity">
  2971. <summary>
  2972. color is intensified
  2973. </summary>
  2974. </member>
  2975. <member name="T:log4net.Appender.ColoredConsoleAppender.LevelColors">
  2976. <summary>
  2977. A class to act as a mapping between the level that a logging call is made at and
  2978. the color it should be displayed as.
  2979. </summary>
  2980. <remarks>
  2981. <para>
  2982. Defines the mapping between a level and the color it should be displayed in.
  2983. </para>
  2984. </remarks>
  2985. </member>
  2986. <member name="M:log4net.Appender.ColoredConsoleAppender.LevelColors.ActivateOptions">
  2987. <summary>
  2988. Initialize the options for the object
  2989. </summary>
  2990. <remarks>
  2991. <para>
  2992. Combine the <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> together.
  2993. </para>
  2994. </remarks>
  2995. </member>
  2996. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor">
  2997. <summary>
  2998. The mapped foreground color for the specified level
  2999. </summary>
  3000. <remarks>
  3001. <para>
  3002. Required property.
  3003. The mapped foreground color for the specified level.
  3004. </para>
  3005. </remarks>
  3006. </member>
  3007. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor">
  3008. <summary>
  3009. The mapped background color for the specified level
  3010. </summary>
  3011. <remarks>
  3012. <para>
  3013. Required property.
  3014. The mapped background color for the specified level.
  3015. </para>
  3016. </remarks>
  3017. </member>
  3018. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.CombinedColor">
  3019. <summary>
  3020. The combined <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> suitable for
  3021. setting the console color.
  3022. </summary>
  3023. </member>
  3024. <member name="T:log4net.Appender.ConsoleAppender">
  3025. <summary>
  3026. Appends logging events to the console.
  3027. </summary>
  3028. <remarks>
  3029. <para>
  3030. ConsoleAppender appends log events to the standard output stream
  3031. or the error output stream using a layout specified by the
  3032. user.
  3033. </para>
  3034. <para>
  3035. By default, all output is written to the console's standard output stream.
  3036. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
  3037. error stream.
  3038. </para>
  3039. <para>
  3040. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  3041. <c>System.Console.Error</c> that is set at the time the event is appended.
  3042. Therefore it is possible to programmatically redirect the output of this appender
  3043. (for example NUnit does this to capture program output). While this is the desired
  3044. behavior of this appender it may have security implications in your application.
  3045. </para>
  3046. </remarks>
  3047. <author>Nicko Cadell</author>
  3048. <author>Gert Driesen</author>
  3049. </member>
  3050. <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
  3051. <summary>
  3052. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3053. standard output stream.
  3054. </summary>
  3055. <remarks>
  3056. <para>
  3057. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3058. standard output stream.
  3059. </para>
  3060. </remarks>
  3061. </member>
  3062. <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
  3063. <summary>
  3064. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3065. standard error output stream.
  3066. </summary>
  3067. <remarks>
  3068. <para>
  3069. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3070. standard error output stream.
  3071. </para>
  3072. </remarks>
  3073. </member>
  3074. <member name="M:log4net.Appender.ConsoleAppender.#ctor">
  3075. <summary>
  3076. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class.
  3077. </summary>
  3078. <remarks>
  3079. The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
  3080. to the standard output stream.
  3081. </remarks>
  3082. </member>
  3083. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
  3084. <summary>
  3085. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
  3086. with the specified layout.
  3087. </summary>
  3088. <param name="layout">the layout to use for this appender</param>
  3089. <remarks>
  3090. The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
  3091. to the standard output stream.
  3092. </remarks>
  3093. </member>
  3094. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  3095. <summary>
  3096. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
  3097. with the specified layout.
  3098. </summary>
  3099. <param name="layout">the layout to use for this appender</param>
  3100. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  3101. <remarks>
  3102. When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
  3103. the standard error output stream. Otherwise, output is written to the standard
  3104. output stream.
  3105. </remarks>
  3106. </member>
  3107. <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
  3108. <summary>
  3109. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  3110. </summary>
  3111. <param name="loggingEvent">The event to log.</param>
  3112. <remarks>
  3113. <para>
  3114. Writes the event to the console.
  3115. </para>
  3116. <para>
  3117. The format of the output will depend on the appender's layout.
  3118. </para>
  3119. </remarks>
  3120. </member>
  3121. <member name="P:log4net.Appender.ConsoleAppender.Target">
  3122. <summary>
  3123. Target is the value of the console output stream.
  3124. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3125. </summary>
  3126. <value>
  3127. Target is the value of the console output stream.
  3128. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3129. </value>
  3130. <remarks>
  3131. <para>
  3132. Target is the value of the console output stream.
  3133. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3134. </para>
  3135. </remarks>
  3136. </member>
  3137. <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
  3138. <summary>
  3139. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3140. </summary>
  3141. <value><c>true</c></value>
  3142. <remarks>
  3143. <para>
  3144. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3145. </para>
  3146. </remarks>
  3147. </member>
  3148. <member name="T:log4net.Appender.DebugAppender">
  3149. <summary>
  3150. Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
  3151. </summary>
  3152. <remarks>
  3153. <para>
  3154. The application configuration file can be used to control what listeners
  3155. are actually used. See the MSDN documentation for the
  3156. <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
  3157. debug system.
  3158. </para>
  3159. <para>
  3160. Events are written using the <see cref="M:System.Diagnostics.Debug.Write(string,string)"/>
  3161. method. The event's logger name is passed as the value for the category name to the Write method.
  3162. </para>
  3163. </remarks>
  3164. <author>Nicko Cadell</author>
  3165. </member>
  3166. <member name="M:log4net.Appender.DebugAppender.#ctor">
  3167. <summary>
  3168. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>.
  3169. </summary>
  3170. <remarks>
  3171. <para>
  3172. Default constructor.
  3173. </para>
  3174. </remarks>
  3175. </member>
  3176. <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
  3177. <summary>
  3178. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>
  3179. with a specified layout.
  3180. </summary>
  3181. <param name="layout">The layout to use with this appender.</param>
  3182. <remarks>
  3183. <para>
  3184. Obsolete constructor.
  3185. </para>
  3186. </remarks>
  3187. </member>
  3188. <member name="M:log4net.Appender.DebugAppender.Flush(System.Int32)">
  3189. <summary>
  3190. Flushes any buffered log data.
  3191. </summary>
  3192. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  3193. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  3194. </member>
  3195. <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
  3196. <summary>
  3197. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  3198. </summary>
  3199. <param name="loggingEvent">The event to log.</param>
  3200. <remarks>
  3201. <para>
  3202. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  3203. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/>
  3204. is called.
  3205. </para>
  3206. </remarks>
  3207. </member>
  3208. <member name="F:log4net.Appender.DebugAppender.m_immediateFlush">
  3209. <summary>
  3210. Immediate flush means that the underlying writer or output stream
  3211. will be flushed at the end of each append operation.
  3212. </summary>
  3213. <remarks>
  3214. <para>
  3215. Immediate flush is slower but ensures that each append request is
  3216. actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to
  3217. <c>false</c>, then there is a good chance that the last few
  3218. logs events are not actually written to persistent media if and
  3219. when the application crashes.
  3220. </para>
  3221. <para>
  3222. The default value is <c>true</c>.</para>
  3223. </remarks>
  3224. </member>
  3225. <member name="F:log4net.Appender.DebugAppender.m_category">
  3226. <summary>
  3227. Defaults to a <see cref="T:log4net.Layout.PatternLayout"/> with %logger as the pattern.
  3228. </summary>
  3229. </member>
  3230. <member name="P:log4net.Appender.DebugAppender.ImmediateFlush">
  3231. <summary>
  3232. Gets or sets a value that indicates whether the appender will
  3233. flush at the end of each write.
  3234. </summary>
  3235. <remarks>
  3236. <para>The default behavior is to flush at the end of each
  3237. write. If the option is set to<c>false</c>, then the underlying
  3238. stream can defer writing to physical medium to a later time.
  3239. </para>
  3240. <para>
  3241. Avoiding the flush operation at the end of each append results
  3242. in a performance gain of 10 to 20 percent. However, there is safety
  3243. trade-off involved in skipping flushing. Indeed, when flushing is
  3244. skipped, then it is likely that the last few log events will not
  3245. be recorded on disk when the application exits. This is a high
  3246. price to pay even for a 20% performance gain.
  3247. </para>
  3248. </remarks>
  3249. </member>
  3250. <member name="P:log4net.Appender.DebugAppender.Category">
  3251. <summary>
  3252. Formats the category parameter sent to the Debug method.
  3253. </summary>
  3254. <remarks>
  3255. <para>
  3256. Defaults to a <see cref="T:log4net.Layout.PatternLayout"/> with %logger as the pattern which will use the logger name of the current
  3257. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  3258. </para>
  3259. <para>
  3260. </para>
  3261. </remarks>
  3262. </member>
  3263. <member name="P:log4net.Appender.DebugAppender.RequiresLayout">
  3264. <summary>
  3265. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3266. </summary>
  3267. <value><c>true</c></value>
  3268. <remarks>
  3269. <para>
  3270. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3271. </para>
  3272. </remarks>
  3273. </member>
  3274. <member name="T:log4net.Appender.EventLogAppender">
  3275. <summary>
  3276. Writes events to the system event log.
  3277. </summary>
  3278. <remarks>
  3279. <para>
  3280. The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges.
  3281. See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog
  3282. </para>
  3283. <para>
  3284. The <c>EventID</c> of the event log entry can be
  3285. set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3286. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3287. </para>
  3288. <para>
  3289. The <c>Category</c> of the event log entry can be
  3290. set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3291. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3292. </para>
  3293. <para>
  3294. There is a limit of 32K characters for an event log message
  3295. </para>
  3296. <para>
  3297. When configuring the EventLogAppender a mapping can be
  3298. specified to map a logging level to an event log entry type. For example:
  3299. </para>
  3300. <code lang="XML">
  3301. &lt;mapping&gt;
  3302. &lt;level value="ERROR" /&gt;
  3303. &lt;eventLogEntryType value="Error" /&gt;
  3304. &lt;/mapping&gt;
  3305. &lt;mapping&gt;
  3306. &lt;level value="DEBUG" /&gt;
  3307. &lt;eventLogEntryType value="Information" /&gt;
  3308. &lt;/mapping&gt;
  3309. </code>
  3310. <para>
  3311. The Level is the standard log4net logging level and eventLogEntryType can be any value
  3312. from the <see cref="T:System.Diagnostics.EventLogEntryType"/> enum, i.e.:
  3313. <list type="bullet">
  3314. <item><term>Error</term><description>an error event</description></item>
  3315. <item><term>Warning</term><description>a warning event</description></item>
  3316. <item><term>Information</term><description>an informational event</description></item>
  3317. </list>
  3318. </para>
  3319. </remarks>
  3320. <author>Aspi Havewala</author>
  3321. <author>Douglas de la Torre</author>
  3322. <author>Nicko Cadell</author>
  3323. <author>Gert Driesen</author>
  3324. <author>Thomas Voss</author>
  3325. </member>
  3326. <member name="M:log4net.Appender.EventLogAppender.#ctor">
  3327. <summary>
  3328. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class.
  3329. </summary>
  3330. <remarks>
  3331. <para>
  3332. Default constructor.
  3333. </para>
  3334. </remarks>
  3335. </member>
  3336. <member name="M:log4net.Appender.EventLogAppender.#ctor(log4net.Layout.ILayout)">
  3337. <summary>
  3338. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class
  3339. with the specified <see cref="T:log4net.Layout.ILayout"/>.
  3340. </summary>
  3341. <param name="layout">The <see cref="T:log4net.Layout.ILayout"/> to use with this appender.</param>
  3342. <remarks>
  3343. <para>
  3344. Obsolete constructor.
  3345. </para>
  3346. </remarks>
  3347. </member>
  3348. <member name="M:log4net.Appender.EventLogAppender.AddMapping(log4net.Appender.EventLogAppender.Level2EventLogEntryType)">
  3349. <summary>
  3350. Add a mapping of level to <see cref="T:System.Diagnostics.EventLogEntryType"/> - done by the config file
  3351. </summary>
  3352. <param name="mapping">The mapping to add</param>
  3353. <remarks>
  3354. <para>
  3355. Add a <see cref="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"/> mapping to this appender.
  3356. Each mapping defines the event log entry type for a level.
  3357. </para>
  3358. </remarks>
  3359. </member>
  3360. <member name="M:log4net.Appender.EventLogAppender.ActivateOptions">
  3361. <summary>
  3362. Initialize the appender based on the options set
  3363. </summary>
  3364. <remarks>
  3365. <para>
  3366. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3367. activation scheme. The <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> method must
  3368. be called on this object after the configuration properties have
  3369. been set. Until <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> is called this
  3370. object is in an undefined state and must not be used.
  3371. </para>
  3372. <para>
  3373. If any of the configuration properties are modified then
  3374. <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> must be called again.
  3375. </para>
  3376. </remarks>
  3377. </member>
  3378. <member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)">
  3379. <summary>
  3380. Create an event log source
  3381. </summary>
  3382. <remarks>
  3383. Uses different API calls under NET_2_0
  3384. </remarks>
  3385. </member>
  3386. <member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)">
  3387. <summary>
  3388. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3389. method.
  3390. </summary>
  3391. <param name="loggingEvent">the event to log</param>
  3392. <remarks>
  3393. <para>Writes the event to the system event log using the
  3394. <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>.</para>
  3395. <para>If the event has an <c>EventID</c> property (see <see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3396. set then this integer will be used as the event log event id.</para>
  3397. <para>
  3398. There is a limit of 32K characters for an event log message
  3399. </para>
  3400. </remarks>
  3401. </member>
  3402. <member name="M:log4net.Appender.EventLogAppender.GetEntryType(log4net.Core.Level)">
  3403. <summary>
  3404. Get the equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/>
  3405. </summary>
  3406. <param name="level">the Level to convert to an EventLogEntryType</param>
  3407. <returns>The equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/></returns>
  3408. <remarks>
  3409. Because there are fewer applicable <see cref="T:System.Diagnostics.EventLogEntryType"/>
  3410. values to use in logging levels than there are in the
  3411. <see cref="T:log4net.Core.Level"/> this is a one way mapping. There is
  3412. a loss of information during the conversion.
  3413. </remarks>
  3414. </member>
  3415. <member name="F:log4net.Appender.EventLogAppender.m_logName">
  3416. <summary>
  3417. The log name is the section in the event logs where the messages
  3418. are stored.
  3419. </summary>
  3420. </member>
  3421. <member name="F:log4net.Appender.EventLogAppender.m_applicationName">
  3422. <summary>
  3423. Name of the application to use when logging. This appears in the
  3424. application column of the event log named by <see cref="F:log4net.Appender.EventLogAppender.m_logName"/>.
  3425. </summary>
  3426. </member>
  3427. <member name="F:log4net.Appender.EventLogAppender.m_machineName">
  3428. <summary>
  3429. The name of the machine which holds the event log. This is
  3430. currently only allowed to be '.' i.e. the current machine.
  3431. </summary>
  3432. </member>
  3433. <member name="F:log4net.Appender.EventLogAppender.m_levelMapping">
  3434. <summary>
  3435. Mapping from level object to EventLogEntryType
  3436. </summary>
  3437. </member>
  3438. <member name="F:log4net.Appender.EventLogAppender.m_securityContext">
  3439. <summary>
  3440. The security context to use for privileged calls
  3441. </summary>
  3442. </member>
  3443. <member name="F:log4net.Appender.EventLogAppender.m_eventId">
  3444. <summary>
  3445. The event ID to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3446. </summary>
  3447. </member>
  3448. <member name="F:log4net.Appender.EventLogAppender.m_category">
  3449. <summary>
  3450. The event category to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3451. </summary>
  3452. </member>
  3453. <member name="F:log4net.Appender.EventLogAppender.declaringType">
  3454. <summary>
  3455. The fully qualified type of the EventLogAppender class.
  3456. </summary>
  3457. <remarks>
  3458. Used by the internal logger to record the Type of the
  3459. log message.
  3460. </remarks>
  3461. </member>
  3462. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_DEFAULT">
  3463. <summary>
  3464. The maximum size supported by default.
  3465. </summary>
  3466. <remarks>
  3467. http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx
  3468. The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766
  3469. may leave space for a two byte null terminator of #0#0). The 32766 max
  3470. length is what the .NET 4.0 source code checks for, but this is WRONG!
  3471. Strings with a length > 31839 on Windows Vista or higher can CORRUPT
  3472. the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent()
  3473. for the use of the 32766 max size.
  3474. </remarks>
  3475. </member>
  3476. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_VISTA_OR_NEWER">
  3477. <summary>
  3478. The maximum size supported by a windows operating system that is vista
  3479. or newer.
  3480. </summary>
  3481. <remarks>
  3482. See ReportEvent API:
  3483. http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx
  3484. ReportEvent's lpStrings parameter:
  3485. "A pointer to a buffer containing an array of
  3486. null-terminated strings that are merged into the message before Event Viewer
  3487. displays the string to the user. This parameter must be a valid pointer
  3488. (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters."
  3489. Going beyond the size of 31839 will (at some point) corrupt the event log on Windows
  3490. Vista or higher! It may succeed for a while...but you will eventually run into the
  3491. error: "System.ComponentModel.Win32Exception : A device attached to the system is
  3492. not functioning", and the event log will then be corrupt (I was able to corrupt
  3493. an event log using a length of 31877 on Windows 7).
  3494. The max size for Windows Vista or higher is documented here:
  3495. http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx.
  3496. Going over this size may succeed a few times but the buffer will overrun and
  3497. eventually corrupt the log (based on testing).
  3498. The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API.
  3499. The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a
  3500. terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the
  3501. buffer, given enough time).
  3502. </remarks>
  3503. </member>
  3504. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE">
  3505. <summary>
  3506. The maximum size that the operating system supports for
  3507. a event log message.
  3508. </summary>
  3509. <remarks>
  3510. Used to determine the maximum string length that can be written
  3511. to the operating system event log and eventually truncate a string
  3512. that exceeds the limits.
  3513. </remarks>
  3514. </member>
  3515. <member name="M:log4net.Appender.EventLogAppender.GetMaxEventLogMessageSize">
  3516. <summary>
  3517. This method determines the maximum event log message size allowed for
  3518. the current environment.
  3519. </summary>
  3520. <returns></returns>
  3521. </member>
  3522. <member name="P:log4net.Appender.EventLogAppender.LogName">
  3523. <summary>
  3524. The name of the log where messages will be stored.
  3525. </summary>
  3526. <value>
  3527. The string name of the log where messages will be stored.
  3528. </value>
  3529. <remarks>
  3530. <para>This is the name of the log as it appears in the Event Viewer
  3531. tree. The default value is to log into the <c>Application</c>
  3532. log, this is where most applications write their events. However
  3533. if you need a separate log for your application (or applications)
  3534. then you should set the <see cref="P:log4net.Appender.EventLogAppender.LogName"/> appropriately.</para>
  3535. <para>This should not be used to distinguish your event log messages
  3536. from those of other applications, the <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>
  3537. property should be used to distinguish events. This property should be
  3538. used to group together events into a single log.
  3539. </para>
  3540. </remarks>
  3541. </member>
  3542. <member name="P:log4net.Appender.EventLogAppender.ApplicationName">
  3543. <summary>
  3544. Property used to set the Application name. This appears in the
  3545. event logs when logging.
  3546. </summary>
  3547. <value>
  3548. The string used to distinguish events from different sources.
  3549. </value>
  3550. <remarks>
  3551. Sets the event log source property.
  3552. </remarks>
  3553. </member>
  3554. <member name="P:log4net.Appender.EventLogAppender.MachineName">
  3555. <summary>
  3556. This property is used to return the name of the computer to use
  3557. when accessing the event logs. Currently, this is the current
  3558. computer, denoted by a dot "."
  3559. </summary>
  3560. <value>
  3561. The string name of the machine holding the event log that
  3562. will be logged into.
  3563. </value>
  3564. <remarks>
  3565. This property cannot be changed. It is currently set to '.'
  3566. i.e. the local machine. This may be changed in future.
  3567. </remarks>
  3568. </member>
  3569. <member name="P:log4net.Appender.EventLogAppender.SecurityContext">
  3570. <summary>
  3571. Gets or sets the <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3572. </summary>
  3573. <value>
  3574. The <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3575. </value>
  3576. <remarks>
  3577. <para>
  3578. The system security context used to write to the EventLog.
  3579. </para>
  3580. <para>
  3581. Unless a <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> specified here for this appender
  3582. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  3583. security context to use. The default behavior is to use the security context
  3584. of the current thread.
  3585. </para>
  3586. </remarks>
  3587. </member>
  3588. <member name="P:log4net.Appender.EventLogAppender.EventId">
  3589. <summary>
  3590. Gets or sets the <c>EventId</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3591. </summary>
  3592. <remarks>
  3593. <para>
  3594. The <c>EventID</c> of the event log entry will normally be
  3595. set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3596. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3597. This property provides the fallback value which defaults to 0.
  3598. </para>
  3599. </remarks>
  3600. </member>
  3601. <member name="P:log4net.Appender.EventLogAppender.Category">
  3602. <summary>
  3603. Gets or sets the <c>Category</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3604. </summary>
  3605. <remarks>
  3606. <para>
  3607. The <c>Category</c> of the event log entry will normally be
  3608. set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3609. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3610. This property provides the fallback value which defaults to 0.
  3611. </para>
  3612. </remarks>
  3613. </member>
  3614. <member name="P:log4net.Appender.EventLogAppender.RequiresLayout">
  3615. <summary>
  3616. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3617. </summary>
  3618. <value><c>true</c></value>
  3619. <remarks>
  3620. <para>
  3621. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3622. </para>
  3623. </remarks>
  3624. </member>
  3625. <member name="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType">
  3626. <summary>
  3627. A class to act as a mapping between the level that a logging call is made at and
  3628. the color it should be displayed as.
  3629. </summary>
  3630. <remarks>
  3631. <para>
  3632. Defines the mapping between a level and its event log entry type.
  3633. </para>
  3634. </remarks>
  3635. </member>
  3636. <member name="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType">
  3637. <summary>
  3638. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3639. </summary>
  3640. <remarks>
  3641. <para>
  3642. Required property.
  3643. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3644. </para>
  3645. </remarks>
  3646. </member>
  3647. <member name="T:log4net.Appender.FileAppender">
  3648. <summary>
  3649. Appends logging events to a file.
  3650. </summary>
  3651. <remarks>
  3652. <para>
  3653. Logging events are sent to the file specified by
  3654. the <see cref="P:log4net.Appender.FileAppender.File"/> property.
  3655. </para>
  3656. <para>
  3657. The file can be opened in either append or overwrite mode
  3658. by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property.
  3659. If the file path is relative it is taken as relative from
  3660. the application base directory. The file encoding can be
  3661. specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property.
  3662. </para>
  3663. <para>
  3664. The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  3665. values will be written each time the file is opened and closed
  3666. respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/>
  3667. then the file may contain multiple copies of the header and footer.
  3668. </para>
  3669. <para>
  3670. This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/>
  3671. is called. This will typically be during configuration.
  3672. If the file cannot be opened for writing the appender will attempt
  3673. to open the file again each time a message is logged to the appender.
  3674. If the file cannot be opened for writing when a message is logged then
  3675. the message will be discarded by this appender.
  3676. </para>
  3677. <para>
  3678. The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via
  3679. the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property.
  3680. The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>
  3681. is to obtain an exclusive write lock on the file until this appender is closed.
  3682. The alternative models only hold a
  3683. write lock while the appender is writing a logging event (<see cref="T:log4net.Appender.FileAppender.MinimalLock"/>)
  3684. or synchronize by using a named system wide Mutex (<see cref="T:log4net.Appender.FileAppender.InterProcessLock"/>).
  3685. </para>
  3686. <para>
  3687. All locking strategies have issues and you should seriously consider using a different strategy that
  3688. avoids having multiple processes logging to the same file.
  3689. </para>
  3690. </remarks>
  3691. <author>Nicko Cadell</author>
  3692. <author>Gert Driesen</author>
  3693. <author>Rodrigo B. de Oliveira</author>
  3694. <author>Douglas de la Torre</author>
  3695. <author>Niall Daley</author>
  3696. </member>
  3697. <member name="T:log4net.Appender.TextWriterAppender">
  3698. <summary>
  3699. Sends logging events to a <see cref="T:System.IO.TextWriter"/>.
  3700. </summary>
  3701. <remarks>
  3702. <para>
  3703. An Appender that writes to a <see cref="T:System.IO.TextWriter"/>.
  3704. </para>
  3705. <para>
  3706. This appender may be used stand alone if initialized with an appropriate
  3707. writer, however it is typically used as a base class for an appender that
  3708. can open a <see cref="T:System.IO.TextWriter"/> to write to.
  3709. </para>
  3710. </remarks>
  3711. <author>Nicko Cadell</author>
  3712. <author>Gert Driesen</author>
  3713. <author>Douglas de la Torre</author>
  3714. </member>
  3715. <member name="M:log4net.Appender.TextWriterAppender.#ctor">
  3716. <summary>
  3717. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class.
  3718. </summary>
  3719. <remarks>
  3720. <para>
  3721. Default constructor.
  3722. </para>
  3723. </remarks>
  3724. </member>
  3725. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)">
  3726. <summary>
  3727. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and
  3728. sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized
  3729. with the specified <see cref="T:System.IO.Stream"/>.
  3730. </summary>
  3731. <param name="layout">The layout to use with this appender.</param>
  3732. <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param>
  3733. <remarks>
  3734. <para>
  3735. Obsolete constructor.
  3736. </para>
  3737. </remarks>
  3738. </member>
  3739. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)">
  3740. <summary>
  3741. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and sets
  3742. the output destination to the specified <see cref="T:System.IO.StreamWriter"/>.
  3743. </summary>
  3744. <param name="layout">The layout to use with this appender</param>
  3745. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to output to</param>
  3746. <remarks>
  3747. The <see cref="T:System.IO.TextWriter"/> must have been previously opened.
  3748. </remarks>
  3749. <remarks>
  3750. <para>
  3751. Obsolete constructor.
  3752. </para>
  3753. </remarks>
  3754. </member>
  3755. <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck">
  3756. <summary>
  3757. This method determines if there is a sense in attempting to append.
  3758. </summary>
  3759. <remarks>
  3760. <para>
  3761. This method checks if an output target has been set and if a
  3762. layout has been set.
  3763. </para>
  3764. </remarks>
  3765. <returns><c>false</c> if any of the preconditions fail.</returns>
  3766. </member>
  3767. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)">
  3768. <summary>
  3769. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3770. method.
  3771. </summary>
  3772. <param name="loggingEvent">The event to log.</param>
  3773. <remarks>
  3774. <para>
  3775. Writes a log statement to the output stream if the output stream exists
  3776. and is writable.
  3777. </para>
  3778. <para>
  3779. The format of the output will depend on the appender's layout.
  3780. </para>
  3781. </remarks>
  3782. </member>
  3783. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
  3784. <summary>
  3785. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  3786. method.
  3787. </summary>
  3788. <param name="loggingEvents">The array of events to log.</param>
  3789. <remarks>
  3790. <para>
  3791. This method writes all the bulk logged events to the output writer
  3792. before flushing the stream.
  3793. </para>
  3794. </remarks>
  3795. </member>
  3796. <member name="M:log4net.Appender.TextWriterAppender.OnClose">
  3797. <summary>
  3798. Close this appender instance. The underlying stream or writer is also closed.
  3799. </summary>
  3800. <remarks>
  3801. Closed appenders cannot be reused.
  3802. </remarks>
  3803. </member>
  3804. <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter">
  3805. <summary>
  3806. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3807. </summary>
  3808. <remarks>
  3809. <para>
  3810. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3811. </para>
  3812. </remarks>
  3813. </member>
  3814. <member name="M:log4net.Appender.TextWriterAppender.CloseWriter">
  3815. <summary>
  3816. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3817. </summary>
  3818. <remarks>
  3819. <para>
  3820. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3821. </para>
  3822. </remarks>
  3823. </member>
  3824. <member name="M:log4net.Appender.TextWriterAppender.Reset">
  3825. <summary>
  3826. Clears internal references to the underlying <see cref="T:System.IO.TextWriter"/>
  3827. and other variables.
  3828. </summary>
  3829. <remarks>
  3830. <para>
  3831. Subclasses can override this method for an alternate closing behavior.
  3832. </para>
  3833. </remarks>
  3834. </member>
  3835. <member name="M:log4net.Appender.TextWriterAppender.WriteFooter">
  3836. <summary>
  3837. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3838. </summary>
  3839. <remarks>
  3840. <para>
  3841. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3842. </para>
  3843. </remarks>
  3844. </member>
  3845. <member name="M:log4net.Appender.TextWriterAppender.WriteHeader">
  3846. <summary>
  3847. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3848. </summary>
  3849. <remarks>
  3850. <para>
  3851. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3852. </para>
  3853. </remarks>
  3854. </member>
  3855. <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter">
  3856. <summary>
  3857. Called to allow a subclass to lazily initialize the writer
  3858. </summary>
  3859. <remarks>
  3860. <para>
  3861. This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or
  3862. <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to
  3863. attempt to initialize the writer multiple times.
  3864. </para>
  3865. </remarks>
  3866. </member>
  3867. <member name="F:log4net.Appender.TextWriterAppender.m_qtw">
  3868. <summary>
  3869. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  3870. will be written to.
  3871. </summary>
  3872. </member>
  3873. <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush">
  3874. <summary>
  3875. Immediate flush means that the underlying <see cref="T:System.IO.TextWriter"/>
  3876. or output stream will be flushed at the end of each append operation.
  3877. </summary>
  3878. <remarks>
  3879. <para>
  3880. Immediate flush is slower but ensures that each append request is
  3881. actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to
  3882. <c>false</c>, then there is a good chance that the last few
  3883. logging events are not actually persisted if and when the application
  3884. crashes.
  3885. </para>
  3886. <para>
  3887. The default value is <c>true</c>.
  3888. </para>
  3889. </remarks>
  3890. </member>
  3891. <member name="F:log4net.Appender.TextWriterAppender.declaringType">
  3892. <summary>
  3893. The fully qualified type of the TextWriterAppender class.
  3894. </summary>
  3895. <remarks>
  3896. Used by the internal logger to record the Type of the
  3897. log message.
  3898. </remarks>
  3899. </member>
  3900. <member name="M:log4net.Appender.TextWriterAppender.Flush(System.Int32)">
  3901. <summary>
  3902. Flushes any buffered log data.
  3903. </summary>
  3904. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  3905. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  3906. </member>
  3907. <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush">
  3908. <summary>
  3909. Gets or set whether the appender will flush at the end
  3910. of each append operation.
  3911. </summary>
  3912. <value>
  3913. <para>
  3914. The default behavior is to flush at the end of each
  3915. append operation.
  3916. </para>
  3917. <para>
  3918. If this option is set to <c>false</c>, then the underlying
  3919. stream can defer persisting the logging event to a later
  3920. time.
  3921. </para>
  3922. </value>
  3923. <remarks>
  3924. Avoiding the flush operation at the end of each append results in
  3925. a performance gain of 10 to 20 percent. However, there is safety
  3926. trade-off involved in skipping flushing. Indeed, when flushing is
  3927. skipped, then it is likely that the last few log events will not
  3928. be recorded on disk when the application exits. This is a high
  3929. price to pay even for a 20% performance gain.
  3930. </remarks>
  3931. </member>
  3932. <member name="P:log4net.Appender.TextWriterAppender.Writer">
  3933. <summary>
  3934. Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go.
  3935. </summary>
  3936. <remarks>
  3937. <para>
  3938. The specified <see cref="T:System.IO.TextWriter"/> must be open and writable.
  3939. </para>
  3940. <para>
  3941. The <see cref="T:System.IO.TextWriter"/> will be closed when the appender
  3942. instance is closed.
  3943. </para>
  3944. <para>
  3945. <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail.
  3946. </para>
  3947. </remarks>
  3948. </member>
  3949. <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler">
  3950. <summary>
  3951. Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying
  3952. <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender.
  3953. </summary>
  3954. <value>
  3955. The <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  3956. </value>
  3957. </member>
  3958. <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout">
  3959. <summary>
  3960. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3961. </summary>
  3962. <value><c>true</c></value>
  3963. <remarks>
  3964. <para>
  3965. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3966. </para>
  3967. </remarks>
  3968. </member>
  3969. <member name="P:log4net.Appender.TextWriterAppender.QuietWriter">
  3970. <summary>
  3971. Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  3972. will be written to.
  3973. </summary>
  3974. <value>
  3975. The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written.
  3976. </value>
  3977. <remarks>
  3978. <para>
  3979. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  3980. will be written to.
  3981. </para>
  3982. </remarks>
  3983. </member>
  3984. <member name="M:log4net.Appender.FileAppender.#ctor">
  3985. <summary>
  3986. Default constructor
  3987. </summary>
  3988. <remarks>
  3989. <para>
  3990. Default constructor
  3991. </para>
  3992. </remarks>
  3993. </member>
  3994. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)">
  3995. <summary>
  3996. Construct a new appender using the layout, file and append mode.
  3997. </summary>
  3998. <param name="layout">the layout to use with this appender</param>
  3999. <param name="filename">the full path to the file to write to</param>
  4000. <param name="append">flag to indicate if the file should be appended to</param>
  4001. <remarks>
  4002. <para>
  4003. Obsolete constructor.
  4004. </para>
  4005. </remarks>
  4006. </member>
  4007. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)">
  4008. <summary>
  4009. Construct a new appender using the layout and file specified.
  4010. The file will be appended to.
  4011. </summary>
  4012. <param name="layout">the layout to use with this appender</param>
  4013. <param name="filename">the full path to the file to write to</param>
  4014. <remarks>
  4015. <para>
  4016. Obsolete constructor.
  4017. </para>
  4018. </remarks>
  4019. </member>
  4020. <member name="M:log4net.Appender.FileAppender.ActivateOptions">
  4021. <summary>
  4022. Activate the options on the file appender.
  4023. </summary>
  4024. <remarks>
  4025. <para>
  4026. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4027. activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must
  4028. be called on this object after the configuration properties have
  4029. been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this
  4030. object is in an undefined state and must not be used.
  4031. </para>
  4032. <para>
  4033. If any of the configuration properties are modified then
  4034. <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again.
  4035. </para>
  4036. <para>
  4037. This will cause the file to be opened.
  4038. </para>
  4039. </remarks>
  4040. </member>
  4041. <member name="M:log4net.Appender.FileAppender.Reset">
  4042. <summary>
  4043. Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>.
  4044. </summary>
  4045. <remarks>
  4046. <para>
  4047. Resets the filename and the file stream.
  4048. </para>
  4049. </remarks>
  4050. </member>
  4051. <member name="M:log4net.Appender.FileAppender.OnClose">
  4052. <summary>
  4053. Close this appender instance. The underlying stream or writer is also closed.
  4054. </summary>
  4055. </member>
  4056. <member name="M:log4net.Appender.FileAppender.PrepareWriter">
  4057. <summary>
  4058. Called to initialize the file writer
  4059. </summary>
  4060. <remarks>
  4061. <para>
  4062. Will be called for each logged message until the file is
  4063. successfully opened.
  4064. </para>
  4065. </remarks>
  4066. </member>
  4067. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)">
  4068. <summary>
  4069. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  4070. method.
  4071. </summary>
  4072. <param name="loggingEvent">The event to log.</param>
  4073. <remarks>
  4074. <para>
  4075. Writes a log statement to the output stream if the output stream exists
  4076. and is writable.
  4077. </para>
  4078. <para>
  4079. The format of the output will depend on the appender's layout.
  4080. </para>
  4081. </remarks>
  4082. </member>
  4083. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
  4084. <summary>
  4085. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  4086. method.
  4087. </summary>
  4088. <param name="loggingEvents">The array of events to log.</param>
  4089. <remarks>
  4090. <para>
  4091. Acquires the output file locks once before writing all the events to
  4092. the stream.
  4093. </para>
  4094. </remarks>
  4095. </member>
  4096. <member name="M:log4net.Appender.FileAppender.WriteFooter">
  4097. <summary>
  4098. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  4099. </summary>
  4100. <remarks>
  4101. <para>
  4102. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  4103. </para>
  4104. </remarks>
  4105. </member>
  4106. <member name="M:log4net.Appender.FileAppender.WriteHeader">
  4107. <summary>
  4108. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  4109. </summary>
  4110. <remarks>
  4111. <para>
  4112. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  4113. </para>
  4114. </remarks>
  4115. </member>
  4116. <member name="M:log4net.Appender.FileAppender.CloseWriter">
  4117. <summary>
  4118. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  4119. </summary>
  4120. <remarks>
  4121. <para>
  4122. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  4123. </para>
  4124. </remarks>
  4125. </member>
  4126. <member name="M:log4net.Appender.FileAppender.CloseFile">
  4127. <summary>
  4128. Closes the previously opened file.
  4129. </summary>
  4130. <remarks>
  4131. <para>
  4132. Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then
  4133. closes the file.
  4134. </para>
  4135. </remarks>
  4136. </member>
  4137. <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)">
  4138. <summary>
  4139. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  4140. </summary>
  4141. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  4142. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  4143. <remarks>
  4144. <para>
  4145. Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception.
  4146. Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>.
  4147. </para>
  4148. </remarks>
  4149. </member>
  4150. <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)">
  4151. <summary>
  4152. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  4153. </summary>
  4154. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  4155. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  4156. <remarks>
  4157. <para>
  4158. If there was already an opened file, then the previous file
  4159. is closed first.
  4160. </para>
  4161. <para>
  4162. This method will ensure that the directory structure
  4163. for the <paramref name="fileName"/> specified exists.
  4164. </para>
  4165. </remarks>
  4166. </member>
  4167. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)">
  4168. <summary>
  4169. Sets the quiet writer used for file output
  4170. </summary>
  4171. <param name="fileStream">the file stream that has been opened for writing</param>
  4172. <remarks>
  4173. <para>
  4174. This implementation of <see cref="M:SetQWForFiles(Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/>
  4175. over the <paramref name="fileStream"/> and passes it to the
  4176. <see cref="M:SetQWForFiles(TextWriter)"/> method.
  4177. </para>
  4178. <para>
  4179. This method can be overridden by sub classes that want to wrap the
  4180. <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output
  4181. data using a <c>System.Security.Cryptography.CryptoStream</c>.
  4182. </para>
  4183. </remarks>
  4184. </member>
  4185. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)">
  4186. <summary>
  4187. Sets the quiet writer being used.
  4188. </summary>
  4189. <param name="writer">the writer over the file stream that has been opened for writing</param>
  4190. <remarks>
  4191. <para>
  4192. This method can be overridden by sub classes that want to
  4193. wrap the <see cref="T:System.IO.TextWriter"/> in some way.
  4194. </para>
  4195. </remarks>
  4196. </member>
  4197. <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)">
  4198. <summary>
  4199. Convert a path into a fully qualified path.
  4200. </summary>
  4201. <param name="path">The path to convert.</param>
  4202. <returns>The fully qualified path.</returns>
  4203. <remarks>
  4204. <para>
  4205. Converts the path specified to a fully
  4206. qualified path. If the path is relative it is
  4207. taken as relative from the application base
  4208. directory.
  4209. </para>
  4210. </remarks>
  4211. </member>
  4212. <member name="F:log4net.Appender.FileAppender.m_appendToFile">
  4213. <summary>
  4214. Flag to indicate if we should append to the file
  4215. or overwrite the file. The default is to append.
  4216. </summary>
  4217. </member>
  4218. <member name="F:log4net.Appender.FileAppender.m_fileName">
  4219. <summary>
  4220. The name of the log file.
  4221. </summary>
  4222. </member>
  4223. <member name="F:log4net.Appender.FileAppender.m_encoding">
  4224. <summary>
  4225. The encoding to use for the file stream.
  4226. </summary>
  4227. </member>
  4228. <member name="F:log4net.Appender.FileAppender.m_securityContext">
  4229. <summary>
  4230. The security context to use for privileged calls
  4231. </summary>
  4232. </member>
  4233. <member name="F:log4net.Appender.FileAppender.m_stream">
  4234. <summary>
  4235. The stream to log to. Has added locking semantics
  4236. </summary>
  4237. </member>
  4238. <member name="F:log4net.Appender.FileAppender.m_lockingModel">
  4239. <summary>
  4240. The locking model to use
  4241. </summary>
  4242. </member>
  4243. <member name="F:log4net.Appender.FileAppender.declaringType">
  4244. <summary>
  4245. The fully qualified type of the FileAppender class.
  4246. </summary>
  4247. <remarks>
  4248. Used by the internal logger to record the Type of the
  4249. log message.
  4250. </remarks>
  4251. </member>
  4252. <member name="P:log4net.Appender.FileAppender.File">
  4253. <summary>
  4254. Gets or sets the path to the file that logging will be written to.
  4255. </summary>
  4256. <value>
  4257. The path to the file that logging will be written to.
  4258. </value>
  4259. <remarks>
  4260. <para>
  4261. If the path is relative it is taken as relative from
  4262. the application base directory.
  4263. </para>
  4264. </remarks>
  4265. </member>
  4266. <member name="P:log4net.Appender.FileAppender.AppendToFile">
  4267. <summary>
  4268. Gets or sets a flag that indicates whether the file should be
  4269. appended to or overwritten.
  4270. </summary>
  4271. <value>
  4272. Indicates whether the file should be appended to or overwritten.
  4273. </value>
  4274. <remarks>
  4275. <para>
  4276. If the value is set to false then the file will be overwritten, if
  4277. it is set to true then the file will be appended to.
  4278. </para>
  4279. The default value is true.
  4280. </remarks>
  4281. </member>
  4282. <member name="P:log4net.Appender.FileAppender.Encoding">
  4283. <summary>
  4284. Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  4285. </summary>
  4286. <value>
  4287. The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  4288. </value>
  4289. <remarks>
  4290. <para>
  4291. The default encoding set is <see cref="P:System.Text.Encoding.Default"/>
  4292. which is the encoding for the system's current ANSI code page.
  4293. </para>
  4294. </remarks>
  4295. </member>
  4296. <member name="P:log4net.Appender.FileAppender.SecurityContext">
  4297. <summary>
  4298. Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  4299. </summary>
  4300. <value>
  4301. The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  4302. </value>
  4303. <remarks>
  4304. <para>
  4305. Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender
  4306. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  4307. security context to use. The default behavior is to use the security context
  4308. of the current thread.
  4309. </para>
  4310. </remarks>
  4311. </member>
  4312. <member name="P:log4net.Appender.FileAppender.LockingModel">
  4313. <summary>
  4314. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  4315. </summary>
  4316. <value>
  4317. The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file.
  4318. </value>
  4319. <remarks>
  4320. <para>
  4321. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  4322. </para>
  4323. <para>
  4324. 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"/> .
  4325. The first locks the file from the start of logging to the end, the
  4326. second locks only for the minimal amount of time when logging each message
  4327. and the last synchronizes processes using a named system wide Mutex.
  4328. </para>
  4329. <para>
  4330. The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>.
  4331. </para>
  4332. </remarks>
  4333. </member>
  4334. <member name="T:log4net.Appender.FileAppender.LockingStream">
  4335. <summary>
  4336. Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/>
  4337. to manage access to an underlying resource.
  4338. </summary>
  4339. </member>
  4340. <member name="M:log4net.Appender.FileAppender.LockingStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
  4341. <summary>
  4342. True asynchronous writes are not supported, the implementation forces a synchronous write.
  4343. </summary>
  4344. </member>
  4345. <member name="T:log4net.Core.LogException">
  4346. <summary>
  4347. Exception base type for log4net.
  4348. </summary>
  4349. <remarks>
  4350. <para>
  4351. This type extends <see cref="T:System.ApplicationException"/>. It
  4352. does not add any new functionality but does differentiate the
  4353. type of exception being thrown.
  4354. </para>
  4355. </remarks>
  4356. <author>Nicko Cadell</author>
  4357. <author>Gert Driesen</author>
  4358. </member>
  4359. <member name="M:log4net.Core.LogException.#ctor">
  4360. <summary>
  4361. Constructor
  4362. </summary>
  4363. <remarks>
  4364. <para>
  4365. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class.
  4366. </para>
  4367. </remarks>
  4368. </member>
  4369. <member name="M:log4net.Core.LogException.#ctor(System.String)">
  4370. <summary>
  4371. Constructor
  4372. </summary>
  4373. <param name="message">A message to include with the exception.</param>
  4374. <remarks>
  4375. <para>
  4376. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class with
  4377. the specified message.
  4378. </para>
  4379. </remarks>
  4380. </member>
  4381. <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)">
  4382. <summary>
  4383. Constructor
  4384. </summary>
  4385. <param name="message">A message to include with the exception.</param>
  4386. <param name="innerException">A nested exception to include.</param>
  4387. <remarks>
  4388. <para>
  4389. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
  4390. with the specified message and inner exception.
  4391. </para>
  4392. </remarks>
  4393. </member>
  4394. <member name="M:log4net.Core.LogException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4395. <summary>
  4396. Serialization constructor
  4397. </summary>
  4398. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
  4399. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  4400. <remarks>
  4401. <para>
  4402. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
  4403. with serialized data.
  4404. </para>
  4405. </remarks>
  4406. </member>
  4407. <member name="T:log4net.Appender.FileAppender.LockingModelBase">
  4408. <summary>
  4409. Locking model base class
  4410. </summary>
  4411. <remarks>
  4412. <para>
  4413. Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers.
  4414. </para>
  4415. </remarks>
  4416. </member>
  4417. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4418. <summary>
  4419. Open the output file
  4420. </summary>
  4421. <param name="filename">The filename to use</param>
  4422. <param name="append">Whether to append to the file, or overwrite</param>
  4423. <param name="encoding">The encoding to use</param>
  4424. <remarks>
  4425. <para>
  4426. Open the file specified and prepare for logging.
  4427. No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called.
  4428. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>,
  4429. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>.
  4430. </para>
  4431. </remarks>
  4432. </member>
  4433. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile">
  4434. <summary>
  4435. Close the file
  4436. </summary>
  4437. <remarks>
  4438. <para>
  4439. Close the file. No further writes will be made.
  4440. </para>
  4441. </remarks>
  4442. </member>
  4443. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ActivateOptions">
  4444. <summary>
  4445. Initializes all resources used by this locking model.
  4446. </summary>
  4447. </member>
  4448. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OnClose">
  4449. <summary>
  4450. Disposes all resources that were initialized by this locking model.
  4451. </summary>
  4452. </member>
  4453. <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock">
  4454. <summary>
  4455. Acquire the lock on the file
  4456. </summary>
  4457. <returns>A stream that is ready to be written to.</returns>
  4458. <remarks>
  4459. <para>
  4460. Acquire the lock on the file in preparation for writing to it.
  4461. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/>
  4462. must be called to release the lock on the output file.
  4463. </para>
  4464. </remarks>
  4465. </member>
  4466. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock">
  4467. <summary>
  4468. Release the lock on the file
  4469. </summary>
  4470. <remarks>
  4471. <para>
  4472. Release the lock on the file. No further writes will be made to the
  4473. stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again.
  4474. </para>
  4475. </remarks>
  4476. </member>
  4477. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CreateStream(System.String,System.Boolean,System.IO.FileShare)">
  4478. <summary>
  4479. Helper method that creates a FileStream under CurrentAppender's SecurityContext.
  4480. </summary>
  4481. <remarks>
  4482. <para>
  4483. Typically called during OpenFile or AcquireLock.
  4484. </para>
  4485. <para>
  4486. If the directory portion of the <paramref name="filename"/> does not exist, it is created
  4487. via Directory.CreateDirecctory.
  4488. </para>
  4489. </remarks>
  4490. <param name="filename"></param>
  4491. <param name="append"></param>
  4492. <param name="fileShare"></param>
  4493. <returns></returns>
  4494. </member>
  4495. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseStream(System.IO.Stream)">
  4496. <summary>
  4497. Helper method to close <paramref name="stream"/> under CurrentAppender's SecurityContext.
  4498. </summary>
  4499. <remarks>
  4500. Does not set <paramref name="stream"/> to null.
  4501. </remarks>
  4502. <param name="stream"></param>
  4503. </member>
  4504. <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender">
  4505. <summary>
  4506. Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  4507. </summary>
  4508. <value>
  4509. The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  4510. </value>
  4511. <remarks>
  4512. <para>
  4513. The file appender this locking model is attached to and working on
  4514. behalf of.
  4515. </para>
  4516. <para>
  4517. The file appender is used to locate the security context and the error handler to use.
  4518. </para>
  4519. <para>
  4520. 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
  4521. called.
  4522. </para>
  4523. </remarks>
  4524. </member>
  4525. <member name="T:log4net.Appender.FileAppender.ExclusiveLock">
  4526. <summary>
  4527. Hold an exclusive lock on the output file
  4528. </summary>
  4529. <remarks>
  4530. <para>
  4531. Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called.
  4532. Maintains an exclusive lock on the file during this time.
  4533. </para>
  4534. </remarks>
  4535. </member>
  4536. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4537. <summary>
  4538. Open the file specified and prepare for logging.
  4539. </summary>
  4540. <param name="filename">The filename to use</param>
  4541. <param name="append">Whether to append to the file, or overwrite</param>
  4542. <param name="encoding">The encoding to use</param>
  4543. <remarks>
  4544. <para>
  4545. Open the file specified and prepare for logging.
  4546. No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called.
  4547. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>,
  4548. <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>.
  4549. </para>
  4550. </remarks>
  4551. </member>
  4552. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile">
  4553. <summary>
  4554. Close the file
  4555. </summary>
  4556. <remarks>
  4557. <para>
  4558. Close the file. No further writes will be made.
  4559. </para>
  4560. </remarks>
  4561. </member>
  4562. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock">
  4563. <summary>
  4564. Acquire the lock on the file
  4565. </summary>
  4566. <returns>A stream that is ready to be written to.</returns>
  4567. <remarks>
  4568. <para>
  4569. Does nothing. The lock is already taken
  4570. </para>
  4571. </remarks>
  4572. </member>
  4573. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock">
  4574. <summary>
  4575. Release the lock on the file
  4576. </summary>
  4577. <remarks>
  4578. <para>
  4579. Does nothing. The lock will be released when the file is closed.
  4580. </para>
  4581. </remarks>
  4582. </member>
  4583. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ActivateOptions">
  4584. <summary>
  4585. Initializes all resources used by this locking model.
  4586. </summary>
  4587. </member>
  4588. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OnClose">
  4589. <summary>
  4590. Disposes all resources that were initialized by this locking model.
  4591. </summary>
  4592. </member>
  4593. <member name="T:log4net.Appender.FileAppender.MinimalLock">
  4594. <summary>
  4595. Acquires the file lock for each write
  4596. </summary>
  4597. <remarks>
  4598. <para>
  4599. Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle,
  4600. thus holding the lock for the minimal amount of time. This method of locking
  4601. is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows
  4602. other processes to move/delete the log file whilst logging continues.
  4603. </para>
  4604. </remarks>
  4605. </member>
  4606. <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4607. <summary>
  4608. Prepares to open the file when the first message is logged.
  4609. </summary>
  4610. <param name="filename">The filename to use</param>
  4611. <param name="append">Whether to append to the file, or overwrite</param>
  4612. <param name="encoding">The encoding to use</param>
  4613. <remarks>
  4614. <para>
  4615. Open the file specified and prepare for logging.
  4616. No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called.
  4617. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>,
  4618. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>.
  4619. </para>
  4620. </remarks>
  4621. </member>
  4622. <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile">
  4623. <summary>
  4624. Close the file
  4625. </summary>
  4626. <remarks>
  4627. <para>
  4628. Close the file. No further writes will be made.
  4629. </para>
  4630. </remarks>
  4631. </member>
  4632. <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock">
  4633. <summary>
  4634. Acquire the lock on the file
  4635. </summary>
  4636. <returns>A stream that is ready to be written to.</returns>
  4637. <remarks>
  4638. <para>
  4639. Acquire the lock on the file in preparation for writing to it.
  4640. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/>
  4641. must be called to release the lock on the output file.
  4642. </para>
  4643. </remarks>
  4644. </member>
  4645. <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock">
  4646. <summary>
  4647. Release the lock on the file
  4648. </summary>
  4649. <remarks>
  4650. <para>
  4651. Release the lock on the file. No further writes will be made to the
  4652. stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again.
  4653. </para>
  4654. </remarks>
  4655. </member>
  4656. <member name="M:log4net.Appender.FileAppender.MinimalLock.ActivateOptions">
  4657. <summary>
  4658. Initializes all resources used by this locking model.
  4659. </summary>
  4660. </member>
  4661. <member name="M:log4net.Appender.FileAppender.MinimalLock.OnClose">
  4662. <summary>
  4663. Disposes all resources that were initialized by this locking model.
  4664. </summary>
  4665. </member>
  4666. <member name="T:log4net.Appender.FileAppender.InterProcessLock">
  4667. <summary>
  4668. Provides cross-process file locking.
  4669. </summary>
  4670. <author>Ron Grabowski</author>
  4671. <author>Steve Wranovsky</author>
  4672. </member>
  4673. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4674. <summary>
  4675. Open the file specified and prepare for logging.
  4676. </summary>
  4677. <param name="filename">The filename to use</param>
  4678. <param name="append">Whether to append to the file, or overwrite</param>
  4679. <param name="encoding">The encoding to use</param>
  4680. <remarks>
  4681. <para>
  4682. Open the file specified and prepare for logging.
  4683. No writes will be made until <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/> is called.
  4684. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/>,
  4685. -<see cref="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"/>.
  4686. </para>
  4687. </remarks>
  4688. </member>
  4689. <member name="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile">
  4690. <summary>
  4691. Close the file
  4692. </summary>
  4693. <remarks>
  4694. <para>
  4695. Close the file. No further writes will be made.
  4696. </para>
  4697. </remarks>
  4698. </member>
  4699. <member name="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock">
  4700. <summary>
  4701. Acquire the lock on the file
  4702. </summary>
  4703. <returns>A stream that is ready to be written to.</returns>
  4704. <remarks>
  4705. <para>
  4706. Does nothing. The lock is already taken
  4707. </para>
  4708. </remarks>
  4709. </member>
  4710. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock">
  4711. <summary>
  4712. Releases the lock and allows others to acquire a lock.
  4713. </summary>
  4714. </member>
  4715. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ActivateOptions">
  4716. <summary>
  4717. Initializes all resources used by this locking model.
  4718. </summary>
  4719. </member>
  4720. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OnClose">
  4721. <summary>
  4722. Disposes all resources that were initialized by this locking model.
  4723. </summary>
  4724. </member>
  4725. <member name="T:log4net.Appender.ForwardingAppender">
  4726. <summary>
  4727. This appender forwards logging events to attached appenders.
  4728. </summary>
  4729. <remarks>
  4730. <para>
  4731. The forwarding appender can be used to specify different thresholds
  4732. and filters for the same appender at different locations within the hierarchy.
  4733. </para>
  4734. </remarks>
  4735. <author>Nicko Cadell</author>
  4736. <author>Gert Driesen</author>
  4737. </member>
  4738. <member name="M:log4net.Appender.ForwardingAppender.#ctor">
  4739. <summary>
  4740. Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender"/> class.
  4741. </summary>
  4742. <remarks>
  4743. <para>
  4744. Default constructor.
  4745. </para>
  4746. </remarks>
  4747. </member>
  4748. <member name="M:log4net.Appender.ForwardingAppender.OnClose">
  4749. <summary>
  4750. Closes the appender and releases resources.
  4751. </summary>
  4752. <remarks>
  4753. <para>
  4754. Releases any resources allocated within the appender such as file handles,
  4755. network connections, etc.
  4756. </para>
  4757. <para>
  4758. It is a programming error to append to a closed appender.
  4759. </para>
  4760. </remarks>
  4761. </member>
  4762. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
  4763. <summary>
  4764. Forward the logging event to the attached appenders
  4765. </summary>
  4766. <param name="loggingEvent">The event to log.</param>
  4767. <remarks>
  4768. <para>
  4769. Delivers the logging event to all the attached appenders.
  4770. </para>
  4771. </remarks>
  4772. </member>
  4773. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
  4774. <summary>
  4775. Forward the logging events to the attached appenders
  4776. </summary>
  4777. <param name="loggingEvents">The array of events to log.</param>
  4778. <remarks>
  4779. <para>
  4780. Delivers the logging events to all the attached appenders.
  4781. </para>
  4782. </remarks>
  4783. </member>
  4784. <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  4785. <summary>
  4786. Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
  4787. instance.
  4788. </summary>
  4789. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
  4790. <remarks>
  4791. <para>
  4792. If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
  4793. appenders, then it won't be added again.
  4794. </para>
  4795. </remarks>
  4796. </member>
  4797. <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)">
  4798. <summary>
  4799. Looks for the appender with the specified name.
  4800. </summary>
  4801. <param name="name">The name of the appender to lookup.</param>
  4802. <returns>
  4803. The appender with the specified name, or <c>null</c>.
  4804. </returns>
  4805. <remarks>
  4806. <para>
  4807. Get the named appender attached to this appender.
  4808. </para>
  4809. </remarks>
  4810. </member>
  4811. <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders">
  4812. <summary>
  4813. Removes all previously added appenders from this appender.
  4814. </summary>
  4815. <remarks>
  4816. <para>
  4817. This is useful when re-reading configuration information.
  4818. </para>
  4819. </remarks>
  4820. </member>
  4821. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  4822. <summary>
  4823. Removes the specified appender from the list of appenders.
  4824. </summary>
  4825. <param name="appender">The appender to remove.</param>
  4826. <returns>The appender removed from the list</returns>
  4827. <remarks>
  4828. The appender removed is not closed.
  4829. If you are discarding the appender you must call
  4830. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4831. </remarks>
  4832. </member>
  4833. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)">
  4834. <summary>
  4835. Removes the appender with the specified name from the list of appenders.
  4836. </summary>
  4837. <param name="name">The name of the appender to remove.</param>
  4838. <returns>The appender removed from the list</returns>
  4839. <remarks>
  4840. The appender removed is not closed.
  4841. If you are discarding the appender you must call
  4842. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4843. </remarks>
  4844. </member>
  4845. <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl">
  4846. <summary>
  4847. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  4848. </summary>
  4849. </member>
  4850. <member name="P:log4net.Appender.ForwardingAppender.Appenders">
  4851. <summary>
  4852. Gets the appenders contained in this appender as an
  4853. <see cref="T:System.Collections.ICollection"/>.
  4854. </summary>
  4855. <remarks>
  4856. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  4857. is returned.
  4858. </remarks>
  4859. <returns>
  4860. A collection of the appenders in this appender.
  4861. </returns>
  4862. </member>
  4863. <member name="T:log4net.Appender.LocalSyslogAppender">
  4864. <summary>
  4865. Logs events to a local syslog service.
  4866. </summary>
  4867. <remarks>
  4868. <note>
  4869. This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>.
  4870. If these functions are not available on the local system then this appender will not work!
  4871. </note>
  4872. <para>
  4873. The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and
  4874. POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service.
  4875. </para>
  4876. <para>
  4877. This appender talks to a local syslog service. If you need to log to a remote syslog
  4878. daemon and you cannot configure your local syslog service to do this you may be
  4879. able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP.
  4880. </para>
  4881. <para>
  4882. Syslog messages must have a facility and and a severity. The severity
  4883. is derived from the Level of the logging event.
  4884. The facility must be chosen from the set of defined syslog
  4885. <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  4886. and cannot be extended.
  4887. </para>
  4888. <para>
  4889. An identifier is specified with each log message. This can be specified
  4890. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  4891. as the tag) must not contain white space. The default value for the
  4892. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  4893. </para>
  4894. </remarks>
  4895. <author>Rob Lyon</author>
  4896. <author>Nicko Cadell</author>
  4897. </member>
  4898. <member name="M:log4net.Appender.LocalSyslogAppender.#ctor">
  4899. <summary>
  4900. Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class.
  4901. </summary>
  4902. <remarks>
  4903. This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class is set up to write
  4904. to a local syslog service.
  4905. </remarks>
  4906. </member>
  4907. <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)">
  4908. <summary>
  4909. Add a mapping of level to severity
  4910. </summary>
  4911. <param name="mapping">The mapping to add</param>
  4912. <remarks>
  4913. <para>
  4914. Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender.
  4915. </para>
  4916. </remarks>
  4917. </member>
  4918. <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions">
  4919. <summary>
  4920. Initialize the appender based on the options set.
  4921. </summary>
  4922. <remarks>
  4923. <para>
  4924. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4925. activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must
  4926. be called on this object after the configuration properties have
  4927. been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this
  4928. object is in an undefined state and must not be used.
  4929. </para>
  4930. <para>
  4931. If any of the configuration properties are modified then
  4932. <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again.
  4933. </para>
  4934. </remarks>
  4935. </member>
  4936. <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)">
  4937. <summary>
  4938. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  4939. </summary>
  4940. <param name="loggingEvent">The event to log.</param>
  4941. <remarks>
  4942. <para>
  4943. Writes the event to a remote syslog daemon.
  4944. </para>
  4945. <para>
  4946. The format of the output will depend on the appender's layout.
  4947. </para>
  4948. </remarks>
  4949. </member>
  4950. <member name="M:log4net.Appender.LocalSyslogAppender.OnClose">
  4951. <summary>
  4952. Close the syslog when the appender is closed
  4953. </summary>
  4954. <remarks>
  4955. <para>
  4956. Close the syslog when the appender is closed
  4957. </para>
  4958. </remarks>
  4959. </member>
  4960. <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)">
  4961. <summary>
  4962. Translates a log4net level to a syslog severity.
  4963. </summary>
  4964. <param name="level">A log4net level.</param>
  4965. <returns>A syslog severity.</returns>
  4966. <remarks>
  4967. <para>
  4968. Translates a log4net level to a syslog severity.
  4969. </para>
  4970. </remarks>
  4971. </member>
  4972. <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)">
  4973. <summary>
  4974. Generate a syslog priority.
  4975. </summary>
  4976. <param name="facility">The syslog facility.</param>
  4977. <param name="severity">The syslog severity.</param>
  4978. <returns>A syslog priority.</returns>
  4979. </member>
  4980. <member name="F:log4net.Appender.LocalSyslogAppender.m_facility">
  4981. <summary>
  4982. The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  4983. </summary>
  4984. </member>
  4985. <member name="F:log4net.Appender.LocalSyslogAppender.m_identity">
  4986. <summary>
  4987. The message identity
  4988. </summary>
  4989. </member>
  4990. <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity">
  4991. <summary>
  4992. Marshaled handle to the identity string. We have to hold on to the
  4993. string as the <c>openlog</c> and <c>syslog</c> APIs just hold the
  4994. pointer to the ident and dereference it for each log message.
  4995. </summary>
  4996. </member>
  4997. <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping">
  4998. <summary>
  4999. Mapping from level object to syslog severity
  5000. </summary>
  5001. </member>
  5002. <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)">
  5003. <summary>
  5004. Open connection to system logger.
  5005. </summary>
  5006. </member>
  5007. <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
  5008. <summary>
  5009. Generate a log message.
  5010. </summary>
  5011. <remarks>
  5012. <para>
  5013. The libc syslog method takes a format string and a variable argument list similar
  5014. to the classic printf function. As this type of vararg list is not supported
  5015. by C# we need to specify the arguments explicitly. Here we have specified the
  5016. format string with a single message argument. The caller must set the format
  5017. string to <c>"%s"</c>.
  5018. </para>
  5019. </remarks>
  5020. </member>
  5021. <member name="M:log4net.Appender.LocalSyslogAppender.closelog">
  5022. <summary>
  5023. Close descriptor used to write to system logger.
  5024. </summary>
  5025. </member>
  5026. <member name="P:log4net.Appender.LocalSyslogAppender.Identity">
  5027. <summary>
  5028. Message identity
  5029. </summary>
  5030. <remarks>
  5031. <para>
  5032. An identifier is specified with each log message. This can be specified
  5033. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  5034. as the tag) must not contain white space. The default value for the
  5035. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  5036. </para>
  5037. </remarks>
  5038. </member>
  5039. <member name="P:log4net.Appender.LocalSyslogAppender.Facility">
  5040. <summary>
  5041. Syslog facility
  5042. </summary>
  5043. <remarks>
  5044. Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of
  5045. facilities is predefined and cannot be extended. The default value
  5046. is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  5047. </remarks>
  5048. </member>
  5049. <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout">
  5050. <summary>
  5051. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  5052. </summary>
  5053. <value><c>true</c></value>
  5054. <remarks>
  5055. <para>
  5056. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  5057. </para>
  5058. </remarks>
  5059. </member>
  5060. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity">
  5061. <summary>
  5062. syslog severities
  5063. </summary>
  5064. <remarks>
  5065. <para>
  5066. The log4net Level maps to a syslog severity using the
  5067. <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/>
  5068. class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>.
  5069. </para>
  5070. </remarks>
  5071. </member>
  5072. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency">
  5073. <summary>
  5074. system is unusable
  5075. </summary>
  5076. </member>
  5077. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert">
  5078. <summary>
  5079. action must be taken immediately
  5080. </summary>
  5081. </member>
  5082. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical">
  5083. <summary>
  5084. critical conditions
  5085. </summary>
  5086. </member>
  5087. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error">
  5088. <summary>
  5089. error conditions
  5090. </summary>
  5091. </member>
  5092. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning">
  5093. <summary>
  5094. warning conditions
  5095. </summary>
  5096. </member>
  5097. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice">
  5098. <summary>
  5099. normal but significant condition
  5100. </summary>
  5101. </member>
  5102. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational">
  5103. <summary>
  5104. informational
  5105. </summary>
  5106. </member>
  5107. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug">
  5108. <summary>
  5109. debug-level messages
  5110. </summary>
  5111. </member>
  5112. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility">
  5113. <summary>
  5114. syslog facilities
  5115. </summary>
  5116. <remarks>
  5117. <para>
  5118. The syslog facility defines which subsystem the logging comes from.
  5119. This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property.
  5120. </para>
  5121. </remarks>
  5122. </member>
  5123. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel">
  5124. <summary>
  5125. kernel messages
  5126. </summary>
  5127. </member>
  5128. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User">
  5129. <summary>
  5130. random user-level messages
  5131. </summary>
  5132. </member>
  5133. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail">
  5134. <summary>
  5135. mail system
  5136. </summary>
  5137. </member>
  5138. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons">
  5139. <summary>
  5140. system daemons
  5141. </summary>
  5142. </member>
  5143. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization">
  5144. <summary>
  5145. security/authorization messages
  5146. </summary>
  5147. </member>
  5148. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog">
  5149. <summary>
  5150. messages generated internally by syslogd
  5151. </summary>
  5152. </member>
  5153. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer">
  5154. <summary>
  5155. line printer subsystem
  5156. </summary>
  5157. </member>
  5158. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News">
  5159. <summary>
  5160. network news subsystem
  5161. </summary>
  5162. </member>
  5163. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp">
  5164. <summary>
  5165. UUCP subsystem
  5166. </summary>
  5167. </member>
  5168. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock">
  5169. <summary>
  5170. clock (cron/at) daemon
  5171. </summary>
  5172. </member>
  5173. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2">
  5174. <summary>
  5175. security/authorization messages (private)
  5176. </summary>
  5177. </member>
  5178. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp">
  5179. <summary>
  5180. ftp daemon
  5181. </summary>
  5182. </member>
  5183. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp">
  5184. <summary>
  5185. NTP subsystem
  5186. </summary>
  5187. </member>
  5188. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit">
  5189. <summary>
  5190. log audit
  5191. </summary>
  5192. </member>
  5193. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert">
  5194. <summary>
  5195. log alert
  5196. </summary>
  5197. </member>
  5198. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2">
  5199. <summary>
  5200. clock daemon
  5201. </summary>
  5202. </member>
  5203. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0">
  5204. <summary>
  5205. reserved for local use
  5206. </summary>
  5207. </member>
  5208. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1">
  5209. <summary>
  5210. reserved for local use
  5211. </summary>
  5212. </member>
  5213. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2">
  5214. <summary>
  5215. reserved for local use
  5216. </summary>
  5217. </member>
  5218. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3">
  5219. <summary>
  5220. reserved for local use
  5221. </summary>
  5222. </member>
  5223. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4">
  5224. <summary>
  5225. reserved for local use
  5226. </summary>
  5227. </member>
  5228. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5">
  5229. <summary>
  5230. reserved for local use
  5231. </summary>
  5232. </member>
  5233. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6">
  5234. <summary>
  5235. reserved for local use
  5236. </summary>
  5237. </member>
  5238. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7">
  5239. <summary>
  5240. reserved for local use
  5241. </summary>
  5242. </member>
  5243. <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity">
  5244. <summary>
  5245. A class to act as a mapping between the level that a logging call is made at and
  5246. the syslog severity that is should be logged at.
  5247. </summary>
  5248. <remarks>
  5249. <para>
  5250. A class to act as a mapping between the level that a logging call is made at and
  5251. the syslog severity that is should be logged at.
  5252. </para>
  5253. </remarks>
  5254. </member>
  5255. <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity">
  5256. <summary>
  5257. The mapped syslog severity for the specified level
  5258. </summary>
  5259. <remarks>
  5260. <para>
  5261. Required property.
  5262. The mapped syslog severity for the specified level
  5263. </para>
  5264. </remarks>
  5265. </member>
  5266. <member name="T:log4net.Appender.ManagedColoredConsoleAppender">
  5267. <summary>
  5268. Appends colorful logging events to the console, using the .NET 2
  5269. built-in capabilities.
  5270. </summary>
  5271. <remarks>
  5272. <para>
  5273. ManagedColoredConsoleAppender appends log events to the standard output stream
  5274. or the error output stream using a layout specified by the
  5275. user. It also allows the color of a specific type of message to be set.
  5276. </para>
  5277. <para>
  5278. By default, all output is written to the console's standard output stream.
  5279. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> property can be set to direct the output to the
  5280. error stream.
  5281. </para>
  5282. <para>
  5283. When configuring the colored console appender, mappings should be
  5284. specified to map logging levels to colors. For example:
  5285. </para>
  5286. <code lang="XML" escaped="true">
  5287. <mapping>
  5288. <level value="ERROR"/>
  5289. <foreColor value="DarkRed"/>
  5290. <backColor value="White"/>
  5291. </mapping>
  5292. <mapping>
  5293. <level value="WARN"/>
  5294. <foreColor value="Yellow"/>
  5295. </mapping>
  5296. <mapping>
  5297. <level value="INFO"/>
  5298. <foreColor value="White"/>
  5299. </mapping>
  5300. <mapping>
  5301. <level value="DEBUG"/>
  5302. <foreColor value="Blue"/>
  5303. </mapping>
  5304. </code>
  5305. <para>
  5306. The Level is the standard log4net logging level while
  5307. ForeColor and BackColor are the values of <see cref="T:System.ConsoleColor"/>
  5308. enumeration.
  5309. </para>
  5310. <para>
  5311. Based on the ColoredConsoleAppender
  5312. </para>
  5313. </remarks>
  5314. <author>Rick Hobbs</author>
  5315. <author>Nicko Cadell</author>
  5316. <author>Pavlos Touboulidis</author>
  5317. </member>
  5318. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleOut">
  5319. <summary>
  5320. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  5321. standard output stream.
  5322. </summary>
  5323. <remarks>
  5324. <para>
  5325. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  5326. standard output stream.
  5327. </para>
  5328. </remarks>
  5329. </member>
  5330. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleError">
  5331. <summary>
  5332. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  5333. standard error output stream.
  5334. </summary>
  5335. <remarks>
  5336. <para>
  5337. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  5338. standard error output stream.
  5339. </para>
  5340. </remarks>
  5341. </member>
  5342. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.#ctor">
  5343. <summary>
  5344. Initializes a new instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender"/> class.
  5345. </summary>
  5346. <remarks>
  5347. The instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender"/> class is set up to write
  5348. to the standard output stream.
  5349. </remarks>
  5350. </member>
  5351. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.AddMapping(log4net.Appender.ManagedColoredConsoleAppender.LevelColors)">
  5352. <summary>
  5353. Add a mapping of level to color - done by the config file
  5354. </summary>
  5355. <param name="mapping">The mapping to add</param>
  5356. <remarks>
  5357. <para>
  5358. Add a <see cref="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors"/> mapping to this appender.
  5359. Each mapping defines the foreground and background colors
  5360. for a level.
  5361. </para>
  5362. </remarks>
  5363. </member>
  5364. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  5365. <summary>
  5366. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  5367. </summary>
  5368. <param name="loggingEvent">The event to log.</param>
  5369. <remarks>
  5370. <para>
  5371. Writes the event to the console.
  5372. </para>
  5373. <para>
  5374. The format of the output will depend on the appender's layout.
  5375. </para>
  5376. </remarks>
  5377. </member>
  5378. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.ActivateOptions">
  5379. <summary>
  5380. Initialize the options for this appender
  5381. </summary>
  5382. <remarks>
  5383. <para>
  5384. Initialize the level to color mappings set on this appender.
  5385. </para>
  5386. </remarks>
  5387. </member>
  5388. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_writeToErrorStream">
  5389. <summary>
  5390. Flag to write output to the error stream rather than the standard output stream
  5391. </summary>
  5392. </member>
  5393. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_levelMapping">
  5394. <summary>
  5395. Mapping from level object to color value
  5396. </summary>
  5397. </member>
  5398. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.Target">
  5399. <summary>
  5400. Target is the value of the console output stream.
  5401. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  5402. </summary>
  5403. <value>
  5404. Target is the value of the console output stream.
  5405. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  5406. </value>
  5407. <remarks>
  5408. <para>
  5409. Target is the value of the console output stream.
  5410. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  5411. </para>
  5412. </remarks>
  5413. </member>
  5414. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.RequiresLayout">
  5415. <summary>
  5416. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5417. </summary>
  5418. <value><c>true</c></value>
  5419. <remarks>
  5420. <para>
  5421. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5422. </para>
  5423. </remarks>
  5424. </member>
  5425. <member name="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors">
  5426. <summary>
  5427. A class to act as a mapping between the level that a logging call is made at and
  5428. the color it should be displayed as.
  5429. </summary>
  5430. <remarks>
  5431. <para>
  5432. Defines the mapping between a level and the color it should be displayed in.
  5433. </para>
  5434. </remarks>
  5435. </member>
  5436. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.ForeColor">
  5437. <summary>
  5438. The mapped foreground color for the specified level
  5439. </summary>
  5440. <remarks>
  5441. <para>
  5442. Required property.
  5443. The mapped foreground color for the specified level.
  5444. </para>
  5445. </remarks>
  5446. </member>
  5447. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.BackColor">
  5448. <summary>
  5449. The mapped background color for the specified level
  5450. </summary>
  5451. <remarks>
  5452. <para>
  5453. Required property.
  5454. The mapped background color for the specified level.
  5455. </para>
  5456. </remarks>
  5457. </member>
  5458. <member name="T:log4net.Appender.MemoryAppender">
  5459. <summary>
  5460. Stores logging events in an array.
  5461. </summary>
  5462. <remarks>
  5463. <para>
  5464. The memory appender stores all the logging events
  5465. that are appended in an in-memory array.
  5466. </para>
  5467. <para>
  5468. Use the <see cref="M:PopAllEvents()"/> method to get
  5469. and clear the current list of events that have been appended.
  5470. </para>
  5471. <para>
  5472. Use the <see cref="M:GetEvents()"/> method to get the current
  5473. list of events that have been appended. Note there is a
  5474. race-condition when calling <see cref="M:GetEvents()"/> and
  5475. <see cref="M:Clear()"/> in pairs, you better use <see
  5476. mref="M:PopAllEvents()"/> in that case.
  5477. </para>
  5478. <para>
  5479. Use the <see cref="M:Clear()"/> method to clear the
  5480. current list of events. Note there is a
  5481. race-condition when calling <see cref="M:GetEvents()"/> and
  5482. <see cref="M:Clear()"/> in pairs, you better use <see
  5483. mref="M:PopAllEvents()"/> in that case.
  5484. </para>
  5485. </remarks>
  5486. <author>Julian Biddle</author>
  5487. <author>Nicko Cadell</author>
  5488. <author>Gert Driesen</author>
  5489. </member>
  5490. <member name="M:log4net.Appender.MemoryAppender.#ctor">
  5491. <summary>
  5492. Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender"/> class.
  5493. </summary>
  5494. <remarks>
  5495. <para>
  5496. Default constructor.
  5497. </para>
  5498. </remarks>
  5499. </member>
  5500. <member name="M:log4net.Appender.MemoryAppender.GetEvents">
  5501. <summary>
  5502. Gets the events that have been logged.
  5503. </summary>
  5504. <returns>The events that have been logged</returns>
  5505. <remarks>
  5506. <para>
  5507. Gets the events that have been logged.
  5508. </para>
  5509. </remarks>
  5510. </member>
  5511. <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)">
  5512. <summary>
  5513. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5514. </summary>
  5515. <param name="loggingEvent">the event to log</param>
  5516. <remarks>
  5517. <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
  5518. </remarks>
  5519. </member>
  5520. <member name="M:log4net.Appender.MemoryAppender.Clear">
  5521. <summary>
  5522. Clear the list of events
  5523. </summary>
  5524. <remarks>
  5525. Clear the list of events
  5526. </remarks>
  5527. </member>
  5528. <member name="M:log4net.Appender.MemoryAppender.PopAllEvents">
  5529. <summary>
  5530. Gets the events that have been logged and clears the list of events.
  5531. </summary>
  5532. <returns>The events that have been logged</returns>
  5533. <remarks>
  5534. <para>
  5535. Gets the events that have been logged and clears the list of events.
  5536. </para>
  5537. </remarks>
  5538. </member>
  5539. <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
  5540. <summary>
  5541. The list of events that have been appended.
  5542. </summary>
  5543. </member>
  5544. <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
  5545. <summary>
  5546. Value indicating which fields in the event should be fixed
  5547. </summary>
  5548. <remarks>
  5549. By default all fields are fixed
  5550. </remarks>
  5551. </member>
  5552. <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
  5553. <summary>
  5554. Gets or sets a value indicating whether only part of the logging event
  5555. data should be fixed.
  5556. </summary>
  5557. <value>
  5558. <c>true</c> if the appender should only fix part of the logging event
  5559. data, otherwise <c>false</c>. The default is <c>false</c>.
  5560. </value>
  5561. <remarks>
  5562. <para>
  5563. Setting this property to <c>true</c> will cause only part of the event
  5564. data to be fixed and stored in the appender, hereby improving performance.
  5565. </para>
  5566. <para>
  5567. See <see cref="M:LoggingEvent.FixVolatileData(bool)"/> for more information.
  5568. </para>
  5569. </remarks>
  5570. </member>
  5571. <member name="P:log4net.Appender.MemoryAppender.Fix">
  5572. <summary>
  5573. Gets or sets the fields that will be fixed in the event
  5574. </summary>
  5575. <remarks>
  5576. <para>
  5577. The logging event needs to have certain thread specific values
  5578. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  5579. for details.
  5580. </para>
  5581. </remarks>
  5582. </member>
  5583. <member name="T:log4net.Appender.NetSendAppender">
  5584. <summary>
  5585. Logs entries by sending network messages using the
  5586. <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/> native function.
  5587. </summary>
  5588. <remarks>
  5589. <para>
  5590. You can send messages only to names that are active
  5591. on the network. If you send the message to a user name,
  5592. that user must be logged on and running the Messenger
  5593. service to receive the message.
  5594. </para>
  5595. <para>
  5596. The receiver will get a top most window displaying the
  5597. messages one at a time, therefore this appender should
  5598. not be used to deliver a high volume of messages.
  5599. </para>
  5600. <para>
  5601. The following table lists some possible uses for this appender :
  5602. </para>
  5603. <para>
  5604. <list type="table">
  5605. <listheader>
  5606. <term>Action</term>
  5607. <description>Property Value(s)</description>
  5608. </listheader>
  5609. <item>
  5610. <term>Send a message to a user account on the local machine</term>
  5611. <description>
  5612. <para>
  5613. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine&gt;
  5614. </para>
  5615. <para>
  5616. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5617. </para>
  5618. </description>
  5619. </item>
  5620. <item>
  5621. <term>Send a message to a user account on a remote machine</term>
  5622. <description>
  5623. <para>
  5624. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the remote machine&gt;
  5625. </para>
  5626. <para>
  5627. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5628. </para>
  5629. </description>
  5630. </item>
  5631. <item>
  5632. <term>Send a message to a domain user account</term>
  5633. <description>
  5634. <para>
  5635. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of a domain controller | uninitialized&gt;
  5636. </para>
  5637. <para>
  5638. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5639. </para>
  5640. </description>
  5641. </item>
  5642. <item>
  5643. <term>Send a message to all the names in a workgroup or domain</term>
  5644. <description>
  5645. <para>
  5646. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;workgroup name | domain name&gt;*
  5647. </para>
  5648. </description>
  5649. </item>
  5650. <item>
  5651. <term>Send a message from the local machine to a remote machine</term>
  5652. <description>
  5653. <para>
  5654. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine | uninitialized&gt;
  5655. </para>
  5656. <para>
  5657. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;name of the remote machine&gt;
  5658. </para>
  5659. </description>
  5660. </item>
  5661. </list>
  5662. </para>
  5663. <para>
  5664. <b>Note :</b> security restrictions apply for sending
  5665. network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/>
  5666. for more information.
  5667. </para>
  5668. </remarks>
  5669. <example>
  5670. <para>
  5671. An example configuration section to log information
  5672. using this appender from the local machine, named
  5673. LOCAL_PC, to machine OPERATOR_PC :
  5674. </para>
  5675. <code lang="XML" escaped="true">
  5676. <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
  5677. <server value="LOCAL_PC"/>
  5678. <recipient value="OPERATOR_PC"/>
  5679. <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n"/>
  5680. </appender>
  5681. </code>
  5682. </example>
  5683. <author>Nicko Cadell</author>
  5684. <author>Gert Driesen</author>
  5685. </member>
  5686. <member name="F:log4net.Appender.NetSendAppender.m_server">
  5687. <summary>
  5688. The DNS or NetBIOS name of the server on which the function is to execute.
  5689. </summary>
  5690. </member>
  5691. <member name="F:log4net.Appender.NetSendAppender.m_sender">
  5692. <summary>
  5693. The sender of the network message.
  5694. </summary>
  5695. </member>
  5696. <member name="F:log4net.Appender.NetSendAppender.m_recipient">
  5697. <summary>
  5698. The message alias to which the message should be sent.
  5699. </summary>
  5700. </member>
  5701. <member name="F:log4net.Appender.NetSendAppender.m_securityContext">
  5702. <summary>
  5703. The security context to use for privileged calls
  5704. </summary>
  5705. </member>
  5706. <member name="M:log4net.Appender.NetSendAppender.#ctor">
  5707. <summary>
  5708. Initializes the appender.
  5709. </summary>
  5710. <remarks>
  5711. The default constructor initializes all fields to their default values.
  5712. </remarks>
  5713. </member>
  5714. <member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
  5715. <summary>
  5716. Initialize the appender based on the options set.
  5717. </summary>
  5718. <remarks>
  5719. <para>
  5720. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5721. activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
  5722. be called on this object after the configuration properties have
  5723. been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
  5724. object is in an undefined state and must not be used.
  5725. </para>
  5726. <para>
  5727. If any of the configuration properties are modified then
  5728. <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
  5729. </para>
  5730. <para>
  5731. The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was specified.
  5732. </para>
  5733. </remarks>
  5734. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was not specified.</exception>
  5735. </member>
  5736. <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
  5737. <summary>
  5738. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5739. </summary>
  5740. <param name="loggingEvent">The event to log.</param>
  5741. <remarks>
  5742. <para>
  5743. Sends the event using a network message.
  5744. </para>
  5745. </remarks>
  5746. </member>
  5747. <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
  5748. <summary>
  5749. Sends a buffer of information to a registered message alias.
  5750. </summary>
  5751. <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
  5752. <param name="msgName">The message alias to which the message buffer should be sent</param>
  5753. <param name="fromName">The originator of the message.</param>
  5754. <param name="buffer">The message text.</param>
  5755. <param name="bufferSize">The length, in bytes, of the message text.</param>
  5756. <remarks>
  5757. <para>
  5758. The following restrictions apply for sending network messages:
  5759. </para>
  5760. <para>
  5761. <list type="table">
  5762. <listheader>
  5763. <term>Platform</term>
  5764. <description>Requirements</description>
  5765. </listheader>
  5766. <item>
  5767. <term>Windows NT</term>
  5768. <description>
  5769. <para>
  5770. No special group membership is required to send a network message.
  5771. </para>
  5772. <para>
  5773. Admin, Accounts, Print, or Server Operator group membership is required to
  5774. successfully send a network message on a remote server.
  5775. </para>
  5776. </description>
  5777. </item>
  5778. <item>
  5779. <term>Windows 2000 or later</term>
  5780. <description>
  5781. <para>
  5782. If you send a message on a domain controller that is running Active Directory,
  5783. access is allowed or denied based on the access control list (ACL) for the securable
  5784. object. The default ACL permits only Domain Admins and Account Operators to send a network message.
  5785. </para>
  5786. <para>
  5787. On a member server or workstation, only Administrators and Server Operators can send a network message.
  5788. </para>
  5789. </description>
  5790. </item>
  5791. </list>
  5792. </para>
  5793. <para>
  5794. 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>.
  5795. </para>
  5796. </remarks>
  5797. <returns>
  5798. <para>
  5799. If the function succeeds, the return value is zero.
  5800. </para>
  5801. </returns>
  5802. </member>
  5803. <member name="P:log4net.Appender.NetSendAppender.Sender">
  5804. <summary>
  5805. Gets or sets the sender of the message.
  5806. </summary>
  5807. <value>
  5808. The sender of the message.
  5809. </value>
  5810. <remarks>
  5811. If this property is not specified, the message is sent from the local computer.
  5812. </remarks>
  5813. </member>
  5814. <member name="P:log4net.Appender.NetSendAppender.Recipient">
  5815. <summary>
  5816. Gets or sets the message alias to which the message should be sent.
  5817. </summary>
  5818. <value>
  5819. The recipient of the message.
  5820. </value>
  5821. <remarks>
  5822. This property should always be specified in order to send a message.
  5823. </remarks>
  5824. </member>
  5825. <member name="P:log4net.Appender.NetSendAppender.Server">
  5826. <summary>
  5827. Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
  5828. </summary>
  5829. <value>
  5830. DNS or NetBIOS name of the remote server on which the function is to execute.
  5831. </value>
  5832. <remarks>
  5833. <para>
  5834. For Windows NT 4.0 and earlier, the string should begin with \\.
  5835. </para>
  5836. <para>
  5837. If this property is not specified, the local computer is used.
  5838. </para>
  5839. </remarks>
  5840. </member>
  5841. <member name="P:log4net.Appender.NetSendAppender.SecurityContext">
  5842. <summary>
  5843. Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5844. </summary>
  5845. <value>
  5846. The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5847. </value>
  5848. <remarks>
  5849. <para>
  5850. Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
  5851. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  5852. security context to use. The default behavior is to use the security context
  5853. of the current thread.
  5854. </para>
  5855. </remarks>
  5856. </member>
  5857. <member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
  5858. <summary>
  5859. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5860. </summary>
  5861. <value><c>true</c></value>
  5862. <remarks>
  5863. <para>
  5864. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5865. </para>
  5866. </remarks>
  5867. </member>
  5868. <member name="T:log4net.Appender.OutputDebugStringAppender">
  5869. <summary>
  5870. Appends log events to the OutputDebugString system.
  5871. </summary>
  5872. <remarks>
  5873. <para>
  5874. OutputDebugStringAppender appends log events to the
  5875. OutputDebugString system.
  5876. </para>
  5877. <para>
  5878. The string is passed to the native <c>OutputDebugString</c>
  5879. function.
  5880. </para>
  5881. </remarks>
  5882. <author>Nicko Cadell</author>
  5883. <author>Gert Driesen</author>
  5884. </member>
  5885. <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
  5886. <summary>
  5887. Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender"/> class.
  5888. </summary>
  5889. <remarks>
  5890. <para>
  5891. Default constructor.
  5892. </para>
  5893. </remarks>
  5894. </member>
  5895. <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
  5896. <summary>
  5897. Write the logging event to the output debug string API
  5898. </summary>
  5899. <param name="loggingEvent">the event to log</param>
  5900. <remarks>
  5901. <para>
  5902. Write the logging event to the output debug string API
  5903. </para>
  5904. </remarks>
  5905. </member>
  5906. <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
  5907. <summary>
  5908. Stub for OutputDebugString native method
  5909. </summary>
  5910. <param name="message">the string to output</param>
  5911. <remarks>
  5912. <para>
  5913. Stub for OutputDebugString native method
  5914. </para>
  5915. </remarks>
  5916. </member>
  5917. <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
  5918. <summary>
  5919. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5920. </summary>
  5921. <value><c>true</c></value>
  5922. <remarks>
  5923. <para>
  5924. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5925. </para>
  5926. </remarks>
  5927. </member>
  5928. <member name="T:log4net.Appender.RemoteSyslogAppender">
  5929. <summary>
  5930. Logs events to a remote syslog daemon.
  5931. </summary>
  5932. <remarks>
  5933. <para>
  5934. The BSD syslog protocol is used to remotely log to
  5935. a syslog daemon. The syslogd listens for for messages
  5936. on UDP port 514.
  5937. </para>
  5938. <para>
  5939. The syslog UDP protocol is not authenticated. Most syslog daemons
  5940. do not accept remote log messages because of the security implications.
  5941. You may be able to use the LocalSyslogAppender to talk to a local
  5942. syslog service.
  5943. </para>
  5944. <para>
  5945. There is an RFC 3164 that claims to document the BSD Syslog Protocol.
  5946. This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html.
  5947. This appender generates what the RFC calls an "Original Device Message",
  5948. i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation
  5949. this format of message will be accepted by all current syslog daemon
  5950. implementations. The daemon will attach the current time and the source
  5951. hostname or IP address to any messages received.
  5952. </para>
  5953. <para>
  5954. Syslog messages must have a facility and and a severity. The severity
  5955. is derived from the Level of the logging event.
  5956. The facility must be chosen from the set of defined syslog
  5957. <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  5958. and cannot be extended.
  5959. </para>
  5960. <para>
  5961. An identifier is specified with each log message. This can be specified
  5962. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  5963. as the tag) must not contain white space. The default value for the
  5964. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  5965. </para>
  5966. </remarks>
  5967. <author>Rob Lyon</author>
  5968. <author>Nicko Cadell</author>
  5969. </member>
  5970. <member name="T:log4net.Appender.UdpAppender">
  5971. <summary>
  5972. Sends logging events as connectionless UDP datagrams to a remote host or a
  5973. multicast group using an <see cref="T:System.Net.Sockets.UdpClient"/>.
  5974. </summary>
  5975. <remarks>
  5976. <para>
  5977. UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
  5978. </para>
  5979. <para>
  5980. To view the logging results, a custom application can be developed that listens for logging
  5981. events.
  5982. </para>
  5983. <para>
  5984. When decoding events send via this appender remember to use the same encoding
  5985. to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
  5986. property to specify the encoding to use.
  5987. </para>
  5988. </remarks>
  5989. <example>
  5990. This example shows how to log receive logging events that are sent
  5991. on IP address 244.0.0.1 and port 8080 to the console. The event is
  5992. encoded in the packet as a unicode string and it is decoded as such.
  5993. <code lang="C#">
  5994. IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
  5995. UdpClient udpClient;
  5996. byte[] buffer;
  5997. string loggingEvent;
  5998. try
  5999. {
  6000. udpClient = new UdpClient(8080);
  6001. while(true)
  6002. {
  6003. buffer = udpClient.Receive(ref remoteEndPoint);
  6004. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
  6005. Console.WriteLine(loggingEvent);
  6006. }
  6007. }
  6008. catch(Exception e)
  6009. {
  6010. Console.WriteLine(e.ToString());
  6011. }
  6012. </code>
  6013. <code lang="Visual Basic">
  6014. Dim remoteEndPoint as IPEndPoint
  6015. Dim udpClient as UdpClient
  6016. Dim buffer as Byte()
  6017. Dim loggingEvent as String
  6018. Try
  6019. remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
  6020. udpClient = new UdpClient(8080)
  6021. While True
  6022. buffer = udpClient.Receive(ByRef remoteEndPoint)
  6023. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
  6024. Console.WriteLine(loggingEvent)
  6025. Wend
  6026. Catch e As Exception
  6027. Console.WriteLine(e.ToString())
  6028. End Try
  6029. </code>
  6030. <para>
  6031. An example configuration section to log information using this appender to the
  6032. IP 224.0.0.1 on port 8080:
  6033. </para>
  6034. <code lang="XML" escaped="true">
  6035. <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
  6036. <remoteAddress value="224.0.0.1"/>
  6037. <remotePort value="8080"/>
  6038. <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline"/>
  6039. </appender>
  6040. </code>
  6041. </example>
  6042. <author>Gert Driesen</author>
  6043. <author>Nicko Cadell</author>
  6044. </member>
  6045. <member name="M:log4net.Appender.UdpAppender.#ctor">
  6046. <summary>
  6047. Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender"/> class.
  6048. </summary>
  6049. <remarks>
  6050. The default constructor initializes all fields to their default values.
  6051. </remarks>
  6052. </member>
  6053. <member name="M:log4net.Appender.UdpAppender.ActivateOptions">
  6054. <summary>
  6055. Initialize the appender based on the options set.
  6056. </summary>
  6057. <remarks>
  6058. <para>
  6059. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6060. activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must
  6061. be called on this object after the configuration properties have
  6062. been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this
  6063. object is in an undefined state and must not be used.
  6064. </para>
  6065. <para>
  6066. If any of the configuration properties are modified then
  6067. <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again.
  6068. </para>
  6069. <para>
  6070. The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was specified or
  6071. an invalid remote or local TCP port number was specified.
  6072. </para>
  6073. </remarks>
  6074. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was not specified.</exception>
  6075. <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>
  6076. </member>
  6077. <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)">
  6078. <summary>
  6079. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  6080. </summary>
  6081. <param name="loggingEvent">The event to log.</param>
  6082. <remarks>
  6083. <para>
  6084. Sends the event using an UDP datagram.
  6085. </para>
  6086. <para>
  6087. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  6088. </para>
  6089. </remarks>
  6090. </member>
  6091. <member name="M:log4net.Appender.UdpAppender.OnClose">
  6092. <summary>
  6093. Closes the UDP connection and releases all resources associated with
  6094. this <see cref="T:log4net.Appender.UdpAppender"/> instance.
  6095. </summary>
  6096. <remarks>
  6097. <para>
  6098. Disables the underlying <see cref="T:System.Net.Sockets.UdpClient"/> and releases all managed
  6099. and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender"/>.
  6100. </para>
  6101. </remarks>
  6102. </member>
  6103. <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection">
  6104. <summary>
  6105. Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient"/> connection.
  6106. </summary>
  6107. <remarks>
  6108. <para>
  6109. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the
  6110. port number from which you intend to communicate.
  6111. </para>
  6112. <para>
  6113. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  6114. </para>
  6115. </remarks>
  6116. </member>
  6117. <member name="F:log4net.Appender.UdpAppender.m_remoteAddress">
  6118. <summary>
  6119. The IP address of the remote host or multicast group to which
  6120. the logging event will be sent.
  6121. </summary>
  6122. </member>
  6123. <member name="F:log4net.Appender.UdpAppender.m_remotePort">
  6124. <summary>
  6125. The TCP port number of the remote host or multicast group to
  6126. which the logging event will be sent.
  6127. </summary>
  6128. </member>
  6129. <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint">
  6130. <summary>
  6131. The cached remote endpoint to which the logging events will be sent.
  6132. </summary>
  6133. </member>
  6134. <member name="F:log4net.Appender.UdpAppender.m_localPort">
  6135. <summary>
  6136. The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  6137. </summary>
  6138. </member>
  6139. <member name="F:log4net.Appender.UdpAppender.m_client">
  6140. <summary>
  6141. The <see cref="T:System.Net.Sockets.UdpClient"/> instance that will be used for sending the
  6142. logging events.
  6143. </summary>
  6144. </member>
  6145. <member name="F:log4net.Appender.UdpAppender.m_encoding">
  6146. <summary>
  6147. The encoding to use for the packet.
  6148. </summary>
  6149. </member>
  6150. <member name="P:log4net.Appender.UdpAppender.RemoteAddress">
  6151. <summary>
  6152. Gets or sets the IP address of the remote host or multicast group to which
  6153. the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
  6154. </summary>
  6155. <value>
  6156. The IP address of the remote host or multicast group to which the logging event
  6157. will be sent.
  6158. </value>
  6159. <remarks>
  6160. <para>
  6161. Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to
  6162. 239.255.255.255). Multicast packets can pass across different networks through routers, so
  6163. it is possible to use multicasts in an Internet scenario as long as your network provider
  6164. supports multicasting.
  6165. </para>
  6166. <para>
  6167. Hosts that want to receive particular multicast messages must register their interest by joining
  6168. the multicast group. Multicast messages are not sent to networks where no host has joined
  6169. the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate
  6170. them from normal host addresses, allowing nodes to easily detect if a message is of interest.
  6171. </para>
  6172. <para>
  6173. Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below:
  6174. </para>
  6175. <para>
  6176. <list type="table">
  6177. <listheader>
  6178. <term>IP Address</term>
  6179. <description>Description</description>
  6180. </listheader>
  6181. <item>
  6182. <term>224.0.0.1</term>
  6183. <description>
  6184. <para>
  6185. Sends a message to all system on the subnet.
  6186. </para>
  6187. </description>
  6188. </item>
  6189. <item>
  6190. <term>224.0.0.2</term>
  6191. <description>
  6192. <para>
  6193. Sends a message to all routers on the subnet.
  6194. </para>
  6195. </description>
  6196. </item>
  6197. <item>
  6198. <term>224.0.0.12</term>
  6199. <description>
  6200. <para>
  6201. The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet.
  6202. </para>
  6203. </description>
  6204. </item>
  6205. </list>
  6206. </para>
  6207. <para>
  6208. A complete list of actually reserved multicast addresses and their owners in the ranges
  6209. defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>.
  6210. </para>
  6211. <para>
  6212. The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative
  6213. addresses. These addresses can be reused with other local groups. Routers are typically
  6214. configured with filters to prevent multicast traffic in this range from flowing outside
  6215. of the local network.
  6216. </para>
  6217. </remarks>
  6218. </member>
  6219. <member name="P:log4net.Appender.UdpAppender.RemotePort">
  6220. <summary>
  6221. Gets or sets the TCP port number of the remote host or multicast group to which
  6222. the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
  6223. </summary>
  6224. <value>
  6225. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  6226. indicating the TCP port number of the remote host or multicast group to which the logging event
  6227. will be sent.
  6228. </value>
  6229. <remarks>
  6230. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will send messages to this TCP port number
  6231. on the remote host or multicast group.
  6232. </remarks>
  6233. <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>
  6234. </member>
  6235. <member name="P:log4net.Appender.UdpAppender.LocalPort">
  6236. <summary>
  6237. Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  6238. </summary>
  6239. <value>
  6240. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  6241. indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  6242. </value>
  6243. <remarks>
  6244. <para>
  6245. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will bind to this port for sending messages.
  6246. </para>
  6247. <para>
  6248. Setting the value to 0 (the default) will cause the udp client not to bind to
  6249. a local port.
  6250. </para>
  6251. </remarks>
  6252. <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>
  6253. </member>
  6254. <member name="P:log4net.Appender.UdpAppender.Encoding">
  6255. <summary>
  6256. Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6257. </summary>
  6258. <value>
  6259. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6260. </value>
  6261. <remarks>
  6262. <para>
  6263. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6264. </para>
  6265. </remarks>
  6266. </member>
  6267. <member name="P:log4net.Appender.UdpAppender.Client">
  6268. <summary>
  6269. Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
  6270. </summary>
  6271. <value>
  6272. The underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
  6273. </value>
  6274. <remarks>
  6275. <see cref="T:log4net.Appender.UdpAppender"/> creates a <see cref="T:System.Net.Sockets.UdpClient"/> to send logging events
  6276. over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender"/> can use this
  6277. property to get or set this <see cref="T:System.Net.Sockets.UdpClient"/>. Use the underlying <see cref="T:System.Net.Sockets.UdpClient"/>
  6278. returned from <see cref="P:log4net.Appender.UdpAppender.Client"/> if you require access beyond that which
  6279. <see cref="T:log4net.Appender.UdpAppender"/> provides.
  6280. </remarks>
  6281. </member>
  6282. <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint">
  6283. <summary>
  6284. Gets or sets the cached remote endpoint to which the logging events should be sent.
  6285. </summary>
  6286. <value>
  6287. The cached remote endpoint to which the logging events will be sent.
  6288. </value>
  6289. <remarks>
  6290. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method will initialize the remote endpoint
  6291. with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/>
  6292. properties.
  6293. </remarks>
  6294. </member>
  6295. <member name="P:log4net.Appender.UdpAppender.RequiresLayout">
  6296. <summary>
  6297. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6298. </summary>
  6299. <value><c>true</c></value>
  6300. <remarks>
  6301. <para>
  6302. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6303. </para>
  6304. </remarks>
  6305. </member>
  6306. <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort">
  6307. <summary>
  6308. Syslog port 514
  6309. </summary>
  6310. </member>
  6311. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferSize">
  6312. <summary>
  6313. Initial buffer size
  6314. </summary>
  6315. </member>
  6316. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferMaxCapacity">
  6317. <summary>
  6318. Maximum buffer size before it is recycled
  6319. </summary>
  6320. </member>
  6321. <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor">
  6322. <summary>
  6323. Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class.
  6324. </summary>
  6325. <remarks>
  6326. This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class is set up to write
  6327. to a remote syslog daemon.
  6328. </remarks>
  6329. </member>
  6330. <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)">
  6331. <summary>
  6332. Add a mapping of level to severity
  6333. </summary>
  6334. <param name="mapping">The mapping to add</param>
  6335. <remarks>
  6336. <para>
  6337. Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender.
  6338. </para>
  6339. </remarks>
  6340. </member>
  6341. <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)">
  6342. <summary>
  6343. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  6344. </summary>
  6345. <param name="loggingEvent">The event to log.</param>
  6346. <remarks>
  6347. <para>
  6348. Writes the event to a remote syslog daemon.
  6349. </para>
  6350. <para>
  6351. The format of the output will depend on the appender's layout.
  6352. </para>
  6353. </remarks>
  6354. </member>
  6355. <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions">
  6356. <summary>
  6357. Initialize the options for this appender
  6358. </summary>
  6359. <remarks>
  6360. <para>
  6361. Initialize the level to syslog severity mappings set on this appender.
  6362. </para>
  6363. </remarks>
  6364. </member>
  6365. <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)">
  6366. <summary>
  6367. Translates a log4net level to a syslog severity.
  6368. </summary>
  6369. <param name="level">A log4net level.</param>
  6370. <returns>A syslog severity.</returns>
  6371. <remarks>
  6372. <para>
  6373. Translates a log4net level to a syslog severity.
  6374. </para>
  6375. </remarks>
  6376. </member>
  6377. <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)">
  6378. <summary>
  6379. Generate a syslog priority.
  6380. </summary>
  6381. <param name="facility">The syslog facility.</param>
  6382. <param name="severity">The syslog severity.</param>
  6383. <returns>A syslog priority.</returns>
  6384. <remarks>
  6385. <para>
  6386. Generate a syslog priority.
  6387. </para>
  6388. </remarks>
  6389. </member>
  6390. <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility">
  6391. <summary>
  6392. The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  6393. </summary>
  6394. </member>
  6395. <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity">
  6396. <summary>
  6397. The message identity
  6398. </summary>
  6399. </member>
  6400. <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping">
  6401. <summary>
  6402. Mapping from level object to syslog severity
  6403. </summary>
  6404. </member>
  6405. <member name="P:log4net.Appender.RemoteSyslogAppender.Identity">
  6406. <summary>
  6407. Message identity
  6408. </summary>
  6409. <remarks>
  6410. <para>
  6411. An identifier is specified with each log message. This can be specified
  6412. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  6413. as the tag) must not contain white space. The default value for the
  6414. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  6415. </para>
  6416. </remarks>
  6417. </member>
  6418. <member name="P:log4net.Appender.RemoteSyslogAppender.Facility">
  6419. <summary>
  6420. Syslog facility
  6421. </summary>
  6422. <remarks>
  6423. Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of
  6424. facilities is predefined and cannot be extended. The default value
  6425. is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  6426. </remarks>
  6427. </member>
  6428. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity">
  6429. <summary>
  6430. syslog severities
  6431. </summary>
  6432. <remarks>
  6433. <para>
  6434. The syslog severities.
  6435. </para>
  6436. </remarks>
  6437. </member>
  6438. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency">
  6439. <summary>
  6440. system is unusable
  6441. </summary>
  6442. </member>
  6443. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert">
  6444. <summary>
  6445. action must be taken immediately
  6446. </summary>
  6447. </member>
  6448. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical">
  6449. <summary>
  6450. critical conditions
  6451. </summary>
  6452. </member>
  6453. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error">
  6454. <summary>
  6455. error conditions
  6456. </summary>
  6457. </member>
  6458. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning">
  6459. <summary>
  6460. warning conditions
  6461. </summary>
  6462. </member>
  6463. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice">
  6464. <summary>
  6465. normal but significant condition
  6466. </summary>
  6467. </member>
  6468. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational">
  6469. <summary>
  6470. informational
  6471. </summary>
  6472. </member>
  6473. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug">
  6474. <summary>
  6475. debug-level messages
  6476. </summary>
  6477. </member>
  6478. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility">
  6479. <summary>
  6480. syslog facilities
  6481. </summary>
  6482. <remarks>
  6483. <para>
  6484. The syslog facilities
  6485. </para>
  6486. </remarks>
  6487. </member>
  6488. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel">
  6489. <summary>
  6490. kernel messages
  6491. </summary>
  6492. </member>
  6493. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User">
  6494. <summary>
  6495. random user-level messages
  6496. </summary>
  6497. </member>
  6498. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail">
  6499. <summary>
  6500. mail system
  6501. </summary>
  6502. </member>
  6503. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons">
  6504. <summary>
  6505. system daemons
  6506. </summary>
  6507. </member>
  6508. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization">
  6509. <summary>
  6510. security/authorization messages
  6511. </summary>
  6512. </member>
  6513. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog">
  6514. <summary>
  6515. messages generated internally by syslogd
  6516. </summary>
  6517. </member>
  6518. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer">
  6519. <summary>
  6520. line printer subsystem
  6521. </summary>
  6522. </member>
  6523. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News">
  6524. <summary>
  6525. network news subsystem
  6526. </summary>
  6527. </member>
  6528. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp">
  6529. <summary>
  6530. UUCP subsystem
  6531. </summary>
  6532. </member>
  6533. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock">
  6534. <summary>
  6535. clock (cron/at) daemon
  6536. </summary>
  6537. </member>
  6538. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2">
  6539. <summary>
  6540. security/authorization messages (private)
  6541. </summary>
  6542. </member>
  6543. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp">
  6544. <summary>
  6545. ftp daemon
  6546. </summary>
  6547. </member>
  6548. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp">
  6549. <summary>
  6550. NTP subsystem
  6551. </summary>
  6552. </member>
  6553. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit">
  6554. <summary>
  6555. log audit
  6556. </summary>
  6557. </member>
  6558. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert">
  6559. <summary>
  6560. log alert
  6561. </summary>
  6562. </member>
  6563. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2">
  6564. <summary>
  6565. clock daemon
  6566. </summary>
  6567. </member>
  6568. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0">
  6569. <summary>
  6570. reserved for local use
  6571. </summary>
  6572. </member>
  6573. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1">
  6574. <summary>
  6575. reserved for local use
  6576. </summary>
  6577. </member>
  6578. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2">
  6579. <summary>
  6580. reserved for local use
  6581. </summary>
  6582. </member>
  6583. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3">
  6584. <summary>
  6585. reserved for local use
  6586. </summary>
  6587. </member>
  6588. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4">
  6589. <summary>
  6590. reserved for local use
  6591. </summary>
  6592. </member>
  6593. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5">
  6594. <summary>
  6595. reserved for local use
  6596. </summary>
  6597. </member>
  6598. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6">
  6599. <summary>
  6600. reserved for local use
  6601. </summary>
  6602. </member>
  6603. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7">
  6604. <summary>
  6605. reserved for local use
  6606. </summary>
  6607. </member>
  6608. <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity">
  6609. <summary>
  6610. A class to act as a mapping between the level that a logging call is made at and
  6611. the syslog severity that is should be logged at.
  6612. </summary>
  6613. <remarks>
  6614. <para>
  6615. A class to act as a mapping between the level that a logging call is made at and
  6616. the syslog severity that is should be logged at.
  6617. </para>
  6618. </remarks>
  6619. </member>
  6620. <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity">
  6621. <summary>
  6622. The mapped syslog severity for the specified level
  6623. </summary>
  6624. <remarks>
  6625. <para>
  6626. Required property.
  6627. The mapped syslog severity for the specified level
  6628. </para>
  6629. </remarks>
  6630. </member>
  6631. <member name="T:log4net.Appender.RemotingAppender">
  6632. <summary>
  6633. Delivers logging events to a remote logging sink.
  6634. </summary>
  6635. <remarks>
  6636. <para>
  6637. This Appender is designed to deliver events to a remote sink.
  6638. That is any object that implements the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6639. interface. It delivers the events using .NET remoting. The
  6640. object to deliver events to is specified by setting the
  6641. appenders <see cref="P:log4net.Appender.RemotingAppender.Sink"/> property.</para>
  6642. <para>
  6643. The RemotingAppender buffers events before sending them. This allows it to
  6644. make more efficient use of the remoting infrastructure.</para>
  6645. <para>
  6646. Once the buffer is full the events are still not sent immediately.
  6647. They are scheduled to be sent using a pool thread. The effect is that
  6648. the send occurs asynchronously. This is very important for a
  6649. number of non obvious reasons. The remoting infrastructure will
  6650. flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  6651. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  6652. remoting boundary. If the server is not contactable then
  6653. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  6654. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  6655. having side effects on the calling application the remoting call must be made
  6656. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  6657. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  6658. the events will block in the thread pool manager until a thread is available.</para>
  6659. <para>
  6660. Because the events are sent asynchronously using pool threads it is possible to close
  6661. this appender before all the queued events have been sent.
  6662. When closing the appender attempts to wait until all the queued events have been sent, but
  6663. this will timeout after 30 seconds regardless.</para>
  6664. <para>
  6665. If this appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
  6666. event has fired it may not be possible to send all the queued events. During process
  6667. exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
  6668. event handler is allowed to run for. If the runtime terminates the threads before
  6669. the queued events have been sent then they will be lost. To ensure that all events
  6670. are sent the appender must be closed before the application exits. See
  6671. <see cref="M:log4net.Core.LoggerManager.Shutdown"/> for details on how to shutdown
  6672. log4net programmatically.</para>
  6673. </remarks>
  6674. <seealso cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6675. <author>Nicko Cadell</author>
  6676. <author>Gert Driesen</author>
  6677. <author>Daniel Cazzulino</author>
  6678. </member>
  6679. <member name="M:log4net.Appender.RemotingAppender.#ctor">
  6680. <summary>
  6681. Initializes a new instance of the <see cref="T:log4net.Appender.RemotingAppender"/> class.
  6682. </summary>
  6683. <remarks>
  6684. <para>
  6685. Default constructor.
  6686. </para>
  6687. </remarks>
  6688. </member>
  6689. <member name="M:log4net.Appender.RemotingAppender.ActivateOptions">
  6690. <summary>
  6691. Initialize the appender based on the options set
  6692. </summary>
  6693. <remarks>
  6694. <para>
  6695. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6696. activation scheme. The <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> method must
  6697. be called on this object after the configuration properties have
  6698. been set. Until <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> is called this
  6699. object is in an undefined state and must not be used.
  6700. </para>
  6701. <para>
  6702. If any of the configuration properties are modified then
  6703. <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> must be called again.
  6704. </para>
  6705. </remarks>
  6706. </member>
  6707. <member name="M:log4net.Appender.RemotingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  6708. <summary>
  6709. Send the contents of the buffer to the remote sink.
  6710. </summary>
  6711. <remarks>
  6712. The events are not sent immediately. They are scheduled to be sent
  6713. using a pool thread. The effect is that the send occurs asynchronously.
  6714. This is very important for a number of non obvious reasons. The remoting
  6715. infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  6716. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  6717. remoting boundary. If the server is not contactable then
  6718. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  6719. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  6720. having side effects on the calling application the remoting call must be made
  6721. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  6722. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  6723. the events will block in the thread pool manager until a thread is available.
  6724. </remarks>
  6725. <param name="events">The events to send.</param>
  6726. </member>
  6727. <member name="M:log4net.Appender.RemotingAppender.OnClose">
  6728. <summary>
  6729. Override base class close.
  6730. </summary>
  6731. <remarks>
  6732. <para>
  6733. This method waits while there are queued work items. The events are
  6734. sent asynchronously using <see cref="T:System.Threading.ThreadPool"/> work items. These items
  6735. will be sent once a thread pool thread is available to send them, therefore
  6736. it is possible to close the appender before all the queued events have been
  6737. sent.</para>
  6738. <para>
  6739. This method attempts to wait until all the queued events have been sent, but this
  6740. method will timeout after 30 seconds regardless.</para>
  6741. <para>
  6742. If the appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
  6743. event has fired it may not be possible to send all the queued events. During process
  6744. exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
  6745. event handler is allowed to run for.</para>
  6746. </remarks>
  6747. </member>
  6748. <member name="M:log4net.Appender.RemotingAppender.Flush(System.Int32)">
  6749. <summary>
  6750. Flushes any buffered log data.
  6751. </summary>
  6752. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  6753. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  6754. </member>
  6755. <member name="M:log4net.Appender.RemotingAppender.BeginAsyncSend">
  6756. <summary>
  6757. A work item is being queued into the thread pool
  6758. </summary>
  6759. </member>
  6760. <member name="M:log4net.Appender.RemotingAppender.EndAsyncSend">
  6761. <summary>
  6762. A work item from the thread pool has completed
  6763. </summary>
  6764. </member>
  6765. <member name="M:log4net.Appender.RemotingAppender.SendBufferCallback(System.Object)">
  6766. <summary>
  6767. Send the contents of the buffer to the remote sink.
  6768. </summary>
  6769. <remarks>
  6770. This method is designed to be used with the <see cref="T:System.Threading.ThreadPool"/>.
  6771. This method expects to be passed an array of <see cref="T:log4net.Core.LoggingEvent"/>
  6772. objects in the state param.
  6773. </remarks>
  6774. <param name="state">the logging events to send</param>
  6775. </member>
  6776. <member name="F:log4net.Appender.RemotingAppender.m_sinkUrl">
  6777. <summary>
  6778. The URL of the remote sink.
  6779. </summary>
  6780. </member>
  6781. <member name="F:log4net.Appender.RemotingAppender.m_sinkObj">
  6782. <summary>
  6783. The local proxy (.NET remoting) for the remote logging sink.
  6784. </summary>
  6785. </member>
  6786. <member name="F:log4net.Appender.RemotingAppender.m_queuedCallbackCount">
  6787. <summary>
  6788. The number of queued callbacks currently waiting or executing
  6789. </summary>
  6790. </member>
  6791. <member name="F:log4net.Appender.RemotingAppender.m_workQueueEmptyEvent">
  6792. <summary>
  6793. Event used to signal when there are no queued work items
  6794. </summary>
  6795. <remarks>
  6796. This event is set when there are no queued work items. In this
  6797. state it is safe to close the appender.
  6798. </remarks>
  6799. </member>
  6800. <member name="P:log4net.Appender.RemotingAppender.Sink">
  6801. <summary>
  6802. Gets or sets the URL of the well-known object that will accept
  6803. the logging events.
  6804. </summary>
  6805. <value>
  6806. The well-known URL of the remote sink.
  6807. </value>
  6808. <remarks>
  6809. <para>
  6810. The URL of the remoting sink that will accept logging events.
  6811. The sink must implement the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6812. interface.
  6813. </para>
  6814. </remarks>
  6815. </member>
  6816. <member name="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink">
  6817. <summary>
  6818. Interface used to deliver <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  6819. </summary>
  6820. <remarks>
  6821. This interface must be implemented by a remoting sink
  6822. if the <see cref="T:log4net.Appender.RemotingAppender"/> is to be used
  6823. to deliver logging events to the sink.
  6824. </remarks>
  6825. </member>
  6826. <member name="M:log4net.Appender.RemotingAppender.IRemoteLoggingSink.LogEvents(log4net.Core.LoggingEvent[])">
  6827. <summary>
  6828. Delivers logging events to the remote sink
  6829. </summary>
  6830. <param name="events">Array of events to log.</param>
  6831. <remarks>
  6832. <para>
  6833. Delivers logging events to the remote sink
  6834. </para>
  6835. </remarks>
  6836. </member>
  6837. <member name="T:log4net.Appender.RollingFileAppender">
  6838. <summary>
  6839. Appender that rolls log files based on size or date or both.
  6840. </summary>
  6841. <remarks>
  6842. <para>
  6843. RollingFileAppender can roll log files based on size or date or both
  6844. depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property.
  6845. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled
  6846. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  6847. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled
  6848. once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  6849. is crossed.
  6850. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be
  6851. rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  6852. is crossed, but within a date boundary the file will also be rolled
  6853. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  6854. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when
  6855. the appender is configured. This effectively means that the log file can be
  6856. rolled once per program execution.
  6857. </para>
  6858. <para>
  6859. A of few additional optional features have been added:
  6860. <list type="bullet">
  6861. <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item>
  6862. <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item>
  6863. <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item>
  6864. </list>
  6865. </para>
  6866. <note>
  6867. <para>
  6868. For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/>
  6869. greater than zero is highly recommended, otherwise all the backup files need
  6870. to be renamed each time a new backup is created.
  6871. </para>
  6872. <para>
  6873. When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6874. to <see langword="true"/> will reduce the number of file renamings to few or none.
  6875. </para>
  6876. </note>
  6877. <note type="caution">
  6878. <para>
  6879. Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing
  6880. the log file directory of backup files will cause unexpected and unwanted side effects.
  6881. </para>
  6882. </note>
  6883. <para>
  6884. If Date/Time based rolling is enabled this appender will attempt to roll existing files
  6885. in the directory without a Date/Time tag based on the last write date of the base log file.
  6886. The appender only rolls the log file when a message is logged. If Date/Time based rolling
  6887. is enabled then the appender will not roll the log file at the Date/Time boundary but
  6888. at the point when the next message is logged after the boundary has been crossed.
  6889. </para>
  6890. <para>
  6891. The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and
  6892. has the same behavior when opening the log file.
  6893. The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>
  6894. is called. This will typically be during configuration.
  6895. If the file cannot be opened for writing the appender will attempt
  6896. to open the file again each time a message is logged to the appender.
  6897. If the file cannot be opened for writing when a message is logged then
  6898. the message will be discarded by this appender.
  6899. </para>
  6900. <para>
  6901. When rolling a backup file necessitates deleting an older backup file the
  6902. file to be deleted is moved to a temporary name before being deleted.
  6903. </para>
  6904. <note type="caution">
  6905. <para>
  6906. A maximum number of backup files when rolling on date/time boundaries is not supported.
  6907. </para>
  6908. </note>
  6909. </remarks>
  6910. <author>Nicko Cadell</author>
  6911. <author>Gert Driesen</author>
  6912. <author>Aspi Havewala</author>
  6913. <author>Douglas de la Torre</author>
  6914. <author>Edward Smit</author>
  6915. </member>
  6916. <member name="M:log4net.Appender.RollingFileAppender.#ctor">
  6917. <summary>
  6918. Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender"/> class.
  6919. </summary>
  6920. <remarks>
  6921. <para>
  6922. Default constructor.
  6923. </para>
  6924. </remarks>
  6925. </member>
  6926. <member name="M:log4net.Appender.RollingFileAppender.Finalize">
  6927. <summary>
  6928. Cleans up all resources used by this appender.
  6929. </summary>
  6930. </member>
  6931. <member name="F:log4net.Appender.RollingFileAppender.declaringType">
  6932. <summary>
  6933. The fully qualified type of the RollingFileAppender class.
  6934. </summary>
  6935. <remarks>
  6936. Used by the internal logger to record the Type of the
  6937. log message.
  6938. </remarks>
  6939. </member>
  6940. <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)">
  6941. <summary>
  6942. Sets the quiet writer being used.
  6943. </summary>
  6944. <remarks>
  6945. This method can be overridden by sub classes.
  6946. </remarks>
  6947. <param name="writer">the writer to set</param>
  6948. </member>
  6949. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)">
  6950. <summary>
  6951. Write out a logging event.
  6952. </summary>
  6953. <param name="loggingEvent">the event to write to file.</param>
  6954. <remarks>
  6955. <para>
  6956. Handles append time behavior for RollingFileAppender. This checks
  6957. if a roll over either by date (checked first) or time (checked second)
  6958. is need and then appends to the file last.
  6959. </para>
  6960. </remarks>
  6961. </member>
  6962. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
  6963. <summary>
  6964. Write out an array of logging events.
  6965. </summary>
  6966. <param name="loggingEvents">the events to write to file.</param>
  6967. <remarks>
  6968. <para>
  6969. Handles append time behavior for RollingFileAppender. This checks
  6970. if a roll over either by date (checked first) or time (checked second)
  6971. is need and then appends to the file last.
  6972. </para>
  6973. </remarks>
  6974. </member>
  6975. <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
  6976. <summary>
  6977. Performs any required rolling before outputting the next event
  6978. </summary>
  6979. <remarks>
  6980. <para>
  6981. Handles append time behavior for RollingFileAppender. This checks
  6982. if a roll over either by date (checked first) or time (checked second)
  6983. is need and then appends to the file last.
  6984. </para>
  6985. </remarks>
  6986. </member>
  6987. <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)">
  6988. <summary>
  6989. Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6990. is false then the fully qualified name is determined and used.
  6991. </summary>
  6992. <param name="fileName">the name of the file to open</param>
  6993. <param name="append">true to append to existing file</param>
  6994. <remarks>
  6995. <para>This method will ensure that the directory structure
  6996. for the <paramref name="fileName"/> specified exists.</para>
  6997. </remarks>
  6998. </member>
  6999. <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)">
  7000. <summary>
  7001. Get the current output file name
  7002. </summary>
  7003. <param name="fileName">the base file name</param>
  7004. <returns>the output file name</returns>
  7005. <remarks>
  7006. The output file name is based on the base fileName specified.
  7007. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output
  7008. file name is the same as the base file passed in. Otherwise
  7009. the output file depends on the date pattern, on the count
  7010. direction or both.
  7011. </remarks>
  7012. </member>
  7013. <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups">
  7014. <summary>
  7015. Determines curSizeRollBackups (only within the current roll point)
  7016. </summary>
  7017. </member>
  7018. <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)">
  7019. <summary>
  7020. Generates a wildcard pattern that can be used to find all files
  7021. that are similar to the base file name.
  7022. </summary>
  7023. <param name="baseFileName"></param>
  7024. <returns></returns>
  7025. </member>
  7026. <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)">
  7027. <summary>
  7028. Builds a list of filenames for all files matching the base filename plus a file
  7029. pattern.
  7030. </summary>
  7031. <param name="baseFilePath"></param>
  7032. <returns></returns>
  7033. </member>
  7034. <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing">
  7035. <summary>
  7036. Initiates a roll over if needed for crossing a date boundary since the last run.
  7037. </summary>
  7038. </member>
  7039. <member name="M:log4net.Appender.RollingFileAppender.ExistingInit">
  7040. <summary>
  7041. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  7042. </summary>
  7043. <remarks>
  7044. <para>
  7045. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  7046. The following is done
  7047. <list type="bullet">
  7048. <item>determine curSizeRollBackups (only within the current roll point)</item>
  7049. <item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
  7050. </list>
  7051. </para>
  7052. </remarks>
  7053. </member>
  7054. <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)">
  7055. <summary>
  7056. Does the work of bumping the 'current' file counter higher
  7057. to the highest count when an incremental file name is seen.
  7058. The highest count is either the first file (when count direction
  7059. is greater than 0) or the last file (when count direction less than 0).
  7060. In either case, we want to know the highest count that is present.
  7061. </summary>
  7062. <param name="baseFile"></param>
  7063. <param name="curFileName"></param>
  7064. </member>
  7065. <member name="M:log4net.Appender.RollingFileAppender.GetBackUpIndex(System.String)">
  7066. <summary>
  7067. Attempts to extract a number from the end of the file name that indicates
  7068. the number of the times the file has been rolled over.
  7069. </summary>
  7070. <remarks>
  7071. Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes.
  7072. </remarks>
  7073. <param name="curFileName"></param>
  7074. <returns></returns>
  7075. </member>
  7076. <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)">
  7077. <summary>
  7078. Takes a list of files and a base file name, and looks for
  7079. 'incremented' versions of the base file. Bumps the max
  7080. count up to the highest count seen.
  7081. </summary>
  7082. <param name="baseFile"></param>
  7083. <param name="arrayFiles"></param>
  7084. </member>
  7085. <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)">
  7086. <summary>
  7087. Calculates the RollPoint for the datePattern supplied.
  7088. </summary>
  7089. <param name="datePattern">the date pattern to calculate the check period for</param>
  7090. <returns>The RollPoint that is most accurate for the date pattern supplied</returns>
  7091. <remarks>
  7092. Essentially the date pattern is examined to determine what the
  7093. most suitable roll point is. The roll point chosen is the roll point
  7094. with the smallest period that can be detected using the date pattern
  7095. supplied. i.e. if the date pattern only outputs the year, month, day
  7096. and hour then the smallest roll point that can be detected would be
  7097. and hourly roll point as minutes could not be detected.
  7098. </remarks>
  7099. </member>
  7100. <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions">
  7101. <summary>
  7102. Initialize the appender based on the options set
  7103. </summary>
  7104. <remarks>
  7105. <para>
  7106. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  7107. activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must
  7108. be called on this object after the configuration properties have
  7109. been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this
  7110. object is in an undefined state and must not be used.
  7111. </para>
  7112. <para>
  7113. If any of the configuration properties are modified then
  7114. <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again.
  7115. </para>
  7116. <para>
  7117. Sets initial conditions including date/time roll over information, first check,
  7118. scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize
  7119. the current number of backups.
  7120. </para>
  7121. </remarks>
  7122. </member>
  7123. <member name="M:log4net.Appender.RollingFileAppender.CombinePath(System.String,System.String)">
  7124. <summary>
  7125. </summary>
  7126. <param name="path1"></param>
  7127. <param name="path2">.1, .2, .3, etc.</param>
  7128. <returns></returns>
  7129. </member>
  7130. <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)">
  7131. <summary>
  7132. Rollover the file(s) to date/time tagged file(s).
  7133. </summary>
  7134. <param name="fileIsOpen">set to true if the file to be rolled is currently open</param>
  7135. <remarks>
  7136. <para>
  7137. Rollover the file(s) to date/time tagged file(s).
  7138. Resets curSizeRollBackups.
  7139. If fileIsOpen is set then the new file is opened (through SafeOpenFile).
  7140. </para>
  7141. </remarks>
  7142. </member>
  7143. <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)">
  7144. <summary>
  7145. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>.
  7146. </summary>
  7147. <param name="fromFile">Name of existing file to roll.</param>
  7148. <param name="toFile">New name for file.</param>
  7149. <remarks>
  7150. <para>
  7151. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It
  7152. also checks for existence of target file and deletes if it does.
  7153. </para>
  7154. </remarks>
  7155. </member>
  7156. <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)">
  7157. <summary>
  7158. Test if a file exists at a specified path
  7159. </summary>
  7160. <param name="path">the path to the file</param>
  7161. <returns>true if the file exists</returns>
  7162. <remarks>
  7163. <para>
  7164. Test if a file exists at a specified path
  7165. </para>
  7166. </remarks>
  7167. </member>
  7168. <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)">
  7169. <summary>
  7170. Deletes the specified file if it exists.
  7171. </summary>
  7172. <param name="fileName">The file to delete.</param>
  7173. <remarks>
  7174. <para>
  7175. Delete a file if is exists.
  7176. The file is first moved to a new filename then deleted.
  7177. This allows the file to be removed even when it cannot
  7178. be deleted, but it still can be moved.
  7179. </para>
  7180. </remarks>
  7181. </member>
  7182. <member name="M:log4net.Appender.RollingFileAppender.RollOverSize">
  7183. <summary>
  7184. Implements file roll base on file size.
  7185. </summary>
  7186. <remarks>
  7187. <para>
  7188. If the maximum number of size based backups is reached
  7189. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  7190. file is deleted -- its index determined by the sign of countDirection.
  7191. If <c>countDirection</c> &lt; 0, then files
  7192. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  7193. are renamed to {<c>File.2</c>, ...,
  7194. <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is
  7195. renamed <c>File.1</c> and closed.
  7196. </para>
  7197. <para>
  7198. A new file is created to receive further log output.
  7199. </para>
  7200. <para>
  7201. If <c>maxSizeRollBackups</c> is equal to zero, then the
  7202. <c>File</c> is truncated with no backup files created.
  7203. </para>
  7204. <para>
  7205. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  7206. renamed if needed and no files are deleted.
  7207. </para>
  7208. </remarks>
  7209. </member>
  7210. <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)">
  7211. <summary>
  7212. Implements file roll.
  7213. </summary>
  7214. <param name="baseFileName">the base name to rename</param>
  7215. <remarks>
  7216. <para>
  7217. If the maximum number of size based backups is reached
  7218. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  7219. file is deleted -- its index determined by the sign of countDirection.
  7220. If <c>countDirection</c> &lt; 0, then files
  7221. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  7222. are renamed to {<c>File.2</c>, ...,
  7223. <c>File.curSizeRollBackups</c>}.
  7224. </para>
  7225. <para>
  7226. If <c>maxSizeRollBackups</c> is equal to zero, then the
  7227. <c>File</c> is truncated with no backup files created.
  7228. </para>
  7229. <para>
  7230. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  7231. renamed if needed and no files are deleted.
  7232. </para>
  7233. <para>
  7234. This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files.
  7235. </para>
  7236. </remarks>
  7237. </member>
  7238. <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
  7239. <summary>
  7240. Get the start time of the next window for the current rollpoint
  7241. </summary>
  7242. <param name="currentDateTime">the current date</param>
  7243. <param name="rollPoint">the type of roll point we are working with</param>
  7244. <returns>the start time for the next roll point an interval after the currentDateTime date</returns>
  7245. <remarks>
  7246. <para>
  7247. Returns the date of the next roll point after the currentDateTime date passed to the method.
  7248. </para>
  7249. <para>
  7250. The basic strategy is to subtract the time parts that are less significant
  7251. than the rollpoint from the current time. This should roll the time back to
  7252. the start of the time window for the current rollpoint. Then we add 1 window
  7253. worth of time and get the start time of the next window for the rollpoint.
  7254. </para>
  7255. </remarks>
  7256. </member>
  7257. <member name="F:log4net.Appender.RollingFileAppender.m_dateTime">
  7258. <summary>
  7259. This object supplies the current date/time. Allows test code to plug in
  7260. a method to control this class when testing date/time based rolling. The default
  7261. implementation uses the underlying value of DateTime.Now.
  7262. </summary>
  7263. </member>
  7264. <member name="F:log4net.Appender.RollingFileAppender.m_datePattern">
  7265. <summary>
  7266. The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c>
  7267. meaning daily rollover.
  7268. </summary>
  7269. </member>
  7270. <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename">
  7271. <summary>
  7272. The actual formatted filename that is currently being written to
  7273. or will be the file transferred to on roll over
  7274. (based on staticLogFileName).
  7275. </summary>
  7276. </member>
  7277. <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck">
  7278. <summary>
  7279. The timestamp when we shall next recompute the filename.
  7280. </summary>
  7281. </member>
  7282. <member name="F:log4net.Appender.RollingFileAppender.m_now">
  7283. <summary>
  7284. Holds date of last roll over
  7285. </summary>
  7286. </member>
  7287. <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint">
  7288. <summary>
  7289. The type of rolling done
  7290. </summary>
  7291. </member>
  7292. <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize">
  7293. <summary>
  7294. The default maximum file size is 10MB
  7295. </summary>
  7296. </member>
  7297. <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups">
  7298. <summary>
  7299. There is zero backup files by default
  7300. </summary>
  7301. </member>
  7302. <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups">
  7303. <summary>
  7304. How many sized based backups have been made so far
  7305. </summary>
  7306. </member>
  7307. <member name="F:log4net.Appender.RollingFileAppender.m_countDirection">
  7308. <summary>
  7309. The rolling file count direction.
  7310. </summary>
  7311. </member>
  7312. <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle">
  7313. <summary>
  7314. The rolling mode used in this appender.
  7315. </summary>
  7316. </member>
  7317. <member name="F:log4net.Appender.RollingFileAppender.m_rollDate">
  7318. <summary>
  7319. Cache flag set if we are rolling by date.
  7320. </summary>
  7321. </member>
  7322. <member name="F:log4net.Appender.RollingFileAppender.m_rollSize">
  7323. <summary>
  7324. Cache flag set if we are rolling by size.
  7325. </summary>
  7326. </member>
  7327. <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName">
  7328. <summary>
  7329. Value indicating whether to always log to the same file.
  7330. </summary>
  7331. </member>
  7332. <member name="F:log4net.Appender.RollingFileAppender.m_preserveLogFileNameExtension">
  7333. <summary>
  7334. Value indicating whether to preserve the file name extension when rolling.
  7335. </summary>
  7336. </member>
  7337. <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName">
  7338. <summary>
  7339. FileName provided in configuration. Used for rolling properly
  7340. </summary>
  7341. </member>
  7342. <member name="F:log4net.Appender.RollingFileAppender.m_mutexForRolling">
  7343. <summary>
  7344. A mutex that is used to lock rolling of files.
  7345. </summary>
  7346. </member>
  7347. <member name="F:log4net.Appender.RollingFileAppender.s_date1970">
  7348. <summary>
  7349. The 1st of January 1970 in UTC
  7350. </summary>
  7351. </member>
  7352. <member name="P:log4net.Appender.RollingFileAppender.DateTimeStrategy">
  7353. <summary>
  7354. Gets or sets the strategy for determining the current date and time. The default
  7355. implementation is to use LocalDateTime which internally calls through to DateTime.Now.
  7356. DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying
  7357. <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  7358. </summary>
  7359. <value>
  7360. An implementation of the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> interface which returns the current date and time.
  7361. </value>
  7362. <remarks>
  7363. <para>
  7364. Gets or sets the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> used to return the current date and time.
  7365. </para>
  7366. <para>
  7367. There are two built strategies for determining the current date and time,
  7368. <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>
  7369. and <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  7370. </para>
  7371. <para>
  7372. The default strategy is <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>.
  7373. </para>
  7374. </remarks>
  7375. </member>
  7376. <member name="P:log4net.Appender.RollingFileAppender.DatePattern">
  7377. <summary>
  7378. Gets or sets the date pattern to be used for generating file names
  7379. when rolling over on date.
  7380. </summary>
  7381. <value>
  7382. The date pattern to be used for generating file names when rolling
  7383. over on date.
  7384. </value>
  7385. <remarks>
  7386. <para>
  7387. Takes a string in the same format as expected by
  7388. <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/>.
  7389. </para>
  7390. <para>
  7391. This property determines the rollover schedule when rolling over
  7392. on date.
  7393. </para>
  7394. </remarks>
  7395. </member>
  7396. <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups">
  7397. <summary>
  7398. Gets or sets the maximum number of backup files that are kept before
  7399. the oldest is erased.
  7400. </summary>
  7401. <value>
  7402. The maximum number of backup files that are kept before the oldest is
  7403. erased.
  7404. </value>
  7405. <remarks>
  7406. <para>
  7407. If set to zero, then there will be no backup files and the log file
  7408. will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>.
  7409. </para>
  7410. <para>
  7411. If a negative number is supplied then no deletions will be made. Note
  7412. that this could result in very slow performance as a large number of
  7413. files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used.
  7414. </para>
  7415. <para>
  7416. The maximum applies to <b>each</b> time based group of files and
  7417. <b>not</b> the total.
  7418. </para>
  7419. </remarks>
  7420. </member>
  7421. <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize">
  7422. <summary>
  7423. Gets or sets the maximum size that the output file is allowed to reach
  7424. before being rolled over to backup files.
  7425. </summary>
  7426. <value>
  7427. The maximum size in bytes that the output file is allowed to reach before being
  7428. rolled over to backup files.
  7429. </value>
  7430. <remarks>
  7431. <para>
  7432. This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except
  7433. that it is required for differentiating the setter taking a
  7434. <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/>
  7435. argument.
  7436. </para>
  7437. <para>
  7438. The default maximum file size is 10MB (10*1024*1024).
  7439. </para>
  7440. </remarks>
  7441. </member>
  7442. <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize">
  7443. <summary>
  7444. Gets or sets the maximum size that the output file is allowed to reach
  7445. before being rolled over to backup files.
  7446. </summary>
  7447. <value>
  7448. The maximum size that the output file is allowed to reach before being
  7449. rolled over to backup files.
  7450. </value>
  7451. <remarks>
  7452. <para>
  7453. This property allows you to specify the maximum size with the
  7454. suffixes "KB", "MB" or "GB" so that the size is interpreted being
  7455. expressed respectively in kilobytes, megabytes or gigabytes.
  7456. </para>
  7457. <para>
  7458. For example, the value "10KB" will be interpreted as 10240 bytes.
  7459. </para>
  7460. <para>
  7461. The default maximum file size is 10MB.
  7462. </para>
  7463. <para>
  7464. If you have the option to set the maximum file size programmatically
  7465. consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this
  7466. allows you to set the size in bytes as a <see cref="T:System.Int64"/>.
  7467. </para>
  7468. </remarks>
  7469. </member>
  7470. <member name="P:log4net.Appender.RollingFileAppender.CountDirection">
  7471. <summary>
  7472. Gets or sets the rolling file count direction.
  7473. </summary>
  7474. <value>
  7475. The rolling file count direction.
  7476. </value>
  7477. <remarks>
  7478. <para>
  7479. Indicates if the current file is the lowest numbered file or the
  7480. highest numbered file.
  7481. </para>
  7482. <para>
  7483. By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &lt; 0),
  7484. i.e. log.1 is most recent, log.5 is the 5th backup, etc...
  7485. </para>
  7486. <para>
  7487. <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &gt;= 0 does the opposite i.e.
  7488. log.1 is the first backup made, log.5 is the 5th backup made, etc.
  7489. For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &gt;= 0 to reduce
  7490. rollover costs.
  7491. </para>
  7492. <para>The default file count direction is -1.</para>
  7493. </remarks>
  7494. </member>
  7495. <member name="P:log4net.Appender.RollingFileAppender.RollingStyle">
  7496. <summary>
  7497. Gets or sets the rolling style.
  7498. </summary>
  7499. <value>The rolling style.</value>
  7500. <remarks>
  7501. <para>
  7502. The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/>.
  7503. </para>
  7504. <para>
  7505. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's
  7506. <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
  7507. the appender would append to a single file rather than rolling
  7508. the file each time it is opened.
  7509. </para>
  7510. </remarks>
  7511. </member>
  7512. <member name="P:log4net.Appender.RollingFileAppender.PreserveLogFileNameExtension">
  7513. <summary>
  7514. Gets or sets a value indicating whether to preserve the file name extension when rolling.
  7515. </summary>
  7516. <value>
  7517. <c>true</c> if the file name extension should be preserved.
  7518. </value>
  7519. <remarks>
  7520. <para>
  7521. By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup.
  7522. However, under Windows the new file name will loose any program associations as the
  7523. extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or
  7524. file.curSizeRollBackup.log to maintain any program associations.
  7525. </para>
  7526. </remarks>
  7527. </member>
  7528. <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName">
  7529. <summary>
  7530. Gets or sets a value indicating whether to always log to
  7531. the same file.
  7532. </summary>
  7533. <value>
  7534. <c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
  7535. </value>
  7536. <remarks>
  7537. <para>
  7538. By default file.log is always the current file. Optionally
  7539. file.log.yyyy-mm-dd for current formatted datePattern can by the currently
  7540. logging file (or file.log.curSizeRollBackup or even
  7541. file.log.yyyy-mm-dd.curSizeRollBackup).
  7542. </para>
  7543. <para>
  7544. This will make time based rollovers with a large number of backups
  7545. much faster as the appender it won't have to rename all the backups!
  7546. </para>
  7547. </remarks>
  7548. </member>
  7549. <member name="T:log4net.Appender.RollingFileAppender.RollingMode">
  7550. <summary>
  7551. Style of rolling to use
  7552. </summary>
  7553. <remarks>
  7554. <para>
  7555. Style of rolling to use
  7556. </para>
  7557. </remarks>
  7558. </member>
  7559. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once">
  7560. <summary>
  7561. Roll files once per program execution
  7562. </summary>
  7563. <remarks>
  7564. <para>
  7565. Roll files once per program execution.
  7566. Well really once each time this appender is
  7567. configured.
  7568. </para>
  7569. <para>
  7570. Setting this option also sets <c>AppendToFile</c> to
  7571. <c>false</c> on the <c>RollingFileAppender</c>, otherwise
  7572. this appender would just be a normal file appender.
  7573. </para>
  7574. </remarks>
  7575. </member>
  7576. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size">
  7577. <summary>
  7578. Roll files based only on the size of the file
  7579. </summary>
  7580. </member>
  7581. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date">
  7582. <summary>
  7583. Roll files based only on the date
  7584. </summary>
  7585. </member>
  7586. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite">
  7587. <summary>
  7588. Roll files based on both the size and date of the file
  7589. </summary>
  7590. </member>
  7591. <member name="T:log4net.Appender.RollingFileAppender.RollPoint">
  7592. <summary>
  7593. The code assumes that the following 'time' constants are in a increasing sequence.
  7594. </summary>
  7595. <remarks>
  7596. <para>
  7597. The code assumes that the following 'time' constants are in a increasing sequence.
  7598. </para>
  7599. </remarks>
  7600. </member>
  7601. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint">
  7602. <summary>
  7603. Roll the log not based on the date
  7604. </summary>
  7605. </member>
  7606. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute">
  7607. <summary>
  7608. Roll the log for each minute
  7609. </summary>
  7610. </member>
  7611. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour">
  7612. <summary>
  7613. Roll the log for each hour
  7614. </summary>
  7615. </member>
  7616. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay">
  7617. <summary>
  7618. Roll the log twice a day (midday and midnight)
  7619. </summary>
  7620. </member>
  7621. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay">
  7622. <summary>
  7623. Roll the log each day (midnight)
  7624. </summary>
  7625. </member>
  7626. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek">
  7627. <summary>
  7628. Roll the log each week
  7629. </summary>
  7630. </member>
  7631. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth">
  7632. <summary>
  7633. Roll the log each month
  7634. </summary>
  7635. </member>
  7636. <member name="T:log4net.Appender.RollingFileAppender.IDateTime">
  7637. <summary>
  7638. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  7639. </summary>
  7640. <remarks>
  7641. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  7642. Used primarily to allow test classes to plug themselves in so they can
  7643. supply test date/times.
  7644. </remarks>
  7645. </member>
  7646. <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now">
  7647. <summary>
  7648. Gets the <i>current</i> time.
  7649. </summary>
  7650. <value>The <i>current</i> time.</value>
  7651. <remarks>
  7652. <para>
  7653. Gets the <i>current</i> time.
  7654. </para>
  7655. </remarks>
  7656. </member>
  7657. <member name="T:log4net.Appender.RollingFileAppender.LocalDateTime">
  7658. <summary>
  7659. Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time.
  7660. </summary>
  7661. </member>
  7662. <member name="P:log4net.Appender.RollingFileAppender.LocalDateTime.Now">
  7663. <summary>
  7664. Gets the <b>current</b> time.
  7665. </summary>
  7666. <value>The <b>current</b> time.</value>
  7667. <remarks>
  7668. <para>
  7669. Gets the <b>current</b> time.
  7670. </para>
  7671. </remarks>
  7672. </member>
  7673. <member name="T:log4net.Appender.RollingFileAppender.UniversalDateTime">
  7674. <summary>
  7675. Implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time as the coordinated universal time (UTC).
  7676. </summary>
  7677. </member>
  7678. <member name="P:log4net.Appender.RollingFileAppender.UniversalDateTime.Now">
  7679. <summary>
  7680. Gets the <b>current</b> time.
  7681. </summary>
  7682. <value>The <b>current</b> time.</value>
  7683. <remarks>
  7684. <para>
  7685. Gets the <b>current</b> time.
  7686. </para>
  7687. </remarks>
  7688. </member>
  7689. <member name="T:log4net.Appender.SmtpAppender">
  7690. <summary>
  7691. Send an e-mail when a specific logging event occurs, typically on errors
  7692. or fatal errors.
  7693. </summary>
  7694. <remarks>
  7695. <para>
  7696. The number of logging events delivered in this e-mail depend on
  7697. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  7698. <see cref="T:log4net.Appender.SmtpAppender"/> keeps only the last
  7699. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  7700. cyclic buffer. This keeps memory requirements at a reasonable level while
  7701. still delivering useful application context.
  7702. </para>
  7703. <note type="caution">
  7704. Authentication and setting the server Port are only available on the MS .NET 1.1 runtime.
  7705. For these features to be enabled you need to ensure that you are using a version of
  7706. the log4net assembly that is built against the MS .NET 1.1 framework and that you are
  7707. running the your application on the MS .NET 1.1 runtime. On all other platforms only sending
  7708. unauthenticated messages to a server listening on port 25 (the default) is supported.
  7709. </note>
  7710. <para>
  7711. Authentication is supported by setting the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property to
  7712. either <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> or <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  7713. If using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> authentication then the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  7714. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> properties must also be set.
  7715. </para>
  7716. <para>
  7717. To set the SMTP server port use the <see cref="P:log4net.Appender.SmtpAppender.Port"/> property. The default port is 25.
  7718. </para>
  7719. </remarks>
  7720. <author>Nicko Cadell</author>
  7721. <author>Gert Driesen</author>
  7722. </member>
  7723. <member name="M:log4net.Appender.SmtpAppender.#ctor">
  7724. <summary>
  7725. Default constructor
  7726. </summary>
  7727. <remarks>
  7728. <para>
  7729. Default constructor
  7730. </para>
  7731. </remarks>
  7732. </member>
  7733. <member name="M:log4net.Appender.SmtpAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  7734. <summary>
  7735. Sends the contents of the cyclic buffer as an e-mail message.
  7736. </summary>
  7737. <param name="events">The logging events to send.</param>
  7738. </member>
  7739. <member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)">
  7740. <summary>
  7741. Send the email message
  7742. </summary>
  7743. <param name="messageBody">the body text to include in the mail</param>
  7744. </member>
  7745. <member name="M:log4net.Appender.SmtpAppender.MaybeTrimSeparators(System.String)">
  7746. <summary>
  7747. trims leading and trailing commas or semicolons
  7748. </summary>
  7749. </member>
  7750. <member name="P:log4net.Appender.SmtpAppender.To">
  7751. <summary>
  7752. Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions).
  7753. </summary>
  7754. <value>
  7755. <para>
  7756. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7757. </para>
  7758. <para>
  7759. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7760. </para>
  7761. </value>
  7762. <remarks>
  7763. <para>
  7764. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7765. </para>
  7766. <para>
  7767. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7768. </para>
  7769. </remarks>
  7770. </member>
  7771. <member name="P:log4net.Appender.SmtpAppender.Cc">
  7772. <summary>
  7773. Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses
  7774. that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions).
  7775. </summary>
  7776. <value>
  7777. <para>
  7778. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7779. </para>
  7780. <para>
  7781. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7782. </para>
  7783. </value>
  7784. <remarks>
  7785. <para>
  7786. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7787. </para>
  7788. <para>
  7789. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7790. </para>
  7791. </remarks>
  7792. </member>
  7793. <member name="P:log4net.Appender.SmtpAppender.Bcc">
  7794. <summary>
  7795. Gets or sets a semicolon-delimited list of recipient e-mail addresses
  7796. that will be blind carbon copied.
  7797. </summary>
  7798. <value>
  7799. A semicolon-delimited list of e-mail addresses.
  7800. </value>
  7801. <remarks>
  7802. <para>
  7803. A semicolon-delimited list of recipient e-mail addresses.
  7804. </para>
  7805. </remarks>
  7806. </member>
  7807. <member name="P:log4net.Appender.SmtpAppender.From">
  7808. <summary>
  7809. Gets or sets the e-mail address of the sender.
  7810. </summary>
  7811. <value>
  7812. The e-mail address of the sender.
  7813. </value>
  7814. <remarks>
  7815. <para>
  7816. The e-mail address of the sender.
  7817. </para>
  7818. </remarks>
  7819. </member>
  7820. <member name="P:log4net.Appender.SmtpAppender.Subject">
  7821. <summary>
  7822. Gets or sets the subject line of the e-mail message.
  7823. </summary>
  7824. <value>
  7825. The subject line of the e-mail message.
  7826. </value>
  7827. <remarks>
  7828. <para>
  7829. The subject line of the e-mail message.
  7830. </para>
  7831. </remarks>
  7832. </member>
  7833. <member name="P:log4net.Appender.SmtpAppender.SmtpHost">
  7834. <summary>
  7835. Gets or sets the name of the SMTP relay mail server to use to send
  7836. the e-mail messages.
  7837. </summary>
  7838. <value>
  7839. The name of the e-mail relay server. If SmtpServer is not set, the
  7840. name of the local SMTP server is used.
  7841. </value>
  7842. <remarks>
  7843. <para>
  7844. The name of the e-mail relay server. If SmtpServer is not set, the
  7845. name of the local SMTP server is used.
  7846. </para>
  7847. </remarks>
  7848. </member>
  7849. <member name="P:log4net.Appender.SmtpAppender.LocationInfo">
  7850. <summary>
  7851. Obsolete
  7852. </summary>
  7853. <remarks>
  7854. Use the BufferingAppenderSkeleton Fix methods instead
  7855. </remarks>
  7856. <remarks>
  7857. <para>
  7858. Obsolete property.
  7859. </para>
  7860. </remarks>
  7861. </member>
  7862. <member name="P:log4net.Appender.SmtpAppender.Authentication">
  7863. <summary>
  7864. The mode to use to authentication with the SMTP server
  7865. </summary>
  7866. <remarks>
  7867. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7868. <para>
  7869. Valid Authentication mode values are: <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>,
  7870. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, and <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  7871. The default value is <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>. When using
  7872. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> you must specify the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  7873. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> to use to authenticate.
  7874. When using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/> the Windows credentials for the current
  7875. thread, if impersonating, or the process will be used to authenticate.
  7876. </para>
  7877. </remarks>
  7878. </member>
  7879. <member name="P:log4net.Appender.SmtpAppender.Username">
  7880. <summary>
  7881. The username to use to authenticate with the SMTP server
  7882. </summary>
  7883. <remarks>
  7884. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7885. <para>
  7886. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7887. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7888. otherwise the username will be ignored.
  7889. </para>
  7890. </remarks>
  7891. </member>
  7892. <member name="P:log4net.Appender.SmtpAppender.Password">
  7893. <summary>
  7894. The password to use to authenticate with the SMTP server
  7895. </summary>
  7896. <remarks>
  7897. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7898. <para>
  7899. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7900. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7901. otherwise the password will be ignored.
  7902. </para>
  7903. </remarks>
  7904. </member>
  7905. <member name="P:log4net.Appender.SmtpAppender.Port">
  7906. <summary>
  7907. The port on which the SMTP server is listening
  7908. </summary>
  7909. <remarks>
  7910. <note type="caution">Server Port is only available on the MS .NET 1.1 runtime.</note>
  7911. <para>
  7912. The port on which the SMTP server is listening. The default
  7913. port is <c>25</c>. The Port can only be changed when running on
  7914. the MS .NET 1.1 runtime.
  7915. </para>
  7916. </remarks>
  7917. </member>
  7918. <member name="P:log4net.Appender.SmtpAppender.Priority">
  7919. <summary>
  7920. Gets or sets the priority of the e-mail message
  7921. </summary>
  7922. <value>
  7923. One of the <see cref="T:System.Net.Mail.MailPriority"/> values.
  7924. </value>
  7925. <remarks>
  7926. <para>
  7927. Sets the priority of the e-mails generated by this
  7928. appender. The default priority is <see cref="F:System.Net.Mail.MailPriority.Normal"/>.
  7929. </para>
  7930. <para>
  7931. If you are using this appender to report errors then
  7932. you may want to set the priority to <see cref="F:System.Net.Mail.MailPriority.High"/>.
  7933. </para>
  7934. </remarks>
  7935. </member>
  7936. <member name="P:log4net.Appender.SmtpAppender.EnableSsl">
  7937. <summary>
  7938. Enable or disable use of SSL when sending e-mail message
  7939. </summary>
  7940. <remarks>
  7941. This is available on MS .NET 2.0 runtime and higher
  7942. </remarks>
  7943. </member>
  7944. <member name="P:log4net.Appender.SmtpAppender.ReplyTo">
  7945. <summary>
  7946. Gets or sets the reply-to e-mail address.
  7947. </summary>
  7948. <remarks>
  7949. This is available on MS .NET 2.0 runtime and higher
  7950. </remarks>
  7951. </member>
  7952. <member name="P:log4net.Appender.SmtpAppender.SubjectEncoding">
  7953. <summary>
  7954. Gets or sets the subject encoding to be used.
  7955. </summary>
  7956. <remarks>
  7957. The default encoding is the operating system's current ANSI codepage.
  7958. </remarks>
  7959. </member>
  7960. <member name="P:log4net.Appender.SmtpAppender.BodyEncoding">
  7961. <summary>
  7962. Gets or sets the body encoding to be used.
  7963. </summary>
  7964. <remarks>
  7965. The default encoding is the operating system's current ANSI codepage.
  7966. </remarks>
  7967. </member>
  7968. <member name="P:log4net.Appender.SmtpAppender.RequiresLayout">
  7969. <summary>
  7970. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7971. </summary>
  7972. <value><c>true</c></value>
  7973. <remarks>
  7974. <para>
  7975. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7976. </para>
  7977. </remarks>
  7978. </member>
  7979. <member name="T:log4net.Appender.SmtpAppender.SmtpAuthentication">
  7980. <summary>
  7981. Values for the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property.
  7982. </summary>
  7983. <remarks>
  7984. <para>
  7985. SMTP authentication modes.
  7986. </para>
  7987. </remarks>
  7988. </member>
  7989. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None">
  7990. <summary>
  7991. No authentication
  7992. </summary>
  7993. </member>
  7994. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic">
  7995. <summary>
  7996. Basic authentication.
  7997. </summary>
  7998. <remarks>
  7999. Requires a username and password to be supplied
  8000. </remarks>
  8001. </member>
  8002. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm">
  8003. <summary>
  8004. Integrated authentication
  8005. </summary>
  8006. <remarks>
  8007. Uses the Windows credentials from the current thread or process to authenticate.
  8008. </remarks>
  8009. </member>
  8010. <member name="T:log4net.Appender.SmtpPickupDirAppender">
  8011. <summary>
  8012. Send an email when a specific logging event occurs, typically on errors
  8013. or fatal errors. Rather than sending via smtp it writes a file into the
  8014. directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such
  8015. as the IIS SMTP agent to manage sending the messages.
  8016. </summary>
  8017. <remarks>
  8018. <para>
  8019. The configuration for this appender is identical to that of the <c>SMTPAppender</c>,
  8020. except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify
  8021. <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>.
  8022. </para>
  8023. <para>
  8024. The number of logging events delivered in this e-mail depend on
  8025. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  8026. <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last
  8027. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  8028. cyclic buffer. This keeps memory requirements at a reasonable level while
  8029. still delivering useful application context.
  8030. </para>
  8031. </remarks>
  8032. <author>Niall Daley</author>
  8033. <author>Nicko Cadell</author>
  8034. </member>
  8035. <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor">
  8036. <summary>
  8037. Default constructor
  8038. </summary>
  8039. <remarks>
  8040. <para>
  8041. Default constructor
  8042. </para>
  8043. </remarks>
  8044. </member>
  8045. <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  8046. <summary>
  8047. Sends the contents of the cyclic buffer as an e-mail message.
  8048. </summary>
  8049. <param name="events">The logging events to send.</param>
  8050. <remarks>
  8051. <para>
  8052. Sends the contents of the cyclic buffer as an e-mail message.
  8053. </para>
  8054. </remarks>
  8055. </member>
  8056. <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions">
  8057. <summary>
  8058. Activate the options on this appender.
  8059. </summary>
  8060. <remarks>
  8061. <para>
  8062. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  8063. activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must
  8064. be called on this object after the configuration properties have
  8065. been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this
  8066. object is in an undefined state and must not be used.
  8067. </para>
  8068. <para>
  8069. If any of the configuration properties are modified then
  8070. <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again.
  8071. </para>
  8072. </remarks>
  8073. </member>
  8074. <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)">
  8075. <summary>
  8076. Convert a path into a fully qualified path.
  8077. </summary>
  8078. <param name="path">The path to convert.</param>
  8079. <returns>The fully qualified path.</returns>
  8080. <remarks>
  8081. <para>
  8082. Converts the path specified to a fully
  8083. qualified path. If the path is relative it is
  8084. taken as relative from the application base
  8085. directory.
  8086. </para>
  8087. </remarks>
  8088. </member>
  8089. <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext">
  8090. <summary>
  8091. The security context to use for privileged calls
  8092. </summary>
  8093. </member>
  8094. <member name="P:log4net.Appender.SmtpPickupDirAppender.To">
  8095. <summary>
  8096. Gets or sets a semicolon-delimited list of recipient e-mail addresses.
  8097. </summary>
  8098. <value>
  8099. A semicolon-delimited list of e-mail addresses.
  8100. </value>
  8101. <remarks>
  8102. <para>
  8103. A semicolon-delimited list of e-mail addresses.
  8104. </para>
  8105. </remarks>
  8106. </member>
  8107. <member name="P:log4net.Appender.SmtpPickupDirAppender.From">
  8108. <summary>
  8109. Gets or sets the e-mail address of the sender.
  8110. </summary>
  8111. <value>
  8112. The e-mail address of the sender.
  8113. </value>
  8114. <remarks>
  8115. <para>
  8116. The e-mail address of the sender.
  8117. </para>
  8118. </remarks>
  8119. </member>
  8120. <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject">
  8121. <summary>
  8122. Gets or sets the subject line of the e-mail message.
  8123. </summary>
  8124. <value>
  8125. The subject line of the e-mail message.
  8126. </value>
  8127. <remarks>
  8128. <para>
  8129. The subject line of the e-mail message.
  8130. </para>
  8131. </remarks>
  8132. </member>
  8133. <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir">
  8134. <summary>
  8135. Gets or sets the path to write the messages to.
  8136. </summary>
  8137. <remarks>
  8138. <para>
  8139. Gets or sets the path to write the messages to. This should be the same
  8140. as that used by the agent sending the messages.
  8141. </para>
  8142. </remarks>
  8143. </member>
  8144. <member name="P:log4net.Appender.SmtpPickupDirAppender.FileExtension">
  8145. <summary>
  8146. Gets or sets the file extension for the generated files
  8147. </summary>
  8148. <value>
  8149. The file extension for the generated files
  8150. </value>
  8151. <remarks>
  8152. <para>
  8153. The file extension for the generated files
  8154. </para>
  8155. </remarks>
  8156. </member>
  8157. <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext">
  8158. <summary>
  8159. Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  8160. </summary>
  8161. <value>
  8162. The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  8163. </value>
  8164. <remarks>
  8165. <para>
  8166. Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender
  8167. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  8168. security context to use. The default behavior is to use the security context
  8169. of the current thread.
  8170. </para>
  8171. </remarks>
  8172. </member>
  8173. <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout">
  8174. <summary>
  8175. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8176. </summary>
  8177. <value><c>true</c></value>
  8178. <remarks>
  8179. <para>
  8180. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8181. </para>
  8182. </remarks>
  8183. </member>
  8184. <member name="T:log4net.Appender.TelnetAppender">
  8185. <summary>
  8186. Appender that allows clients to connect via Telnet to receive log messages
  8187. </summary>
  8188. <remarks>
  8189. <para>
  8190. The TelnetAppender accepts socket connections and streams logging messages
  8191. back to the client.
  8192. The output is provided in a telnet-friendly way so that a log can be monitored
  8193. over a TCP/IP socket.
  8194. This allows simple remote monitoring of application logging.
  8195. </para>
  8196. <para>
  8197. The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port).
  8198. </para>
  8199. </remarks>
  8200. <author>Keith Long</author>
  8201. <author>Nicko Cadell</author>
  8202. </member>
  8203. <member name="M:log4net.Appender.TelnetAppender.#ctor">
  8204. <summary>
  8205. Default constructor
  8206. </summary>
  8207. <remarks>
  8208. <para>
  8209. Default constructor
  8210. </para>
  8211. </remarks>
  8212. </member>
  8213. <member name="F:log4net.Appender.TelnetAppender.declaringType">
  8214. <summary>
  8215. The fully qualified type of the TelnetAppender class.
  8216. </summary>
  8217. <remarks>
  8218. Used by the internal logger to record the Type of the
  8219. log message.
  8220. </remarks>
  8221. </member>
  8222. <member name="M:log4net.Appender.TelnetAppender.OnClose">
  8223. <summary>
  8224. Overrides the parent method to close the socket handler
  8225. </summary>
  8226. <remarks>
  8227. <para>
  8228. Closes all the outstanding connections.
  8229. </para>
  8230. </remarks>
  8231. </member>
  8232. <member name="M:log4net.Appender.TelnetAppender.ActivateOptions">
  8233. <summary>
  8234. Initialize the appender based on the options set.
  8235. </summary>
  8236. <remarks>
  8237. <para>
  8238. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  8239. activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must
  8240. be called on this object after the configuration properties have
  8241. been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this
  8242. object is in an undefined state and must not be used.
  8243. </para>
  8244. <para>
  8245. If any of the configuration properties are modified then
  8246. <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again.
  8247. </para>
  8248. <para>
  8249. Create the socket handler and wait for connections
  8250. </para>
  8251. </remarks>
  8252. </member>
  8253. <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)">
  8254. <summary>
  8255. Writes the logging event to each connected client.
  8256. </summary>
  8257. <param name="loggingEvent">The event to log.</param>
  8258. <remarks>
  8259. <para>
  8260. Writes the logging event to each connected client.
  8261. </para>
  8262. </remarks>
  8263. </member>
  8264. <member name="P:log4net.Appender.TelnetAppender.Port">
  8265. <summary>
  8266. Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  8267. </summary>
  8268. <value>
  8269. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  8270. indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  8271. </value>
  8272. <remarks>
  8273. <para>
  8274. The default value is 23 (the telnet port).
  8275. </para>
  8276. </remarks>
  8277. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/>
  8278. or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
  8279. </member>
  8280. <member name="P:log4net.Appender.TelnetAppender.RequiresLayout">
  8281. <summary>
  8282. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8283. </summary>
  8284. <value><c>true</c></value>
  8285. <remarks>
  8286. <para>
  8287. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8288. </para>
  8289. </remarks>
  8290. </member>
  8291. <member name="T:log4net.Appender.TelnetAppender.SocketHandler">
  8292. <summary>
  8293. Helper class to manage connected clients
  8294. </summary>
  8295. <remarks>
  8296. <para>
  8297. The SocketHandler class is used to accept connections from
  8298. clients. It is threaded so that clients can connect/disconnect
  8299. asynchronously.
  8300. </para>
  8301. </remarks>
  8302. </member>
  8303. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)">
  8304. <summary>
  8305. Opens a new server port on <paramref ref="port"/>
  8306. </summary>
  8307. <param name="port">the local port to listen on for connections</param>
  8308. <remarks>
  8309. <para>
  8310. Creates a socket handler on the specified local server port.
  8311. </para>
  8312. </remarks>
  8313. </member>
  8314. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)">
  8315. <summary>
  8316. Sends a string message to each of the connected clients
  8317. </summary>
  8318. <param name="message">the text to send</param>
  8319. <remarks>
  8320. <para>
  8321. Sends a string message to each of the connected clients
  8322. </para>
  8323. </remarks>
  8324. </member>
  8325. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  8326. <summary>
  8327. Add a client to the internal clients list
  8328. </summary>
  8329. <param name="client">client to add</param>
  8330. </member>
  8331. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  8332. <summary>
  8333. Remove a client from the internal clients list
  8334. </summary>
  8335. <param name="client">client to remove</param>
  8336. </member>
  8337. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.OnConnect(System.IAsyncResult)">
  8338. <summary>
  8339. Callback used to accept a connection on the server socket
  8340. </summary>
  8341. <param name="asyncResult">The result of the asynchronous operation</param>
  8342. <remarks>
  8343. <para>
  8344. On connection adds to the list of connections
  8345. if there are two many open connections you will be disconnected
  8346. </para>
  8347. </remarks>
  8348. </member>
  8349. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose">
  8350. <summary>
  8351. Close all network connections
  8352. </summary>
  8353. <remarks>
  8354. <para>
  8355. Make sure we close all network connections
  8356. </para>
  8357. </remarks>
  8358. </member>
  8359. <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections">
  8360. <summary>
  8361. Test if this handler has active connections
  8362. </summary>
  8363. <value>
  8364. <c>true</c> if this handler has active connections
  8365. </value>
  8366. <remarks>
  8367. <para>
  8368. This property will be <c>true</c> while this handler has
  8369. active connections, that is at least one connection that
  8370. the handler will attempt to send a message to.
  8371. </para>
  8372. </remarks>
  8373. </member>
  8374. <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient">
  8375. <summary>
  8376. Class that represents a client connected to this handler
  8377. </summary>
  8378. <remarks>
  8379. <para>
  8380. Class that represents a client connected to this handler
  8381. </para>
  8382. </remarks>
  8383. </member>
  8384. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)">
  8385. <summary>
  8386. Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/>
  8387. </summary>
  8388. <param name="socket">the client's socket</param>
  8389. <remarks>
  8390. <para>
  8391. Opens a stream writer on the socket.
  8392. </para>
  8393. </remarks>
  8394. </member>
  8395. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)">
  8396. <summary>
  8397. Write a string to the client
  8398. </summary>
  8399. <param name="message">string to send</param>
  8400. <remarks>
  8401. <para>
  8402. Write a string to the client
  8403. </para>
  8404. </remarks>
  8405. </member>
  8406. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose">
  8407. <summary>
  8408. Cleanup the clients connection
  8409. </summary>
  8410. <remarks>
  8411. <para>
  8412. Close the socket connection.
  8413. </para>
  8414. </remarks>
  8415. </member>
  8416. <member name="T:log4net.Appender.TraceAppender">
  8417. <summary>
  8418. Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system.
  8419. </summary>
  8420. <remarks>
  8421. <para>
  8422. The application configuration file can be used to control what listeners
  8423. are actually used. See the MSDN documentation for the
  8424. <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the
  8425. trace system.
  8426. </para>
  8427. <para>
  8428. Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c>
  8429. method. The event's logger name is the default value for the category parameter
  8430. of the Write method.
  8431. </para>
  8432. <para>
  8433. <b>Compact Framework</b><br/>
  8434. The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/>
  8435. class for any operation except <c>Assert</c>. When using the Compact Framework this
  8436. appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than
  8437. the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>.
  8438. </para>
  8439. </remarks>
  8440. <author>Douglas de la Torre</author>
  8441. <author>Nicko Cadell</author>
  8442. <author>Gert Driesen</author>
  8443. <author>Ron Grabowski</author>
  8444. </member>
  8445. <member name="M:log4net.Appender.TraceAppender.#ctor">
  8446. <summary>
  8447. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>.
  8448. </summary>
  8449. <remarks>
  8450. <para>
  8451. Default constructor.
  8452. </para>
  8453. </remarks>
  8454. </member>
  8455. <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)">
  8456. <summary>
  8457. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>
  8458. with a specified layout.
  8459. </summary>
  8460. <param name="layout">The layout to use with this appender.</param>
  8461. <remarks>
  8462. <para>
  8463. Obsolete constructor.
  8464. </para>
  8465. </remarks>
  8466. </member>
  8467. <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)">
  8468. <summary>
  8469. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  8470. </summary>
  8471. <param name="loggingEvent">The event to log.</param>
  8472. <remarks>
  8473. <para>
  8474. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  8475. </para>
  8476. </remarks>
  8477. </member>
  8478. <member name="F:log4net.Appender.TraceAppender.m_immediateFlush">
  8479. <summary>
  8480. Immediate flush means that the underlying writer or output stream
  8481. will be flushed at the end of each append operation.
  8482. </summary>
  8483. <remarks>
  8484. <para>
  8485. Immediate flush is slower but ensures that each append request is
  8486. actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to
  8487. <c>false</c>, then there is a good chance that the last few
  8488. logs events are not actually written to persistent media if and
  8489. when the application crashes.
  8490. </para>
  8491. <para>
  8492. The default value is <c>true</c>.</para>
  8493. </remarks>
  8494. </member>
  8495. <member name="F:log4net.Appender.TraceAppender.m_category">
  8496. <summary>
  8497. Defaults to %logger
  8498. </summary>
  8499. </member>
  8500. <member name="M:log4net.Appender.TraceAppender.Flush(System.Int32)">
  8501. <summary>
  8502. Flushes any buffered log data.
  8503. </summary>
  8504. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  8505. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  8506. </member>
  8507. <member name="P:log4net.Appender.TraceAppender.ImmediateFlush">
  8508. <summary>
  8509. Gets or sets a value that indicates whether the appender will
  8510. flush at the end of each write.
  8511. </summary>
  8512. <remarks>
  8513. <para>The default behavior is to flush at the end of each
  8514. write. If the option is set to<c>false</c>, then the underlying
  8515. stream can defer writing to physical medium to a later time.
  8516. </para>
  8517. <para>
  8518. Avoiding the flush operation at the end of each append results
  8519. in a performance gain of 10 to 20 percent. However, there is safety
  8520. trade-off involved in skipping flushing. Indeed, when flushing is
  8521. skipped, then it is likely that the last few log events will not
  8522. be recorded on disk when the application exits. This is a high
  8523. price to pay even for a 20% performance gain.
  8524. </para>
  8525. </remarks>
  8526. </member>
  8527. <member name="P:log4net.Appender.TraceAppender.Category">
  8528. <summary>
  8529. The category parameter sent to the Trace method.
  8530. </summary>
  8531. <remarks>
  8532. <para>
  8533. Defaults to %logger which will use the logger name of the current
  8534. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  8535. </para>
  8536. <para>
  8537. </para>
  8538. </remarks>
  8539. </member>
  8540. <member name="P:log4net.Appender.TraceAppender.RequiresLayout">
  8541. <summary>
  8542. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8543. </summary>
  8544. <value><c>true</c></value>
  8545. <remarks>
  8546. <para>
  8547. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8548. </para>
  8549. </remarks>
  8550. </member>
  8551. <member name="T:log4net.Config.AliasDomainAttribute">
  8552. <summary>
  8553. Assembly level attribute that specifies a domain to alias to this assembly's repository.
  8554. </summary>
  8555. <remarks>
  8556. <para>
  8557. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  8558. </para>
  8559. <para>
  8560. An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>,
  8561. however this can be overridden by an assembly loaded before the target assembly.
  8562. </para>
  8563. <para>
  8564. An assembly can alias another assembly's domain to its repository by
  8565. specifying this attribute with the name of the target domain.
  8566. </para>
  8567. <para>
  8568. This attribute can only be specified on the assembly and may be used
  8569. as many times as necessary to alias all the required domains.
  8570. </para>
  8571. </remarks>
  8572. <author>Nicko Cadell</author>
  8573. <author>Gert Driesen</author>
  8574. </member>
  8575. <member name="T:log4net.Config.AliasRepositoryAttribute">
  8576. <summary>
  8577. Assembly level attribute that specifies a repository to alias to this assembly's repository.
  8578. </summary>
  8579. <remarks>
  8580. <para>
  8581. An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>,
  8582. however this can be overridden by an assembly loaded before the target assembly.
  8583. </para>
  8584. <para>
  8585. An assembly can alias another assembly's repository to its repository by
  8586. specifying this attribute with the name of the target repository.
  8587. </para>
  8588. <para>
  8589. This attribute can only be specified on the assembly and may be used
  8590. as many times as necessary to alias all the required repositories.
  8591. </para>
  8592. </remarks>
  8593. <author>Nicko Cadell</author>
  8594. <author>Gert Driesen</author>
  8595. </member>
  8596. <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)">
  8597. <summary>
  8598. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
  8599. the specified repository to alias to this assembly's repository.
  8600. </summary>
  8601. <param name="name">The repository to alias to this assemby's repository.</param>
  8602. <remarks>
  8603. <para>
  8604. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
  8605. the specified repository to alias to this assembly's repository.
  8606. </para>
  8607. </remarks>
  8608. </member>
  8609. <member name="P:log4net.Config.AliasRepositoryAttribute.Name">
  8610. <summary>
  8611. Gets or sets the repository to alias to this assemby's repository.
  8612. </summary>
  8613. <value>
  8614. The repository to alias to this assemby's repository.
  8615. </value>
  8616. <remarks>
  8617. <para>
  8618. The name of the repository to alias to this assemby's repository.
  8619. </para>
  8620. </remarks>
  8621. </member>
  8622. <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)">
  8623. <summary>
  8624. Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute"/> class with
  8625. the specified domain to alias to this assembly's repository.
  8626. </summary>
  8627. <param name="name">The domain to alias to this assemby's repository.</param>
  8628. <remarks>
  8629. <para>
  8630. Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>.
  8631. </para>
  8632. </remarks>
  8633. </member>
  8634. <member name="T:log4net.Config.BasicConfigurator">
  8635. <summary>
  8636. Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  8637. </summary>
  8638. <remarks>
  8639. <para>
  8640. Allows very simple programmatic configuration of log4net.
  8641. </para>
  8642. <para>
  8643. Only one appender can be configured using this configurator.
  8644. The appender is set at the root of the hierarchy and all logging
  8645. events will be delivered to that appender.
  8646. </para>
  8647. <para>
  8648. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  8649. they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions()"/> method
  8650. be called after the appenders properties have been configured.
  8651. </para>
  8652. </remarks>
  8653. <author>Nicko Cadell</author>
  8654. <author>Gert Driesen</author>
  8655. </member>
  8656. <member name="F:log4net.Config.BasicConfigurator.declaringType">
  8657. <summary>
  8658. The fully qualified type of the BasicConfigurator class.
  8659. </summary>
  8660. <remarks>
  8661. Used by the internal logger to record the Type of the
  8662. log message.
  8663. </remarks>
  8664. </member>
  8665. <member name="M:log4net.Config.BasicConfigurator.#ctor">
  8666. <summary>
  8667. Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator"/> class.
  8668. </summary>
  8669. <remarks>
  8670. <para>
  8671. Uses a private access modifier to prevent instantiation of this class.
  8672. </para>
  8673. </remarks>
  8674. </member>
  8675. <member name="M:log4net.Config.BasicConfigurator.Configure">
  8676. <summary>
  8677. Initializes the log4net system with a default configuration.
  8678. </summary>
  8679. <remarks>
  8680. <para>
  8681. Initializes the log4net logging system using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  8682. that will write to <c>Console.Out</c>. The log messages are
  8683. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  8684. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  8685. layout style.
  8686. </para>
  8687. </remarks>
  8688. </member>
  8689. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender[])">
  8690. <summary>
  8691. Initializes the log4net system using the specified appenders.
  8692. </summary>
  8693. <param name="appenders">The appenders to use to log all logging events.</param>
  8694. <remarks>
  8695. <para>
  8696. Initializes the log4net system using the specified appenders.
  8697. </para>
  8698. </remarks>
  8699. </member>
  8700. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender)">
  8701. <summary>
  8702. Initializes the log4net system using the specified appender.
  8703. </summary>
  8704. <param name="appender">The appender to use to log all logging events.</param>
  8705. <remarks>
  8706. <para>
  8707. Initializes the log4net system using the specified appender.
  8708. </para>
  8709. </remarks>
  8710. </member>
  8711. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8712. <summary>
  8713. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration.
  8714. </summary>
  8715. <param name="repository">The repository to configure.</param>
  8716. <remarks>
  8717. <para>
  8718. Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  8719. that will write to <c>Console.Out</c>. The log messages are
  8720. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  8721. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  8722. layout style.
  8723. </para>
  8724. </remarks>
  8725. </member>
  8726. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)">
  8727. <summary>
  8728. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8729. </summary>
  8730. <param name="repository">The repository to configure.</param>
  8731. <param name="appender">The appender to use to log all logging events.</param>
  8732. <remarks>
  8733. <para>
  8734. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8735. </para>
  8736. </remarks>
  8737. </member>
  8738. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender[])">
  8739. <summary>
  8740. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appenders.
  8741. </summary>
  8742. <param name="repository">The repository to configure.</param>
  8743. <param name="appenders">The appenders to use to log all logging events.</param>
  8744. <remarks>
  8745. <para>
  8746. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8747. </para>
  8748. </remarks>
  8749. </member>
  8750. <member name="T:log4net.Config.ConfiguratorAttribute">
  8751. <summary>
  8752. Base class for all log4net configuration attributes.
  8753. </summary>
  8754. <remarks>
  8755. This is an abstract class that must be extended by
  8756. specific configurators. This attribute allows the
  8757. configurator to be parameterized by an assembly level
  8758. attribute.
  8759. </remarks>
  8760. <author>Nicko Cadell</author>
  8761. <author>Gert Driesen</author>
  8762. </member>
  8763. <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)">
  8764. <summary>
  8765. Constructor used by subclasses.
  8766. </summary>
  8767. <param name="priority">the ordering priority for this configurator</param>
  8768. <remarks>
  8769. <para>
  8770. The <paramref name="priority"/> is used to order the configurator
  8771. attributes before they are invoked. Higher priority configurators are executed
  8772. before lower priority ones.
  8773. </para>
  8774. </remarks>
  8775. </member>
  8776. <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8777. <summary>
  8778. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  8779. </summary>
  8780. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8781. <param name="targetRepository">The repository to configure.</param>
  8782. <remarks>
  8783. <para>
  8784. Abstract method implemented by a subclass. When this method is called
  8785. the subclass should configure the <paramref name="targetRepository"/>.
  8786. </para>
  8787. </remarks>
  8788. </member>
  8789. <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)">
  8790. <summary>
  8791. Compare this instance to another ConfiguratorAttribute
  8792. </summary>
  8793. <param name="obj">the object to compare to</param>
  8794. <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns>
  8795. <remarks>
  8796. <para>
  8797. Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances.
  8798. Sorts by priority in descending order. Objects with the same priority are
  8799. randomly ordered.
  8800. </para>
  8801. </remarks>
  8802. </member>
  8803. <member name="T:log4net.Config.DomainAttribute">
  8804. <summary>
  8805. Assembly level attribute that specifies the logging domain for the assembly.
  8806. </summary>
  8807. <remarks>
  8808. <para>
  8809. <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b>
  8810. </para>
  8811. <para>
  8812. Assemblies are mapped to logging domains. Each domain has its own
  8813. logging repository. This attribute specified on the assembly controls
  8814. the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  8815. of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  8816. specifies the type of the repository objects to create for the domain. If
  8817. this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified
  8818. then the assembly will be part of the default shared logging domain.
  8819. </para>
  8820. <para>
  8821. This attribute can only be specified on the assembly and may only be used
  8822. once per assembly.
  8823. </para>
  8824. </remarks>
  8825. <author>Nicko Cadell</author>
  8826. <author>Gert Driesen</author>
  8827. </member>
  8828. <member name="T:log4net.Config.RepositoryAttribute">
  8829. <summary>
  8830. Assembly level attribute that specifies the logging repository for the assembly.
  8831. </summary>
  8832. <remarks>
  8833. <para>
  8834. Assemblies are mapped to logging repository. This attribute specified
  8835. on the assembly controls
  8836. the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  8837. of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  8838. specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object
  8839. to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/>
  8840. is not specified then the assembly will be part of the default shared logging repository.
  8841. </para>
  8842. <para>
  8843. This attribute can only be specified on the assembly and may only be used
  8844. once per assembly.
  8845. </para>
  8846. </remarks>
  8847. <author>Nicko Cadell</author>
  8848. <author>Gert Driesen</author>
  8849. </member>
  8850. <member name="M:log4net.Config.RepositoryAttribute.#ctor">
  8851. <summary>
  8852. Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class.
  8853. </summary>
  8854. <remarks>
  8855. <para>
  8856. Default constructor.
  8857. </para>
  8858. </remarks>
  8859. </member>
  8860. <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)">
  8861. <summary>
  8862. Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class
  8863. with the name of the repository.
  8864. </summary>
  8865. <param name="name">The name of the repository.</param>
  8866. <remarks>
  8867. <para>
  8868. Initialize the attribute with the name for the assembly's repository.
  8869. </para>
  8870. </remarks>
  8871. </member>
  8872. <member name="P:log4net.Config.RepositoryAttribute.Name">
  8873. <summary>
  8874. Gets or sets the name of the logging repository.
  8875. </summary>
  8876. <value>
  8877. The string name to use as the name of the repository associated with this
  8878. assembly.
  8879. </value>
  8880. <remarks>
  8881. <para>
  8882. This value does not have to be unique. Several assemblies can share the
  8883. same repository. They will share the logging configuration of the repository.
  8884. </para>
  8885. </remarks>
  8886. </member>
  8887. <member name="P:log4net.Config.RepositoryAttribute.RepositoryType">
  8888. <summary>
  8889. Gets or sets the type of repository to create for this assembly.
  8890. </summary>
  8891. <value>
  8892. The type of repository to create for this assembly.
  8893. </value>
  8894. <remarks>
  8895. <para>
  8896. The type of the repository to create for the assembly.
  8897. The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/>
  8898. interface.
  8899. </para>
  8900. <para>
  8901. This will be the type of repository created when
  8902. the repository is created. If multiple assemblies reference the
  8903. same repository then the repository is only created once using the
  8904. <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> of the first assembly to call into the
  8905. repository.
  8906. </para>
  8907. </remarks>
  8908. </member>
  8909. <member name="M:log4net.Config.DomainAttribute.#ctor">
  8910. <summary>
  8911. Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class.
  8912. </summary>
  8913. <remarks>
  8914. <para>
  8915. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8916. </para>
  8917. </remarks>
  8918. </member>
  8919. <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)">
  8920. <summary>
  8921. Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class
  8922. with the name of the domain.
  8923. </summary>
  8924. <param name="name">The name of the domain.</param>
  8925. <remarks>
  8926. <para>
  8927. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8928. </para>
  8929. </remarks>
  8930. </member>
  8931. <member name="T:log4net.Config.DOMConfigurator">
  8932. <summary>
  8933. Use this class to initialize the log4net environment using an Xml tree.
  8934. </summary>
  8935. <remarks>
  8936. <para>
  8937. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8938. </para>
  8939. <para>
  8940. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  8941. </para>
  8942. </remarks>
  8943. <author>Nicko Cadell</author>
  8944. <author>Gert Driesen</author>
  8945. </member>
  8946. <member name="M:log4net.Config.DOMConfigurator.#ctor">
  8947. <summary>
  8948. Private constructor
  8949. </summary>
  8950. </member>
  8951. <member name="M:log4net.Config.DOMConfigurator.Configure">
  8952. <summary>
  8953. Automatically configures the log4net system based on the
  8954. application's configuration settings.
  8955. </summary>
  8956. <remarks>
  8957. <para>
  8958. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8959. </para>
  8960. Each application has a configuration file. This has the
  8961. same name as the application with '.config' appended.
  8962. This file is XML and calling this function prompts the
  8963. configurator to look in that file for a section called
  8964. <c>log4net</c> that contains the configuration data.
  8965. </remarks>
  8966. </member>
  8967. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8968. <summary>
  8969. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  8970. stored in the application's configuration file.
  8971. </summary>
  8972. <remarks>
  8973. <para>
  8974. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8975. </para>
  8976. Each application has a configuration file. This has the
  8977. same name as the application with '.config' appended.
  8978. This file is XML and calling this function prompts the
  8979. configurator to look in that file for a section called
  8980. <c>log4net</c> that contains the configuration data.
  8981. </remarks>
  8982. <param name="repository">The repository to configure.</param>
  8983. </member>
  8984. <member name="M:log4net.Config.DOMConfigurator.Configure(System.Xml.XmlElement)">
  8985. <summary>
  8986. Configures log4net using a <c>log4net</c> element
  8987. </summary>
  8988. <remarks>
  8989. <para>
  8990. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8991. </para>
  8992. Loads the log4net configuration from the XML element
  8993. supplied as <paramref name="element"/>.
  8994. </remarks>
  8995. <param name="element">The element to parse.</param>
  8996. </member>
  8997. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  8998. <summary>
  8999. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  9000. element.
  9001. </summary>
  9002. <remarks>
  9003. <para>
  9004. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9005. </para>
  9006. Loads the log4net configuration from the XML element
  9007. supplied as <paramref name="element"/>.
  9008. </remarks>
  9009. <param name="repository">The repository to configure.</param>
  9010. <param name="element">The element to parse.</param>
  9011. </member>
  9012. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)">
  9013. <summary>
  9014. Configures log4net using the specified configuration file.
  9015. </summary>
  9016. <param name="configFile">The XML file to load the configuration from.</param>
  9017. <remarks>
  9018. <para>
  9019. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9020. </para>
  9021. <para>
  9022. The configuration file must be valid XML. It must contain
  9023. at least one element called <c>log4net</c> that holds
  9024. the log4net configuration data.
  9025. </para>
  9026. <para>
  9027. The log4net configuration file can possible be specified in the application's
  9028. configuration file (either <c>MyAppName.exe.config</c> for a
  9029. normal application on <c>Web.config</c> for an ASP.NET application).
  9030. </para>
  9031. <example>
  9032. The following example configures log4net using a configuration file, of which the
  9033. location is stored in the application's configuration file :
  9034. </example>
  9035. <code lang="C#">
  9036. using log4net.Config;
  9037. using System.IO;
  9038. using System.Configuration;
  9039. ...
  9040. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9041. </code>
  9042. <para>
  9043. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9044. </para>
  9045. <code lang="XML" escaped="true">
  9046. <configuration>
  9047. <appSettings>
  9048. <add key="log4net-config-file" value="log.config"/>
  9049. </appSettings>
  9050. </configuration>
  9051. </code>
  9052. </remarks>
  9053. </member>
  9054. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.Stream)">
  9055. <summary>
  9056. Configures log4net using the specified configuration file.
  9057. </summary>
  9058. <param name="configStream">A stream to load the XML configuration from.</param>
  9059. <remarks>
  9060. <para>
  9061. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9062. </para>
  9063. <para>
  9064. The configuration data must be valid XML. It must contain
  9065. at least one element called <c>log4net</c> that holds
  9066. the log4net configuration data.
  9067. </para>
  9068. <para>
  9069. Note that this method will NOT close the stream parameter.
  9070. </para>
  9071. </remarks>
  9072. </member>
  9073. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9074. <summary>
  9075. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9076. file.
  9077. </summary>
  9078. <param name="repository">The repository to configure.</param>
  9079. <param name="configFile">The XML file to load the configuration from.</param>
  9080. <remarks>
  9081. <para>
  9082. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9083. </para>
  9084. <para>
  9085. The configuration file must be valid XML. It must contain
  9086. at least one element called <c>log4net</c> that holds
  9087. the configuration data.
  9088. </para>
  9089. <para>
  9090. The log4net configuration file can possible be specified in the application's
  9091. configuration file (either <c>MyAppName.exe.config</c> for a
  9092. normal application on <c>Web.config</c> for an ASP.NET application).
  9093. </para>
  9094. <example>
  9095. The following example configures log4net using a configuration file, of which the
  9096. location is stored in the application's configuration file :
  9097. </example>
  9098. <code lang="C#">
  9099. using log4net.Config;
  9100. using System.IO;
  9101. using System.Configuration;
  9102. ...
  9103. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9104. </code>
  9105. <para>
  9106. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9107. </para>
  9108. <code lang="XML" escaped="true">
  9109. <configuration>
  9110. <appSettings>
  9111. <add key="log4net-config-file" value="log.config"/>
  9112. </appSettings>
  9113. </configuration>
  9114. </code>
  9115. </remarks>
  9116. </member>
  9117. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  9118. <summary>
  9119. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9120. file.
  9121. </summary>
  9122. <param name="repository">The repository to configure.</param>
  9123. <param name="configStream">The stream to load the XML configuration from.</param>
  9124. <remarks>
  9125. <para>
  9126. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9127. </para>
  9128. <para>
  9129. The configuration data must be valid XML. It must contain
  9130. at least one element called <c>log4net</c> that holds
  9131. the configuration data.
  9132. </para>
  9133. <para>
  9134. Note that this method will NOT close the stream parameter.
  9135. </para>
  9136. </remarks>
  9137. </member>
  9138. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  9139. <summary>
  9140. Configures log4net using the file specified, monitors the file for changes
  9141. and reloads the configuration if a change is detected.
  9142. </summary>
  9143. <param name="configFile">The XML file to load the configuration from.</param>
  9144. <remarks>
  9145. <para>
  9146. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9147. </para>
  9148. <para>
  9149. The configuration file must be valid XML. It must contain
  9150. at least one element called <c>log4net</c> that holds
  9151. the configuration data.
  9152. </para>
  9153. <para>
  9154. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9155. and depends on the behavior of that class.
  9156. </para>
  9157. <para>
  9158. For more information on how to configure log4net using
  9159. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9160. </para>
  9161. </remarks>
  9162. <seealso cref="M:Configure(FileInfo)"/>
  9163. </member>
  9164. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9165. <summary>
  9166. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  9167. monitors the file for changes and reloads the configuration if a change
  9168. is detected.
  9169. </summary>
  9170. <param name="repository">The repository to configure.</param>
  9171. <param name="configFile">The XML file to load the configuration from.</param>
  9172. <remarks>
  9173. <para>
  9174. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  9175. </para>
  9176. <para>
  9177. The configuration file must be valid XML. It must contain
  9178. at least one element called <c>log4net</c> that holds
  9179. the configuration data.
  9180. </para>
  9181. <para>
  9182. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9183. and depends on the behavior of that class.
  9184. </para>
  9185. <para>
  9186. For more information on how to configure log4net using
  9187. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9188. </para>
  9189. </remarks>
  9190. <seealso cref="M:Configure(FileInfo)"/>
  9191. </member>
  9192. <member name="T:log4net.Config.DOMConfiguratorAttribute">
  9193. <summary>
  9194. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  9195. </summary>
  9196. <remarks>
  9197. <para>
  9198. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  9199. </para>
  9200. <para>
  9201. This attribute may only be used at the assembly scope and can only
  9202. be used once per assembly.
  9203. </para>
  9204. <para>
  9205. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9206. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9207. methods.
  9208. </para>
  9209. </remarks>
  9210. <author>Nicko Cadell</author>
  9211. <author>Gert Driesen</author>
  9212. </member>
  9213. <member name="T:log4net.Config.XmlConfiguratorAttribute">
  9214. <summary>
  9215. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  9216. </summary>
  9217. <remarks>
  9218. <para>
  9219. This attribute may only be used at the assembly scope and can only
  9220. be used once per assembly.
  9221. </para>
  9222. <para>
  9223. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9224. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9225. methods.
  9226. </para>
  9227. <para>
  9228. If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>
  9229. properties are set the configuration is loaded from the application's .config file.
  9230. If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the
  9231. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property
  9232. specifies a path to a file to load the config from. The path is relative to the
  9233. application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  9234. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name.
  9235. The config file must be located in the application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  9236. For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to
  9237. <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or
  9238. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties.
  9239. </para>
  9240. <para>
  9241. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/>
  9242. to watch the configuration file for changes.
  9243. </para>
  9244. <note>
  9245. <para>
  9246. Log4net will only look for assembly level configuration attributes once.
  9247. When using the log4net assembly level attributes to control the configuration
  9248. of log4net you must ensure that the first call to any of the
  9249. <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration
  9250. attributes.
  9251. </para>
  9252. <para>
  9253. If you cannot guarantee the order in which log4net calls will be made from
  9254. different assemblies you must use programmatic configuration instead, i.e.
  9255. call the <see cref="M:XmlConfigurator.Configure()"/> method directly.
  9256. </para>
  9257. </note>
  9258. </remarks>
  9259. <author>Nicko Cadell</author>
  9260. <author>Gert Driesen</author>
  9261. </member>
  9262. <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor">
  9263. <summary>
  9264. Default constructor
  9265. </summary>
  9266. <remarks>
  9267. <para>
  9268. Default constructor
  9269. </para>
  9270. </remarks>
  9271. </member>
  9272. <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9273. <summary>
  9274. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9275. </summary>
  9276. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9277. <param name="targetRepository">The repository to configure.</param>
  9278. <remarks>
  9279. <para>
  9280. Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>.
  9281. The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  9282. class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to
  9283. configure it.
  9284. </para>
  9285. </remarks>
  9286. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetRepository"/> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception>
  9287. </member>
  9288. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9289. <summary>
  9290. Attempt to load configuration from the local file system
  9291. </summary>
  9292. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9293. <param name="targetRepository">The repository to configure.</param>
  9294. </member>
  9295. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9296. <summary>
  9297. Configure the specified repository using a <see cref="T:System.IO.FileInfo"/>
  9298. </summary>
  9299. <param name="targetRepository">The repository to configure.</param>
  9300. <param name="configFile">the FileInfo pointing to the config file</param>
  9301. </member>
  9302. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9303. <summary>
  9304. Attempt to load configuration from a URI
  9305. </summary>
  9306. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9307. <param name="targetRepository">The repository to configure.</param>
  9308. </member>
  9309. <member name="F:log4net.Config.XmlConfiguratorAttribute.declaringType">
  9310. <summary>
  9311. The fully qualified type of the XmlConfiguratorAttribute class.
  9312. </summary>
  9313. <remarks>
  9314. Used by the internal logger to record the Type of the
  9315. log message.
  9316. </remarks>
  9317. </member>
  9318. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile">
  9319. <summary>
  9320. Gets or sets the filename of the configuration file.
  9321. </summary>
  9322. <value>
  9323. The filename of the configuration file.
  9324. </value>
  9325. <remarks>
  9326. <para>
  9327. If specified, this is the name of the configuration file to use with
  9328. the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the
  9329. <b>application base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>).
  9330. </para>
  9331. <para>
  9332. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  9333. </para>
  9334. </remarks>
  9335. </member>
  9336. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension">
  9337. <summary>
  9338. Gets or sets the extension of the configuration file.
  9339. </summary>
  9340. <value>
  9341. The extension of the configuration file.
  9342. </value>
  9343. <remarks>
  9344. <para>
  9345. If specified this is the extension for the configuration file.
  9346. The path to the config file is built by using the <b>application
  9347. base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>),
  9348. the <b>assembly file name</b> and the config file extension.
  9349. </para>
  9350. <para>
  9351. If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then
  9352. possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or
  9353. <c>MyClassLibrary.dll.MyExt</c>.
  9354. </para>
  9355. <para>
  9356. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  9357. </para>
  9358. </remarks>
  9359. </member>
  9360. <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch">
  9361. <summary>
  9362. Gets or sets a value indicating whether to watch the configuration file.
  9363. </summary>
  9364. <value>
  9365. <c>true</c> if the configuration should be watched, <c>false</c> otherwise.
  9366. </value>
  9367. <remarks>
  9368. <para>
  9369. If this flag is specified and set to <c>true</c> then the framework
  9370. will watch the configuration file and will reload the config each time
  9371. the file is modified.
  9372. </para>
  9373. <para>
  9374. The config file can only be watched if it is loaded from local disk.
  9375. In a No-Touch (Smart Client) deployment where the application is downloaded
  9376. from a web server the config file may not reside on the local disk
  9377. and therefore it may not be able to watch it.
  9378. </para>
  9379. <note>
  9380. Watching configuration is not supported on the SSCLI.
  9381. </note>
  9382. </remarks>
  9383. </member>
  9384. <member name="T:log4net.Config.Log4NetConfigurationSectionHandler">
  9385. <summary>
  9386. Class to register for the log4net section of the configuration file
  9387. </summary>
  9388. <remarks>
  9389. The log4net section of the configuration file needs to have a section
  9390. handler registered. This is the section handler used. It simply returns
  9391. the XML element that is the root of the section.
  9392. </remarks>
  9393. <example>
  9394. Example of registering the log4net section handler :
  9395. <code lang="XML" escaped="true">
  9396. <configuration>
  9397. <configSections>
  9398. <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  9399. </configSections>
  9400. <log4net>
  9401. log4net configuration XML goes here
  9402. </log4net>
  9403. </configuration>
  9404. </code>
  9405. </example>
  9406. <author>Nicko Cadell</author>
  9407. <author>Gert Driesen</author>
  9408. </member>
  9409. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.#ctor">
  9410. <summary>
  9411. Initializes a new instance of the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> class.
  9412. </summary>
  9413. <remarks>
  9414. <para>
  9415. Default constructor.
  9416. </para>
  9417. </remarks>
  9418. </member>
  9419. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.Create(System.Object,System.Object,System.Xml.XmlNode)">
  9420. <summary>
  9421. Parses the configuration section.
  9422. </summary>
  9423. <param name="parent">The configuration settings in a corresponding parent configuration section.</param>
  9424. <param name="configContext">The configuration context when called from the ASP.NET configuration system. Otherwise, this parameter is reserved and is a null reference.</param>
  9425. <param name="section">The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</param>
  9426. <returns>The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</returns>
  9427. <remarks>
  9428. <para>
  9429. Returns the <see cref="T:System.Xml.XmlNode"/> containing the configuration data,
  9430. </para>
  9431. </remarks>
  9432. </member>
  9433. <member name="T:log4net.Config.PluginAttribute">
  9434. <summary>
  9435. Assembly level attribute that specifies a plugin to attach to
  9436. the repository.
  9437. </summary>
  9438. <remarks>
  9439. <para>
  9440. Specifies the type of a plugin to create and attach to the
  9441. assembly's repository. The plugin type must implement the
  9442. <see cref="T:log4net.Plugin.IPlugin"/> interface.
  9443. </para>
  9444. </remarks>
  9445. <author>Nicko Cadell</author>
  9446. <author>Gert Driesen</author>
  9447. </member>
  9448. <member name="T:log4net.Plugin.IPluginFactory">
  9449. <summary>
  9450. Interface used to create plugins.
  9451. </summary>
  9452. <remarks>
  9453. <para>
  9454. Interface used to create a plugin.
  9455. </para>
  9456. </remarks>
  9457. <author>Nicko Cadell</author>
  9458. <author>Gert Driesen</author>
  9459. </member>
  9460. <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin">
  9461. <summary>
  9462. Creates the plugin object.
  9463. </summary>
  9464. <returns>the new plugin instance</returns>
  9465. <remarks>
  9466. <para>
  9467. Create and return a new plugin instance.
  9468. </para>
  9469. </remarks>
  9470. </member>
  9471. <member name="M:log4net.Config.PluginAttribute.#ctor(System.String)">
  9472. <summary>
  9473. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
  9474. with the specified type.
  9475. </summary>
  9476. <param name="typeName">The type name of plugin to create.</param>
  9477. <remarks>
  9478. <para>
  9479. Create the attribute with the plugin type specified.
  9480. </para>
  9481. <para>
  9482. Where possible use the constructor that takes a <see cref="T:System.Type"/>.
  9483. </para>
  9484. </remarks>
  9485. </member>
  9486. <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
  9487. <summary>
  9488. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
  9489. with the specified type.
  9490. </summary>
  9491. <param name="type">The type of plugin to create.</param>
  9492. <remarks>
  9493. <para>
  9494. Create the attribute with the plugin type specified.
  9495. </para>
  9496. </remarks>
  9497. </member>
  9498. <member name="M:log4net.Config.PluginAttribute.CreatePlugin">
  9499. <summary>
  9500. Creates the plugin object defined by this attribute.
  9501. </summary>
  9502. <remarks>
  9503. <para>
  9504. Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as
  9505. specified by this attribute.
  9506. </para>
  9507. </remarks>
  9508. <returns>The plugin object.</returns>
  9509. </member>
  9510. <member name="M:log4net.Config.PluginAttribute.ToString">
  9511. <summary>
  9512. Returns a representation of the properties of this object.
  9513. </summary>
  9514. <remarks>
  9515. <para>
  9516. Overrides base class <see cref="M:Object.ToString()" /> method to
  9517. return a representation of the properties of this object.
  9518. </para>
  9519. </remarks>
  9520. <returns>A representation of the properties of this object</returns>
  9521. </member>
  9522. <member name="P:log4net.Config.PluginAttribute.Type">
  9523. <summary>
  9524. Gets or sets the type for the plugin.
  9525. </summary>
  9526. <value>
  9527. The type for the plugin.
  9528. </value>
  9529. <remarks>
  9530. <para>
  9531. The type for the plugin.
  9532. </para>
  9533. </remarks>
  9534. </member>
  9535. <member name="P:log4net.Config.PluginAttribute.TypeName">
  9536. <summary>
  9537. Gets or sets the type name for the plugin.
  9538. </summary>
  9539. <value>
  9540. The type name for the plugin.
  9541. </value>
  9542. <remarks>
  9543. <para>
  9544. The type name for the plugin.
  9545. </para>
  9546. <para>
  9547. Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
  9548. </para>
  9549. </remarks>
  9550. </member>
  9551. <member name="T:log4net.Config.SecurityContextProviderAttribute">
  9552. <summary>
  9553. Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>.
  9554. </summary>
  9555. <remarks>
  9556. <para>
  9557. This attribute may only be used at the assembly scope and can only
  9558. be used once per assembly.
  9559. </para>
  9560. <para>
  9561. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9562. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9563. methods.
  9564. </para>
  9565. </remarks>
  9566. <author>Nicko Cadell</author>
  9567. </member>
  9568. <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)">
  9569. <summary>
  9570. Construct provider attribute with type specified
  9571. </summary>
  9572. <param name="providerType">the type of the provider to use</param>
  9573. <remarks>
  9574. <para>
  9575. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  9576. class.
  9577. </para>
  9578. </remarks>
  9579. </member>
  9580. <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9581. <summary>
  9582. Configures the SecurityContextProvider
  9583. </summary>
  9584. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9585. <param name="targetRepository">The repository to configure.</param>
  9586. <remarks>
  9587. <para>
  9588. Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified.
  9589. Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>.
  9590. </para>
  9591. </remarks>
  9592. </member>
  9593. <member name="F:log4net.Config.SecurityContextProviderAttribute.declaringType">
  9594. <summary>
  9595. The fully qualified type of the SecurityContextProviderAttribute class.
  9596. </summary>
  9597. <remarks>
  9598. Used by the internal logger to record the Type of the
  9599. log message.
  9600. </remarks>
  9601. </member>
  9602. <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType">
  9603. <summary>
  9604. Gets or sets the type of the provider to use.
  9605. </summary>
  9606. <value>
  9607. the type of the provider to use.
  9608. </value>
  9609. <remarks>
  9610. <para>
  9611. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  9612. class.
  9613. </para>
  9614. </remarks>
  9615. </member>
  9616. <member name="T:log4net.Config.XmlConfigurator">
  9617. <summary>
  9618. Use this class to initialize the log4net environment using an Xml tree.
  9619. </summary>
  9620. <remarks>
  9621. <para>
  9622. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  9623. </para>
  9624. </remarks>
  9625. <author>Nicko Cadell</author>
  9626. <author>Gert Driesen</author>
  9627. </member>
  9628. <member name="M:log4net.Config.XmlConfigurator.#ctor">
  9629. <summary>
  9630. Private constructor
  9631. </summary>
  9632. </member>
  9633. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  9634. <summary>
  9635. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  9636. stored in the application's configuration file.
  9637. </summary>
  9638. <remarks>
  9639. <para>
  9640. Each application has a configuration file. This has the
  9641. same name as the application with '.config' appended.
  9642. This file is XML and calling this function prompts the
  9643. configurator to look in that file for a section called
  9644. <c>log4net</c> that contains the configuration data.
  9645. </para>
  9646. <para>
  9647. To use this method to configure log4net you must specify
  9648. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  9649. handler for the <c>log4net</c> configuration section. See the
  9650. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  9651. </para>
  9652. </remarks>
  9653. <param name="repository">The repository to configure.</param>
  9654. </member>
  9655. <member name="M:log4net.Config.XmlConfigurator.Configure">
  9656. <summary>
  9657. Automatically configures the log4net system based on the
  9658. application's configuration settings.
  9659. </summary>
  9660. <remarks>
  9661. <para>
  9662. Each application has a configuration file. This has the
  9663. same name as the application with '.config' appended.
  9664. This file is XML and calling this function prompts the
  9665. configurator to look in that file for a section called
  9666. <c>log4net</c> that contains the configuration data.
  9667. </para>
  9668. <para>
  9669. To use this method to configure log4net you must specify
  9670. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  9671. handler for the <c>log4net</c> configuration section. See the
  9672. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  9673. </para>
  9674. </remarks>
  9675. <seealso cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/>
  9676. </member>
  9677. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Xml.XmlElement)">
  9678. <summary>
  9679. Configures log4net using a <c>log4net</c> element
  9680. </summary>
  9681. <remarks>
  9682. <para>
  9683. Loads the log4net configuration from the XML element
  9684. supplied as <paramref name="element"/>.
  9685. </para>
  9686. </remarks>
  9687. <param name="element">The element to parse.</param>
  9688. </member>
  9689. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)">
  9690. <summary>
  9691. Configures log4net using the specified configuration file.
  9692. </summary>
  9693. <param name="configFile">The XML file to load the configuration from.</param>
  9694. <remarks>
  9695. <para>
  9696. The configuration file must be valid XML. It must contain
  9697. at least one element called <c>log4net</c> that holds
  9698. the log4net configuration data.
  9699. </para>
  9700. <para>
  9701. The log4net configuration file can possible be specified in the application's
  9702. configuration file (either <c>MyAppName.exe.config</c> for a
  9703. normal application on <c>Web.config</c> for an ASP.NET application).
  9704. </para>
  9705. <para>
  9706. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  9707. configuration. If this file is also a .NET .config file then you must specify
  9708. a configuration section for the <c>log4net</c> element otherwise .NET will
  9709. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  9710. <code lang="XML" escaped="true">
  9711. <configSections>
  9712. <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
  9713. </configSections>
  9714. </code>
  9715. </para>
  9716. <example>
  9717. The following example configures log4net using a configuration file, of which the
  9718. location is stored in the application's configuration file :
  9719. </example>
  9720. <code lang="C#">
  9721. using log4net.Config;
  9722. using System.IO;
  9723. using System.Configuration;
  9724. ...
  9725. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9726. </code>
  9727. <para>
  9728. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9729. </para>
  9730. <code lang="XML" escaped="true">
  9731. <configuration>
  9732. <appSettings>
  9733. <add key="log4net-config-file" value="log.config"/>
  9734. </appSettings>
  9735. </configuration>
  9736. </code>
  9737. </remarks>
  9738. </member>
  9739. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Uri)">
  9740. <summary>
  9741. Configures log4net using the specified configuration URI.
  9742. </summary>
  9743. <param name="configUri">A URI to load the XML configuration from.</param>
  9744. <remarks>
  9745. <para>
  9746. The configuration data must be valid XML. It must contain
  9747. at least one element called <c>log4net</c> that holds
  9748. the log4net configuration data.
  9749. </para>
  9750. <para>
  9751. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  9752. </para>
  9753. </remarks>
  9754. </member>
  9755. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.Stream)">
  9756. <summary>
  9757. Configures log4net using the specified configuration data stream.
  9758. </summary>
  9759. <param name="configStream">A stream to load the XML configuration from.</param>
  9760. <remarks>
  9761. <para>
  9762. The configuration data must be valid XML. It must contain
  9763. at least one element called <c>log4net</c> that holds
  9764. the log4net configuration data.
  9765. </para>
  9766. <para>
  9767. Note that this method will NOT close the stream parameter.
  9768. </para>
  9769. </remarks>
  9770. </member>
  9771. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9772. <summary>
  9773. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  9774. element.
  9775. </summary>
  9776. <remarks>
  9777. Loads the log4net configuration from the XML element
  9778. supplied as <paramref name="element"/>.
  9779. </remarks>
  9780. <param name="repository">The repository to configure.</param>
  9781. <param name="element">The element to parse.</param>
  9782. </member>
  9783. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9784. <summary>
  9785. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9786. file.
  9787. </summary>
  9788. <param name="repository">The repository to configure.</param>
  9789. <param name="configFile">The XML file to load the configuration from.</param>
  9790. <remarks>
  9791. <para>
  9792. The configuration file must be valid XML. It must contain
  9793. at least one element called <c>log4net</c> that holds
  9794. the configuration data.
  9795. </para>
  9796. <para>
  9797. The log4net configuration file can possible be specified in the application's
  9798. configuration file (either <c>MyAppName.exe.config</c> for a
  9799. normal application on <c>Web.config</c> for an ASP.NET application).
  9800. </para>
  9801. <para>
  9802. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  9803. configuration. If this file is also a .NET .config file then you must specify
  9804. a configuration section for the <c>log4net</c> element otherwise .NET will
  9805. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  9806. <code lang="XML" escaped="true">
  9807. <configSections>
  9808. <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
  9809. </configSections>
  9810. </code>
  9811. </para>
  9812. <example>
  9813. The following example configures log4net using a configuration file, of which the
  9814. location is stored in the application's configuration file :
  9815. </example>
  9816. <code lang="C#">
  9817. using log4net.Config;
  9818. using System.IO;
  9819. using System.Configuration;
  9820. ...
  9821. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9822. </code>
  9823. <para>
  9824. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9825. </para>
  9826. <code lang="XML" escaped="true">
  9827. <configuration>
  9828. <appSettings>
  9829. <add key="log4net-config-file" value="log.config"/>
  9830. </appSettings>
  9831. </configuration>
  9832. </code>
  9833. </remarks>
  9834. </member>
  9835. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)">
  9836. <summary>
  9837. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9838. URI.
  9839. </summary>
  9840. <param name="repository">The repository to configure.</param>
  9841. <param name="configUri">A URI to load the XML configuration from.</param>
  9842. <remarks>
  9843. <para>
  9844. The configuration data must be valid XML. It must contain
  9845. at least one element called <c>log4net</c> that holds
  9846. the configuration data.
  9847. </para>
  9848. <para>
  9849. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  9850. </para>
  9851. </remarks>
  9852. </member>
  9853. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  9854. <summary>
  9855. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9856. file.
  9857. </summary>
  9858. <param name="repository">The repository to configure.</param>
  9859. <param name="configStream">The stream to load the XML configuration from.</param>
  9860. <remarks>
  9861. <para>
  9862. The configuration data must be valid XML. It must contain
  9863. at least one element called <c>log4net</c> that holds
  9864. the configuration data.
  9865. </para>
  9866. <para>
  9867. Note that this method will NOT close the stream parameter.
  9868. </para>
  9869. </remarks>
  9870. </member>
  9871. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  9872. <summary>
  9873. Configures log4net using the file specified, monitors the file for changes
  9874. and reloads the configuration if a change is detected.
  9875. </summary>
  9876. <param name="configFile">The XML file to load the configuration from.</param>
  9877. <remarks>
  9878. <para>
  9879. The configuration file must be valid XML. It must contain
  9880. at least one element called <c>log4net</c> that holds
  9881. the configuration data.
  9882. </para>
  9883. <para>
  9884. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9885. and depends on the behavior of that class.
  9886. </para>
  9887. <para>
  9888. For more information on how to configure log4net using
  9889. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9890. </para>
  9891. </remarks>
  9892. <seealso cref="M:Configure(FileInfo)"/>
  9893. </member>
  9894. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9895. <summary>
  9896. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  9897. monitors the file for changes and reloads the configuration if a change
  9898. is detected.
  9899. </summary>
  9900. <param name="repository">The repository to configure.</param>
  9901. <param name="configFile">The XML file to load the configuration from.</param>
  9902. <remarks>
  9903. <para>
  9904. The configuration file must be valid XML. It must contain
  9905. at least one element called <c>log4net</c> that holds
  9906. the configuration data.
  9907. </para>
  9908. <para>
  9909. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9910. and depends on the behavior of that class.
  9911. </para>
  9912. <para>
  9913. For more information on how to configure log4net using
  9914. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9915. </para>
  9916. </remarks>
  9917. <seealso cref="M:Configure(FileInfo)"/>
  9918. </member>
  9919. <member name="M:log4net.Config.XmlConfigurator.InternalConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9920. <summary>
  9921. Configures the specified repository using a <c>log4net</c> element.
  9922. </summary>
  9923. <param name="repository">The hierarchy to configure.</param>
  9924. <param name="element">The element to parse.</param>
  9925. <remarks>
  9926. <para>
  9927. Loads the log4net configuration from the XML element
  9928. supplied as <paramref name="element"/>.
  9929. </para>
  9930. <para>
  9931. This method is ultimately called by one of the Configure methods
  9932. to load the configuration from an <see cref="T:System.Xml.XmlElement"/>.
  9933. </para>
  9934. </remarks>
  9935. </member>
  9936. <member name="F:log4net.Config.XmlConfigurator.m_repositoryName2ConfigAndWatchHandler">
  9937. <summary>
  9938. Maps repository names to ConfigAndWatchHandler instances to allow a particular
  9939. ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is
  9940. reconfigured.
  9941. </summary>
  9942. </member>
  9943. <member name="F:log4net.Config.XmlConfigurator.declaringType">
  9944. <summary>
  9945. The fully qualified type of the XmlConfigurator class.
  9946. </summary>
  9947. <remarks>
  9948. Used by the internal logger to record the Type of the
  9949. log message.
  9950. </remarks>
  9951. </member>
  9952. <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler">
  9953. <summary>
  9954. Class used to watch config files.
  9955. </summary>
  9956. <remarks>
  9957. <para>
  9958. Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor
  9959. changes to a specified file. Because multiple change notifications
  9960. may be raised when the file is modified, a timer is used to
  9961. compress the notifications into a single event. The timer
  9962. waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering
  9963. the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/>
  9964. change notifications arrive while the timer is waiting it
  9965. is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to
  9966. elapse.
  9967. </para>
  9968. </remarks>
  9969. </member>
  9970. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis">
  9971. <summary>
  9972. The default amount of time to wait after receiving notification
  9973. before reloading the config file.
  9974. </summary>
  9975. </member>
  9976. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile">
  9977. <summary>
  9978. Holds the FileInfo used to configure the XmlConfigurator
  9979. </summary>
  9980. </member>
  9981. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository">
  9982. <summary>
  9983. Holds the repository being configured.
  9984. </summary>
  9985. </member>
  9986. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer">
  9987. <summary>
  9988. The timer used to compress the notification events.
  9989. </summary>
  9990. </member>
  9991. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_watcher">
  9992. <summary>
  9993. Watches file for changes. This object should be disposed when no longer
  9994. needed to free system handles on the watched resources.
  9995. </summary>
  9996. </member>
  9997. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9998. <summary>
  9999. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class to
  10000. watch a specified config file used to configure a repository.
  10001. </summary>
  10002. <param name="repository">The repository to configure.</param>
  10003. <param name="configFile">The configuration file to watch.</param>
  10004. <remarks>
  10005. <para>
  10006. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class.
  10007. </para>
  10008. </remarks>
  10009. </member>
  10010. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)">
  10011. <summary>
  10012. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  10013. </summary>
  10014. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  10015. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  10016. <remarks>
  10017. <para>
  10018. This handler reloads the configuration from the file when the event is fired.
  10019. </para>
  10020. </remarks>
  10021. </member>
  10022. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)">
  10023. <summary>
  10024. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  10025. </summary>
  10026. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  10027. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  10028. <remarks>
  10029. <para>
  10030. This handler reloads the configuration from the file when the event is fired.
  10031. </para>
  10032. </remarks>
  10033. </member>
  10034. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)">
  10035. <summary>
  10036. Called by the timer when the configuration has been updated.
  10037. </summary>
  10038. <param name="state">null</param>
  10039. </member>
  10040. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.Dispose">
  10041. <summary>
  10042. Release the handles held by the watcher and timer.
  10043. </summary>
  10044. </member>
  10045. <member name="T:log4net.Core.CompactRepositorySelector">
  10046. <summary>
  10047. The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable
  10048. for use with the compact framework
  10049. </summary>
  10050. <remarks>
  10051. <para>
  10052. This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple
  10053. mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/>
  10054. object.
  10055. </para>
  10056. <para>
  10057. The .NET Compact Framework 1.0 does not support retrieving assembly
  10058. level attributes therefore unlike the <c>DefaultRepositorySelector</c>
  10059. this selector does not examine the calling assembly for attributes.
  10060. </para>
  10061. </remarks>
  10062. <author>Nicko Cadell</author>
  10063. </member>
  10064. <member name="T:log4net.Core.IRepositorySelector">
  10065. <summary>
  10066. Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10067. </summary>
  10068. <remarks>
  10069. <para>
  10070. The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/>
  10071. to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/>
  10072. to return to the caller.
  10073. </para>
  10074. </remarks>
  10075. <author>Nicko Cadell</author>
  10076. <author>Gert Driesen</author>
  10077. </member>
  10078. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10079. <summary>
  10080. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10081. </summary>
  10082. <param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10083. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns>
  10084. <remarks>
  10085. <para>
  10086. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10087. </para>
  10088. <para>
  10089. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  10090. is made is not defined. The implementation may choose any method for
  10091. this association. The results of this method must be repeatable, i.e.
  10092. when called again with the same arguments the result must be the
  10093. save value.
  10094. </para>
  10095. </remarks>
  10096. </member>
  10097. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)">
  10098. <summary>
  10099. Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10100. </summary>
  10101. <param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10102. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  10103. <remarks>
  10104. Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by
  10105. calling <see cref="M:CreateRepository(string,Type)"/>.
  10106. </remarks>
  10107. </member>
  10108. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10109. <summary>
  10110. Creates a new repository for the assembly specified.
  10111. </summary>
  10112. <param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10113. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10114. <returns>The repository created.</returns>
  10115. <remarks>
  10116. <para>
  10117. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain
  10118. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10119. same assembly specified will return the same repository instance.
  10120. </para>
  10121. <para>
  10122. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  10123. is made is not defined. The implementation may choose any method for
  10124. this association.
  10125. </para>
  10126. </remarks>
  10127. </member>
  10128. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)">
  10129. <summary>
  10130. Creates a new repository with the name specified.
  10131. </summary>
  10132. <param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10133. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10134. <returns>The repository created.</returns>
  10135. <remarks>
  10136. <para>
  10137. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name
  10138. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10139. same name will return the same repository instance.
  10140. </para>
  10141. </remarks>
  10142. </member>
  10143. <member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)">
  10144. <summary>
  10145. Test if a named repository exists
  10146. </summary>
  10147. <param name="repositoryName">the named repository to check</param>
  10148. <returns><c>true</c> if the repository exists</returns>
  10149. <remarks>
  10150. <para>
  10151. Test if a named repository exists. Use <see cref="M:CreateRepository(Assembly, Type)"/>
  10152. to create a new repository and <see cref="M:GetRepository(Assembly)"/> to retrieve
  10153. a repository.
  10154. </para>
  10155. </remarks>
  10156. </member>
  10157. <member name="M:log4net.Core.IRepositorySelector.GetAllRepositories">
  10158. <summary>
  10159. Gets an array of all currently defined repositories.
  10160. </summary>
  10161. <returns>
  10162. An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by
  10163. this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns>
  10164. <remarks>
  10165. <para>
  10166. Gets an array of all of the repositories created by this selector.
  10167. </para>
  10168. </remarks>
  10169. </member>
  10170. <member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent">
  10171. <summary>
  10172. Event to notify that a logger repository has been created.
  10173. </summary>
  10174. <value>
  10175. Event to notify that a logger repository has been created.
  10176. </value>
  10177. <remarks>
  10178. <para>
  10179. Event raised when a new repository is created.
  10180. The event source will be this selector. The event args will
  10181. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  10182. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10183. </para>
  10184. </remarks>
  10185. </member>
  10186. <member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)">
  10187. <summary>
  10188. Create a new repository selector
  10189. </summary>
  10190. <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10191. <remarks>
  10192. <para>
  10193. Create an new compact repository selector.
  10194. The default type for repositories must be specified,
  10195. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  10196. </para>
  10197. </remarks>
  10198. <exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception>
  10199. <exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception>
  10200. </member>
  10201. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10202. <summary>
  10203. Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly
  10204. </summary>
  10205. <param name="assembly">not used</param>
  10206. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  10207. <remarks>
  10208. <para>
  10209. The <paramref name="assembly"/> argument is not used. This selector does not create a
  10210. separate repository for each assembly.
  10211. </para>
  10212. <para>
  10213. As a named repository is not specified the default repository is
  10214. returned. The default repository is named <c>log4net-default-repository</c>.
  10215. </para>
  10216. </remarks>
  10217. </member>
  10218. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)">
  10219. <summary>
  10220. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>
  10221. </summary>
  10222. <param name="repositoryName">the name of the repository to lookup</param>
  10223. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  10224. <remarks>
  10225. <para>
  10226. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default
  10227. repository is <c>log4net-default-repository</c>. Other repositories
  10228. must be created using the <see cref="M:CreateRepository(string, Type)"/>.
  10229. If the named repository does not exist an exception is thrown.
  10230. </para>
  10231. </remarks>
  10232. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  10233. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception>
  10234. </member>
  10235. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10236. <summary>
  10237. Create a new repository for the assembly specified
  10238. </summary>
  10239. <param name="assembly">not used</param>
  10240. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10241. <returns>the repository created</returns>
  10242. <remarks>
  10243. <para>
  10244. The <paramref name="assembly"/> argument is not used. This selector does not create a
  10245. separate repository for each assembly.
  10246. </para>
  10247. <para>
  10248. If the <paramref name="repositoryType"/> is <c>null</c> then the
  10249. default repository type specified to the constructor is used.
  10250. </para>
  10251. <para>
  10252. As a named repository is not specified the default repository is
  10253. returned. The default repository is named <c>log4net-default-repository</c>.
  10254. </para>
  10255. </remarks>
  10256. </member>
  10257. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)">
  10258. <summary>
  10259. Create a new repository for the repository specified
  10260. </summary>
  10261. <param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10262. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10263. If this param is null then the default repository type is used.</param>
  10264. <returns>the repository created</returns>
  10265. <remarks>
  10266. <para>
  10267. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10268. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10269. same repository specified will return the same repository instance.
  10270. </para>
  10271. <para>
  10272. If the named repository already exists an exception will be thrown.
  10273. </para>
  10274. <para>
  10275. If <paramref name="repositoryType"/> is <c>null</c> then the default
  10276. repository type specified to the constructor is used.
  10277. </para>
  10278. </remarks>
  10279. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  10280. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception>
  10281. </member>
  10282. <member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)">
  10283. <summary>
  10284. Test if a named repository exists
  10285. </summary>
  10286. <param name="repositoryName">the named repository to check</param>
  10287. <returns><c>true</c> if the repository exists</returns>
  10288. <remarks>
  10289. <para>
  10290. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  10291. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  10292. a repository.
  10293. </para>
  10294. </remarks>
  10295. </member>
  10296. <member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories">
  10297. <summary>
  10298. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  10299. </summary>
  10300. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  10301. <remarks>
  10302. <para>
  10303. Gets an array of all of the repositories created by this selector.
  10304. </para>
  10305. </remarks>
  10306. </member>
  10307. <member name="F:log4net.Core.CompactRepositorySelector.declaringType">
  10308. <summary>
  10309. The fully qualified type of the CompactRepositorySelector class.
  10310. </summary>
  10311. <remarks>
  10312. Used by the internal logger to record the Type of the
  10313. log message.
  10314. </remarks>
  10315. </member>
  10316. <member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  10317. <summary>
  10318. Notify the registered listeners that the repository has been created
  10319. </summary>
  10320. <param name="repository">The repository that has been created</param>
  10321. <remarks>
  10322. <para>
  10323. Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event>
  10324. event.
  10325. </para>
  10326. </remarks>
  10327. </member>
  10328. <member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">
  10329. <summary>
  10330. Event to notify that a logger repository has been created.
  10331. </summary>
  10332. <value>
  10333. Event to notify that a logger repository has been created.
  10334. </value>
  10335. <remarks>
  10336. <para>
  10337. Event raised when a new repository is created.
  10338. The event source will be this selector. The event args will
  10339. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  10340. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10341. </para>
  10342. </remarks>
  10343. </member>
  10344. <member name="T:log4net.Core.DefaultRepositorySelector">
  10345. <summary>
  10346. The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface.
  10347. </summary>
  10348. <remarks>
  10349. <para>
  10350. Uses attributes defined on the calling assembly to determine how to
  10351. configure the hierarchy for the repository.
  10352. </para>
  10353. </remarks>
  10354. <author>Nicko Cadell</author>
  10355. <author>Gert Driesen</author>
  10356. </member>
  10357. <member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)">
  10358. <summary>
  10359. Creates a new repository selector.
  10360. </summary>
  10361. <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10362. <remarks>
  10363. <para>
  10364. Create an new repository selector.
  10365. The default type for repositories must be specified,
  10366. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  10367. </para>
  10368. </remarks>
  10369. <exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null"/>.</exception>
  10370. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception>
  10371. </member>
  10372. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10373. <summary>
  10374. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10375. </summary>
  10376. <param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10377. <remarks>
  10378. <para>
  10379. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
  10380. to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
  10381. attribute on the <paramref name="repositoryAssembly"/>.
  10382. </para>
  10383. <para>
  10384. The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  10385. implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10386. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10387. </para>
  10388. <para>
  10389. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
  10390. any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
  10391. the <paramref name="repositoryAssembly"/>.
  10392. </para>
  10393. </remarks>
  10394. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
  10395. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  10396. </member>
  10397. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
  10398. <summary>
  10399. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.
  10400. </summary>
  10401. <param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10402. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns>
  10403. <remarks>
  10404. <para>
  10405. Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c>
  10406. a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository
  10407. does not exist a <see cref="T:log4net.Core.LogException"/> is thrown.
  10408. </para>
  10409. <para>
  10410. Use <see cref="M:CreateRepository(string, Type)"/> to create a repository.
  10411. </para>
  10412. </remarks>
  10413. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
  10414. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception>
  10415. </member>
  10416. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10417. <summary>
  10418. Create a new repository for the assembly specified
  10419. </summary>
  10420. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10421. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10422. <returns>The repository created.</returns>
  10423. <remarks>
  10424. <para>
  10425. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10426. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10427. same assembly specified will return the same repository instance.
  10428. </para>
  10429. <para>
  10430. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  10431. the repository to create can be overridden by specifying the
  10432. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10433. <paramref name="repositoryAssembly"/>. The default values are to use the
  10434. <paramref name="repositoryType"/> implementation of the
  10435. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10436. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10437. </para>
  10438. <para>
  10439. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  10440. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10441. attributes defined on the <paramref name="repositoryAssembly"/>.
  10442. </para>
  10443. <para>
  10444. If a repository for the <paramref name="repositoryAssembly"/> already exists
  10445. that repository will be returned. An error will not be raised and that
  10446. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  10447. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10448. assembly may be used to override the repository type specified in
  10449. <paramref name="repositoryType"/>.
  10450. </para>
  10451. </remarks>
  10452. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  10453. </member>
  10454. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)">
  10455. <summary>
  10456. Creates a new repository for the assembly specified.
  10457. </summary>
  10458. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10459. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10460. <param name="repositoryName">The name to assign to the created repository</param>
  10461. <param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param>
  10462. <returns>The repository created.</returns>
  10463. <remarks>
  10464. <para>
  10465. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10466. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10467. same assembly specified will return the same repository instance.
  10468. </para>
  10469. <para>
  10470. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  10471. the repository to create can be overridden by specifying the
  10472. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10473. <paramref name="repositoryAssembly"/>. The default values are to use the
  10474. <paramref name="repositoryType"/> implementation of the
  10475. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10476. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10477. </para>
  10478. <para>
  10479. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  10480. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10481. attributes defined on the <paramref name="repositoryAssembly"/>.
  10482. </para>
  10483. <para>
  10484. If a repository for the <paramref name="repositoryAssembly"/> already exists
  10485. that repository will be returned. An error will not be raised and that
  10486. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  10487. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10488. assembly may be used to override the repository type specified in
  10489. <paramref name="repositoryType"/>.
  10490. </para>
  10491. </remarks>
  10492. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  10493. </member>
  10494. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)">
  10495. <summary>
  10496. Creates a new repository for the specified repository.
  10497. </summary>
  10498. <param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10499. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10500. If this param is <see langword="null"/> then the default repository type is used.</param>
  10501. <returns>The new repository.</returns>
  10502. <remarks>
  10503. <para>
  10504. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10505. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10506. same repository specified will return the same repository instance.
  10507. </para>
  10508. </remarks>
  10509. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
  10510. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception>
  10511. </member>
  10512. <member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)">
  10513. <summary>
  10514. Test if a named repository exists
  10515. </summary>
  10516. <param name="repositoryName">the named repository to check</param>
  10517. <returns><c>true</c> if the repository exists</returns>
  10518. <remarks>
  10519. <para>
  10520. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  10521. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  10522. a repository.
  10523. </para>
  10524. </remarks>
  10525. </member>
  10526. <member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories">
  10527. <summary>
  10528. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  10529. </summary>
  10530. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  10531. <remarks>
  10532. <para>
  10533. Gets an array of all of the repositories created by this selector.
  10534. </para>
  10535. </remarks>
  10536. </member>
  10537. <member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)">
  10538. <summary>
  10539. Aliases a repository to an existing repository.
  10540. </summary>
  10541. <param name="repositoryAlias">The repository to alias.</param>
  10542. <param name="repositoryTarget">The repository that the repository is aliased to.</param>
  10543. <remarks>
  10544. <para>
  10545. The repository specified will be aliased to the repository when created.
  10546. The repository must not already exist.
  10547. </para>
  10548. <para>
  10549. When the repository is created it must utilize the same repository type as
  10550. the repository it is aliased to, otherwise the aliasing will fail.
  10551. </para>
  10552. </remarks>
  10553. <exception cref="T:System.ArgumentNullException">
  10554. <para><paramref name="repositoryAlias"/> is <see langword="null"/>.</para>
  10555. <para>-or-</para>
  10556. <para><paramref name="repositoryTarget"/> is <see langword="null"/>.</para>
  10557. </exception>
  10558. </member>
  10559. <member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  10560. <summary>
  10561. Notifies the registered listeners that the repository has been created.
  10562. </summary>
  10563. <param name="repository">The repository that has been created.</param>
  10564. <remarks>
  10565. <para>
  10566. Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  10567. </para>
  10568. </remarks>
  10569. </member>
  10570. <member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)">
  10571. <summary>
  10572. Gets the repository name and repository type for the specified assembly.
  10573. </summary>
  10574. <param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param>
  10575. <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>
  10576. <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>
  10577. <exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception>
  10578. </member>
  10579. <member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10580. <summary>
  10581. Configures the repository using information from the assembly.
  10582. </summary>
  10583. <param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10584. attributes which define the configuration for the repository.</param>
  10585. <param name="repository">The repository to configure.</param>
  10586. <exception cref="T:System.ArgumentNullException">
  10587. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  10588. <para>-or-</para>
  10589. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  10590. </exception>
  10591. </member>
  10592. <member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10593. <summary>
  10594. Loads the attribute defined plugins on the assembly.
  10595. </summary>
  10596. <param name="assembly">The assembly that contains the attributes.</param>
  10597. <param name="repository">The repository to add the plugins to.</param>
  10598. <exception cref="T:System.ArgumentNullException">
  10599. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  10600. <para>-or-</para>
  10601. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  10602. </exception>
  10603. </member>
  10604. <member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10605. <summary>
  10606. Loads the attribute defined aliases on the assembly.
  10607. </summary>
  10608. <param name="assembly">The assembly that contains the attributes.</param>
  10609. <param name="repository">The repository to alias to.</param>
  10610. <exception cref="T:System.ArgumentNullException">
  10611. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  10612. <para>-or-</para>
  10613. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  10614. </exception>
  10615. </member>
  10616. <member name="F:log4net.Core.DefaultRepositorySelector.declaringType">
  10617. <summary>
  10618. The fully qualified type of the DefaultRepositorySelector class.
  10619. </summary>
  10620. <remarks>
  10621. Used by the internal logger to record the Type of the
  10622. log message.
  10623. </remarks>
  10624. </member>
  10625. <member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent">
  10626. <summary>
  10627. Event to notify that a logger repository has been created.
  10628. </summary>
  10629. <value>
  10630. Event to notify that a logger repository has been created.
  10631. </value>
  10632. <remarks>
  10633. <para>
  10634. Event raised when a new repository is created.
  10635. The event source will be this selector. The event args will
  10636. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  10637. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10638. </para>
  10639. </remarks>
  10640. </member>
  10641. <member name="T:log4net.Core.ErrorCode">
  10642. <summary>
  10643. Defined error codes that can be passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  10644. </summary>
  10645. <remarks>
  10646. <para>
  10647. Values passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  10648. </para>
  10649. </remarks>
  10650. <author>Nicko Cadell</author>
  10651. </member>
  10652. <member name="F:log4net.Core.ErrorCode.GenericFailure">
  10653. <summary>
  10654. A general error
  10655. </summary>
  10656. </member>
  10657. <member name="F:log4net.Core.ErrorCode.WriteFailure">
  10658. <summary>
  10659. Error while writing output
  10660. </summary>
  10661. </member>
  10662. <member name="F:log4net.Core.ErrorCode.FlushFailure">
  10663. <summary>
  10664. Failed to flush file
  10665. </summary>
  10666. </member>
  10667. <member name="F:log4net.Core.ErrorCode.CloseFailure">
  10668. <summary>
  10669. Failed to close file
  10670. </summary>
  10671. </member>
  10672. <member name="F:log4net.Core.ErrorCode.FileOpenFailure">
  10673. <summary>
  10674. Unable to open output file
  10675. </summary>
  10676. </member>
  10677. <member name="F:log4net.Core.ErrorCode.MissingLayout">
  10678. <summary>
  10679. No layout specified
  10680. </summary>
  10681. </member>
  10682. <member name="F:log4net.Core.ErrorCode.AddressParseFailure">
  10683. <summary>
  10684. Failed to parse address
  10685. </summary>
  10686. </member>
  10687. <member name="T:log4net.Core.ExceptionEvaluator">
  10688. <summary>
  10689. An evaluator that triggers on an Exception type
  10690. </summary>
  10691. <remarks>
  10692. <para>
  10693. This evaluator will trigger if the type of the Exception
  10694. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  10695. is equal to a Type in <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. ///
  10696. </para>
  10697. </remarks>
  10698. <author>Drew Schaeffer</author>
  10699. </member>
  10700. <member name="T:log4net.Core.ITriggeringEventEvaluator">
  10701. <summary>
  10702. Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action
  10703. </summary>
  10704. <remarks>
  10705. <para>
  10706. Implementations of this interface allow certain appenders to decide
  10707. when to perform an appender specific action.
  10708. </para>
  10709. <para>
  10710. The action or behavior triggered is defined by the implementation.
  10711. </para>
  10712. </remarks>
  10713. <author>Nicko Cadell</author>
  10714. </member>
  10715. <member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10716. <summary>
  10717. Test if this event triggers the action
  10718. </summary>
  10719. <param name="loggingEvent">The event to check</param>
  10720. <returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns>
  10721. <remarks>
  10722. <para>
  10723. Return <c>true</c> if this event triggers the action
  10724. </para>
  10725. </remarks>
  10726. </member>
  10727. <member name="F:log4net.Core.ExceptionEvaluator.m_type">
  10728. <summary>
  10729. The type that causes the trigger to fire.
  10730. </summary>
  10731. </member>
  10732. <member name="F:log4net.Core.ExceptionEvaluator.m_triggerOnSubclass">
  10733. <summary>
  10734. Causes subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/> to cause the trigger to fire.
  10735. </summary>
  10736. </member>
  10737. <member name="M:log4net.Core.ExceptionEvaluator.#ctor">
  10738. <summary>
  10739. Default ctor to allow dynamic creation through a configurator.
  10740. </summary>
  10741. </member>
  10742. <member name="M:log4net.Core.ExceptionEvaluator.#ctor(System.Type,System.Boolean)">
  10743. <summary>
  10744. Constructs an evaluator and initializes to trigger on <paramref name="exType"/>
  10745. </summary>
  10746. <param name="exType">the type that triggers this evaluator.</param>
  10747. <param name="triggerOnSubClass">If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.</param>
  10748. </member>
  10749. <member name="M:log4net.Core.ExceptionEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10750. <summary>
  10751. Is this <paramref name="loggingEvent"/> the triggering event?
  10752. </summary>
  10753. <param name="loggingEvent">The event to check</param>
  10754. <returns>This method returns <c>true</c>, if the logging event Exception
  10755. Type is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10756. Otherwise it returns <c>false</c></returns>
  10757. <remarks>
  10758. <para>
  10759. This evaluator will trigger if the Exception Type of the event
  10760. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  10761. is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10762. </para>
  10763. </remarks>
  10764. </member>
  10765. <member name="P:log4net.Core.ExceptionEvaluator.ExceptionType">
  10766. <summary>
  10767. The type that triggers this evaluator.
  10768. </summary>
  10769. </member>
  10770. <member name="P:log4net.Core.ExceptionEvaluator.TriggerOnSubclass">
  10771. <summary>
  10772. If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10773. </summary>
  10774. </member>
  10775. <member name="T:log4net.Core.IErrorHandler">
  10776. <summary>
  10777. Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler"/>.
  10778. </summary>
  10779. <remarks>
  10780. <para>
  10781. Error handling is a particularly tedious to get right because by
  10782. definition errors are hard to predict and to reproduce.
  10783. </para>
  10784. </remarks>
  10785. <author>Nicko Cadell</author>
  10786. <author>Gert Driesen</author>
  10787. </member>
  10788. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  10789. <summary>
  10790. Handles the error and information about the error condition is passed as
  10791. a parameter.
  10792. </summary>
  10793. <param name="message">The message associated with the error.</param>
  10794. <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
  10795. <param name="errorCode">The error code associated with the error.</param>
  10796. <remarks>
  10797. <para>
  10798. Handles the error and information about the error condition is passed as
  10799. a parameter.
  10800. </para>
  10801. </remarks>
  10802. </member>
  10803. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)">
  10804. <summary>
  10805. Prints the error message passed as a parameter.
  10806. </summary>
  10807. <param name="message">The message associated with the error.</param>
  10808. <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
  10809. <remarks>
  10810. <para>
  10811. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  10812. </para>
  10813. </remarks>
  10814. </member>
  10815. <member name="M:log4net.Core.IErrorHandler.Error(System.String)">
  10816. <summary>
  10817. Prints the error message passed as a parameter.
  10818. </summary>
  10819. <param name="message">The message associated with the error.</param>
  10820. <remarks>
  10821. <para>
  10822. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  10823. </para>
  10824. </remarks>
  10825. </member>
  10826. <member name="T:log4net.Core.IFixingRequired">
  10827. <summary>
  10828. Interface for objects that require fixing.
  10829. </summary>
  10830. <remarks>
  10831. <para>
  10832. Interface that indicates that the object requires fixing before it
  10833. can be taken outside the context of the appender's
  10834. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  10835. </para>
  10836. <para>
  10837. When objects that implement this interface are stored
  10838. in the context properties maps <see cref="T:log4net.GlobalContext"/>
  10839. <see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/>
  10840. <see cref="P:log4net.ThreadContext.Properties"/> are fixed
  10841. (see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/>
  10842. method will be called.
  10843. </para>
  10844. </remarks>
  10845. <author>Nicko Cadell</author>
  10846. </member>
  10847. <member name="M:log4net.Core.IFixingRequired.GetFixedObject">
  10848. <summary>
  10849. Get a portable version of this object
  10850. </summary>
  10851. <returns>the portable instance of this object</returns>
  10852. <remarks>
  10853. <para>
  10854. Get a portable instance object that represents the current
  10855. state of this object. The portable object can be stored
  10856. and logged from any thread with identical results.
  10857. </para>
  10858. </remarks>
  10859. </member>
  10860. <member name="T:log4net.Core.ILogger">
  10861. <summary>
  10862. Interface that all loggers implement
  10863. </summary>
  10864. <remarks>
  10865. <para>
  10866. This interface supports logging events and testing if a level
  10867. is enabled for logging.
  10868. </para>
  10869. <para>
  10870. These methods will not throw exceptions. Note to implementor, ensure
  10871. that the implementation of these methods cannot allow an exception
  10872. to be thrown to the caller.
  10873. </para>
  10874. </remarks>
  10875. <author>Nicko Cadell</author>
  10876. <author>Gert Driesen</author>
  10877. </member>
  10878. <member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  10879. <summary>
  10880. This generic form is intended to be used by wrappers.
  10881. </summary>
  10882. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  10883. the stack boundary into the logging system for this call.</param>
  10884. <param name="level">The level of the message to be logged.</param>
  10885. <param name="message">The message object to log.</param>
  10886. <param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param>
  10887. <remarks>
  10888. <para>
  10889. Generates a logging event for the specified <paramref name="level"/> using
  10890. the <paramref name="message"/> and <paramref name="exception"/>.
  10891. </para>
  10892. </remarks>
  10893. </member>
  10894. <member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)">
  10895. <summary>
  10896. This is the most generic printing method that is intended to be used
  10897. by wrappers.
  10898. </summary>
  10899. <param name="logEvent">The event being logged.</param>
  10900. <remarks>
  10901. <para>
  10902. Logs the specified logging event through this logger.
  10903. </para>
  10904. </remarks>
  10905. </member>
  10906. <member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)">
  10907. <summary>
  10908. Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter.
  10909. </summary>
  10910. <param name="level">The level to check.</param>
  10911. <returns>
  10912. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  10913. </returns>
  10914. <remarks>
  10915. <para>
  10916. Test if this logger is going to log events of the specified <paramref name="level"/>.
  10917. </para>
  10918. </remarks>
  10919. </member>
  10920. <member name="P:log4net.Core.ILogger.Name">
  10921. <summary>
  10922. Gets the name of the logger.
  10923. </summary>
  10924. <value>
  10925. The name of the logger.
  10926. </value>
  10927. <remarks>
  10928. <para>
  10929. The name of this logger
  10930. </para>
  10931. </remarks>
  10932. </member>
  10933. <member name="P:log4net.Core.ILogger.Repository">
  10934. <summary>
  10935. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  10936. <c>Logger</c> instance is attached to.
  10937. </summary>
  10938. <value>
  10939. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
  10940. </value>
  10941. <remarks>
  10942. <para>
  10943. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  10944. <c>Logger</c> instance is attached to.
  10945. </para>
  10946. </remarks>
  10947. </member>
  10948. <member name="T:log4net.Core.ILoggerWrapper">
  10949. <summary>
  10950. Base interface for all wrappers
  10951. </summary>
  10952. <remarks>
  10953. <para>
  10954. Base interface for all wrappers.
  10955. </para>
  10956. <para>
  10957. All wrappers must implement this interface.
  10958. </para>
  10959. </remarks>
  10960. <author>Nicko Cadell</author>
  10961. </member>
  10962. <member name="P:log4net.Core.ILoggerWrapper.Logger">
  10963. <summary>
  10964. Get the implementation behind this wrapper object.
  10965. </summary>
  10966. <value>
  10967. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object.
  10968. </value>
  10969. <remarks>
  10970. <para>
  10971. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this
  10972. object. The <c>Logger</c> object may not
  10973. be the same object as this object because of logger decorators.
  10974. This gets the actual underlying objects that is used to process
  10975. the log events.
  10976. </para>
  10977. </remarks>
  10978. </member>
  10979. <member name="T:log4net.Core.LoggerRepositoryCreationEventHandler">
  10980. <summary>
  10981. Delegate used to handle logger repository creation event notifications
  10982. </summary>
  10983. <param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param>
  10984. <param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args
  10985. that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param>
  10986. <remarks>
  10987. <para>
  10988. Delegate used to handle logger repository creation event notifications.
  10989. </para>
  10990. </remarks>
  10991. </member>
  10992. <member name="T:log4net.Core.LoggerRepositoryCreationEventArgs">
  10993. <summary>
  10994. Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  10995. </summary>
  10996. <remarks>
  10997. <para>
  10998. A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/>
  10999. event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created.
  11000. </para>
  11001. </remarks>
  11002. </member>
  11003. <member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository">
  11004. <summary>
  11005. The <see cref="T:log4net.Repository.ILoggerRepository"/> created
  11006. </summary>
  11007. </member>
  11008. <member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)">
  11009. <summary>
  11010. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  11011. </summary>
  11012. <param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param>
  11013. <remarks>
  11014. <para>
  11015. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  11016. </para>
  11017. </remarks>
  11018. </member>
  11019. <member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository">
  11020. <summary>
  11021. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  11022. </summary>
  11023. <value>
  11024. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  11025. </value>
  11026. <remarks>
  11027. <para>
  11028. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  11029. </para>
  11030. </remarks>
  11031. </member>
  11032. <member name="T:log4net.Core.Level">
  11033. <summary>
  11034. Defines the default set of levels recognized by the system.
  11035. </summary>
  11036. <remarks>
  11037. <para>
  11038. Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>.
  11039. </para>
  11040. <para>
  11041. Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative
  11042. ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/>
  11043. are deemed to be equivalent.
  11044. </para>
  11045. <para>
  11046. The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/>
  11047. and each repository can have different levels defined. The levels are stored
  11048. in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are
  11049. looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>.
  11050. </para>
  11051. <para>
  11052. When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but
  11053. the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is
  11054. <see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map.
  11055. </para>
  11056. <para>
  11057. Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The
  11058. <see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default
  11059. the display name is the same as the level name, but this can be used to alias levels
  11060. or to localize the log output.
  11061. </para>
  11062. <para>
  11063. Some of the predefined levels recognized by the system are:
  11064. </para>
  11065. <list type="bullet">
  11066. <item>
  11067. <description><see cref="F:log4net.Core.Level.Off"/>.</description>
  11068. </item>
  11069. <item>
  11070. <description><see cref="F:log4net.Core.Level.Fatal"/>.</description>
  11071. </item>
  11072. <item>
  11073. <description><see cref="F:log4net.Core.Level.Error"/>.</description>
  11074. </item>
  11075. <item>
  11076. <description><see cref="F:log4net.Core.Level.Warn"/>.</description>
  11077. </item>
  11078. <item>
  11079. <description><see cref="F:log4net.Core.Level.Info"/>.</description>
  11080. </item>
  11081. <item>
  11082. <description><see cref="F:log4net.Core.Level.Debug"/>.</description>
  11083. </item>
  11084. <item>
  11085. <description><see cref="F:log4net.Core.Level.All"/>.</description>
  11086. </item>
  11087. </list>
  11088. </remarks>
  11089. <author>Nicko Cadell</author>
  11090. <author>Gert Driesen</author>
  11091. </member>
  11092. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)">
  11093. <summary>
  11094. Constructor
  11095. </summary>
  11096. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  11097. <param name="levelName">The string name of this level.</param>
  11098. <param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param>
  11099. <remarks>
  11100. <para>
  11101. Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
  11102. the specified level name and value.
  11103. </para>
  11104. </remarks>
  11105. </member>
  11106. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)">
  11107. <summary>
  11108. Constructor
  11109. </summary>
  11110. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  11111. <param name="levelName">The string name of this level.</param>
  11112. <remarks>
  11113. <para>
  11114. Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
  11115. the specified level name and value.
  11116. </para>
  11117. </remarks>
  11118. </member>
  11119. <member name="M:log4net.Core.Level.ToString">
  11120. <summary>
  11121. Returns the <see cref="T:System.String"/> representation of the current
  11122. <see cref="T:log4net.Core.Level"/>.
  11123. </summary>
  11124. <returns>
  11125. A <see cref="T:System.String"/> representation of the current <see cref="T:log4net.Core.Level"/>.
  11126. </returns>
  11127. <remarks>
  11128. <para>
  11129. Returns the level <see cref="P:log4net.Core.Level.Name"/>.
  11130. </para>
  11131. </remarks>
  11132. </member>
  11133. <member name="M:log4net.Core.Level.Equals(System.Object)">
  11134. <summary>
  11135. Compares levels.
  11136. </summary>
  11137. <param name="o">The object to compare against.</param>
  11138. <returns><c>true</c> if the objects are equal.</returns>
  11139. <remarks>
  11140. <para>
  11141. Compares the levels of <see cref="T:log4net.Core.Level"/> instances, and
  11142. defers to base class if the target object is not a <see cref="T:log4net.Core.Level"/>
  11143. instance.
  11144. </para>
  11145. </remarks>
  11146. </member>
  11147. <member name="M:log4net.Core.Level.GetHashCode">
  11148. <summary>
  11149. Returns a hash code
  11150. </summary>
  11151. <returns>A hash code for the current <see cref="T:log4net.Core.Level"/>.</returns>
  11152. <remarks>
  11153. <para>
  11154. Returns a hash code suitable for use in hashing algorithms and data
  11155. structures like a hash table.
  11156. </para>
  11157. <para>
  11158. Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>.
  11159. </para>
  11160. </remarks>
  11161. </member>
  11162. <member name="M:log4net.Core.Level.CompareTo(System.Object)">
  11163. <summary>
  11164. Compares this instance to a specified object and returns an
  11165. indication of their relative values.
  11166. </summary>
  11167. <param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null"/> to compare with this instance.</param>
  11168. <returns>
  11169. A 32-bit signed integer that indicates the relative order of the
  11170. values compared. The return value has these meanings:
  11171. <list type="table">
  11172. <listheader>
  11173. <term>Value</term>
  11174. <description>Meaning</description>
  11175. </listheader>
  11176. <item>
  11177. <term>Less than zero</term>
  11178. <description>This instance is less than <paramref name="r"/>.</description>
  11179. </item>
  11180. <item>
  11181. <term>Zero</term>
  11182. <description>This instance is equal to <paramref name="r"/>.</description>
  11183. </item>
  11184. <item>
  11185. <term>Greater than zero</term>
  11186. <description>
  11187. <para>This instance is greater than <paramref name="r"/>.</para>
  11188. <para>-or-</para>
  11189. <para><paramref name="r"/> is <see langword="null"/>.</para>
  11190. </description>
  11191. </item>
  11192. </list>
  11193. </returns>
  11194. <remarks>
  11195. <para>
  11196. <paramref name="r"/> must be an instance of <see cref="T:log4net.Core.Level"/>
  11197. or <see langword="null"/>; otherwise, an exception is thrown.
  11198. </para>
  11199. </remarks>
  11200. <exception cref="T:System.ArgumentException"><paramref name="r"/> is not a <see cref="T:log4net.Core.Level"/>.</exception>
  11201. </member>
  11202. <member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)">
  11203. <summary>
  11204. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  11205. is greater than another specified <see cref="T:log4net.Core.Level"/>.
  11206. </summary>
  11207. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  11208. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  11209. <returns>
  11210. <c>true</c> if <paramref name="l"/> is greater than
  11211. <paramref name="r"/>; otherwise, <c>false</c>.
  11212. </returns>
  11213. <remarks>
  11214. <para>
  11215. Compares two levels.
  11216. </para>
  11217. </remarks>
  11218. </member>
  11219. <member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)">
  11220. <summary>
  11221. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  11222. is less than another specified <see cref="T:log4net.Core.Level"/>.
  11223. </summary>
  11224. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  11225. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  11226. <returns>
  11227. <c>true</c> if <paramref name="l"/> is less than
  11228. <paramref name="r"/>; otherwise, <c>false</c>.
  11229. </returns>
  11230. <remarks>
  11231. <para>
  11232. Compares two levels.
  11233. </para>
  11234. </remarks>
  11235. </member>
  11236. <member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  11237. <summary>
  11238. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  11239. is greater than or equal to another specified <see cref="T:log4net.Core.Level"/>.
  11240. </summary>
  11241. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  11242. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  11243. <returns>
  11244. <c>true</c> if <paramref name="l"/> is greater than or equal to
  11245. <paramref name="r"/>; otherwise, <c>false</c>.
  11246. </returns>
  11247. <remarks>
  11248. <para>
  11249. Compares two levels.
  11250. </para>
  11251. </remarks>
  11252. </member>
  11253. <member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  11254. <summary>
  11255. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  11256. is less than or equal to another specified <see cref="T:log4net.Core.Level"/>.
  11257. </summary>
  11258. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  11259. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  11260. <returns>
  11261. <c>true</c> if <paramref name="l"/> is less than or equal to
  11262. <paramref name="r"/>; otherwise, <c>false</c>.
  11263. </returns>
  11264. <remarks>
  11265. <para>
  11266. Compares two levels.
  11267. </para>
  11268. </remarks>
  11269. </member>
  11270. <member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)">
  11271. <summary>
  11272. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
  11273. objects have the same value.
  11274. </summary>
  11275. <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  11276. <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  11277. <returns>
  11278. <c>true</c> if the value of <paramref name="l"/> is the same as the
  11279. value of <paramref name="r"/>; otherwise, <c>false</c>.
  11280. </returns>
  11281. <remarks>
  11282. <para>
  11283. Compares two levels.
  11284. </para>
  11285. </remarks>
  11286. </member>
  11287. <member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)">
  11288. <summary>
  11289. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
  11290. objects have different values.
  11291. </summary>
  11292. <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  11293. <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  11294. <returns>
  11295. <c>true</c> if the value of <paramref name="l"/> is different from
  11296. the value of <paramref name="r"/>; otherwise, <c>false</c>.
  11297. </returns>
  11298. <remarks>
  11299. <para>
  11300. Compares two levels.
  11301. </para>
  11302. </remarks>
  11303. </member>
  11304. <member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)">
  11305. <summary>
  11306. Compares two specified <see cref="T:log4net.Core.Level"/> instances.
  11307. </summary>
  11308. <param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param>
  11309. <param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param>
  11310. <returns>
  11311. A 32-bit signed integer that indicates the relative order of the
  11312. two values compared. The return value has these meanings:
  11313. <list type="table">
  11314. <listheader>
  11315. <term>Value</term>
  11316. <description>Meaning</description>
  11317. </listheader>
  11318. <item>
  11319. <term>Less than zero</term>
  11320. <description><paramref name="l"/> is less than <paramref name="r"/>.</description>
  11321. </item>
  11322. <item>
  11323. <term>Zero</term>
  11324. <description><paramref name="l"/> is equal to <paramref name="r"/>.</description>
  11325. </item>
  11326. <item>
  11327. <term>Greater than zero</term>
  11328. <description><paramref name="l"/> is greater than <paramref name="r"/>.</description>
  11329. </item>
  11330. </list>
  11331. </returns>
  11332. <remarks>
  11333. <para>
  11334. Compares two levels.
  11335. </para>
  11336. </remarks>
  11337. </member>
  11338. <member name="F:log4net.Core.Level.Off">
  11339. <summary>
  11340. The <see cref="F:log4net.Core.Level.Off"/> level designates a higher level than all the rest.
  11341. </summary>
  11342. </member>
  11343. <member name="F:log4net.Core.Level.Log4Net_Debug">
  11344. <summary>
  11345. The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
  11346. System unusable, emergencies.
  11347. </summary>
  11348. </member>
  11349. <member name="F:log4net.Core.Level.Emergency">
  11350. <summary>
  11351. The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
  11352. System unusable, emergencies.
  11353. </summary>
  11354. </member>
  11355. <member name="F:log4net.Core.Level.Fatal">
  11356. <summary>
  11357. The <see cref="F:log4net.Core.Level.Fatal"/> level designates very severe error events
  11358. that will presumably lead the application to abort.
  11359. </summary>
  11360. </member>
  11361. <member name="F:log4net.Core.Level.Alert">
  11362. <summary>
  11363. The <see cref="F:log4net.Core.Level.Alert"/> level designates very severe error events.
  11364. Take immediate action, alerts.
  11365. </summary>
  11366. </member>
  11367. <member name="F:log4net.Core.Level.Critical">
  11368. <summary>
  11369. The <see cref="F:log4net.Core.Level.Critical"/> level designates very severe error events.
  11370. Critical condition, critical.
  11371. </summary>
  11372. </member>
  11373. <member name="F:log4net.Core.Level.Severe">
  11374. <summary>
  11375. The <see cref="F:log4net.Core.Level.Severe"/> level designates very severe error events.
  11376. </summary>
  11377. </member>
  11378. <member name="F:log4net.Core.Level.Error">
  11379. <summary>
  11380. The <see cref="F:log4net.Core.Level.Error"/> level designates error events that might
  11381. still allow the application to continue running.
  11382. </summary>
  11383. </member>
  11384. <member name="F:log4net.Core.Level.Warn">
  11385. <summary>
  11386. The <see cref="F:log4net.Core.Level.Warn"/> level designates potentially harmful
  11387. situations.
  11388. </summary>
  11389. </member>
  11390. <member name="F:log4net.Core.Level.Notice">
  11391. <summary>
  11392. The <see cref="F:log4net.Core.Level.Notice"/> level designates informational messages
  11393. that highlight the progress of the application at the highest level.
  11394. </summary>
  11395. </member>
  11396. <member name="F:log4net.Core.Level.Info">
  11397. <summary>
  11398. The <see cref="F:log4net.Core.Level.Info"/> level designates informational messages that
  11399. highlight the progress of the application at coarse-grained level.
  11400. </summary>
  11401. </member>
  11402. <member name="F:log4net.Core.Level.Debug">
  11403. <summary>
  11404. The <see cref="F:log4net.Core.Level.Debug"/> level designates fine-grained informational
  11405. events that are most useful to debug an application.
  11406. </summary>
  11407. </member>
  11408. <member name="F:log4net.Core.Level.Fine">
  11409. <summary>
  11410. The <see cref="F:log4net.Core.Level.Fine"/> level designates fine-grained informational
  11411. events that are most useful to debug an application.
  11412. </summary>
  11413. </member>
  11414. <member name="F:log4net.Core.Level.Trace">
  11415. <summary>
  11416. The <see cref="F:log4net.Core.Level.Trace"/> level designates fine-grained informational
  11417. events that are most useful to debug an application.
  11418. </summary>
  11419. </member>
  11420. <member name="F:log4net.Core.Level.Finer">
  11421. <summary>
  11422. The <see cref="F:log4net.Core.Level.Finer"/> level designates fine-grained informational
  11423. events that are most useful to debug an application.
  11424. </summary>
  11425. </member>
  11426. <member name="F:log4net.Core.Level.Verbose">
  11427. <summary>
  11428. The <see cref="F:log4net.Core.Level.Verbose"/> level designates fine-grained informational
  11429. events that are most useful to debug an application.
  11430. </summary>
  11431. </member>
  11432. <member name="F:log4net.Core.Level.Finest">
  11433. <summary>
  11434. The <see cref="F:log4net.Core.Level.Finest"/> level designates fine-grained informational
  11435. events that are most useful to debug an application.
  11436. </summary>
  11437. </member>
  11438. <member name="F:log4net.Core.Level.All">
  11439. <summary>
  11440. The <see cref="F:log4net.Core.Level.All"/> level designates the lowest level possible.
  11441. </summary>
  11442. </member>
  11443. <member name="P:log4net.Core.Level.Name">
  11444. <summary>
  11445. Gets the name of this level.
  11446. </summary>
  11447. <value>
  11448. The name of this level.
  11449. </value>
  11450. <remarks>
  11451. <para>
  11452. Gets the name of this level.
  11453. </para>
  11454. </remarks>
  11455. </member>
  11456. <member name="P:log4net.Core.Level.Value">
  11457. <summary>
  11458. Gets the value of this level.
  11459. </summary>
  11460. <value>
  11461. The value of this level.
  11462. </value>
  11463. <remarks>
  11464. <para>
  11465. Gets the value of this level.
  11466. </para>
  11467. </remarks>
  11468. </member>
  11469. <member name="P:log4net.Core.Level.DisplayName">
  11470. <summary>
  11471. Gets the display name of this level.
  11472. </summary>
  11473. <value>
  11474. The display name of this level.
  11475. </value>
  11476. <remarks>
  11477. <para>
  11478. Gets the display name of this level.
  11479. </para>
  11480. </remarks>
  11481. </member>
  11482. <member name="T:log4net.Core.LevelCollection">
  11483. <summary>
  11484. A strongly-typed collection of <see cref="T:log4net.Core.Level"/> objects.
  11485. </summary>
  11486. <author>Nicko Cadell</author>
  11487. </member>
  11488. <member name="M:log4net.Core.LevelCollection.ReadOnly(log4net.Core.LevelCollection)">
  11489. <summary>
  11490. Creates a read-only wrapper for a <c>LevelCollection</c> instance.
  11491. </summary>
  11492. <param name="list">list to create a readonly wrapper arround</param>
  11493. <returns>
  11494. A <c>LevelCollection</c> wrapper that is read-only.
  11495. </returns>
  11496. </member>
  11497. <member name="M:log4net.Core.LevelCollection.#ctor">
  11498. <summary>
  11499. Initializes a new instance of the <c>LevelCollection</c> class
  11500. that is empty and has the default initial capacity.
  11501. </summary>
  11502. </member>
  11503. <member name="M:log4net.Core.LevelCollection.#ctor(System.Int32)">
  11504. <summary>
  11505. Initializes a new instance of the <c>LevelCollection</c> class
  11506. that has the specified initial capacity.
  11507. </summary>
  11508. <param name="capacity">
  11509. The number of elements that the new <c>LevelCollection</c> is initially capable of storing.
  11510. </param>
  11511. </member>
  11512. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection)">
  11513. <summary>
  11514. Initializes a new instance of the <c>LevelCollection</c> class
  11515. that contains elements copied from the specified <c>LevelCollection</c>.
  11516. </summary>
  11517. <param name="c">The <c>LevelCollection</c> whose elements are copied to the new collection.</param>
  11518. </member>
  11519. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.Level[])">
  11520. <summary>
  11521. Initializes a new instance of the <c>LevelCollection</c> class
  11522. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> array.
  11523. </summary>
  11524. <param name="a">The <see cref="T:log4net.Core.Level"/> array whose elements are copied to the new list.</param>
  11525. </member>
  11526. <member name="M:log4net.Core.LevelCollection.#ctor(System.Collections.ICollection)">
  11527. <summary>
  11528. Initializes a new instance of the <c>LevelCollection</c> class
  11529. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> collection.
  11530. </summary>
  11531. <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements are copied to the new list.</param>
  11532. </member>
  11533. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection.Tag)">
  11534. <summary>
  11535. Allow subclasses to avoid our default constructors
  11536. </summary>
  11537. <param name="tag"></param>
  11538. </member>
  11539. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[])">
  11540. <summary>
  11541. Copies the entire <c>LevelCollection</c> to a one-dimensional
  11542. <see cref="T:log4net.Core.Level"/> array.
  11543. </summary>
  11544. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  11545. </member>
  11546. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[],System.Int32)">
  11547. <summary>
  11548. Copies the entire <c>LevelCollection</c> to a one-dimensional
  11549. <see cref="T:log4net.Core.Level"/> array, starting at the specified index of the target array.
  11550. </summary>
  11551. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  11552. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  11553. </member>
  11554. <member name="M:log4net.Core.LevelCollection.Add(log4net.Core.Level)">
  11555. <summary>
  11556. Adds a <see cref="T:log4net.Core.Level"/> to the end of the <c>LevelCollection</c>.
  11557. </summary>
  11558. <param name="item">The <see cref="T:log4net.Core.Level"/> to be added to the end of the <c>LevelCollection</c>.</param>
  11559. <returns>The index at which the value has been added.</returns>
  11560. </member>
  11561. <member name="M:log4net.Core.LevelCollection.Clear">
  11562. <summary>
  11563. Removes all elements from the <c>LevelCollection</c>.
  11564. </summary>
  11565. </member>
  11566. <member name="M:log4net.Core.LevelCollection.Clone">
  11567. <summary>
  11568. Creates a shallow copy of the <see cref="T:log4net.Core.LevelCollection"/>.
  11569. </summary>
  11570. <returns>A new <see cref="T:log4net.Core.LevelCollection"/> with a shallow copy of the collection data.</returns>
  11571. </member>
  11572. <member name="M:log4net.Core.LevelCollection.Contains(log4net.Core.Level)">
  11573. <summary>
  11574. Determines whether a given <see cref="T:log4net.Core.Level"/> is in the <c>LevelCollection</c>.
  11575. </summary>
  11576. <param name="item">The <see cref="T:log4net.Core.Level"/> to check for.</param>
  11577. <returns><c>true</c> if <paramref name="item"/> is found in the <c>LevelCollection</c>; otherwise, <c>false</c>.</returns>
  11578. </member>
  11579. <member name="M:log4net.Core.LevelCollection.IndexOf(log4net.Core.Level)">
  11580. <summary>
  11581. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Core.Level"/>
  11582. in the <c>LevelCollection</c>.
  11583. </summary>
  11584. <param name="item">The <see cref="T:log4net.Core.Level"/> to locate in the <c>LevelCollection</c>.</param>
  11585. <returns>
  11586. The zero-based index of the first occurrence of <paramref name="item"/>
  11587. in the entire <c>LevelCollection</c>, if found; otherwise, -1.
  11588. </returns>
  11589. </member>
  11590. <member name="M:log4net.Core.LevelCollection.Insert(System.Int32,log4net.Core.Level)">
  11591. <summary>
  11592. Inserts an element into the <c>LevelCollection</c> at the specified index.
  11593. </summary>
  11594. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  11595. <param name="item">The <see cref="T:log4net.Core.Level"/> to insert.</param>
  11596. <exception cref="T:System.ArgumentOutOfRangeException">
  11597. <para><paramref name="index"/> is less than zero</para>
  11598. <para>-or-</para>
  11599. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11600. </exception>
  11601. </member>
  11602. <member name="M:log4net.Core.LevelCollection.Remove(log4net.Core.Level)">
  11603. <summary>
  11604. Removes the first occurrence of a specific <see cref="T:log4net.Core.Level"/> from the <c>LevelCollection</c>.
  11605. </summary>
  11606. <param name="item">The <see cref="T:log4net.Core.Level"/> to remove from the <c>LevelCollection</c>.</param>
  11607. <exception cref="T:System.ArgumentException">
  11608. The specified <see cref="T:log4net.Core.Level"/> was not found in the <c>LevelCollection</c>.
  11609. </exception>
  11610. </member>
  11611. <member name="M:log4net.Core.LevelCollection.RemoveAt(System.Int32)">
  11612. <summary>
  11613. Removes the element at the specified index of the <c>LevelCollection</c>.
  11614. </summary>
  11615. <param name="index">The zero-based index of the element to remove.</param>
  11616. <exception cref="T:System.ArgumentOutOfRangeException">
  11617. <para><paramref name="index"/> is less than zero</para>
  11618. <para>-or-</para>
  11619. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11620. </exception>
  11621. </member>
  11622. <member name="M:log4net.Core.LevelCollection.GetEnumerator">
  11623. <summary>
  11624. Returns an enumerator that can iterate through the <c>LevelCollection</c>.
  11625. </summary>
  11626. <returns>An <see cref="T:log4net.Core.LevelCollection.Enumerator"/> for the entire <c>LevelCollection</c>.</returns>
  11627. </member>
  11628. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.LevelCollection)">
  11629. <summary>
  11630. Adds the elements of another <c>LevelCollection</c> to the current <c>LevelCollection</c>.
  11631. </summary>
  11632. <param name="x">The <c>LevelCollection</c> whose elements should be added to the end of the current <c>LevelCollection</c>.</param>
  11633. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11634. </member>
  11635. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.Level[])">
  11636. <summary>
  11637. Adds the elements of a <see cref="T:log4net.Core.Level"/> array to the current <c>LevelCollection</c>.
  11638. </summary>
  11639. <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>
  11640. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11641. </member>
  11642. <member name="M:log4net.Core.LevelCollection.AddRange(System.Collections.ICollection)">
  11643. <summary>
  11644. Adds the elements of a <see cref="T:log4net.Core.Level"/> collection to the current <c>LevelCollection</c>.
  11645. </summary>
  11646. <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>
  11647. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11648. </member>
  11649. <member name="M:log4net.Core.LevelCollection.TrimToSize">
  11650. <summary>
  11651. Sets the capacity to the actual number of elements.
  11652. </summary>
  11653. </member>
  11654. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32)">
  11655. <exception cref="T:System.ArgumentOutOfRangeException">
  11656. <para><paramref name="i"/> is less than zero</para>
  11657. <para>-or-</para>
  11658. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11659. </exception>
  11660. </member>
  11661. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32,System.Boolean)">
  11662. <exception cref="T:System.ArgumentOutOfRangeException">
  11663. <para><paramref name="i"/> is less than zero</para>
  11664. <para>-or-</para>
  11665. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11666. </exception>
  11667. </member>
  11668. <member name="P:log4net.Core.LevelCollection.Count">
  11669. <summary>
  11670. Gets the number of elements actually contained in the <c>LevelCollection</c>.
  11671. </summary>
  11672. </member>
  11673. <member name="P:log4net.Core.LevelCollection.IsSynchronized">
  11674. <summary>
  11675. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  11676. </summary>
  11677. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  11678. </member>
  11679. <member name="P:log4net.Core.LevelCollection.SyncRoot">
  11680. <summary>
  11681. Gets an object that can be used to synchronize access to the collection.
  11682. </summary>
  11683. </member>
  11684. <member name="P:log4net.Core.LevelCollection.Item(System.Int32)">
  11685. <summary>
  11686. Gets or sets the <see cref="T:log4net.Core.Level"/> at the specified index.
  11687. </summary>
  11688. <param name="index">The zero-based index of the element to get or set.</param>
  11689. <exception cref="T:System.ArgumentOutOfRangeException">
  11690. <para><paramref name="index"/> is less than zero</para>
  11691. <para>-or-</para>
  11692. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11693. </exception>
  11694. </member>
  11695. <member name="P:log4net.Core.LevelCollection.IsFixedSize">
  11696. <summary>
  11697. Gets a value indicating whether the collection has a fixed size.
  11698. </summary>
  11699. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  11700. </member>
  11701. <member name="P:log4net.Core.LevelCollection.IsReadOnly">
  11702. <summary>
  11703. Gets a value indicating whether the IList is read-only.
  11704. </summary>
  11705. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  11706. </member>
  11707. <member name="P:log4net.Core.LevelCollection.Capacity">
  11708. <summary>
  11709. Gets or sets the number of elements the <c>LevelCollection</c> can contain.
  11710. </summary>
  11711. </member>
  11712. <member name="T:log4net.Core.LevelCollection.ILevelCollectionEnumerator">
  11713. <summary>
  11714. Supports type-safe iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  11715. </summary>
  11716. </member>
  11717. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.MoveNext">
  11718. <summary>
  11719. Advances the enumerator to the next element in the collection.
  11720. </summary>
  11721. <returns>
  11722. <c>true</c> if the enumerator was successfully advanced to the next element;
  11723. <c>false</c> if the enumerator has passed the end of the collection.
  11724. </returns>
  11725. <exception cref="T:System.InvalidOperationException">
  11726. The collection was modified after the enumerator was created.
  11727. </exception>
  11728. </member>
  11729. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Reset">
  11730. <summary>
  11731. Sets the enumerator to its initial position, before the first element in the collection.
  11732. </summary>
  11733. </member>
  11734. <member name="P:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Current">
  11735. <summary>
  11736. Gets the current element in the collection.
  11737. </summary>
  11738. </member>
  11739. <member name="T:log4net.Core.LevelCollection.Tag">
  11740. <summary>
  11741. Type visible only to our subclasses
  11742. Used to access protected constructor
  11743. </summary>
  11744. </member>
  11745. <member name="F:log4net.Core.LevelCollection.Tag.Default">
  11746. <summary>
  11747. A value
  11748. </summary>
  11749. </member>
  11750. <member name="T:log4net.Core.LevelCollection.Enumerator">
  11751. <summary>
  11752. Supports simple iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  11753. </summary>
  11754. </member>
  11755. <member name="M:log4net.Core.LevelCollection.Enumerator.#ctor(log4net.Core.LevelCollection)">
  11756. <summary>
  11757. Initializes a new instance of the <c>Enumerator</c> class.
  11758. </summary>
  11759. <param name="tc"></param>
  11760. </member>
  11761. <member name="M:log4net.Core.LevelCollection.Enumerator.MoveNext">
  11762. <summary>
  11763. Advances the enumerator to the next element in the collection.
  11764. </summary>
  11765. <returns>
  11766. <c>true</c> if the enumerator was successfully advanced to the next element;
  11767. <c>false</c> if the enumerator has passed the end of the collection.
  11768. </returns>
  11769. <exception cref="T:System.InvalidOperationException">
  11770. The collection was modified after the enumerator was created.
  11771. </exception>
  11772. </member>
  11773. <member name="M:log4net.Core.LevelCollection.Enumerator.Reset">
  11774. <summary>
  11775. Sets the enumerator to its initial position, before the first element in the collection.
  11776. </summary>
  11777. </member>
  11778. <member name="P:log4net.Core.LevelCollection.Enumerator.Current">
  11779. <summary>
  11780. Gets the current element in the collection.
  11781. </summary>
  11782. </member>
  11783. <member name="T:log4net.Core.LevelEvaluator">
  11784. <summary>
  11785. An evaluator that triggers at a threshold level
  11786. </summary>
  11787. <remarks>
  11788. <para>
  11789. This evaluator will trigger if the level of the event
  11790. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11791. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11792. level.
  11793. </para>
  11794. </remarks>
  11795. <author>Nicko Cadell</author>
  11796. </member>
  11797. <member name="F:log4net.Core.LevelEvaluator.m_threshold">
  11798. <summary>
  11799. The threshold for triggering
  11800. </summary>
  11801. </member>
  11802. <member name="M:log4net.Core.LevelEvaluator.#ctor">
  11803. <summary>
  11804. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  11805. </summary>
  11806. <remarks>
  11807. <para>
  11808. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  11809. </para>
  11810. <para>
  11811. This evaluator will trigger if the level of the event
  11812. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11813. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11814. level.
  11815. </para>
  11816. </remarks>
  11817. </member>
  11818. <member name="M:log4net.Core.LevelEvaluator.#ctor(log4net.Core.Level)">
  11819. <summary>
  11820. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  11821. </summary>
  11822. <param name="threshold">the threshold to trigger at</param>
  11823. <remarks>
  11824. <para>
  11825. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  11826. </para>
  11827. <para>
  11828. This evaluator will trigger if the level of the event
  11829. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11830. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11831. level.
  11832. </para>
  11833. </remarks>
  11834. </member>
  11835. <member name="M:log4net.Core.LevelEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  11836. <summary>
  11837. Is this <paramref name="loggingEvent"/> the triggering event?
  11838. </summary>
  11839. <param name="loggingEvent">The event to check</param>
  11840. <returns>This method returns <c>true</c>, if the event level
  11841. is equal or higher than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>.
  11842. Otherwise it returns <c>false</c></returns>
  11843. <remarks>
  11844. <para>
  11845. This evaluator will trigger if the level of the event
  11846. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11847. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11848. level.
  11849. </para>
  11850. </remarks>
  11851. </member>
  11852. <member name="P:log4net.Core.LevelEvaluator.Threshold">
  11853. <summary>
  11854. the threshold to trigger at
  11855. </summary>
  11856. <value>
  11857. The <see cref="T:log4net.Core.Level"/> that will cause this evaluator to trigger
  11858. </value>
  11859. <remarks>
  11860. <para>
  11861. This evaluator will trigger if the level of the event
  11862. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11863. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11864. level.
  11865. </para>
  11866. </remarks>
  11867. </member>
  11868. <member name="T:log4net.Core.LevelMap">
  11869. <summary>
  11870. Mapping between string name and Level object
  11871. </summary>
  11872. <remarks>
  11873. <para>
  11874. Mapping between string name and <see cref="T:log4net.Core.Level"/> object.
  11875. This mapping is held separately for each <see cref="T:log4net.Repository.ILoggerRepository"/>.
  11876. The level name is case insensitive.
  11877. </para>
  11878. </remarks>
  11879. <author>Nicko Cadell</author>
  11880. </member>
  11881. <member name="F:log4net.Core.LevelMap.m_mapName2Level">
  11882. <summary>
  11883. Mapping from level name to Level object. The
  11884. level name is case insensitive
  11885. </summary>
  11886. </member>
  11887. <member name="M:log4net.Core.LevelMap.#ctor">
  11888. <summary>
  11889. Construct the level map
  11890. </summary>
  11891. <remarks>
  11892. <para>
  11893. Construct the level map.
  11894. </para>
  11895. </remarks>
  11896. </member>
  11897. <member name="M:log4net.Core.LevelMap.Clear">
  11898. <summary>
  11899. Clear the internal maps of all levels
  11900. </summary>
  11901. <remarks>
  11902. <para>
  11903. Clear the internal maps of all levels
  11904. </para>
  11905. </remarks>
  11906. </member>
  11907. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32)">
  11908. <summary>
  11909. Create a new Level and add it to the map
  11910. </summary>
  11911. <param name="name">the string to display for the Level</param>
  11912. <param name="value">the level value to give to the Level</param>
  11913. <remarks>
  11914. <para>
  11915. Create a new Level and add it to the map
  11916. </para>
  11917. </remarks>
  11918. <seealso cref="M:Add(string,int,string)"/>
  11919. </member>
  11920. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32,System.String)">
  11921. <summary>
  11922. Create a new Level and add it to the map
  11923. </summary>
  11924. <param name="name">the string to display for the Level</param>
  11925. <param name="value">the level value to give to the Level</param>
  11926. <param name="displayName">the display name to give to the Level</param>
  11927. <remarks>
  11928. <para>
  11929. Create a new Level and add it to the map
  11930. </para>
  11931. </remarks>
  11932. </member>
  11933. <member name="M:log4net.Core.LevelMap.Add(log4net.Core.Level)">
  11934. <summary>
  11935. Add a Level to the map
  11936. </summary>
  11937. <param name="level">the Level to add</param>
  11938. <remarks>
  11939. <para>
  11940. Add a Level to the map
  11941. </para>
  11942. </remarks>
  11943. </member>
  11944. <member name="M:log4net.Core.LevelMap.LookupWithDefault(log4net.Core.Level)">
  11945. <summary>
  11946. Lookup a named level from the map
  11947. </summary>
  11948. <param name="defaultLevel">the name of the level to lookup is taken from this level.
  11949. If the level is not set on the map then this level is added</param>
  11950. <returns>the level in the map with the name specified</returns>
  11951. <remarks>
  11952. <para>
  11953. Lookup a named level from the map. The name of the level to lookup is taken
  11954. from the <see cref="P:log4net.Core.Level.Name"/> property of the <paramref name="defaultLevel"/>
  11955. argument.
  11956. </para>
  11957. <para>
  11958. If no level with the specified name is found then the
  11959. <paramref name="defaultLevel"/> argument is added to the level map
  11960. and returned.
  11961. </para>
  11962. </remarks>
  11963. </member>
  11964. <member name="P:log4net.Core.LevelMap.Item(System.String)">
  11965. <summary>
  11966. Lookup a <see cref="T:log4net.Core.Level"/> by name
  11967. </summary>
  11968. <param name="name">The name of the Level to lookup</param>
  11969. <returns>a Level from the map with the name specified</returns>
  11970. <remarks>
  11971. <para>
  11972. Returns the <see cref="T:log4net.Core.Level"/> from the
  11973. map with the name specified. If the no level is
  11974. found then <c>null</c> is returned.
  11975. </para>
  11976. </remarks>
  11977. </member>
  11978. <member name="P:log4net.Core.LevelMap.AllLevels">
  11979. <summary>
  11980. Return all possible levels as a list of Level objects.
  11981. </summary>
  11982. <returns>all possible levels as a list of Level objects</returns>
  11983. <remarks>
  11984. <para>
  11985. Return all possible levels as a list of Level objects.
  11986. </para>
  11987. </remarks>
  11988. </member>
  11989. <member name="T:log4net.Core.LocationInfo">
  11990. <summary>
  11991. The internal representation of caller location information.
  11992. </summary>
  11993. <remarks>
  11994. <para>
  11995. This class uses the <c>System.Diagnostics.StackTrace</c> class to generate
  11996. a call stack. The caller's information is then extracted from this stack.
  11997. </para>
  11998. <para>
  11999. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  12000. .NET Compact Framework 1.0 therefore caller location information is not
  12001. available on that framework.
  12002. </para>
  12003. <para>
  12004. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  12005. </para>
  12006. <para>
  12007. "StackTrace information will be most informative with Debug build configurations.
  12008. By default, Debug builds include debug symbols, while Release builds do not. The
  12009. debug symbols contain most of the file, method name, line number, and column
  12010. information used in constructing StackFrame and StackTrace objects. StackTrace
  12011. might not report as many method calls as expected, due to code transformations
  12012. that occur during optimization."
  12013. </para>
  12014. <para>
  12015. This means that in a Release build the caller information may be incomplete or may
  12016. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  12017. </para>
  12018. </remarks>
  12019. <author>Nicko Cadell</author>
  12020. <author>Gert Driesen</author>
  12021. </member>
  12022. <member name="F:log4net.Core.LocationInfo.NA">
  12023. <summary>
  12024. When location information is not available the constant
  12025. <c>NA</c> is returned. Current value of this string
  12026. constant is <b>?</b>.
  12027. </summary>
  12028. </member>
  12029. <member name="M:log4net.Core.LocationInfo.#ctor(System.Type)">
  12030. <summary>
  12031. Constructor
  12032. </summary>
  12033. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12034. the stack boundary into the logging system for this call.</param>
  12035. <remarks>
  12036. <para>
  12037. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/>
  12038. class based on the current thread.
  12039. </para>
  12040. </remarks>
  12041. </member>
  12042. <member name="M:log4net.Core.LocationInfo.#ctor(System.String,System.String,System.String,System.String)">
  12043. <summary>
  12044. Constructor
  12045. </summary>
  12046. <param name="className">The fully qualified class name.</param>
  12047. <param name="methodName">The method name.</param>
  12048. <param name="fileName">The file name.</param>
  12049. <param name="lineNumber">The line number of the method within the file.</param>
  12050. <remarks>
  12051. <para>
  12052. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/>
  12053. class with the specified data.
  12054. </para>
  12055. </remarks>
  12056. </member>
  12057. <member name="F:log4net.Core.LocationInfo.declaringType">
  12058. <summary>
  12059. The fully qualified type of the LocationInfo class.
  12060. </summary>
  12061. <remarks>
  12062. Used by the internal logger to record the Type of the
  12063. log message.
  12064. </remarks>
  12065. </member>
  12066. <member name="P:log4net.Core.LocationInfo.ClassName">
  12067. <summary>
  12068. Gets the fully qualified class name of the caller making the logging
  12069. request.
  12070. </summary>
  12071. <value>
  12072. The fully qualified class name of the caller making the logging
  12073. request.
  12074. </value>
  12075. <remarks>
  12076. <para>
  12077. Gets the fully qualified class name of the caller making the logging
  12078. request.
  12079. </para>
  12080. </remarks>
  12081. </member>
  12082. <member name="P:log4net.Core.LocationInfo.FileName">
  12083. <summary>
  12084. Gets the file name of the caller.
  12085. </summary>
  12086. <value>
  12087. The file name of the caller.
  12088. </value>
  12089. <remarks>
  12090. <para>
  12091. Gets the file name of the caller.
  12092. </para>
  12093. </remarks>
  12094. </member>
  12095. <member name="P:log4net.Core.LocationInfo.LineNumber">
  12096. <summary>
  12097. Gets the line number of the caller.
  12098. </summary>
  12099. <value>
  12100. The line number of the caller.
  12101. </value>
  12102. <remarks>
  12103. <para>
  12104. Gets the line number of the caller.
  12105. </para>
  12106. </remarks>
  12107. </member>
  12108. <member name="P:log4net.Core.LocationInfo.MethodName">
  12109. <summary>
  12110. Gets the method name of the caller.
  12111. </summary>
  12112. <value>
  12113. The method name of the caller.
  12114. </value>
  12115. <remarks>
  12116. <para>
  12117. Gets the method name of the caller.
  12118. </para>
  12119. </remarks>
  12120. </member>
  12121. <member name="P:log4net.Core.LocationInfo.FullInfo">
  12122. <summary>
  12123. Gets all available caller information
  12124. </summary>
  12125. <value>
  12126. All available caller information, in the format
  12127. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  12128. </value>
  12129. <remarks>
  12130. <para>
  12131. Gets all available caller information, in the format
  12132. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  12133. </para>
  12134. </remarks>
  12135. </member>
  12136. <member name="P:log4net.Core.LocationInfo.StackFrames">
  12137. <summary>
  12138. Gets the stack frames from the stack trace of the caller making the log request
  12139. </summary>
  12140. </member>
  12141. <member name="T:log4net.Core.LoggerManager">
  12142. <summary>
  12143. Static manager that controls the creation of repositories
  12144. </summary>
  12145. <remarks>
  12146. <para>
  12147. Static manager that controls the creation of repositories
  12148. </para>
  12149. <para>
  12150. This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>)
  12151. to provide access to the <see cref="T:log4net.Core.ILogger"/> objects.
  12152. </para>
  12153. <para>
  12154. This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to
  12155. lookup and create repositories. The selector can be set either programmatically using
  12156. the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c>
  12157. AppSetting in the applications config file to the fully qualified type name of the
  12158. selector to use.
  12159. </para>
  12160. </remarks>
  12161. <author>Nicko Cadell</author>
  12162. <author>Gert Driesen</author>
  12163. </member>
  12164. <member name="M:log4net.Core.LoggerManager.#ctor">
  12165. <summary>
  12166. Private constructor to prevent instances. Only static methods should be used.
  12167. </summary>
  12168. <remarks>
  12169. <para>
  12170. Private constructor to prevent instances. Only static methods should be used.
  12171. </para>
  12172. </remarks>
  12173. </member>
  12174. <member name="M:log4net.Core.LoggerManager.#cctor">
  12175. <summary>
  12176. Hook the shutdown event
  12177. </summary>
  12178. <remarks>
  12179. <para>
  12180. On the full .NET runtime, the static constructor hooks up the
  12181. <c>AppDomain.ProcessExit</c> and <c>AppDomain.DomainUnload</c>> events.
  12182. These are used to shutdown the log4net system as the application exits.
  12183. </para>
  12184. </remarks>
  12185. </member>
  12186. <member name="M:log4net.Core.LoggerManager.RegisterAppDomainEvents">
  12187. <summary>
  12188. Register for ProcessExit and DomainUnload events on the AppDomain
  12189. </summary>
  12190. <remarks>
  12191. <para>
  12192. This needs to be in a separate method because the events make
  12193. a LinkDemand for the ControlAppDomain SecurityPermission. Because
  12194. this is a LinkDemand it is demanded at JIT time. Therefore we cannot
  12195. catch the exception in the method itself, we have to catch it in the
  12196. caller.
  12197. </para>
  12198. </remarks>
  12199. </member>
  12200. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.String)">
  12201. <summary>
  12202. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12203. </summary>
  12204. <param name="repository">the repository to lookup in</param>
  12205. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  12206. <remarks>
  12207. <para>
  12208. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  12209. by the <paramref name="repository"/> argument.
  12210. </para>
  12211. </remarks>
  12212. </member>
  12213. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.Reflection.Assembly)">
  12214. <summary>
  12215. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12216. </summary>
  12217. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12218. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  12219. </member>
  12220. <member name="M:log4net.Core.LoggerManager.GetRepository(System.String)">
  12221. <summary>
  12222. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12223. </summary>
  12224. <param name="repository">the repository to lookup in</param>
  12225. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  12226. <remarks>
  12227. <para>
  12228. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  12229. by the <paramref name="repository"/> argument.
  12230. </para>
  12231. </remarks>
  12232. </member>
  12233. <member name="M:log4net.Core.LoggerManager.GetRepository(System.Reflection.Assembly)">
  12234. <summary>
  12235. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12236. </summary>
  12237. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12238. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  12239. <remarks>
  12240. <para>
  12241. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12242. </para>
  12243. </remarks>
  12244. </member>
  12245. <member name="M:log4net.Core.LoggerManager.Exists(System.String,System.String)">
  12246. <summary>
  12247. Returns the named logger if it exists.
  12248. </summary>
  12249. <param name="repository">The repository to lookup in.</param>
  12250. <param name="name">The fully qualified logger name to look for.</param>
  12251. <returns>
  12252. The logger found, or <c>null</c> if the named logger does not exist in the
  12253. specified repository.
  12254. </returns>
  12255. <remarks>
  12256. <para>
  12257. If the named logger exists (in the specified repository) then it
  12258. returns a reference to the logger, otherwise it returns
  12259. <c>null</c>.
  12260. </para>
  12261. </remarks>
  12262. </member>
  12263. <member name="M:log4net.Core.LoggerManager.Exists(System.Reflection.Assembly,System.String)">
  12264. <summary>
  12265. Returns the named logger if it exists.
  12266. </summary>
  12267. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12268. <param name="name">The fully qualified logger name to look for.</param>
  12269. <returns>
  12270. The logger found, or <c>null</c> if the named logger does not exist in the
  12271. specified assembly's repository.
  12272. </returns>
  12273. <remarks>
  12274. <para>
  12275. If the named logger exists (in the specified assembly's repository) then it
  12276. returns a reference to the logger, otherwise it returns
  12277. <c>null</c>.
  12278. </para>
  12279. </remarks>
  12280. </member>
  12281. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.String)">
  12282. <summary>
  12283. Returns all the currently defined loggers in the specified repository.
  12284. </summary>
  12285. <param name="repository">The repository to lookup in.</param>
  12286. <returns>All the defined loggers.</returns>
  12287. <remarks>
  12288. <para>
  12289. The root logger is <b>not</b> included in the returned array.
  12290. </para>
  12291. </remarks>
  12292. </member>
  12293. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.Reflection.Assembly)">
  12294. <summary>
  12295. Returns all the currently defined loggers in the specified assembly's repository.
  12296. </summary>
  12297. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12298. <returns>All the defined loggers.</returns>
  12299. <remarks>
  12300. <para>
  12301. The root logger is <b>not</b> included in the returned array.
  12302. </para>
  12303. </remarks>
  12304. </member>
  12305. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.String)">
  12306. <summary>
  12307. Retrieves or creates a named logger.
  12308. </summary>
  12309. <param name="repository">The repository to lookup in.</param>
  12310. <param name="name">The name of the logger to retrieve.</param>
  12311. <returns>The logger with the name specified.</returns>
  12312. <remarks>
  12313. <para>
  12314. Retrieves a logger named as the <paramref name="name"/>
  12315. parameter. If the named logger already exists, then the
  12316. existing instance will be returned. Otherwise, a new instance is
  12317. created.
  12318. </para>
  12319. <para>
  12320. By default, loggers do not have a set level but inherit
  12321. it from the hierarchy. This is one of the central features of
  12322. log4net.
  12323. </para>
  12324. </remarks>
  12325. </member>
  12326. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.String)">
  12327. <summary>
  12328. Retrieves or creates a named logger.
  12329. </summary>
  12330. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12331. <param name="name">The name of the logger to retrieve.</param>
  12332. <returns>The logger with the name specified.</returns>
  12333. <remarks>
  12334. <para>
  12335. Retrieves a logger named as the <paramref name="name"/>
  12336. parameter. If the named logger already exists, then the
  12337. existing instance will be returned. Otherwise, a new instance is
  12338. created.
  12339. </para>
  12340. <para>
  12341. By default, loggers do not have a set level but inherit
  12342. it from the hierarchy. This is one of the central features of
  12343. log4net.
  12344. </para>
  12345. </remarks>
  12346. </member>
  12347. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.Type)">
  12348. <summary>
  12349. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  12350. </summary>
  12351. <param name="repository">The repository to lookup in.</param>
  12352. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  12353. <returns>The logger with the name specified.</returns>
  12354. <remarks>
  12355. <para>
  12356. Gets the logger for the fully qualified name of the type specified.
  12357. </para>
  12358. </remarks>
  12359. </member>
  12360. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.Type)">
  12361. <summary>
  12362. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  12363. </summary>
  12364. <param name="repositoryAssembly">the assembly to use to lookup the repository</param>
  12365. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  12366. <returns>The logger with the name specified.</returns>
  12367. <remarks>
  12368. <para>
  12369. Gets the logger for the fully qualified name of the type specified.
  12370. </para>
  12371. </remarks>
  12372. </member>
  12373. <member name="M:log4net.Core.LoggerManager.Shutdown">
  12374. <summary>
  12375. Shuts down the log4net system.
  12376. </summary>
  12377. <remarks>
  12378. <para>
  12379. Calling this method will <b>safely</b> close and remove all
  12380. appenders in all the loggers including root contained in all the
  12381. default repositories.
  12382. </para>
  12383. <para>
  12384. Some appenders need to be closed before the application exists.
  12385. Otherwise, pending logging events might be lost.
  12386. </para>
  12387. <para>
  12388. The <c>shutdown</c> method is careful to close nested
  12389. appenders before closing regular appenders. This is allows
  12390. configurations where a regular appender is attached to a logger
  12391. and again to a nested appender.
  12392. </para>
  12393. </remarks>
  12394. </member>
  12395. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.String)">
  12396. <summary>
  12397. Shuts down the repository for the repository specified.
  12398. </summary>
  12399. <param name="repository">The repository to shutdown.</param>
  12400. <remarks>
  12401. <para>
  12402. Calling this method will <b>safely</b> close and remove all
  12403. appenders in all the loggers including root contained in the
  12404. repository for the <paramref name="repository"/> specified.
  12405. </para>
  12406. <para>
  12407. Some appenders need to be closed before the application exists.
  12408. Otherwise, pending logging events might be lost.
  12409. </para>
  12410. <para>
  12411. The <c>shutdown</c> method is careful to close nested
  12412. appenders before closing regular appenders. This is allows
  12413. configurations where a regular appender is attached to a logger
  12414. and again to a nested appender.
  12415. </para>
  12416. </remarks>
  12417. </member>
  12418. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.Reflection.Assembly)">
  12419. <summary>
  12420. Shuts down the repository for the repository specified.
  12421. </summary>
  12422. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12423. <remarks>
  12424. <para>
  12425. Calling this method will <b>safely</b> close and remove all
  12426. appenders in all the loggers including root contained in the
  12427. repository for the repository. The repository is looked up using
  12428. the <paramref name="repositoryAssembly"/> specified.
  12429. </para>
  12430. <para>
  12431. Some appenders need to be closed before the application exists.
  12432. Otherwise, pending logging events might be lost.
  12433. </para>
  12434. <para>
  12435. The <c>shutdown</c> method is careful to close nested
  12436. appenders before closing regular appenders. This is allows
  12437. configurations where a regular appender is attached to a logger
  12438. and again to a nested appender.
  12439. </para>
  12440. </remarks>
  12441. </member>
  12442. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.String)">
  12443. <summary>
  12444. Resets all values contained in this repository instance to their defaults.
  12445. </summary>
  12446. <param name="repository">The repository to reset.</param>
  12447. <remarks>
  12448. <para>
  12449. Resets all values contained in the repository instance to their
  12450. defaults. This removes all appenders from all loggers, sets
  12451. the level of all non-root loggers to <c>null</c>,
  12452. sets their additivity flag to <c>true</c> and sets the level
  12453. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  12454. message disabling is set its default "off" value.
  12455. </para>
  12456. </remarks>
  12457. </member>
  12458. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.Reflection.Assembly)">
  12459. <summary>
  12460. Resets all values contained in this repository instance to their defaults.
  12461. </summary>
  12462. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  12463. <remarks>
  12464. <para>
  12465. Resets all values contained in the repository instance to their
  12466. defaults. This removes all appenders from all loggers, sets
  12467. the level of all non-root loggers to <c>null</c>,
  12468. sets their additivity flag to <c>true</c> and sets the level
  12469. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  12470. message disabling is set its default "off" value.
  12471. </para>
  12472. </remarks>
  12473. </member>
  12474. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String)">
  12475. <summary>
  12476. Creates a repository with the specified name.
  12477. </summary>
  12478. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  12479. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12480. <remarks>
  12481. <para>
  12482. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12483. </para>
  12484. <para>
  12485. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  12486. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  12487. </para>
  12488. <para>
  12489. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12490. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  12491. </para>
  12492. </remarks>
  12493. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12494. </member>
  12495. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String)">
  12496. <summary>
  12497. Creates a repository with the specified name.
  12498. </summary>
  12499. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  12500. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12501. <remarks>
  12502. <para>
  12503. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  12504. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  12505. </para>
  12506. <para>
  12507. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12508. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  12509. </para>
  12510. </remarks>
  12511. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12512. </member>
  12513. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String,System.Type)">
  12514. <summary>
  12515. Creates a repository with the specified name and repository type.
  12516. </summary>
  12517. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  12518. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12519. and has a no arg constructor. An instance of this type will be created to act
  12520. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12521. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12522. <remarks>
  12523. <para>
  12524. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12525. </para>
  12526. <para>
  12527. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12528. An Exception will be thrown if the repository already exists.
  12529. </para>
  12530. </remarks>
  12531. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12532. </member>
  12533. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String,System.Type)">
  12534. <summary>
  12535. Creates a repository with the specified name and repository type.
  12536. </summary>
  12537. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  12538. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12539. and has a no arg constructor. An instance of this type will be created to act
  12540. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12541. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12542. <remarks>
  12543. <para>
  12544. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12545. An Exception will be thrown if the repository already exists.
  12546. </para>
  12547. </remarks>
  12548. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12549. </member>
  12550. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  12551. <summary>
  12552. Creates a repository for the specified assembly and repository type.
  12553. </summary>
  12554. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  12555. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12556. and has a no arg constructor. An instance of this type will be created to act
  12557. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12558. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12559. <remarks>
  12560. <para>
  12561. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12562. </para>
  12563. <para>
  12564. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  12565. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  12566. same assembly specified will return the same repository instance.
  12567. </para>
  12568. </remarks>
  12569. </member>
  12570. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  12571. <summary>
  12572. Creates a repository for the specified assembly and repository type.
  12573. </summary>
  12574. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  12575. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12576. and has a no arg constructor. An instance of this type will be created to act
  12577. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12578. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12579. <remarks>
  12580. <para>
  12581. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  12582. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  12583. same assembly specified will return the same repository instance.
  12584. </para>
  12585. </remarks>
  12586. </member>
  12587. <member name="M:log4net.Core.LoggerManager.GetAllRepositories">
  12588. <summary>
  12589. Gets an array of all currently defined repositories.
  12590. </summary>
  12591. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  12592. <remarks>
  12593. <para>
  12594. Gets an array of all currently defined repositories.
  12595. </para>
  12596. </remarks>
  12597. </member>
  12598. <member name="M:log4net.Core.LoggerManager.GetVersionInfo">
  12599. <summary>
  12600. Internal method to get pertinent version info.
  12601. </summary>
  12602. <returns>A string of version info.</returns>
  12603. </member>
  12604. <member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)">
  12605. <summary>
  12606. Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires
  12607. </summary>
  12608. <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
  12609. <param name="e">null</param>
  12610. <remarks>
  12611. <para>
  12612. Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires.
  12613. </para>
  12614. <para>
  12615. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  12616. </para>
  12617. </remarks>
  12618. </member>
  12619. <member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)">
  12620. <summary>
  12621. Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires
  12622. </summary>
  12623. <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
  12624. <param name="e">null</param>
  12625. <remarks>
  12626. <para>
  12627. Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires.
  12628. </para>
  12629. <para>
  12630. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  12631. </para>
  12632. </remarks>
  12633. </member>
  12634. <member name="F:log4net.Core.LoggerManager.declaringType">
  12635. <summary>
  12636. The fully qualified type of the LoggerManager class.
  12637. </summary>
  12638. <remarks>
  12639. Used by the internal logger to record the Type of the
  12640. log message.
  12641. </remarks>
  12642. </member>
  12643. <member name="F:log4net.Core.LoggerManager.s_repositorySelector">
  12644. <summary>
  12645. Initialize the default repository selector
  12646. </summary>
  12647. </member>
  12648. <member name="P:log4net.Core.LoggerManager.RepositorySelector">
  12649. <summary>
  12650. Gets or sets the repository selector used by the <see cref="T:log4net.LogManager"/>.
  12651. </summary>
  12652. <value>
  12653. The repository selector used by the <see cref="T:log4net.LogManager"/>.
  12654. </value>
  12655. <remarks>
  12656. <para>
  12657. The repository selector (<see cref="T:log4net.Core.IRepositorySelector"/>) is used by
  12658. the <see cref="T:log4net.LogManager"/> to create and select repositories
  12659. (<see cref="T:log4net.Repository.ILoggerRepository"/>).
  12660. </para>
  12661. <para>
  12662. The caller to <see cref="T:log4net.LogManager"/> supplies either a string name
  12663. or an assembly (if not supplied the assembly is inferred using
  12664. <see cref="M:Assembly.GetCallingAssembly()"/>).
  12665. </para>
  12666. <para>
  12667. This context is used by the selector to lookup a specific repository.
  12668. </para>
  12669. <para>
  12670. For the full .NET Framework, the default repository is <c>DefaultRepositorySelector</c>;
  12671. for the .NET Compact Framework <c>CompactRepositorySelector</c> is the default
  12672. repository.
  12673. </para>
  12674. </remarks>
  12675. </member>
  12676. <member name="T:log4net.Core.LoggerWrapperImpl">
  12677. <summary>
  12678. Implementation of the <see cref="T:log4net.Core.ILoggerWrapper"/> interface.
  12679. </summary>
  12680. <remarks>
  12681. <para>
  12682. This class should be used as the base for all wrapper implementations.
  12683. </para>
  12684. </remarks>
  12685. <author>Nicko Cadell</author>
  12686. <author>Gert Driesen</author>
  12687. </member>
  12688. <member name="M:log4net.Core.LoggerWrapperImpl.#ctor(log4net.Core.ILogger)">
  12689. <summary>
  12690. Constructs a new wrapper for the specified logger.
  12691. </summary>
  12692. <param name="logger">The logger to wrap.</param>
  12693. <remarks>
  12694. <para>
  12695. Constructs a new wrapper for the specified logger.
  12696. </para>
  12697. </remarks>
  12698. </member>
  12699. <member name="F:log4net.Core.LoggerWrapperImpl.m_logger">
  12700. <summary>
  12701. The logger that this object is wrapping
  12702. </summary>
  12703. </member>
  12704. <member name="P:log4net.Core.LoggerWrapperImpl.Logger">
  12705. <summary>
  12706. Gets the implementation behind this wrapper object.
  12707. </summary>
  12708. <value>
  12709. The <see cref="T:log4net.Core.ILogger"/> object that this object is implementing.
  12710. </value>
  12711. <remarks>
  12712. <para>
  12713. The <c>Logger</c> object may not be the same object as this object
  12714. because of logger decorators.
  12715. </para>
  12716. <para>
  12717. This gets the actual underlying objects that is used to process
  12718. the log events.
  12719. </para>
  12720. </remarks>
  12721. </member>
  12722. <member name="T:log4net.Core.LoggingEventData">
  12723. <summary>
  12724. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  12725. </summary>
  12726. <remarks>
  12727. <para>
  12728. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  12729. </para>
  12730. </remarks>
  12731. <author>Nicko Cadell</author>
  12732. </member>
  12733. <member name="F:log4net.Core.LoggingEventData.LoggerName">
  12734. <summary>
  12735. The logger name.
  12736. </summary>
  12737. <remarks>
  12738. <para>
  12739. The logger name.
  12740. </para>
  12741. </remarks>
  12742. </member>
  12743. <member name="F:log4net.Core.LoggingEventData.Level">
  12744. <summary>
  12745. Level of logging event.
  12746. </summary>
  12747. <remarks>
  12748. <para>
  12749. Level of logging event. Level cannot be Serializable
  12750. because it is a flyweight. Due to its special serialization it
  12751. cannot be declared final either.
  12752. </para>
  12753. </remarks>
  12754. </member>
  12755. <member name="F:log4net.Core.LoggingEventData.Message">
  12756. <summary>
  12757. The application supplied message.
  12758. </summary>
  12759. <remarks>
  12760. <para>
  12761. The application supplied message of logging event.
  12762. </para>
  12763. </remarks>
  12764. </member>
  12765. <member name="F:log4net.Core.LoggingEventData.ThreadName">
  12766. <summary>
  12767. The name of thread
  12768. </summary>
  12769. <remarks>
  12770. <para>
  12771. The name of thread in which this logging event was generated
  12772. </para>
  12773. </remarks>
  12774. </member>
  12775. <member name="F:log4net.Core.LoggingEventData.TimeStamp">
  12776. <summary>
  12777. Gets or sets the local time the event was logged
  12778. </summary>
  12779. <remarks>
  12780. <para>
  12781. Prefer using the <see cref="P:log4net.Core.LoggingEventData.TimeStampUtc"/> setter, since local time can be ambiguous.
  12782. </para>
  12783. </remarks>
  12784. </member>
  12785. <member name="F:log4net.Core.LoggingEventData.LocationInfo">
  12786. <summary>
  12787. Location information for the caller.
  12788. </summary>
  12789. <remarks>
  12790. <para>
  12791. Location information for the caller.
  12792. </para>
  12793. </remarks>
  12794. </member>
  12795. <member name="F:log4net.Core.LoggingEventData.UserName">
  12796. <summary>
  12797. String representation of the user
  12798. </summary>
  12799. <remarks>
  12800. <para>
  12801. String representation of the user's windows name,
  12802. like DOMAIN\username
  12803. </para>
  12804. </remarks>
  12805. </member>
  12806. <member name="F:log4net.Core.LoggingEventData.Identity">
  12807. <summary>
  12808. String representation of the identity.
  12809. </summary>
  12810. <remarks>
  12811. <para>
  12812. String representation of the current thread's principal identity.
  12813. </para>
  12814. </remarks>
  12815. </member>
  12816. <member name="F:log4net.Core.LoggingEventData.ExceptionString">
  12817. <summary>
  12818. The string representation of the exception
  12819. </summary>
  12820. <remarks>
  12821. <para>
  12822. The string representation of the exception
  12823. </para>
  12824. </remarks>
  12825. </member>
  12826. <member name="F:log4net.Core.LoggingEventData.Domain">
  12827. <summary>
  12828. String representation of the AppDomain.
  12829. </summary>
  12830. <remarks>
  12831. <para>
  12832. String representation of the AppDomain.
  12833. </para>
  12834. </remarks>
  12835. </member>
  12836. <member name="F:log4net.Core.LoggingEventData.Properties">
  12837. <summary>
  12838. Additional event specific properties
  12839. </summary>
  12840. <remarks>
  12841. <para>
  12842. A logger or an appender may attach additional
  12843. properties to specific events. These properties
  12844. have a string key and an object value.
  12845. </para>
  12846. </remarks>
  12847. </member>
  12848. <member name="P:log4net.Core.LoggingEventData.TimeStampUtc">
  12849. <summary>
  12850. Gets or sets the UTC time the event was logged
  12851. </summary>
  12852. <remarks>
  12853. <para>
  12854. The TimeStamp is stored in the UTC time zone.
  12855. </para>
  12856. </remarks>
  12857. </member>
  12858. <member name="T:log4net.Core.FixFlags">
  12859. <summary>
  12860. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  12861. </summary>
  12862. <remarks>
  12863. <para>
  12864. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  12865. </para>
  12866. </remarks>
  12867. <author>Nicko Cadell</author>
  12868. </member>
  12869. <member name="F:log4net.Core.FixFlags.Mdc">
  12870. <summary>
  12871. Fix the MDC
  12872. </summary>
  12873. </member>
  12874. <member name="F:log4net.Core.FixFlags.Ndc">
  12875. <summary>
  12876. Fix the NDC
  12877. </summary>
  12878. </member>
  12879. <member name="F:log4net.Core.FixFlags.Message">
  12880. <summary>
  12881. Fix the rendered message
  12882. </summary>
  12883. </member>
  12884. <member name="F:log4net.Core.FixFlags.ThreadName">
  12885. <summary>
  12886. Fix the thread name
  12887. </summary>
  12888. </member>
  12889. <member name="F:log4net.Core.FixFlags.LocationInfo">
  12890. <summary>
  12891. Fix the callers location information
  12892. </summary>
  12893. <remarks>
  12894. CAUTION: Very slow to generate
  12895. </remarks>
  12896. </member>
  12897. <member name="F:log4net.Core.FixFlags.UserName">
  12898. <summary>
  12899. Fix the callers windows user name
  12900. </summary>
  12901. <remarks>
  12902. CAUTION: Slow to generate
  12903. </remarks>
  12904. </member>
  12905. <member name="F:log4net.Core.FixFlags.Domain">
  12906. <summary>
  12907. Fix the domain friendly name
  12908. </summary>
  12909. </member>
  12910. <member name="F:log4net.Core.FixFlags.Identity">
  12911. <summary>
  12912. Fix the callers principal name
  12913. </summary>
  12914. <remarks>
  12915. CAUTION: May be slow to generate
  12916. </remarks>
  12917. </member>
  12918. <member name="F:log4net.Core.FixFlags.Exception">
  12919. <summary>
  12920. Fix the exception text
  12921. </summary>
  12922. </member>
  12923. <member name="F:log4net.Core.FixFlags.Properties">
  12924. <summary>
  12925. Fix the event properties. Active properties must implement <see cref="T:log4net.Core.IFixingRequired"/> in order to be eligible for fixing.
  12926. </summary>
  12927. </member>
  12928. <member name="F:log4net.Core.FixFlags.None">
  12929. <summary>
  12930. No fields fixed
  12931. </summary>
  12932. </member>
  12933. <member name="F:log4net.Core.FixFlags.All">
  12934. <summary>
  12935. All fields fixed
  12936. </summary>
  12937. </member>
  12938. <member name="F:log4net.Core.FixFlags.Partial">
  12939. <summary>
  12940. Partial fields fixed
  12941. </summary>
  12942. <remarks>
  12943. <para>
  12944. This set of partial fields gives good performance. The following fields are fixed:
  12945. </para>
  12946. <list type="bullet">
  12947. <item><description><see cref="F:log4net.Core.FixFlags.Message"/></description></item>
  12948. <item><description><see cref="F:log4net.Core.FixFlags.ThreadName"/></description></item>
  12949. <item><description><see cref="F:log4net.Core.FixFlags.Exception"/></description></item>
  12950. <item><description><see cref="F:log4net.Core.FixFlags.Domain"/></description></item>
  12951. <item><description><see cref="F:log4net.Core.FixFlags.Properties"/></description></item>
  12952. </list>
  12953. </remarks>
  12954. </member>
  12955. <member name="T:log4net.Core.LoggingEvent">
  12956. <summary>
  12957. The internal representation of logging events.
  12958. </summary>
  12959. <remarks>
  12960. <para>
  12961. When an affirmative decision is made to log then a
  12962. <see cref="T:log4net.Core.LoggingEvent"/> instance is created. This instance
  12963. is passed around to the different log4net components.
  12964. </para>
  12965. <para>
  12966. This class is of concern to those wishing to extend log4net.
  12967. </para>
  12968. <para>
  12969. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  12970. are considered volatile, that is the values are correct at the
  12971. time the event is delivered to appenders, but will not be consistent
  12972. at any time afterwards. If an event is to be stored and then processed
  12973. at a later time these volatile values must be fixed by calling
  12974. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  12975. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  12976. is essential to maintaining data consistency.
  12977. </para>
  12978. </remarks>
  12979. <author>Nicko Cadell</author>
  12980. <author>Gert Driesen</author>
  12981. <author>Douglas de la Torre</author>
  12982. <author>Daniel Cazzulino</author>
  12983. </member>
  12984. <member name="F:log4net.Core.LoggingEvent.HostNameProperty">
  12985. <summary>
  12986. The key into the Properties map for the host name value.
  12987. </summary>
  12988. </member>
  12989. <member name="F:log4net.Core.LoggingEvent.IdentityProperty">
  12990. <summary>
  12991. The key into the Properties map for the thread identity value.
  12992. </summary>
  12993. </member>
  12994. <member name="F:log4net.Core.LoggingEvent.UserNameProperty">
  12995. <summary>
  12996. The key into the Properties map for the user name value.
  12997. </summary>
  12998. </member>
  12999. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,System.String,log4net.Core.Level,System.Object,System.Exception)">
  13000. <summary>
  13001. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  13002. from the supplied parameters.
  13003. </summary>
  13004. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  13005. the stack boundary into the logging system for this call.</param>
  13006. <param name="repository">The repository this event is logged in.</param>
  13007. <param name="loggerName">The name of the logger of this event.</param>
  13008. <param name="level">The level of this event.</param>
  13009. <param name="message">The message of this event.</param>
  13010. <param name="exception">The exception for this event.</param>
  13011. <remarks>
  13012. <para>
  13013. Except <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>, <see cref="P:log4net.Core.LoggingEvent.Level"/> and <see cref="P:log4net.Core.LoggingEvent.LoggerName"/>,
  13014. all fields of <c>LoggingEvent</c> are filled when actually needed. Call
  13015. <see cref="M:FixVolatileData()"/> to cache all data locally
  13016. to prevent inconsistencies.
  13017. </para>
  13018. <para>This method is called by the log4net framework
  13019. to create a logging event.
  13020. </para>
  13021. </remarks>
  13022. </member>
  13023. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)">
  13024. <summary>
  13025. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  13026. using specific data.
  13027. </summary>
  13028. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  13029. the stack boundary into the logging system for this call.</param>
  13030. <param name="repository">The repository this event is logged in.</param>
  13031. <param name="data">Data used to initialize the logging event.</param>
  13032. <param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param>
  13033. <remarks>
  13034. <para>
  13035. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
  13036. to be created independently of the log4net framework. This can
  13037. be useful if you require a custom serialization scheme.
  13038. </para>
  13039. <para>
  13040. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  13041. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  13042. </para>
  13043. <para>
  13044. The <paramref name="fixedData"/> parameter should be used to specify which fields in the
  13045. <paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/>
  13046. will be captured from the environment if requested or fixed.
  13047. </para>
  13048. </remarks>
  13049. </member>
  13050. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)">
  13051. <summary>
  13052. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  13053. using specific data.
  13054. </summary>
  13055. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  13056. the stack boundary into the logging system for this call.</param>
  13057. <param name="repository">The repository this event is logged in.</param>
  13058. <param name="data">Data used to initialize the logging event.</param>
  13059. <remarks>
  13060. <para>
  13061. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
  13062. to be created independently of the log4net framework. This can
  13063. be useful if you require a custom serialization scheme.
  13064. </para>
  13065. <para>
  13066. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  13067. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  13068. </para>
  13069. <para>
  13070. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  13071. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  13072. parameter and no other data should be captured from the environment.
  13073. </para>
  13074. </remarks>
  13075. </member>
  13076. <member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)">
  13077. <summary>
  13078. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  13079. using specific data.
  13080. </summary>
  13081. <param name="data">Data used to initialize the logging event.</param>
  13082. <remarks>
  13083. <para>
  13084. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
  13085. to be created independently of the log4net framework. This can
  13086. be useful if you require a custom serialization scheme.
  13087. </para>
  13088. <para>
  13089. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  13090. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  13091. </para>
  13092. <para>
  13093. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  13094. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  13095. parameter and no other data should be captured from the environment.
  13096. </para>
  13097. </remarks>
  13098. </member>
  13099. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13100. <summary>
  13101. Serialization constructor
  13102. </summary>
  13103. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
  13104. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  13105. <remarks>
  13106. <para>
  13107. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  13108. with serialized data.
  13109. </para>
  13110. </remarks>
  13111. </member>
  13112. <member name="M:log4net.Core.LoggingEvent.EnsureRepository(log4net.Repository.ILoggerRepository)">
  13113. <summary>
  13114. Ensure that the repository is set.
  13115. </summary>
  13116. <param name="repository">the value for the repository</param>
  13117. </member>
  13118. <member name="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)">
  13119. <summary>
  13120. Write the rendered message to a TextWriter
  13121. </summary>
  13122. <param name="writer">the writer to write the message to</param>
  13123. <remarks>
  13124. <para>
  13125. Unlike the <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property this method
  13126. does store the message data in the internal cache. Therefore
  13127. if called only once this method should be faster than the
  13128. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property, however if the message is
  13129. to be accessed multiple times then the property will be more efficient.
  13130. </para>
  13131. </remarks>
  13132. </member>
  13133. <member name="M:log4net.Core.LoggingEvent.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13134. <summary>
  13135. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
  13136. </summary>
  13137. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
  13138. <param name="context">The destination for this serialization.</param>
  13139. <remarks>
  13140. <para>
  13141. The data in this event must be fixed before it can be serialized.
  13142. </para>
  13143. <para>
  13144. The <see cref="M:FixVolatileData()"/> method must be called during the
  13145. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method call if this event
  13146. is to be used outside that method.
  13147. </para>
  13148. </remarks>
  13149. </member>
  13150. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData">
  13151. <summary>
  13152. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>.
  13153. </summary>
  13154. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  13155. <remarks>
  13156. <para>
  13157. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  13158. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  13159. </para>
  13160. <para>
  13161. Does a <see cref="F:log4net.Core.FixFlags.Partial"/> fix of the data
  13162. in the logging event before returning the event data.
  13163. </para>
  13164. </remarks>
  13165. </member>
  13166. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)">
  13167. <summary>
  13168. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>.
  13169. </summary>
  13170. <param name="fixFlags">The set of data to ensure is fixed in the LoggingEventData</param>
  13171. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  13172. <remarks>
  13173. <para>
  13174. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  13175. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  13176. </para>
  13177. </remarks>
  13178. </member>
  13179. <member name="M:log4net.Core.LoggingEvent.GetExceptionStrRep">
  13180. <summary>
  13181. Returns this event's exception's rendered using the
  13182. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13183. </summary>
  13184. <returns>
  13185. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13186. </returns>
  13187. <remarks>
  13188. <para>
  13189. <b>Obsolete. Use <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> instead.</b>
  13190. </para>
  13191. </remarks>
  13192. </member>
  13193. <member name="M:log4net.Core.LoggingEvent.GetExceptionString">
  13194. <summary>
  13195. Returns this event's exception's rendered using the
  13196. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13197. </summary>
  13198. <returns>
  13199. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13200. </returns>
  13201. <remarks>
  13202. <para>
  13203. Returns this event's exception's rendered using the
  13204. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13205. </para>
  13206. </remarks>
  13207. </member>
  13208. <member name="M:log4net.Core.LoggingEvent.FixVolatileData">
  13209. <summary>
  13210. Fix instance fields that hold volatile data.
  13211. </summary>
  13212. <remarks>
  13213. <para>
  13214. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  13215. are considered volatile, that is the values are correct at the
  13216. time the event is delivered to appenders, but will not be consistent
  13217. at any time afterwards. If an event is to be stored and then processed
  13218. at a later time these volatile values must be fixed by calling
  13219. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  13220. incurred by calling <see cref="M:FixVolatileData()"/> but it
  13221. is essential to maintaining data consistency.
  13222. </para>
  13223. <para>
  13224. Calling <see cref="M:FixVolatileData()"/> is equivalent to
  13225. calling <see cref="M:FixVolatileData(bool)"/> passing the parameter
  13226. <c>false</c>.
  13227. </para>
  13228. <para>
  13229. See <see cref="M:FixVolatileData(bool)"/> for more
  13230. information.
  13231. </para>
  13232. </remarks>
  13233. </member>
  13234. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)">
  13235. <summary>
  13236. Fixes instance fields that hold volatile data.
  13237. </summary>
  13238. <param name="fastButLoose">Set to <c>true</c> to not fix data that takes a long time to fix.</param>
  13239. <remarks>
  13240. <para>
  13241. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  13242. are considered volatile, that is the values are correct at the
  13243. time the event is delivered to appenders, but will not be consistent
  13244. at any time afterwards. If an event is to be stored and then processed
  13245. at a later time these volatile values must be fixed by calling
  13246. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  13247. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  13248. is essential to maintaining data consistency.
  13249. </para>
  13250. <para>
  13251. The <paramref name="fastButLoose"/> param controls the data that
  13252. is fixed. Some of the data that can be fixed takes a long time to
  13253. generate, therefore if you do not require those settings to be fixed
  13254. they can be ignored by setting the <paramref name="fastButLoose"/> param
  13255. to <c>true</c>. This setting will ignore the <see cref="P:log4net.Core.LoggingEvent.LocationInformation"/>
  13256. and <see cref="P:log4net.Core.LoggingEvent.UserName"/> settings.
  13257. </para>
  13258. <para>
  13259. Set <paramref name="fastButLoose"/> to <c>false</c> to ensure that all
  13260. settings are fixed.
  13261. </para>
  13262. </remarks>
  13263. </member>
  13264. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)">
  13265. <summary>
  13266. Fix the fields specified by the <see cref="T:log4net.Core.FixFlags"/> parameter
  13267. </summary>
  13268. <param name="flags">the fields to fix</param>
  13269. <remarks>
  13270. <para>
  13271. Only fields specified in the <paramref name="flags"/> will be fixed.
  13272. Fields will not be fixed if they have previously been fixed.
  13273. It is not possible to 'unfix' a field.
  13274. </para>
  13275. </remarks>
  13276. </member>
  13277. <member name="M:log4net.Core.LoggingEvent.LookupProperty(System.String)">
  13278. <summary>
  13279. Lookup a composite property in this event
  13280. </summary>
  13281. <param name="key">the key for the property to lookup</param>
  13282. <returns>the value for the property</returns>
  13283. <remarks>
  13284. <para>
  13285. This event has composite properties that combine together properties from
  13286. several different contexts in the following order:
  13287. <list type="definition">
  13288. <item>
  13289. <term>this events properties</term>
  13290. <description>
  13291. This event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  13292. properties are specific to this event only.
  13293. </description>
  13294. </item>
  13295. <item>
  13296. <term>the thread properties</term>
  13297. <description>
  13298. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  13299. thread. These properties are shared by all events logged on this thread.
  13300. </description>
  13301. </item>
  13302. <item>
  13303. <term>the global properties</term>
  13304. <description>
  13305. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  13306. properties are shared by all the threads in the AppDomain.
  13307. </description>
  13308. </item>
  13309. </list>
  13310. </para>
  13311. </remarks>
  13312. </member>
  13313. <member name="M:log4net.Core.LoggingEvent.GetProperties">
  13314. <summary>
  13315. Get all the composite properties in this event
  13316. </summary>
  13317. <returns>the <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the properties</returns>
  13318. <remarks>
  13319. <para>
  13320. See <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> for details of the composite properties
  13321. stored by the event.
  13322. </para>
  13323. <para>
  13324. This method returns a single <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the
  13325. properties defined for this event.
  13326. </para>
  13327. </remarks>
  13328. </member>
  13329. <member name="F:log4net.Core.LoggingEvent.m_data">
  13330. <summary>
  13331. The internal logging event data.
  13332. </summary>
  13333. </member>
  13334. <member name="F:log4net.Core.LoggingEvent.m_compositeProperties">
  13335. <summary>
  13336. The internal logging event data.
  13337. </summary>
  13338. </member>
  13339. <member name="F:log4net.Core.LoggingEvent.m_eventProperties">
  13340. <summary>
  13341. The internal logging event data.
  13342. </summary>
  13343. </member>
  13344. <member name="F:log4net.Core.LoggingEvent.m_callerStackBoundaryDeclaringType">
  13345. <summary>
  13346. The fully qualified Type of the calling
  13347. logger class in the stack frame (i.e. the declaring type of the method).
  13348. </summary>
  13349. </member>
  13350. <member name="F:log4net.Core.LoggingEvent.m_message">
  13351. <summary>
  13352. The application supplied message of logging event.
  13353. </summary>
  13354. </member>
  13355. <member name="F:log4net.Core.LoggingEvent.m_thrownException">
  13356. <summary>
  13357. The exception that was thrown.
  13358. </summary>
  13359. <remarks>
  13360. This is not serialized. The string representation
  13361. is serialized instead.
  13362. </remarks>
  13363. </member>
  13364. <member name="F:log4net.Core.LoggingEvent.m_repository">
  13365. <summary>
  13366. The repository that generated the logging event
  13367. </summary>
  13368. <remarks>
  13369. This is not serialized.
  13370. </remarks>
  13371. </member>
  13372. <member name="F:log4net.Core.LoggingEvent.m_fixFlags">
  13373. <summary>
  13374. The fix state for this event
  13375. </summary>
  13376. <remarks>
  13377. These flags indicate which fields have been fixed.
  13378. Not serialized.
  13379. </remarks>
  13380. </member>
  13381. <member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable">
  13382. <summary>
  13383. Indicated that the internal cache is updateable (ie not fixed)
  13384. </summary>
  13385. <remarks>
  13386. This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler
  13387. changes in the caching strategy.
  13388. </remarks>
  13389. </member>
  13390. <member name="P:log4net.Core.LoggingEvent.StartTime">
  13391. <summary>
  13392. Gets the time when the current process started.
  13393. </summary>
  13394. <value>
  13395. This is the time when this process started.
  13396. </value>
  13397. <remarks>
  13398. <para>
  13399. The TimeStamp is stored internally in UTC and converted to the local time zone for this computer.
  13400. </para>
  13401. <para>
  13402. Tries to get the start time for the current process.
  13403. Failing that it returns the time of the first call to
  13404. this property.
  13405. </para>
  13406. <para>
  13407. Note that AppDomains may be loaded and unloaded within the
  13408. same process without the process terminating and therefore
  13409. without the process start time being reset.
  13410. </para>
  13411. </remarks>
  13412. </member>
  13413. <member name="P:log4net.Core.LoggingEvent.StartTimeUtc">
  13414. <summary>
  13415. Gets the UTC time when the current process started.
  13416. </summary>
  13417. <value>
  13418. This is the UTC time when this process started.
  13419. </value>
  13420. <remarks>
  13421. <para>
  13422. Tries to get the start time for the current process.
  13423. Failing that it returns the time of the first call to
  13424. this property.
  13425. </para>
  13426. <para>
  13427. Note that AppDomains may be loaded and unloaded within the
  13428. same process without the process terminating and therefore
  13429. without the process start time being reset.
  13430. </para>
  13431. </remarks>
  13432. </member>
  13433. <member name="P:log4net.Core.LoggingEvent.Level">
  13434. <summary>
  13435. Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
  13436. </summary>
  13437. <value>
  13438. The <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
  13439. </value>
  13440. <remarks>
  13441. <para>
  13442. Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
  13443. </para>
  13444. </remarks>
  13445. </member>
  13446. <member name="P:log4net.Core.LoggingEvent.TimeStamp">
  13447. <summary>
  13448. Gets the time of the logging event.
  13449. </summary>
  13450. <value>
  13451. The time of the logging event.
  13452. </value>
  13453. <remarks>
  13454. <para>
  13455. The TimeStamp is stored in UTC and converted to the local time zone for this computer.
  13456. </para>
  13457. </remarks>
  13458. </member>
  13459. <member name="P:log4net.Core.LoggingEvent.TimeStampUtc">
  13460. <summary>
  13461. Gets UTC the time of the logging event.
  13462. </summary>
  13463. <value>
  13464. The UTC time of the logging event.
  13465. </value>
  13466. </member>
  13467. <member name="P:log4net.Core.LoggingEvent.LoggerName">
  13468. <summary>
  13469. Gets the name of the logger that logged the event.
  13470. </summary>
  13471. <value>
  13472. The name of the logger that logged the event.
  13473. </value>
  13474. <remarks>
  13475. <para>
  13476. Gets the name of the logger that logged the event.
  13477. </para>
  13478. </remarks>
  13479. </member>
  13480. <member name="P:log4net.Core.LoggingEvent.LocationInformation">
  13481. <summary>
  13482. Gets the location information for this logging event.
  13483. </summary>
  13484. <value>
  13485. The location information for this logging event.
  13486. </value>
  13487. <remarks>
  13488. <para>
  13489. The collected information is cached for future use.
  13490. </para>
  13491. <para>
  13492. See the <see cref="T:log4net.Core.LocationInfo"/> class for more information on
  13493. supported frameworks and the different behavior in Debug and
  13494. Release builds.
  13495. </para>
  13496. </remarks>
  13497. </member>
  13498. <member name="P:log4net.Core.LoggingEvent.MessageObject">
  13499. <summary>
  13500. Gets the message object used to initialize this event.
  13501. </summary>
  13502. <value>
  13503. The message object used to initialize this event.
  13504. </value>
  13505. <remarks>
  13506. <para>
  13507. Gets the message object used to initialize this event.
  13508. Note that this event may not have a valid message object.
  13509. If the event is serialized the message object will not
  13510. be transferred. To get the text of the message the
  13511. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property must be used
  13512. not this property.
  13513. </para>
  13514. <para>
  13515. If there is no defined message object for this event then
  13516. null will be returned.
  13517. </para>
  13518. </remarks>
  13519. </member>
  13520. <member name="P:log4net.Core.LoggingEvent.ExceptionObject">
  13521. <summary>
  13522. Gets the exception object used to initialize this event.
  13523. </summary>
  13524. <value>
  13525. The exception object used to initialize this event.
  13526. </value>
  13527. <remarks>
  13528. <para>
  13529. Gets the exception object used to initialize this event.
  13530. Note that this event may not have a valid exception object.
  13531. If the event is serialized the exception object will not
  13532. be transferred. To get the text of the exception the
  13533. <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> method must be used
  13534. not this property.
  13535. </para>
  13536. <para>
  13537. If there is no defined exception object for this event then
  13538. null will be returned.
  13539. </para>
  13540. </remarks>
  13541. </member>
  13542. <member name="P:log4net.Core.LoggingEvent.Repository">
  13543. <summary>
  13544. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  13545. </summary>
  13546. <remarks>
  13547. <para>
  13548. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  13549. </para>
  13550. </remarks>
  13551. </member>
  13552. <member name="P:log4net.Core.LoggingEvent.RenderedMessage">
  13553. <summary>
  13554. Gets the message, rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13555. </summary>
  13556. <value>
  13557. The message rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13558. </value>
  13559. <remarks>
  13560. <para>
  13561. The collected information is cached for future use.
  13562. </para>
  13563. </remarks>
  13564. </member>
  13565. <member name="P:log4net.Core.LoggingEvent.ThreadName">
  13566. <summary>
  13567. Gets the name of the current thread.
  13568. </summary>
  13569. <value>
  13570. The name of the current thread, or the thread ID when
  13571. the name is not available.
  13572. </value>
  13573. <remarks>
  13574. <para>
  13575. The collected information is cached for future use.
  13576. </para>
  13577. </remarks>
  13578. </member>
  13579. <member name="P:log4net.Core.LoggingEvent.UserName">
  13580. <summary>
  13581. Gets the name of the current user.
  13582. </summary>
  13583. <value>
  13584. The name of the current user, or <c>NOT AVAILABLE</c> when the
  13585. underlying runtime has no support for retrieving the name of the
  13586. current user.
  13587. </value>
  13588. <remarks>
  13589. <para>
  13590. Calls <c>WindowsIdentity.GetCurrent().Name</c> to get the name of
  13591. the current windows user.
  13592. </para>
  13593. <para>
  13594. To improve performance, we could cache the string representation of
  13595. the name, and reuse that as long as the identity stayed constant.
  13596. Once the identity changed, we would need to re-assign and re-render
  13597. the string.
  13598. </para>
  13599. <para>
  13600. However, the <c>WindowsIdentity.GetCurrent()</c> call seems to
  13601. return different objects every time, so the current implementation
  13602. doesn't do this type of caching.
  13603. </para>
  13604. <para>
  13605. Timing for these operations:
  13606. </para>
  13607. <list type="table">
  13608. <listheader>
  13609. <term>Method</term>
  13610. <description>Results</description>
  13611. </listheader>
  13612. <item>
  13613. <term><c>WindowsIdentity.GetCurrent()</c></term>
  13614. <description>10000 loops, 00:00:00.2031250 seconds</description>
  13615. </item>
  13616. <item>
  13617. <term><c>WindowsIdentity.GetCurrent().Name</c></term>
  13618. <description>10000 loops, 00:00:08.0468750 seconds</description>
  13619. </item>
  13620. </list>
  13621. <para>
  13622. This means we could speed things up almost 40 times by caching the
  13623. value of the <c>WindowsIdentity.GetCurrent().Name</c> property, since
  13624. this takes (8.04-0.20) = 7.84375 seconds.
  13625. </para>
  13626. </remarks>
  13627. </member>
  13628. <member name="P:log4net.Core.LoggingEvent.Identity">
  13629. <summary>
  13630. Gets the identity of the current thread principal.
  13631. </summary>
  13632. <value>
  13633. The string name of the identity of the current thread principal.
  13634. </value>
  13635. <remarks>
  13636. <para>
  13637. Calls <c>System.Threading.Thread.CurrentPrincipal.Identity.Name</c> to get
  13638. the name of the current thread principal.
  13639. </para>
  13640. </remarks>
  13641. </member>
  13642. <member name="P:log4net.Core.LoggingEvent.Domain">
  13643. <summary>
  13644. Gets the AppDomain friendly name.
  13645. </summary>
  13646. <value>
  13647. The AppDomain friendly name.
  13648. </value>
  13649. <remarks>
  13650. <para>
  13651. Gets the AppDomain friendly name.
  13652. </para>
  13653. </remarks>
  13654. </member>
  13655. <member name="P:log4net.Core.LoggingEvent.Properties">
  13656. <summary>
  13657. Additional event specific properties.
  13658. </summary>
  13659. <value>
  13660. Additional event specific properties.
  13661. </value>
  13662. <remarks>
  13663. <para>
  13664. A logger or an appender may attach additional
  13665. properties to specific events. These properties
  13666. have a string key and an object value.
  13667. </para>
  13668. <para>
  13669. This property is for events that have been added directly to
  13670. this event. The aggregate properties (which include these
  13671. event properties) can be retrieved using <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/>
  13672. and <see cref="M:log4net.Core.LoggingEvent.GetProperties"/>.
  13673. </para>
  13674. <para>
  13675. Once the properties have been fixed <see cref="P:log4net.Core.LoggingEvent.Fix"/> this property
  13676. returns the combined cached properties. This ensures that updates to
  13677. this property are always reflected in the underlying storage. When
  13678. returning the combined properties there may be more keys in the
  13679. Dictionary than expected.
  13680. </para>
  13681. </remarks>
  13682. </member>
  13683. <member name="P:log4net.Core.LoggingEvent.Fix">
  13684. <summary>
  13685. The fixed fields in this event
  13686. </summary>
  13687. <value>
  13688. The set of fields that are fixed in this event
  13689. </value>
  13690. <remarks>
  13691. <para>
  13692. Fields will not be fixed if they have previously been fixed.
  13693. It is not possible to 'unfix' a field.
  13694. </para>
  13695. </remarks>
  13696. </member>
  13697. <member name="T:log4net.Core.LogImpl">
  13698. <summary>
  13699. Implementation of <see cref="T:log4net.ILog"/> wrapper interface.
  13700. </summary>
  13701. <remarks>
  13702. <para>
  13703. This implementation of the <see cref="T:log4net.ILog"/> interface
  13704. forwards to the <see cref="T:log4net.Core.ILogger"/> held by the base class.
  13705. </para>
  13706. <para>
  13707. This logger has methods to allow the caller to log at the following
  13708. levels:
  13709. </para>
  13710. <list type="definition">
  13711. <item>
  13712. <term>DEBUG</term>
  13713. <description>
  13714. The <see cref="M:Debug(object)"/> and <see cref="M:DebugFormat(string, object[])"/> methods log messages
  13715. at the <c>DEBUG</c> level. That is the level with that name defined in the
  13716. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13717. for this level is <see cref="F:log4net.Core.Level.Debug"/>. The <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  13718. property tests if this level is enabled for logging.
  13719. </description>
  13720. </item>
  13721. <item>
  13722. <term>INFO</term>
  13723. <description>
  13724. The <see cref="M:Info(object)"/> and <see cref="M:InfoFormat(string, object[])"/> methods log messages
  13725. at the <c>INFO</c> level. That is the level with that name defined in the
  13726. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13727. for this level is <see cref="F:log4net.Core.Level.Info"/>. The <see cref="P:log4net.Core.LogImpl.IsInfoEnabled"/>
  13728. property tests if this level is enabled for logging.
  13729. </description>
  13730. </item>
  13731. <item>
  13732. <term>WARN</term>
  13733. <description>
  13734. The <see cref="M:Warn(object)"/> and <see cref="M:WarnFormat(string, object[])"/> methods log messages
  13735. at the <c>WARN</c> level. That is the level with that name defined in the
  13736. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13737. for this level is <see cref="F:log4net.Core.Level.Warn"/>. The <see cref="P:log4net.Core.LogImpl.IsWarnEnabled"/>
  13738. property tests if this level is enabled for logging.
  13739. </description>
  13740. </item>
  13741. <item>
  13742. <term>ERROR</term>
  13743. <description>
  13744. The <see cref="M:Error(object)"/> and <see cref="M:ErrorFormat(string, object[])"/> methods log messages
  13745. at the <c>ERROR</c> level. That is the level with that name defined in the
  13746. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13747. for this level is <see cref="F:log4net.Core.Level.Error"/>. The <see cref="P:log4net.Core.LogImpl.IsErrorEnabled"/>
  13748. property tests if this level is enabled for logging.
  13749. </description>
  13750. </item>
  13751. <item>
  13752. <term>FATAL</term>
  13753. <description>
  13754. The <see cref="M:Fatal(object)"/> and <see cref="M:FatalFormat(string, object[])"/> methods log messages
  13755. at the <c>FATAL</c> level. That is the level with that name defined in the
  13756. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13757. for this level is <see cref="F:log4net.Core.Level.Fatal"/>. The <see cref="P:log4net.Core.LogImpl.IsFatalEnabled"/>
  13758. property tests if this level is enabled for logging.
  13759. </description>
  13760. </item>
  13761. </list>
  13762. <para>
  13763. The values for these levels and their semantic meanings can be changed by
  13764. configuring the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> for the repository.
  13765. </para>
  13766. </remarks>
  13767. <author>Nicko Cadell</author>
  13768. <author>Gert Driesen</author>
  13769. </member>
  13770. <member name="T:log4net.ILog">
  13771. <summary>
  13772. The ILog interface is use by application to log messages into
  13773. the log4net framework.
  13774. </summary>
  13775. <remarks>
  13776. <para>
  13777. Use the <see cref="T:log4net.LogManager"/> to obtain logger instances
  13778. that implement this interface. The <see cref="M:LogManager.GetLogger(Assembly,Type)"/>
  13779. static method is used to get logger instances.
  13780. </para>
  13781. <para>
  13782. This class contains methods for logging at different levels and also
  13783. has properties for determining if those logging levels are
  13784. enabled in the current configuration.
  13785. </para>
  13786. <para>
  13787. This interface can be implemented in different ways. This documentation
  13788. specifies reasonable behavior that a caller can expect from the actual
  13789. implementation, however different implementations reserve the right to
  13790. do things differently.
  13791. </para>
  13792. </remarks>
  13793. <example>Simple example of logging messages
  13794. <code lang="C#">
  13795. ILog log = LogManager.GetLogger("application-log");
  13796. log.Info("Application Start");
  13797. log.Debug("This is a debug message");
  13798. if (log.IsDebugEnabled)
  13799. {
  13800. log.Debug("This is another debug message");
  13801. }
  13802. </code>
  13803. </example>
  13804. <seealso cref="T:log4net.LogManager"/>
  13805. <seealso cref="M:LogManager.GetLogger(Assembly, Type)"/>
  13806. <author>Nicko Cadell</author>
  13807. <author>Gert Driesen</author>
  13808. </member>
  13809. <member name="M:log4net.ILog.Debug(System.Object)">
  13810. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  13811. <summary>
  13812. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13813. </summary>
  13814. <param name="message">The message object to log.</param>
  13815. <remarks>
  13816. <para>
  13817. This method first checks if this logger is <c>DEBUG</c>
  13818. enabled by comparing the level of this logger with the
  13819. <see cref="F:log4net.Core.Level.Debug"/> level. If this logger is
  13820. <c>DEBUG</c> enabled, then it converts the message object
  13821. (passed as parameter) to a string by invoking the appropriate
  13822. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13823. proceeds to call all the registered appenders in this logger
  13824. and also higher in the hierarchy depending on the value of
  13825. the additivity flag.
  13826. </para>
  13827. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13828. to this method will print the name of the <see cref="T:System.Exception"/>
  13829. but no stack trace. To print a stack trace use the
  13830. <see cref="M:Debug(object,Exception)"/> form instead.
  13831. </para>
  13832. </remarks>
  13833. <seealso cref="M:Debug(object,Exception)"/>
  13834. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13835. </member>
  13836. <member name="M:log4net.ILog.Debug(System.Object,System.Exception)">
  13837. <summary>
  13838. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  13839. the stack trace of the <see cref="T:System.Exception"/> passed
  13840. as a parameter.
  13841. </summary>
  13842. <param name="message">The message object to log.</param>
  13843. <param name="exception">The exception to log, including its stack trace.</param>
  13844. <remarks>
  13845. <para>
  13846. See the <see cref="M:Debug(object)"/> form for more detailed information.
  13847. </para>
  13848. </remarks>
  13849. <seealso cref="M:Debug(object)"/>
  13850. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13851. </member>
  13852. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object[])">
  13853. <overloads>Log a formatted string with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  13854. <summary>
  13855. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13856. </summary>
  13857. <param name="format">A String containing zero or more format items</param>
  13858. <param name="args">An Object array containing zero or more objects to format</param>
  13859. <remarks>
  13860. <para>
  13861. The message is formatted using the <c>String.Format</c> method. See
  13862. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13863. of the formatting.
  13864. </para>
  13865. <para>
  13866. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13867. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13868. methods instead.
  13869. </para>
  13870. </remarks>
  13871. <seealso cref="M:Debug(object)"/>
  13872. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13873. </member>
  13874. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object)">
  13875. <summary>
  13876. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13877. </summary>
  13878. <param name="format">A String containing zero or more format items</param>
  13879. <param name="arg0">An Object to format</param>
  13880. <remarks>
  13881. <para>
  13882. The message is formatted using the <c>String.Format</c> method. See
  13883. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13884. of the formatting.
  13885. </para>
  13886. <para>
  13887. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13888. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13889. methods instead.
  13890. </para>
  13891. </remarks>
  13892. <seealso cref="M:Debug(object)"/>
  13893. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13894. </member>
  13895. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)">
  13896. <summary>
  13897. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13898. </summary>
  13899. <param name="format">A String containing zero or more format items</param>
  13900. <param name="arg0">An Object to format</param>
  13901. <param name="arg1">An Object to format</param>
  13902. <remarks>
  13903. <para>
  13904. The message is formatted using the <c>String.Format</c> method. See
  13905. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13906. of the formatting.
  13907. </para>
  13908. <para>
  13909. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13910. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13911. methods instead.
  13912. </para>
  13913. </remarks>
  13914. <seealso cref="M:Debug(object)"/>
  13915. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13916. </member>
  13917. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  13918. <summary>
  13919. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13920. </summary>
  13921. <param name="format">A String containing zero or more format items</param>
  13922. <param name="arg0">An Object to format</param>
  13923. <param name="arg1">An Object to format</param>
  13924. <param name="arg2">An Object to format</param>
  13925. <remarks>
  13926. <para>
  13927. The message is formatted using the <c>String.Format</c> method. See
  13928. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13929. of the formatting.
  13930. </para>
  13931. <para>
  13932. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13933. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13934. methods instead.
  13935. </para>
  13936. </remarks>
  13937. <seealso cref="M:Debug(object)"/>
  13938. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13939. </member>
  13940. <member name="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  13941. <summary>
  13942. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13943. </summary>
  13944. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  13945. <param name="format">A String containing zero or more format items</param>
  13946. <param name="args">An Object array containing zero or more objects to format</param>
  13947. <remarks>
  13948. <para>
  13949. The message is formatted using the <c>String.Format</c> method. See
  13950. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13951. of the formatting.
  13952. </para>
  13953. <para>
  13954. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13955. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13956. methods instead.
  13957. </para>
  13958. </remarks>
  13959. <seealso cref="M:Debug(object)"/>
  13960. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13961. </member>
  13962. <member name="M:log4net.ILog.Info(System.Object)">
  13963. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  13964. <summary>
  13965. Logs a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  13966. </summary>
  13967. <remarks>
  13968. <para>
  13969. This method first checks if this logger is <c>INFO</c>
  13970. enabled by comparing the level of this logger with the
  13971. <see cref="F:log4net.Core.Level.Info"/> level. If this logger is
  13972. <c>INFO</c> enabled, then it converts the message object
  13973. (passed as parameter) to a string by invoking the appropriate
  13974. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13975. proceeds to call all the registered appenders in this logger
  13976. and also higher in the hierarchy depending on the value of the
  13977. additivity flag.
  13978. </para>
  13979. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13980. to this method will print the name of the <see cref="T:System.Exception"/>
  13981. but no stack trace. To print a stack trace use the
  13982. <see cref="M:Info(object,Exception)"/> form instead.
  13983. </para>
  13984. </remarks>
  13985. <param name="message">The message object to log.</param>
  13986. <seealso cref="M:Info(object,Exception)"/>
  13987. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  13988. </member>
  13989. <member name="M:log4net.ILog.Info(System.Object,System.Exception)">
  13990. <summary>
  13991. Logs a message object with the <c>INFO</c> level including
  13992. the stack trace of the <see cref="T:System.Exception"/> passed
  13993. as a parameter.
  13994. </summary>
  13995. <param name="message">The message object to log.</param>
  13996. <param name="exception">The exception to log, including its stack trace.</param>
  13997. <remarks>
  13998. <para>
  13999. See the <see cref="M:Info(object)"/> form for more detailed information.
  14000. </para>
  14001. </remarks>
  14002. <seealso cref="M:Info(object)"/>
  14003. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14004. </member>
  14005. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
  14006. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  14007. <summary>
  14008. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14009. </summary>
  14010. <param name="format">A String containing zero or more format items</param>
  14011. <param name="args">An Object array containing zero or more objects to format</param>
  14012. <remarks>
  14013. <para>
  14014. The message is formatted using the <c>String.Format</c> method. See
  14015. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14016. of the formatting.
  14017. </para>
  14018. <para>
  14019. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14020. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14021. methods instead.
  14022. </para>
  14023. </remarks>
  14024. <seealso cref="M:Info(object,Exception)"/>
  14025. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14026. </member>
  14027. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object)">
  14028. <summary>
  14029. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14030. </summary>
  14031. <param name="format">A String containing zero or more format items</param>
  14032. <param name="arg0">An Object to format</param>
  14033. <remarks>
  14034. <para>
  14035. The message is formatted using the <c>String.Format</c> method. See
  14036. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14037. of the formatting.
  14038. </para>
  14039. <para>
  14040. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14041. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14042. methods instead.
  14043. </para>
  14044. </remarks>
  14045. <seealso cref="M:Info(object)"/>
  14046. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14047. </member>
  14048. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)">
  14049. <summary>
  14050. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14051. </summary>
  14052. <param name="format">A String containing zero or more format items</param>
  14053. <param name="arg0">An Object to format</param>
  14054. <param name="arg1">An Object to format</param>
  14055. <remarks>
  14056. <para>
  14057. The message is formatted using the <c>String.Format</c> method. See
  14058. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14059. of the formatting.
  14060. </para>
  14061. <para>
  14062. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14063. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14064. methods instead.
  14065. </para>
  14066. </remarks>
  14067. <seealso cref="M:Info(object)"/>
  14068. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14069. </member>
  14070. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  14071. <summary>
  14072. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14073. </summary>
  14074. <param name="format">A String containing zero or more format items</param>
  14075. <param name="arg0">An Object to format</param>
  14076. <param name="arg1">An Object to format</param>
  14077. <param name="arg2">An Object to format</param>
  14078. <remarks>
  14079. <para>
  14080. The message is formatted using the <c>String.Format</c> method. See
  14081. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14082. of the formatting.
  14083. </para>
  14084. <para>
  14085. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14086. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14087. methods instead.
  14088. </para>
  14089. </remarks>
  14090. <seealso cref="M:Info(object)"/>
  14091. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14092. </member>
  14093. <member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  14094. <summary>
  14095. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14096. </summary>
  14097. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14098. <param name="format">A String containing zero or more format items</param>
  14099. <param name="args">An Object array containing zero or more objects to format</param>
  14100. <remarks>
  14101. <para>
  14102. The message is formatted using the <c>String.Format</c> method. See
  14103. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14104. of the formatting.
  14105. </para>
  14106. <para>
  14107. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14108. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14109. methods instead.
  14110. </para>
  14111. </remarks>
  14112. <seealso cref="M:Info(object,Exception)"/>
  14113. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14114. </member>
  14115. <member name="M:log4net.ILog.Warn(System.Object)">
  14116. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  14117. <summary>
  14118. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14119. </summary>
  14120. <remarks>
  14121. <para>
  14122. This method first checks if this logger is <c>WARN</c>
  14123. enabled by comparing the level of this logger with the
  14124. <see cref="F:log4net.Core.Level.Warn"/> level. If this logger is
  14125. <c>WARN</c> enabled, then it converts the message object
  14126. (passed as parameter) to a string by invoking the appropriate
  14127. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14128. proceeds to call all the registered appenders in this logger
  14129. and also higher in the hierarchy depending on the value of the
  14130. additivity flag.
  14131. </para>
  14132. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14133. to this method will print the name of the <see cref="T:System.Exception"/>
  14134. but no stack trace. To print a stack trace use the
  14135. <see cref="M:Warn(object,Exception)"/> form instead.
  14136. </para>
  14137. </remarks>
  14138. <param name="message">The message object to log.</param>
  14139. <seealso cref="M:Warn(object,Exception)"/>
  14140. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14141. </member>
  14142. <member name="M:log4net.ILog.Warn(System.Object,System.Exception)">
  14143. <summary>
  14144. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  14145. the stack trace of the <see cref="T:System.Exception"/> passed
  14146. as a parameter.
  14147. </summary>
  14148. <param name="message">The message object to log.</param>
  14149. <param name="exception">The exception to log, including its stack trace.</param>
  14150. <remarks>
  14151. <para>
  14152. See the <see cref="M:Warn(object)"/> form for more detailed information.
  14153. </para>
  14154. </remarks>
  14155. <seealso cref="M:Warn(object)"/>
  14156. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14157. </member>
  14158. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object[])">
  14159. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  14160. <summary>
  14161. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14162. </summary>
  14163. <param name="format">A String containing zero or more format items</param>
  14164. <param name="args">An Object array containing zero or more objects to format</param>
  14165. <remarks>
  14166. <para>
  14167. The message is formatted using the <c>String.Format</c> method. See
  14168. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14169. of the formatting.
  14170. </para>
  14171. <para>
  14172. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14173. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14174. methods instead.
  14175. </para>
  14176. </remarks>
  14177. <seealso cref="M:Warn(object,Exception)"/>
  14178. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14179. </member>
  14180. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object)">
  14181. <summary>
  14182. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14183. </summary>
  14184. <param name="format">A String containing zero or more format items</param>
  14185. <param name="arg0">An Object to format</param>
  14186. <remarks>
  14187. <para>
  14188. The message is formatted using the <c>String.Format</c> method. See
  14189. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14190. of the formatting.
  14191. </para>
  14192. <para>
  14193. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14194. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14195. methods instead.
  14196. </para>
  14197. </remarks>
  14198. <seealso cref="M:Warn(object)"/>
  14199. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14200. </member>
  14201. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)">
  14202. <summary>
  14203. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14204. </summary>
  14205. <param name="format">A String containing zero or more format items</param>
  14206. <param name="arg0">An Object to format</param>
  14207. <param name="arg1">An Object to format</param>
  14208. <remarks>
  14209. <para>
  14210. The message is formatted using the <c>String.Format</c> method. See
  14211. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14212. of the formatting.
  14213. </para>
  14214. <para>
  14215. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14216. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14217. methods instead.
  14218. </para>
  14219. </remarks>
  14220. <seealso cref="M:Warn(object)"/>
  14221. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14222. </member>
  14223. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  14224. <summary>
  14225. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14226. </summary>
  14227. <param name="format">A String containing zero or more format items</param>
  14228. <param name="arg0">An Object to format</param>
  14229. <param name="arg1">An Object to format</param>
  14230. <param name="arg2">An Object to format</param>
  14231. <remarks>
  14232. <para>
  14233. The message is formatted using the <c>String.Format</c> method. See
  14234. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14235. of the formatting.
  14236. </para>
  14237. <para>
  14238. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14239. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14240. methods instead.
  14241. </para>
  14242. </remarks>
  14243. <seealso cref="M:Warn(object)"/>
  14244. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14245. </member>
  14246. <member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  14247. <summary>
  14248. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14249. </summary>
  14250. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14251. <param name="format">A String containing zero or more format items</param>
  14252. <param name="args">An Object array containing zero or more objects to format</param>
  14253. <remarks>
  14254. <para>
  14255. The message is formatted using the <c>String.Format</c> method. See
  14256. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14257. of the formatting.
  14258. </para>
  14259. <para>
  14260. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14261. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14262. methods instead.
  14263. </para>
  14264. </remarks>
  14265. <seealso cref="M:Warn(object,Exception)"/>
  14266. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14267. </member>
  14268. <member name="M:log4net.ILog.Error(System.Object)">
  14269. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  14270. <summary>
  14271. Logs a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  14272. </summary>
  14273. <param name="message">The message object to log.</param>
  14274. <remarks>
  14275. <para>
  14276. This method first checks if this logger is <c>ERROR</c>
  14277. enabled by comparing the level of this logger with the
  14278. <see cref="F:log4net.Core.Level.Error"/> level. If this logger is
  14279. <c>ERROR</c> enabled, then it converts the message object
  14280. (passed as parameter) to a string by invoking the appropriate
  14281. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14282. proceeds to call all the registered appenders in this logger
  14283. and also higher in the hierarchy depending on the value of the
  14284. additivity flag.
  14285. </para>
  14286. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14287. to this method will print the name of the <see cref="T:System.Exception"/>
  14288. but no stack trace. To print a stack trace use the
  14289. <see cref="M:Error(object,Exception)"/> form instead.
  14290. </para>
  14291. </remarks>
  14292. <seealso cref="M:Error(object,Exception)"/>
  14293. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14294. </member>
  14295. <member name="M:log4net.ILog.Error(System.Object,System.Exception)">
  14296. <summary>
  14297. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  14298. the stack trace of the <see cref="T:System.Exception"/> passed
  14299. as a parameter.
  14300. </summary>
  14301. <param name="message">The message object to log.</param>
  14302. <param name="exception">The exception to log, including its stack trace.</param>
  14303. <remarks>
  14304. <para>
  14305. See the <see cref="M:Error(object)"/> form for more detailed information.
  14306. </para>
  14307. </remarks>
  14308. <seealso cref="M:Error(object)"/>
  14309. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14310. </member>
  14311. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object[])">
  14312. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  14313. <summary>
  14314. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14315. </summary>
  14316. <param name="format">A String containing zero or more format items</param>
  14317. <param name="args">An Object array containing zero or more objects to format</param>
  14318. <remarks>
  14319. <para>
  14320. The message is formatted using the <c>String.Format</c> method. See
  14321. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14322. of the formatting.
  14323. </para>
  14324. <para>
  14325. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14326. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14327. methods instead.
  14328. </para>
  14329. </remarks>
  14330. <seealso cref="M:Error(object,Exception)"/>
  14331. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14332. </member>
  14333. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)">
  14334. <summary>
  14335. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14336. </summary>
  14337. <param name="format">A String containing zero or more format items</param>
  14338. <param name="arg0">An Object to format</param>
  14339. <remarks>
  14340. <para>
  14341. The message is formatted using the <c>String.Format</c> method. See
  14342. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14343. of the formatting.
  14344. </para>
  14345. <para>
  14346. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14347. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  14348. methods instead.
  14349. </para>
  14350. </remarks>
  14351. <seealso cref="M:Error(object)"/>
  14352. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14353. </member>
  14354. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)">
  14355. <summary>
  14356. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14357. </summary>
  14358. <param name="format">A String containing zero or more format items</param>
  14359. <param name="arg0">An Object to format</param>
  14360. <param name="arg1">An Object to format</param>
  14361. <remarks>
  14362. <para>
  14363. The message is formatted using the <c>String.Format</c> method. See
  14364. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14365. of the formatting.
  14366. </para>
  14367. <para>
  14368. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14369. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  14370. methods instead.
  14371. </para>
  14372. </remarks>
  14373. <seealso cref="M:Error(object)"/>
  14374. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14375. </member>
  14376. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  14377. <summary>
  14378. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14379. </summary>
  14380. <param name="format">A String containing zero or more format items</param>
  14381. <param name="arg0">An Object to format</param>
  14382. <param name="arg1">An Object to format</param>
  14383. <param name="arg2">An Object to format</param>
  14384. <remarks>
  14385. <para>
  14386. The message is formatted using the <c>String.Format</c> method. See
  14387. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14388. of the formatting.
  14389. </para>
  14390. <para>
  14391. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14392. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  14393. methods instead.
  14394. </para>
  14395. </remarks>
  14396. <seealso cref="M:Error(object)"/>
  14397. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14398. </member>
  14399. <member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  14400. <summary>
  14401. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14402. </summary>
  14403. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14404. <param name="format">A String containing zero or more format items</param>
  14405. <param name="args">An Object array containing zero or more objects to format</param>
  14406. <remarks>
  14407. <para>
  14408. The message is formatted using the <c>String.Format</c> method. See
  14409. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14410. of the formatting.
  14411. </para>
  14412. <para>
  14413. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14414. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14415. methods instead.
  14416. </para>
  14417. </remarks>
  14418. <seealso cref="M:Error(object,Exception)"/>
  14419. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14420. </member>
  14421. <member name="M:log4net.ILog.Fatal(System.Object)">
  14422. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  14423. <summary>
  14424. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14425. </summary>
  14426. <remarks>
  14427. <para>
  14428. This method first checks if this logger is <c>FATAL</c>
  14429. enabled by comparing the level of this logger with the
  14430. <see cref="F:log4net.Core.Level.Fatal"/> level. If this logger is
  14431. <c>FATAL</c> enabled, then it converts the message object
  14432. (passed as parameter) to a string by invoking the appropriate
  14433. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14434. proceeds to call all the registered appenders in this logger
  14435. and also higher in the hierarchy depending on the value of the
  14436. additivity flag.
  14437. </para>
  14438. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14439. to this method will print the name of the <see cref="T:System.Exception"/>
  14440. but no stack trace. To print a stack trace use the
  14441. <see cref="M:Fatal(object,Exception)"/> form instead.
  14442. </para>
  14443. </remarks>
  14444. <param name="message">The message object to log.</param>
  14445. <seealso cref="M:Fatal(object,Exception)"/>
  14446. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14447. </member>
  14448. <member name="M:log4net.ILog.Fatal(System.Object,System.Exception)">
  14449. <summary>
  14450. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  14451. the stack trace of the <see cref="T:System.Exception"/> passed
  14452. as a parameter.
  14453. </summary>
  14454. <param name="message">The message object to log.</param>
  14455. <param name="exception">The exception to log, including its stack trace.</param>
  14456. <remarks>
  14457. <para>
  14458. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  14459. </para>
  14460. </remarks>
  14461. <seealso cref="M:Fatal(object)"/>
  14462. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14463. </member>
  14464. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object[])">
  14465. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  14466. <summary>
  14467. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14468. </summary>
  14469. <param name="format">A String containing zero or more format items</param>
  14470. <param name="args">An Object array containing zero or more objects to format</param>
  14471. <remarks>
  14472. <para>
  14473. The message is formatted using the <c>String.Format</c> method. See
  14474. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14475. of the formatting.
  14476. </para>
  14477. <para>
  14478. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14479. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14480. methods instead.
  14481. </para>
  14482. </remarks>
  14483. <seealso cref="M:Fatal(object,Exception)"/>
  14484. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14485. </member>
  14486. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object)">
  14487. <summary>
  14488. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14489. </summary>
  14490. <param name="format">A String containing zero or more format items</param>
  14491. <param name="arg0">An Object to format</param>
  14492. <remarks>
  14493. <para>
  14494. The message is formatted using the <c>String.Format</c> method. See
  14495. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14496. of the formatting.
  14497. </para>
  14498. <para>
  14499. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14500. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  14501. methods instead.
  14502. </para>
  14503. </remarks>
  14504. <seealso cref="M:Fatal(object)"/>
  14505. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14506. </member>
  14507. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)">
  14508. <summary>
  14509. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14510. </summary>
  14511. <param name="format">A String containing zero or more format items</param>
  14512. <param name="arg0">An Object to format</param>
  14513. <param name="arg1">An Object to format</param>
  14514. <remarks>
  14515. <para>
  14516. The message is formatted using the <c>String.Format</c> method. See
  14517. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14518. of the formatting.
  14519. </para>
  14520. <para>
  14521. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14522. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  14523. methods instead.
  14524. </para>
  14525. </remarks>
  14526. <seealso cref="M:Fatal(object)"/>
  14527. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14528. </member>
  14529. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  14530. <summary>
  14531. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14532. </summary>
  14533. <param name="format">A String containing zero or more format items</param>
  14534. <param name="arg0">An Object to format</param>
  14535. <param name="arg1">An Object to format</param>
  14536. <param name="arg2">An Object to format</param>
  14537. <remarks>
  14538. <para>
  14539. The message is formatted using the <c>String.Format</c> method. See
  14540. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14541. of the formatting.
  14542. </para>
  14543. <para>
  14544. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14545. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  14546. methods instead.
  14547. </para>
  14548. </remarks>
  14549. <seealso cref="M:Fatal(object)"/>
  14550. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14551. </member>
  14552. <member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  14553. <summary>
  14554. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14555. </summary>
  14556. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14557. <param name="format">A String containing zero or more format items</param>
  14558. <param name="args">An Object array containing zero or more objects to format</param>
  14559. <remarks>
  14560. <para>
  14561. The message is formatted using the <c>String.Format</c> method. See
  14562. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14563. of the formatting.
  14564. </para>
  14565. <para>
  14566. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14567. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14568. methods instead.
  14569. </para>
  14570. </remarks>
  14571. <seealso cref="M:Fatal(object,Exception)"/>
  14572. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14573. </member>
  14574. <member name="P:log4net.ILog.IsDebugEnabled">
  14575. <summary>
  14576. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Debug"/> level.
  14577. </summary>
  14578. <value>
  14579. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Debug"/> events, <c>false</c> otherwise.
  14580. </value>
  14581. <remarks>
  14582. <para>
  14583. This function is intended to lessen the computational cost of
  14584. disabled log debug statements.
  14585. </para>
  14586. <para> For some ILog interface <c>log</c>, when you write:</para>
  14587. <code lang="C#">
  14588. log.Debug("This is entry number: " + i );
  14589. </code>
  14590. <para>
  14591. You incur the cost constructing the message, string construction and concatenation in
  14592. this case, regardless of whether the message is logged or not.
  14593. </para>
  14594. <para>
  14595. If you are worried about speed (who isn't), then you should write:
  14596. </para>
  14597. <code lang="C#">
  14598. if (log.IsDebugEnabled)
  14599. {
  14600. log.Debug("This is entry number: " + i );
  14601. }
  14602. </code>
  14603. <para>
  14604. This way you will not incur the cost of parameter
  14605. construction if debugging is disabled for <c>log</c>. On
  14606. the other hand, if the <c>log</c> is debug enabled, you
  14607. will incur the cost of evaluating whether the logger is debug
  14608. enabled twice. Once in <see cref="P:log4net.ILog.IsDebugEnabled"/> and once in
  14609. the <see cref="M:Debug(object)"/>. This is an insignificant overhead
  14610. since evaluating a logger takes about 1% of the time it
  14611. takes to actually log. This is the preferred style of logging.
  14612. </para>
  14613. <para>Alternatively if your logger is available statically then the is debug
  14614. enabled state can be stored in a static variable like this:
  14615. </para>
  14616. <code lang="C#">
  14617. private static readonly bool isDebugEnabled = log.IsDebugEnabled;
  14618. </code>
  14619. <para>
  14620. Then when you come to log you can write:
  14621. </para>
  14622. <code lang="C#">
  14623. if (isDebugEnabled)
  14624. {
  14625. log.Debug("This is entry number: " + i );
  14626. }
  14627. </code>
  14628. <para>
  14629. This way the debug enabled state is only queried once
  14630. when the class is loaded. Using a <c>private static readonly</c>
  14631. variable is the most efficient because it is a run time constant
  14632. and can be heavily optimized by the JIT compiler.
  14633. </para>
  14634. <para>
  14635. Of course if you use a static readonly variable to
  14636. hold the enabled state of the logger then you cannot
  14637. change the enabled state at runtime to vary the logging
  14638. that is produced. You have to decide if you need absolute
  14639. speed or runtime flexibility.
  14640. </para>
  14641. </remarks>
  14642. <seealso cref="M:Debug(object)"/>
  14643. <seealso cref="M:DebugFormat(IFormatProvider, string, object[])"/>
  14644. </member>
  14645. <member name="P:log4net.ILog.IsInfoEnabled">
  14646. <summary>
  14647. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Info"/> level.
  14648. </summary>
  14649. <value>
  14650. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Info"/> events, <c>false</c> otherwise.
  14651. </value>
  14652. <remarks>
  14653. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14654. </remarks>
  14655. <seealso cref="M:Info(object)"/>
  14656. <seealso cref="M:InfoFormat(IFormatProvider, string, object[])"/>
  14657. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14658. </member>
  14659. <member name="P:log4net.ILog.IsWarnEnabled">
  14660. <summary>
  14661. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Warn"/> level.
  14662. </summary>
  14663. <value>
  14664. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Warn"/> events, <c>false</c> otherwise.
  14665. </value>
  14666. <remarks>
  14667. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14668. </remarks>
  14669. <seealso cref="M:Warn(object)"/>
  14670. <seealso cref="M:WarnFormat(IFormatProvider, string, object[])"/>
  14671. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14672. </member>
  14673. <member name="P:log4net.ILog.IsErrorEnabled">
  14674. <summary>
  14675. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Error"/> level.
  14676. </summary>
  14677. <value>
  14678. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Error"/> events, <c>false</c> otherwise.
  14679. </value>
  14680. <remarks>
  14681. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14682. </remarks>
  14683. <seealso cref="M:Error(object)"/>
  14684. <seealso cref="M:ErrorFormat(IFormatProvider, string, object[])"/>
  14685. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14686. </member>
  14687. <member name="P:log4net.ILog.IsFatalEnabled">
  14688. <summary>
  14689. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14690. </summary>
  14691. <value>
  14692. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Fatal"/> events, <c>false</c> otherwise.
  14693. </value>
  14694. <remarks>
  14695. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14696. </remarks>
  14697. <seealso cref="M:Fatal(object)"/>
  14698. <seealso cref="M:FatalFormat(IFormatProvider, string, object[])"/>
  14699. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14700. </member>
  14701. <member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)">
  14702. <summary>
  14703. Construct a new wrapper for the specified logger.
  14704. </summary>
  14705. <param name="logger">The logger to wrap.</param>
  14706. <remarks>
  14707. <para>
  14708. Construct a new wrapper for the specified logger.
  14709. </para>
  14710. </remarks>
  14711. </member>
  14712. <member name="M:log4net.Core.LogImpl.ReloadLevels(log4net.Repository.ILoggerRepository)">
  14713. <summary>
  14714. Virtual method called when the configuration of the repository changes
  14715. </summary>
  14716. <param name="repository">the repository holding the levels</param>
  14717. <remarks>
  14718. <para>
  14719. Virtual method called when the configuration of the repository changes
  14720. </para>
  14721. </remarks>
  14722. </member>
  14723. <member name="M:log4net.Core.LogImpl.Debug(System.Object)">
  14724. <summary>
  14725. Logs a message object with the <c>DEBUG</c> level.
  14726. </summary>
  14727. <param name="message">The message object to log.</param>
  14728. <remarks>
  14729. <para>
  14730. This method first checks if this logger is <c>DEBUG</c>
  14731. enabled by comparing the level of this logger with the
  14732. <c>DEBUG</c> level. If this logger is
  14733. <c>DEBUG</c> enabled, then it converts the message object
  14734. (passed as parameter) to a string by invoking the appropriate
  14735. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14736. proceeds to call all the registered appenders in this logger
  14737. and also higher in the hierarchy depending on the value of the
  14738. additivity flag.
  14739. </para>
  14740. <para>
  14741. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14742. to this method will print the name of the <see cref="T:System.Exception"/>
  14743. but no stack trace. To print a stack trace use the
  14744. <see cref="M:Debug(object,Exception)"/> form instead.
  14745. </para>
  14746. </remarks>
  14747. </member>
  14748. <member name="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)">
  14749. <summary>
  14750. Logs a message object with the <c>DEBUG</c> level
  14751. </summary>
  14752. <param name="message">The message object to log.</param>
  14753. <param name="exception">The exception to log, including its stack trace.</param>
  14754. <remarks>
  14755. <para>
  14756. Logs a message object with the <c>DEBUG</c> level including
  14757. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> passed
  14758. as a parameter.
  14759. </para>
  14760. <para>
  14761. See the <see cref="M:Debug(object)"/> form for more detailed information.
  14762. </para>
  14763. </remarks>
  14764. <seealso cref="M:Debug(object)"/>
  14765. </member>
  14766. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
  14767. <summary>
  14768. Logs a formatted message string with the <c>DEBUG</c> level.
  14769. </summary>
  14770. <param name="format">A String containing zero or more format items</param>
  14771. <param name="args">An Object array containing zero or more objects to format</param>
  14772. <remarks>
  14773. <para>
  14774. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14775. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14776. of the formatting.
  14777. </para>
  14778. <para>
  14779. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14780. format provider. To specify a localized provider use the
  14781. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14782. </para>
  14783. <para>
  14784. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14785. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14786. methods instead.
  14787. </para>
  14788. </remarks>
  14789. </member>
  14790. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)">
  14791. <summary>
  14792. Logs a formatted message string with the <c>DEBUG</c> level.
  14793. </summary>
  14794. <param name="format">A String containing zero or more format items</param>
  14795. <param name="arg0">An Object to format</param>
  14796. <remarks>
  14797. <para>
  14798. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14799. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14800. of the formatting.
  14801. </para>
  14802. <para>
  14803. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14804. format provider. To specify a localized provider use the
  14805. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14806. </para>
  14807. <para>
  14808. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14809. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14810. methods instead.
  14811. </para>
  14812. </remarks>
  14813. </member>
  14814. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)">
  14815. <summary>
  14816. Logs a formatted message string with the <c>DEBUG</c> level.
  14817. </summary>
  14818. <param name="format">A String containing zero or more format items</param>
  14819. <param name="arg0">An Object to format</param>
  14820. <param name="arg1">An Object to format</param>
  14821. <remarks>
  14822. <para>
  14823. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14824. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14825. of the formatting.
  14826. </para>
  14827. <para>
  14828. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14829. format provider. To specify a localized provider use the
  14830. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14831. </para>
  14832. <para>
  14833. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14834. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14835. methods instead.
  14836. </para>
  14837. </remarks>
  14838. </member>
  14839. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  14840. <summary>
  14841. Logs a formatted message string with the <c>DEBUG</c> level.
  14842. </summary>
  14843. <param name="format">A String containing zero or more format items</param>
  14844. <param name="arg0">An Object to format</param>
  14845. <param name="arg1">An Object to format</param>
  14846. <param name="arg2">An Object to format</param>
  14847. <remarks>
  14848. <para>
  14849. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14850. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14851. of the formatting.
  14852. </para>
  14853. <para>
  14854. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14855. format provider. To specify a localized provider use the
  14856. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14857. </para>
  14858. <para>
  14859. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14860. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14861. methods instead.
  14862. </para>
  14863. </remarks>
  14864. </member>
  14865. <member name="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  14866. <summary>
  14867. Logs a formatted message string with the <c>DEBUG</c> level.
  14868. </summary>
  14869. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14870. <param name="format">A String containing zero or more format items</param>
  14871. <param name="args">An Object array containing zero or more objects to format</param>
  14872. <remarks>
  14873. <para>
  14874. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14875. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14876. of the formatting.
  14877. </para>
  14878. <para>
  14879. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14880. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14881. methods instead.
  14882. </para>
  14883. </remarks>
  14884. </member>
  14885. <member name="M:log4net.Core.LogImpl.Info(System.Object)">
  14886. <summary>
  14887. Logs a message object with the <c>INFO</c> level.
  14888. </summary>
  14889. <param name="message">The message object to log.</param>
  14890. <remarks>
  14891. <para>
  14892. This method first checks if this logger is <c>INFO</c>
  14893. enabled by comparing the level of this logger with the
  14894. <c>INFO</c> level. If this logger is
  14895. <c>INFO</c> enabled, then it converts the message object
  14896. (passed as parameter) to a string by invoking the appropriate
  14897. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14898. proceeds to call all the registered appenders in this logger
  14899. and also higher in the hierarchy depending on the value of
  14900. the additivity flag.
  14901. </para>
  14902. <para>
  14903. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14904. to this method will print the name of the <see cref="T:System.Exception"/>
  14905. but no stack trace. To print a stack trace use the
  14906. <see cref="M:Info(object,Exception)"/> form instead.
  14907. </para>
  14908. </remarks>
  14909. </member>
  14910. <member name="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)">
  14911. <summary>
  14912. Logs a message object with the <c>INFO</c> level.
  14913. </summary>
  14914. <param name="message">The message object to log.</param>
  14915. <param name="exception">The exception to log, including its stack trace.</param>
  14916. <remarks>
  14917. <para>
  14918. Logs a message object with the <c>INFO</c> level including
  14919. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14920. passed as a parameter.
  14921. </para>
  14922. <para>
  14923. See the <see cref="M:Info(object)"/> form for more detailed information.
  14924. </para>
  14925. </remarks>
  14926. <seealso cref="M:Info(object)"/>
  14927. </member>
  14928. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])">
  14929. <summary>
  14930. Logs a formatted message string with the <c>INFO</c> level.
  14931. </summary>
  14932. <param name="format">A String containing zero or more format items</param>
  14933. <param name="args">An Object array containing zero or more objects to format</param>
  14934. <remarks>
  14935. <para>
  14936. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14937. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14938. of the formatting.
  14939. </para>
  14940. <para>
  14941. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14942. format provider. To specify a localized provider use the
  14943. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  14944. </para>
  14945. <para>
  14946. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14947. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14948. methods instead.
  14949. </para>
  14950. </remarks>
  14951. </member>
  14952. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)">
  14953. <summary>
  14954. Logs a formatted message string with the <c>INFO</c> level.
  14955. </summary>
  14956. <param name="format">A String containing zero or more format items</param>
  14957. <param name="arg0">An Object to format</param>
  14958. <remarks>
  14959. <para>
  14960. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14961. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14962. of the formatting.
  14963. </para>
  14964. <para>
  14965. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14966. format provider. To specify a localized provider use the
  14967. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  14968. </para>
  14969. <para>
  14970. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14971. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14972. methods instead.
  14973. </para>
  14974. </remarks>
  14975. </member>
  14976. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)">
  14977. <summary>
  14978. Logs a formatted message string with the <c>INFO</c> level.
  14979. </summary>
  14980. <param name="format">A String containing zero or more format items</param>
  14981. <param name="arg0">An Object to format</param>
  14982. <param name="arg1">An Object to format</param>
  14983. <remarks>
  14984. <para>
  14985. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14986. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14987. of the formatting.
  14988. </para>
  14989. <para>
  14990. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14991. format provider. To specify a localized provider use the
  14992. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  14993. </para>
  14994. <para>
  14995. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14996. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14997. methods instead.
  14998. </para>
  14999. </remarks>
  15000. </member>
  15001. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  15002. <summary>
  15003. Logs a formatted message string with the <c>INFO</c> level.
  15004. </summary>
  15005. <param name="format">A String containing zero or more format items</param>
  15006. <param name="arg0">An Object to format</param>
  15007. <param name="arg1">An Object to format</param>
  15008. <param name="arg2">An Object to format</param>
  15009. <remarks>
  15010. <para>
  15011. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15012. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15013. of the formatting.
  15014. </para>
  15015. <para>
  15016. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15017. format provider. To specify a localized provider use the
  15018. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  15019. </para>
  15020. <para>
  15021. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15022. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  15023. methods instead.
  15024. </para>
  15025. </remarks>
  15026. </member>
  15027. <member name="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  15028. <summary>
  15029. Logs a formatted message string with the <c>INFO</c> level.
  15030. </summary>
  15031. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15032. <param name="format">A String containing zero or more format items</param>
  15033. <param name="args">An Object array containing zero or more objects to format</param>
  15034. <remarks>
  15035. <para>
  15036. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15037. <c>String.Format</c> 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:Info(object)"/>
  15043. methods instead.
  15044. </para>
  15045. </remarks>
  15046. </member>
  15047. <member name="M:log4net.Core.LogImpl.Warn(System.Object)">
  15048. <summary>
  15049. Logs a message object with the <c>WARN</c> level.
  15050. </summary>
  15051. <param name="message">the message object to log</param>
  15052. <remarks>
  15053. <para>
  15054. This method first checks if this logger is <c>WARN</c>
  15055. enabled by comparing the level of this logger with the
  15056. <c>WARN</c> level. If this logger is
  15057. <c>WARN</c> enabled, then it converts the message object
  15058. (passed as parameter) to a string by invoking the appropriate
  15059. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  15060. proceeds to call all the registered appenders in this logger and
  15061. also higher in the hierarchy depending on the value of the
  15062. additivity flag.
  15063. </para>
  15064. <para>
  15065. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  15066. method will print the name of the <see cref="T:System.Exception"/> but no
  15067. stack trace. To print a stack trace use the
  15068. <see cref="M:Warn(object,Exception)"/> form instead.
  15069. </para>
  15070. </remarks>
  15071. </member>
  15072. <member name="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)">
  15073. <summary>
  15074. Logs a message object with the <c>WARN</c> level
  15075. </summary>
  15076. <param name="message">The message object to log.</param>
  15077. <param name="exception">The exception to log, including its stack trace.</param>
  15078. <remarks>
  15079. <para>
  15080. Logs a message object with the <c>WARN</c> level including
  15081. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  15082. passed as a parameter.
  15083. </para>
  15084. <para>
  15085. See the <see cref="M:Warn(object)"/> form for more detailed information.
  15086. </para>
  15087. </remarks>
  15088. <seealso cref="M:Warn(object)"/>
  15089. </member>
  15090. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])">
  15091. <summary>
  15092. Logs a formatted message string with the <c>WARN</c> level.
  15093. </summary>
  15094. <param name="format">A String containing zero or more format items</param>
  15095. <param name="args">An Object array containing zero or more objects to format</param>
  15096. <remarks>
  15097. <para>
  15098. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15099. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15100. of the formatting.
  15101. </para>
  15102. <para>
  15103. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15104. format provider. To specify a localized provider use the
  15105. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  15106. </para>
  15107. <para>
  15108. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15109. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  15110. methods instead.
  15111. </para>
  15112. </remarks>
  15113. </member>
  15114. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)">
  15115. <summary>
  15116. Logs a formatted message string with the <c>WARN</c> level.
  15117. </summary>
  15118. <param name="format">A String containing zero or more format items</param>
  15119. <param name="arg0">An Object to format</param>
  15120. <remarks>
  15121. <para>
  15122. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15123. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15124. of the formatting.
  15125. </para>
  15126. <para>
  15127. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15128. format provider. To specify a localized provider use the
  15129. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  15130. </para>
  15131. <para>
  15132. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15133. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  15134. methods instead.
  15135. </para>
  15136. </remarks>
  15137. </member>
  15138. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)">
  15139. <summary>
  15140. Logs a formatted message string with the <c>WARN</c> level.
  15141. </summary>
  15142. <param name="format">A String containing zero or more format items</param>
  15143. <param name="arg0">An Object to format</param>
  15144. <param name="arg1">An Object to format</param>
  15145. <remarks>
  15146. <para>
  15147. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15148. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15149. of the formatting.
  15150. </para>
  15151. <para>
  15152. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15153. format provider. To specify a localized provider use the
  15154. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  15155. </para>
  15156. <para>
  15157. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15158. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  15159. methods instead.
  15160. </para>
  15161. </remarks>
  15162. </member>
  15163. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  15164. <summary>
  15165. Logs a formatted message string with the <c>WARN</c> level.
  15166. </summary>
  15167. <param name="format">A String containing zero or more format items</param>
  15168. <param name="arg0">An Object to format</param>
  15169. <param name="arg1">An Object to format</param>
  15170. <param name="arg2">An Object to format</param>
  15171. <remarks>
  15172. <para>
  15173. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15174. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15175. of the formatting.
  15176. </para>
  15177. <para>
  15178. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15179. format provider. To specify a localized provider use the
  15180. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  15181. </para>
  15182. <para>
  15183. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15184. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  15185. methods instead.
  15186. </para>
  15187. </remarks>
  15188. </member>
  15189. <member name="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  15190. <summary>
  15191. Logs a formatted message string with the <c>WARN</c> level.
  15192. </summary>
  15193. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15194. <param name="format">A String containing zero or more format items</param>
  15195. <param name="args">An Object array containing zero or more objects to format</param>
  15196. <remarks>
  15197. <para>
  15198. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15199. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15200. of the formatting.
  15201. </para>
  15202. <para>
  15203. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15204. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  15205. methods instead.
  15206. </para>
  15207. </remarks>
  15208. </member>
  15209. <member name="M:log4net.Core.LogImpl.Error(System.Object)">
  15210. <summary>
  15211. Logs a message object with the <c>ERROR</c> level.
  15212. </summary>
  15213. <param name="message">The message object to log.</param>
  15214. <remarks>
  15215. <para>
  15216. This method first checks if this logger is <c>ERROR</c>
  15217. enabled by comparing the level of this logger with the
  15218. <c>ERROR</c> level. If this logger is
  15219. <c>ERROR</c> enabled, then it converts the message object
  15220. (passed as parameter) to a string by invoking the appropriate
  15221. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  15222. proceeds to call all the registered appenders in this logger and
  15223. also higher in the hierarchy depending on the value of the
  15224. additivity flag.
  15225. </para>
  15226. <para>
  15227. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  15228. method will print the name of the <see cref="T:System.Exception"/> but no
  15229. stack trace. To print a stack trace use the
  15230. <see cref="M:Error(object,Exception)"/> form instead.
  15231. </para>
  15232. </remarks>
  15233. </member>
  15234. <member name="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)">
  15235. <summary>
  15236. Logs a message object with the <c>ERROR</c> level
  15237. </summary>
  15238. <param name="message">The message object to log.</param>
  15239. <param name="exception">The exception to log, including its stack trace.</param>
  15240. <remarks>
  15241. <para>
  15242. Logs a message object with the <c>ERROR</c> level including
  15243. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  15244. passed as a parameter.
  15245. </para>
  15246. <para>
  15247. See the <see cref="M:Error(object)"/> form for more detailed information.
  15248. </para>
  15249. </remarks>
  15250. <seealso cref="M:Error(object)"/>
  15251. </member>
  15252. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])">
  15253. <summary>
  15254. Logs a formatted message string with the <c>ERROR</c> level.
  15255. </summary>
  15256. <param name="format">A String containing zero or more format items</param>
  15257. <param name="args">An Object array containing zero or more objects to format</param>
  15258. <remarks>
  15259. <para>
  15260. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15261. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15262. of the formatting.
  15263. </para>
  15264. <para>
  15265. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15266. format provider. To specify a localized provider use the
  15267. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  15268. </para>
  15269. <para>
  15270. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15271. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15272. methods instead.
  15273. </para>
  15274. </remarks>
  15275. </member>
  15276. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)">
  15277. <summary>
  15278. Logs a formatted message string with the <c>ERROR</c> level.
  15279. </summary>
  15280. <param name="format">A String containing zero or more format items</param>
  15281. <param name="arg0">An Object to format</param>
  15282. <remarks>
  15283. <para>
  15284. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15285. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15286. of the formatting.
  15287. </para>
  15288. <para>
  15289. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15290. format provider. To specify a localized provider use the
  15291. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  15292. </para>
  15293. <para>
  15294. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15295. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15296. methods instead.
  15297. </para>
  15298. </remarks>
  15299. </member>
  15300. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)">
  15301. <summary>
  15302. Logs a formatted message string with the <c>ERROR</c> level.
  15303. </summary>
  15304. <param name="format">A String containing zero or more format items</param>
  15305. <param name="arg0">An Object to format</param>
  15306. <param name="arg1">An Object to format</param>
  15307. <remarks>
  15308. <para>
  15309. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15310. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15311. of the formatting.
  15312. </para>
  15313. <para>
  15314. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15315. format provider. To specify a localized provider use the
  15316. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  15317. </para>
  15318. <para>
  15319. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15320. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15321. methods instead.
  15322. </para>
  15323. </remarks>
  15324. </member>
  15325. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  15326. <summary>
  15327. Logs a formatted message string with the <c>ERROR</c> level.
  15328. </summary>
  15329. <param name="format">A String containing zero or more format items</param>
  15330. <param name="arg0">An Object to format</param>
  15331. <param name="arg1">An Object to format</param>
  15332. <param name="arg2">An Object to format</param>
  15333. <remarks>
  15334. <para>
  15335. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15336. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15337. of the formatting.
  15338. </para>
  15339. <para>
  15340. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15341. format provider. To specify a localized provider use the
  15342. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  15343. </para>
  15344. <para>
  15345. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15346. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15347. methods instead.
  15348. </para>
  15349. </remarks>
  15350. </member>
  15351. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  15352. <summary>
  15353. Logs a formatted message string with the <c>ERROR</c> level.
  15354. </summary>
  15355. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15356. <param name="format">A String containing zero or more format items</param>
  15357. <param name="args">An Object array containing zero or more objects to format</param>
  15358. <remarks>
  15359. <para>
  15360. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15361. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15362. of the formatting.
  15363. </para>
  15364. <para>
  15365. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15366. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15367. methods instead.
  15368. </para>
  15369. </remarks>
  15370. </member>
  15371. <member name="M:log4net.Core.LogImpl.Fatal(System.Object)">
  15372. <summary>
  15373. Logs a message object with the <c>FATAL</c> level.
  15374. </summary>
  15375. <param name="message">The message object to log.</param>
  15376. <remarks>
  15377. <para>
  15378. This method first checks if this logger is <c>FATAL</c>
  15379. enabled by comparing the level of this logger with the
  15380. <c>FATAL</c> level. If this logger is
  15381. <c>FATAL</c> enabled, then it converts the message object
  15382. (passed as parameter) to a string by invoking the appropriate
  15383. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  15384. proceeds to call all the registered appenders in this logger and
  15385. also higher in the hierarchy depending on the value of the
  15386. additivity flag.
  15387. </para>
  15388. <para>
  15389. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  15390. method will print the name of the <see cref="T:System.Exception"/> but no
  15391. stack trace. To print a stack trace use the
  15392. <see cref="M:Fatal(object,Exception)"/> form instead.
  15393. </para>
  15394. </remarks>
  15395. </member>
  15396. <member name="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)">
  15397. <summary>
  15398. Logs a message object with the <c>FATAL</c> level
  15399. </summary>
  15400. <param name="message">The message object to log.</param>
  15401. <param name="exception">The exception to log, including its stack trace.</param>
  15402. <remarks>
  15403. <para>
  15404. Logs a message object with the <c>FATAL</c> level including
  15405. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  15406. passed as a parameter.
  15407. </para>
  15408. <para>
  15409. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  15410. </para>
  15411. </remarks>
  15412. <seealso cref="M:Fatal(object)"/>
  15413. </member>
  15414. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
  15415. <summary>
  15416. Logs a formatted message string with the <c>FATAL</c> level.
  15417. </summary>
  15418. <param name="format">A String containing zero or more format items</param>
  15419. <param name="args">An Object array containing zero or more objects to format</param>
  15420. <remarks>
  15421. <para>
  15422. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15423. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15424. of the formatting.
  15425. </para>
  15426. <para>
  15427. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15428. format provider. To specify a localized provider use the
  15429. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15430. </para>
  15431. <para>
  15432. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15433. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15434. methods instead.
  15435. </para>
  15436. </remarks>
  15437. </member>
  15438. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)">
  15439. <summary>
  15440. Logs a formatted message string with the <c>FATAL</c> level.
  15441. </summary>
  15442. <param name="format">A String containing zero or more format items</param>
  15443. <param name="arg0">An Object to format</param>
  15444. <remarks>
  15445. <para>
  15446. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15447. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15448. of the formatting.
  15449. </para>
  15450. <para>
  15451. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15452. format provider. To specify a localized provider use the
  15453. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15454. </para>
  15455. <para>
  15456. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15457. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15458. methods instead.
  15459. </para>
  15460. </remarks>
  15461. </member>
  15462. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)">
  15463. <summary>
  15464. Logs a formatted message string with the <c>FATAL</c> level.
  15465. </summary>
  15466. <param name="format">A String containing zero or more format items</param>
  15467. <param name="arg0">An Object to format</param>
  15468. <param name="arg1">An Object to format</param>
  15469. <remarks>
  15470. <para>
  15471. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15472. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15473. of the formatting.
  15474. </para>
  15475. <para>
  15476. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15477. format provider. To specify a localized provider use the
  15478. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15479. </para>
  15480. <para>
  15481. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15482. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15483. methods instead.
  15484. </para>
  15485. </remarks>
  15486. </member>
  15487. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  15488. <summary>
  15489. Logs a formatted message string with the <c>FATAL</c> level.
  15490. </summary>
  15491. <param name="format">A String containing zero or more format items</param>
  15492. <param name="arg0">An Object to format</param>
  15493. <param name="arg1">An Object to format</param>
  15494. <param name="arg2">An Object to format</param>
  15495. <remarks>
  15496. <para>
  15497. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15498. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15499. of the formatting.
  15500. </para>
  15501. <para>
  15502. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15503. format provider. To specify a localized provider use the
  15504. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15505. </para>
  15506. <para>
  15507. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15508. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15509. methods instead.
  15510. </para>
  15511. </remarks>
  15512. </member>
  15513. <member name="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  15514. <summary>
  15515. Logs a formatted message string with the <c>FATAL</c> level.
  15516. </summary>
  15517. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15518. <param name="format">A String containing zero or more format items</param>
  15519. <param name="args">An Object array containing zero or more objects to format</param>
  15520. <remarks>
  15521. <para>
  15522. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15523. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15524. of the formatting.
  15525. </para>
  15526. <para>
  15527. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15528. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15529. methods instead.
  15530. </para>
  15531. </remarks>
  15532. </member>
  15533. <member name="M:log4net.Core.LogImpl.LoggerRepositoryConfigurationChanged(System.Object,System.EventArgs)">
  15534. <summary>
  15535. Event handler for the <see cref="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"/> event
  15536. </summary>
  15537. <param name="sender">the repository</param>
  15538. <param name="e">Empty</param>
  15539. </member>
  15540. <member name="F:log4net.Core.LogImpl.ThisDeclaringType">
  15541. <summary>
  15542. The fully qualified name of this declaring type not the type of any subclass.
  15543. </summary>
  15544. </member>
  15545. <member name="P:log4net.Core.LogImpl.IsDebugEnabled">
  15546. <summary>
  15547. Checks if this logger is enabled for the <c>DEBUG</c>
  15548. level.
  15549. </summary>
  15550. <value>
  15551. <c>true</c> if this logger is enabled for <c>DEBUG</c> events,
  15552. <c>false</c> otherwise.
  15553. </value>
  15554. <remarks>
  15555. <para>
  15556. This function is intended to lessen the computational cost of
  15557. disabled log debug statements.
  15558. </para>
  15559. <para>
  15560. For some <c>log</c> Logger object, when you write:
  15561. </para>
  15562. <code lang="C#">
  15563. log.Debug("This is entry number: " + i );
  15564. </code>
  15565. <para>
  15566. You incur the cost constructing the message, concatenation in
  15567. this case, regardless of whether the message is logged or not.
  15568. </para>
  15569. <para>
  15570. If you are worried about speed, then you should write:
  15571. </para>
  15572. <code lang="C#">
  15573. if (log.IsDebugEnabled())
  15574. {
  15575. log.Debug("This is entry number: " + i );
  15576. }
  15577. </code>
  15578. <para>
  15579. This way you will not incur the cost of parameter
  15580. construction if debugging is disabled for <c>log</c>. On
  15581. the other hand, if the <c>log</c> is debug enabled, you
  15582. will incur the cost of evaluating whether the logger is debug
  15583. enabled twice. Once in <c>IsDebugEnabled</c> and once in
  15584. the <c>Debug</c>. This is an insignificant overhead
  15585. since evaluating a logger takes about 1% of the time it
  15586. takes to actually log.
  15587. </para>
  15588. </remarks>
  15589. </member>
  15590. <member name="P:log4net.Core.LogImpl.IsInfoEnabled">
  15591. <summary>
  15592. Checks if this logger is enabled for the <c>INFO</c> level.
  15593. </summary>
  15594. <value>
  15595. <c>true</c> if this logger is enabled for <c>INFO</c> events,
  15596. <c>false</c> otherwise.
  15597. </value>
  15598. <remarks>
  15599. <para>
  15600. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  15601. of using this method.
  15602. </para>
  15603. </remarks>
  15604. <seealso cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  15605. </member>
  15606. <member name="P:log4net.Core.LogImpl.IsWarnEnabled">
  15607. <summary>
  15608. Checks if this logger is enabled for the <c>WARN</c> level.
  15609. </summary>
  15610. <value>
  15611. <c>true</c> if this logger is enabled for <c>WARN</c> events,
  15612. <c>false</c> otherwise.
  15613. </value>
  15614. <remarks>
  15615. <para>
  15616. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  15617. of using this method.
  15618. </para>
  15619. </remarks>
  15620. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15621. </member>
  15622. <member name="P:log4net.Core.LogImpl.IsErrorEnabled">
  15623. <summary>
  15624. Checks if this logger is enabled for the <c>ERROR</c> level.
  15625. </summary>
  15626. <value>
  15627. <c>true</c> if this logger is enabled for <c>ERROR</c> events,
  15628. <c>false</c> otherwise.
  15629. </value>
  15630. <remarks>
  15631. <para>
  15632. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  15633. </para>
  15634. </remarks>
  15635. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15636. </member>
  15637. <member name="P:log4net.Core.LogImpl.IsFatalEnabled">
  15638. <summary>
  15639. Checks if this logger is enabled for the <c>FATAL</c> level.
  15640. </summary>
  15641. <value>
  15642. <c>true</c> if this logger is enabled for <c>FATAL</c> events,
  15643. <c>false</c> otherwise.
  15644. </value>
  15645. <remarks>
  15646. <para>
  15647. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  15648. </para>
  15649. </remarks>
  15650. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15651. </member>
  15652. <member name="T:log4net.Core.MethodItem">
  15653. <summary>
  15654. provides method information without actually referencing a System.Reflection.MethodBase
  15655. as that would require that the containing assembly is loaded.
  15656. </summary>
  15657. </member>
  15658. <member name="F:log4net.Core.MethodItem.NA">
  15659. <summary>
  15660. When location information is not available the constant
  15661. <c>NA</c> is returned. Current value of this string
  15662. constant is <b>?</b>.
  15663. </summary>
  15664. </member>
  15665. <member name="M:log4net.Core.MethodItem.#ctor">
  15666. <summary>
  15667. constructs a method item for an unknown method.
  15668. </summary>
  15669. </member>
  15670. <member name="M:log4net.Core.MethodItem.#ctor(System.String)">
  15671. <summary>
  15672. constructs a method item from the name of the method.
  15673. </summary>
  15674. <param name="name"></param>
  15675. </member>
  15676. <member name="M:log4net.Core.MethodItem.#ctor(System.String,System.String[])">
  15677. <summary>
  15678. constructs a method item from the name of the method and its parameters.
  15679. </summary>
  15680. <param name="name"></param>
  15681. <param name="parameters"></param>
  15682. </member>
  15683. <member name="M:log4net.Core.MethodItem.#ctor(System.Reflection.MethodBase)">
  15684. <summary>
  15685. constructs a method item from a method base by determining the method name and its parameters.
  15686. </summary>
  15687. <param name="methodBase"></param>
  15688. </member>
  15689. <member name="F:log4net.Core.MethodItem.declaringType">
  15690. <summary>
  15691. The fully qualified type of the StackFrameItem class.
  15692. </summary>
  15693. <remarks>
  15694. Used by the internal logger to record the Type of the
  15695. log message.
  15696. </remarks>
  15697. </member>
  15698. <member name="P:log4net.Core.MethodItem.Name">
  15699. <summary>
  15700. Gets the method name of the caller making the logging
  15701. request.
  15702. </summary>
  15703. <value>
  15704. The method name of the caller making the logging
  15705. request.
  15706. </value>
  15707. <remarks>
  15708. <para>
  15709. Gets the method name of the caller making the logging
  15710. request.
  15711. </para>
  15712. </remarks>
  15713. </member>
  15714. <member name="P:log4net.Core.MethodItem.Parameters">
  15715. <summary>
  15716. Gets the method parameters of the caller making
  15717. the logging request.
  15718. </summary>
  15719. <value>
  15720. The method parameters of the caller making
  15721. the logging request
  15722. </value>
  15723. <remarks>
  15724. <para>
  15725. Gets the method parameters of the caller making
  15726. the logging request.
  15727. </para>
  15728. </remarks>
  15729. </member>
  15730. <member name="T:log4net.Core.SecurityContext">
  15731. <summary>
  15732. A SecurityContext used by log4net when interacting with protected resources
  15733. </summary>
  15734. <remarks>
  15735. <para>
  15736. A SecurityContext used by log4net when interacting with protected resources
  15737. for example with operating system services. This can be used to impersonate
  15738. a principal that has been granted privileges on the system resources.
  15739. </para>
  15740. </remarks>
  15741. <author>Nicko Cadell</author>
  15742. </member>
  15743. <member name="M:log4net.Core.SecurityContext.Impersonate(System.Object)">
  15744. <summary>
  15745. Impersonate this SecurityContext
  15746. </summary>
  15747. <param name="state">State supplied by the caller</param>
  15748. <returns>An <see cref="T:System.IDisposable"/> instance that will
  15749. revoke the impersonation of this SecurityContext, or <c>null</c></returns>
  15750. <remarks>
  15751. <para>
  15752. Impersonate this security context. Further calls on the current
  15753. thread should now be made in the security context provided
  15754. by this object. When the <see cref="T:System.IDisposable"/> result
  15755. <see cref="M:System.IDisposable.Dispose"/> method is called the security
  15756. context of the thread should be reverted to the state it was in
  15757. before <see cref="M:log4net.Core.SecurityContext.Impersonate(System.Object)"/> was called.
  15758. </para>
  15759. </remarks>
  15760. </member>
  15761. <member name="T:log4net.Core.SecurityContextProvider">
  15762. <summary>
  15763. The <see cref="T:log4net.Core.SecurityContextProvider"/> providers default <see cref="T:log4net.Core.SecurityContext"/> instances.
  15764. </summary>
  15765. <remarks>
  15766. <para>
  15767. A configured component that interacts with potentially protected system
  15768. resources uses a <see cref="T:log4net.Core.SecurityContext"/> to provide the elevated
  15769. privileges required. If the <see cref="T:log4net.Core.SecurityContext"/> object has
  15770. been not been explicitly provided to the component then the component
  15771. will request one from this <see cref="T:log4net.Core.SecurityContextProvider"/>.
  15772. </para>
  15773. <para>
  15774. By default the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is
  15775. an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> which returns only
  15776. <see cref="T:log4net.Util.NullSecurityContext"/> objects. This is a reasonable default
  15777. where the privileges required are not know by the system.
  15778. </para>
  15779. <para>
  15780. This default behavior can be overridden by subclassing the <see cref="T:log4net.Core.SecurityContextProvider"/>
  15781. and overriding the <see cref="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"/> method to return
  15782. the desired <see cref="T:log4net.Core.SecurityContext"/> objects. The default provider
  15783. can be replaced by programmatically setting the value of the
  15784. <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> property.
  15785. </para>
  15786. <para>
  15787. An alternative is to use the <c>log4net.Config.SecurityContextProviderAttribute</c>
  15788. This attribute can be applied to an assembly in the same way as the
  15789. <c>log4net.Config.XmlConfiguratorAttribute"</c>. The attribute takes
  15790. the type to use as the <see cref="T:log4net.Core.SecurityContextProvider"/> as an argument.
  15791. </para>
  15792. </remarks>
  15793. <author>Nicko Cadell</author>
  15794. </member>
  15795. <member name="F:log4net.Core.SecurityContextProvider.s_defaultProvider">
  15796. <summary>
  15797. The default provider
  15798. </summary>
  15799. </member>
  15800. <member name="M:log4net.Core.SecurityContextProvider.#ctor">
  15801. <summary>
  15802. Protected default constructor to allow subclassing
  15803. </summary>
  15804. <remarks>
  15805. <para>
  15806. Protected default constructor to allow subclassing
  15807. </para>
  15808. </remarks>
  15809. </member>
  15810. <member name="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)">
  15811. <summary>
  15812. Create a SecurityContext for a consumer
  15813. </summary>
  15814. <param name="consumer">The consumer requesting the SecurityContext</param>
  15815. <returns>An impersonation context</returns>
  15816. <remarks>
  15817. <para>
  15818. The default implementation is to return a <see cref="T:log4net.Util.NullSecurityContext"/>.
  15819. </para>
  15820. <para>
  15821. Subclasses should override this method to provide their own
  15822. behavior.
  15823. </para>
  15824. </remarks>
  15825. </member>
  15826. <member name="P:log4net.Core.SecurityContextProvider.DefaultProvider">
  15827. <summary>
  15828. Gets or sets the default SecurityContextProvider
  15829. </summary>
  15830. <value>
  15831. The default SecurityContextProvider
  15832. </value>
  15833. <remarks>
  15834. <para>
  15835. The default provider is used by configured components that
  15836. require a <see cref="T:log4net.Core.SecurityContext"/> and have not had one
  15837. given to them.
  15838. </para>
  15839. <para>
  15840. By default this is an instance of <see cref="T:log4net.Core.SecurityContextProvider"/>
  15841. that returns <see cref="T:log4net.Util.NullSecurityContext"/> objects.
  15842. </para>
  15843. <para>
  15844. The default provider can be set programmatically by setting
  15845. the value of this property to a sub class of <see cref="T:log4net.Core.SecurityContextProvider"/>
  15846. that has the desired behavior.
  15847. </para>
  15848. </remarks>
  15849. </member>
  15850. <member name="T:log4net.Core.StackFrameItem">
  15851. <summary>
  15852. provides stack frame information without actually referencing a System.Diagnostics.StackFrame
  15853. as that would require that the containing assembly is loaded.
  15854. </summary>
  15855. </member>
  15856. <member name="F:log4net.Core.StackFrameItem.NA">
  15857. <summary>
  15858. When location information is not available the constant
  15859. <c>NA</c> is returned. Current value of this string
  15860. constant is <b>?</b>.
  15861. </summary>
  15862. </member>
  15863. <member name="M:log4net.Core.StackFrameItem.#ctor(System.Diagnostics.StackFrame)">
  15864. <summary>
  15865. returns a stack frame item from a stack frame. This
  15866. </summary>
  15867. <param name="frame"></param>
  15868. <returns></returns>
  15869. </member>
  15870. <member name="F:log4net.Core.StackFrameItem.declaringType">
  15871. <summary>
  15872. The fully qualified type of the StackFrameItem class.
  15873. </summary>
  15874. <remarks>
  15875. Used by the internal logger to record the Type of the
  15876. log message.
  15877. </remarks>
  15878. </member>
  15879. <member name="P:log4net.Core.StackFrameItem.ClassName">
  15880. <summary>
  15881. Gets the fully qualified class name of the caller making the logging
  15882. request.
  15883. </summary>
  15884. <value>
  15885. The fully qualified class name of the caller making the logging
  15886. request.
  15887. </value>
  15888. <remarks>
  15889. <para>
  15890. Gets the fully qualified class name of the caller making the logging
  15891. request.
  15892. </para>
  15893. </remarks>
  15894. </member>
  15895. <member name="P:log4net.Core.StackFrameItem.FileName">
  15896. <summary>
  15897. Gets the file name of the caller.
  15898. </summary>
  15899. <value>
  15900. The file name of the caller.
  15901. </value>
  15902. <remarks>
  15903. <para>
  15904. Gets the file name of the caller.
  15905. </para>
  15906. </remarks>
  15907. </member>
  15908. <member name="P:log4net.Core.StackFrameItem.LineNumber">
  15909. <summary>
  15910. Gets the line number of the caller.
  15911. </summary>
  15912. <value>
  15913. The line number of the caller.
  15914. </value>
  15915. <remarks>
  15916. <para>
  15917. Gets the line number of the caller.
  15918. </para>
  15919. </remarks>
  15920. </member>
  15921. <member name="P:log4net.Core.StackFrameItem.Method">
  15922. <summary>
  15923. Gets the method name of the caller.
  15924. </summary>
  15925. <value>
  15926. The method name of the caller.
  15927. </value>
  15928. <remarks>
  15929. <para>
  15930. Gets the method name of the caller.
  15931. </para>
  15932. </remarks>
  15933. </member>
  15934. <member name="P:log4net.Core.StackFrameItem.FullInfo">
  15935. <summary>
  15936. Gets all available caller information
  15937. </summary>
  15938. <value>
  15939. All available caller information, in the format
  15940. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  15941. </value>
  15942. <remarks>
  15943. <para>
  15944. Gets all available caller information, in the format
  15945. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  15946. </para>
  15947. </remarks>
  15948. </member>
  15949. <member name="T:log4net.Core.TimeEvaluator">
  15950. <summary>
  15951. An evaluator that triggers after specified number of seconds.
  15952. </summary>
  15953. <remarks>
  15954. <para>
  15955. This evaluator will trigger if the specified time period
  15956. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15957. </para>
  15958. </remarks>
  15959. <author>Robert Sevcik</author>
  15960. </member>
  15961. <member name="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL">
  15962. <summary>
  15963. The default time threshold for triggering in seconds. Zero means it won't trigger at all.
  15964. </summary>
  15965. </member>
  15966. <member name="F:log4net.Core.TimeEvaluator.m_interval">
  15967. <summary>
  15968. The time threshold for triggering in seconds. Zero means it won't trigger at all.
  15969. </summary>
  15970. </member>
  15971. <member name="F:log4net.Core.TimeEvaluator.m_lastTimeUtc">
  15972. <summary>
  15973. The UTC time of last check. This gets updated when the object is created and when the evaluator triggers.
  15974. </summary>
  15975. </member>
  15976. <member name="M:log4net.Core.TimeEvaluator.#ctor">
  15977. <summary>
  15978. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  15979. </summary>
  15980. <remarks>
  15981. <para>
  15982. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  15983. </para>
  15984. <para>
  15985. This evaluator will trigger if the specified time period
  15986. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15987. </para>
  15988. </remarks>
  15989. </member>
  15990. <member name="M:log4net.Core.TimeEvaluator.#ctor(System.Int32)">
  15991. <summary>
  15992. Create a new evaluator using the specified time threshold in seconds.
  15993. </summary>
  15994. <param name="interval">
  15995. The time threshold in seconds to trigger after.
  15996. Zero means it won't trigger at all.
  15997. </param>
  15998. <remarks>
  15999. <para>
  16000. Create a new evaluator using the specified time threshold in seconds.
  16001. </para>
  16002. <para>
  16003. This evaluator will trigger if the specified time period
  16004. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  16005. </para>
  16006. </remarks>
  16007. </member>
  16008. <member name="M:log4net.Core.TimeEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  16009. <summary>
  16010. Is this <paramref name="loggingEvent"/> the triggering event?
  16011. </summary>
  16012. <param name="loggingEvent">The event to check</param>
  16013. <returns>This method returns <c>true</c>, if the specified time period
  16014. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check..
  16015. Otherwise it returns <c>false</c></returns>
  16016. <remarks>
  16017. <para>
  16018. This evaluator will trigger if the specified time period
  16019. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  16020. </para>
  16021. </remarks>
  16022. </member>
  16023. <member name="P:log4net.Core.TimeEvaluator.Interval">
  16024. <summary>
  16025. The time threshold in seconds to trigger after
  16026. </summary>
  16027. <value>
  16028. The time threshold in seconds to trigger after.
  16029. Zero means it won't trigger at all.
  16030. </value>
  16031. <remarks>
  16032. <para>
  16033. This evaluator will trigger if the specified time period
  16034. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  16035. </para>
  16036. </remarks>
  16037. </member>
  16038. <member name="T:log4net.Core.WrapperCreationHandler">
  16039. <summary>
  16040. Delegate used to handle creation of new wrappers.
  16041. </summary>
  16042. <param name="logger">The logger to wrap in a wrapper.</param>
  16043. <remarks>
  16044. <para>
  16045. Delegate used to handle creation of new wrappers. This delegate
  16046. is called from the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  16047. method to construct the wrapper for the specified logger.
  16048. </para>
  16049. <para>
  16050. The delegate to use is supplied to the <see cref="T:log4net.Core.WrapperMap"/>
  16051. constructor.
  16052. </para>
  16053. </remarks>
  16054. </member>
  16055. <member name="T:log4net.Core.WrapperMap">
  16056. <summary>
  16057. Maps between logger objects and wrapper objects.
  16058. </summary>
  16059. <remarks>
  16060. <para>
  16061. This class maintains a mapping between <see cref="T:log4net.Core.ILogger"/> objects and
  16062. <see cref="T:log4net.Core.ILoggerWrapper"/> objects. Use the <see cref="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"/> method to
  16063. lookup the <see cref="T:log4net.Core.ILoggerWrapper"/> for the specified <see cref="T:log4net.Core.ILogger"/>.
  16064. </para>
  16065. <para>
  16066. New wrapper instances are created by the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  16067. method. The default behavior is for this method to delegate construction
  16068. of the wrapper to the <see cref="T:log4net.Core.WrapperCreationHandler"/> delegate supplied
  16069. to the constructor. This allows specialization of the behavior without
  16070. requiring subclassing of this type.
  16071. </para>
  16072. </remarks>
  16073. <author>Nicko Cadell</author>
  16074. <author>Gert Driesen</author>
  16075. </member>
  16076. <member name="M:log4net.Core.WrapperMap.#ctor(log4net.Core.WrapperCreationHandler)">
  16077. <summary>
  16078. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/>
  16079. </summary>
  16080. <param name="createWrapperHandler">The handler to use to create the wrapper objects.</param>
  16081. <remarks>
  16082. <para>
  16083. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/> class with
  16084. the specified handler to create the wrapper objects.
  16085. </para>
  16086. </remarks>
  16087. </member>
  16088. <member name="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)">
  16089. <summary>
  16090. Gets the wrapper object for the specified logger.
  16091. </summary>
  16092. <returns>The wrapper object for the specified logger</returns>
  16093. <remarks>
  16094. <para>
  16095. If the logger is null then the corresponding wrapper is null.
  16096. </para>
  16097. <para>
  16098. Looks up the wrapper it it has previously been requested and
  16099. returns it. If the wrapper has never been requested before then
  16100. the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> virtual method is
  16101. called.
  16102. </para>
  16103. </remarks>
  16104. </member>
  16105. <member name="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)">
  16106. <summary>
  16107. Creates the wrapper object for the specified logger.
  16108. </summary>
  16109. <param name="logger">The logger to wrap in a wrapper.</param>
  16110. <returns>The wrapper object for the logger.</returns>
  16111. <remarks>
  16112. <para>
  16113. This implementation uses the <see cref="T:log4net.Core.WrapperCreationHandler"/>
  16114. passed to the constructor to create the wrapper. This method
  16115. can be overridden in a subclass.
  16116. </para>
  16117. </remarks>
  16118. </member>
  16119. <member name="M:log4net.Core.WrapperMap.RepositoryShutdown(log4net.Repository.ILoggerRepository)">
  16120. <summary>
  16121. Called when a monitored repository shutdown event is received.
  16122. </summary>
  16123. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down</param>
  16124. <remarks>
  16125. <para>
  16126. This method is called when a <see cref="T:log4net.Repository.ILoggerRepository"/> that this
  16127. <see cref="T:log4net.Core.WrapperMap"/> is holding loggers for has signaled its shutdown
  16128. event <see cref="E:log4net.Repository.ILoggerRepository.ShutdownEvent"/>. The default
  16129. behavior of this method is to release the references to the loggers
  16130. and their wrappers generated for this repository.
  16131. </para>
  16132. </remarks>
  16133. </member>
  16134. <member name="M:log4net.Core.WrapperMap.ILoggerRepository_Shutdown(System.Object,System.EventArgs)">
  16135. <summary>
  16136. Event handler for repository shutdown event.
  16137. </summary>
  16138. <param name="sender">The sender of the event.</param>
  16139. <param name="e">The event args.</param>
  16140. </member>
  16141. <member name="F:log4net.Core.WrapperMap.m_repositories">
  16142. <summary>
  16143. Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings
  16144. </summary>
  16145. </member>
  16146. <member name="F:log4net.Core.WrapperMap.m_createWrapperHandler">
  16147. <summary>
  16148. The handler to use to create the extension wrapper objects.
  16149. </summary>
  16150. </member>
  16151. <member name="F:log4net.Core.WrapperMap.m_shutdownHandler">
  16152. <summary>
  16153. Internal reference to the delegate used to register for repository shutdown events.
  16154. </summary>
  16155. </member>
  16156. <member name="P:log4net.Core.WrapperMap.Repositories">
  16157. <summary>
  16158. Gets the map of logger repositories.
  16159. </summary>
  16160. <value>
  16161. Map of logger repositories.
  16162. </value>
  16163. <remarks>
  16164. <para>
  16165. Gets the hashtable that is keyed on <see cref="T:log4net.Repository.ILoggerRepository"/>. The
  16166. values are hashtables keyed on <see cref="T:log4net.Core.ILogger"/> with the
  16167. value being the corresponding <see cref="T:log4net.Core.ILoggerWrapper"/>.
  16168. </para>
  16169. </remarks>
  16170. </member>
  16171. <member name="T:log4net.DateFormatter.AbsoluteTimeDateFormatter">
  16172. <summary>
  16173. Formats a <see cref="T:System.DateTime"/> as <c>"HH:mm:ss,fff"</c>.
  16174. </summary>
  16175. <remarks>
  16176. <para>
  16177. Formats a <see cref="T:System.DateTime"/> in the format <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  16178. </para>
  16179. </remarks>
  16180. <author>Nicko Cadell</author>
  16181. <author>Gert Driesen</author>
  16182. </member>
  16183. <member name="T:log4net.DateFormatter.IDateFormatter">
  16184. <summary>
  16185. Render a <see cref="T:System.DateTime"/> as a string.
  16186. </summary>
  16187. <remarks>
  16188. <para>
  16189. Interface to abstract the rendering of a <see cref="T:System.DateTime"/>
  16190. instance into a string.
  16191. </para>
  16192. <para>
  16193. The <see cref="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/> method is used to render the
  16194. date to a text writer.
  16195. </para>
  16196. </remarks>
  16197. <author>Nicko Cadell</author>
  16198. <author>Gert Driesen</author>
  16199. </member>
  16200. <member name="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  16201. <summary>
  16202. Formats the specified date as a string.
  16203. </summary>
  16204. <param name="dateToFormat">The date to format.</param>
  16205. <param name="writer">The writer to write to.</param>
  16206. <remarks>
  16207. <para>
  16208. Format the <see cref="T:System.DateTime"/> as a string and write it
  16209. to the <see cref="T:System.IO.TextWriter"/> provided.
  16210. </para>
  16211. </remarks>
  16212. </member>
  16213. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.AbsoluteTimeDateFormat">
  16214. <summary>
  16215. String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is <b>ABSOLUTE</b>.
  16216. </summary>
  16217. </member>
  16218. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.DateAndTimeDateFormat">
  16219. <summary>
  16220. String constant used to specify DateTimeDateFormat in layouts. Current value is <b>DATE</b>.
  16221. </summary>
  16222. </member>
  16223. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.Iso8601TimeDateFormat">
  16224. <summary>
  16225. String constant used to specify ISO8601DateFormat in layouts. Current value is <b>ISO8601</b>.
  16226. </summary>
  16227. </member>
  16228. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  16229. <summary>
  16230. Renders the date into a string. Format is <c>"HH:mm:ss"</c>.
  16231. </summary>
  16232. <param name="dateToFormat">The date to render into a string.</param>
  16233. <param name="buffer">The string builder to write to.</param>
  16234. <remarks>
  16235. <para>
  16236. Subclasses should override this method to render the date
  16237. into a string using a precision up to the second. This method
  16238. will be called at most once per second and the result will be
  16239. reused if it is needed again during the same second.
  16240. </para>
  16241. </remarks>
  16242. </member>
  16243. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  16244. <summary>
  16245. Renders the date into a string. Format is "HH:mm:ss,fff".
  16246. </summary>
  16247. <param name="dateToFormat">The date to render into a string.</param>
  16248. <param name="writer">The writer to write to.</param>
  16249. <remarks>
  16250. <para>
  16251. Uses the <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> method to generate the
  16252. time string up to the seconds and then appends the current
  16253. milliseconds. The results from <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> are
  16254. cached and <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> is called at most once
  16255. per second.
  16256. </para>
  16257. <para>
  16258. Sub classes should override <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/>
  16259. rather than <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/>.
  16260. </para>
  16261. </remarks>
  16262. </member>
  16263. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeToTheSecond">
  16264. <summary>
  16265. Last stored time with precision up to the second.
  16266. </summary>
  16267. </member>
  16268. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeBuf">
  16269. <summary>
  16270. Last stored time with precision up to the second, formatted
  16271. as a string.
  16272. </summary>
  16273. </member>
  16274. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeStrings">
  16275. <summary>
  16276. Last stored time with precision up to the second, formatted
  16277. as a string.
  16278. </summary>
  16279. </member>
  16280. <member name="T:log4net.DateFormatter.DateTimeDateFormatter">
  16281. <summary>
  16282. Formats a <see cref="T:System.DateTime"/> as <c>"dd MMM yyyy HH:mm:ss,fff"</c>
  16283. </summary>
  16284. <remarks>
  16285. <para>
  16286. Formats a <see cref="T:System.DateTime"/> in the format
  16287. <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example,
  16288. <c>"06 Nov 1994 15:49:37,459"</c>.
  16289. </para>
  16290. </remarks>
  16291. <author>Nicko Cadell</author>
  16292. <author>Gert Driesen</author>
  16293. <author>Angelika Schnagl</author>
  16294. </member>
  16295. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.#ctor">
  16296. <summary>
  16297. Default constructor.
  16298. </summary>
  16299. <remarks>
  16300. <para>
  16301. Initializes a new instance of the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> class.
  16302. </para>
  16303. </remarks>
  16304. </member>
  16305. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  16306. <summary>
  16307. Formats the date without the milliseconds part
  16308. </summary>
  16309. <param name="dateToFormat">The date to format.</param>
  16310. <param name="buffer">The string builder to write to.</param>
  16311. <remarks>
  16312. <para>
  16313. Formats a DateTime in the format <c>"dd MMM yyyy HH:mm:ss"</c>
  16314. for example, <c>"06 Nov 1994 15:49:37"</c>.
  16315. </para>
  16316. <para>
  16317. The base class will append the <c>",fff"</c> milliseconds section.
  16318. This method will only be called at most once per second.
  16319. </para>
  16320. </remarks>
  16321. </member>
  16322. <member name="F:log4net.DateFormatter.DateTimeDateFormatter.m_dateTimeFormatInfo">
  16323. <summary>
  16324. The format info for the invariant culture.
  16325. </summary>
  16326. </member>
  16327. <member name="T:log4net.DateFormatter.Iso8601DateFormatter">
  16328. <summary>
  16329. Formats the <see cref="T:System.DateTime"/> as <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  16330. </summary>
  16331. <remarks>
  16332. <para>
  16333. Formats the <see cref="T:System.DateTime"/> specified as a string: <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  16334. </para>
  16335. </remarks>
  16336. <author>Nicko Cadell</author>
  16337. <author>Gert Driesen</author>
  16338. </member>
  16339. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.#ctor">
  16340. <summary>
  16341. Default constructor
  16342. </summary>
  16343. <remarks>
  16344. <para>
  16345. Initializes a new instance of the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> class.
  16346. </para>
  16347. </remarks>
  16348. </member>
  16349. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  16350. <summary>
  16351. Formats the date without the milliseconds part
  16352. </summary>
  16353. <param name="dateToFormat">The date to format.</param>
  16354. <param name="buffer">The string builder to write to.</param>
  16355. <remarks>
  16356. <para>
  16357. Formats the date specified as a string: <c>"yyyy-MM-dd HH:mm:ss"</c>.
  16358. </para>
  16359. <para>
  16360. The base class will append the <c>",fff"</c> milliseconds section.
  16361. This method will only be called at most once per second.
  16362. </para>
  16363. </remarks>
  16364. </member>
  16365. <member name="T:log4net.DateFormatter.SimpleDateFormatter">
  16366. <summary>
  16367. Formats the <see cref="T:System.DateTime"/> using the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  16368. </summary>
  16369. <remarks>
  16370. <para>
  16371. Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  16372. </para>
  16373. </remarks>
  16374. <author>Nicko Cadell</author>
  16375. <author>Gert Driesen</author>
  16376. </member>
  16377. <member name="M:log4net.DateFormatter.SimpleDateFormatter.#ctor(System.String)">
  16378. <summary>
  16379. Constructor
  16380. </summary>
  16381. <param name="format">The format string.</param>
  16382. <remarks>
  16383. <para>
  16384. Initializes a new instance of the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> class
  16385. with the specified format string.
  16386. </para>
  16387. <para>
  16388. The format string must be compatible with the options
  16389. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  16390. </para>
  16391. </remarks>
  16392. </member>
  16393. <member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  16394. <summary>
  16395. Formats the date using <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  16396. </summary>
  16397. <param name="dateToFormat">The date to convert to a string.</param>
  16398. <param name="writer">The writer to write to.</param>
  16399. <remarks>
  16400. <para>
  16401. Uses the date format string supplied to the constructor to call
  16402. the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method to format the date.
  16403. </para>
  16404. </remarks>
  16405. </member>
  16406. <member name="F:log4net.DateFormatter.SimpleDateFormatter.m_formatString">
  16407. <summary>
  16408. The format string used to format the <see cref="T:System.DateTime"/>.
  16409. </summary>
  16410. <remarks>
  16411. <para>
  16412. The format string must be compatible with the options
  16413. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  16414. </para>
  16415. </remarks>
  16416. </member>
  16417. <member name="T:log4net.Filter.DenyAllFilter">
  16418. <summary>
  16419. This filter drops all <see cref="T:log4net.Core.LoggingEvent"/>.
  16420. </summary>
  16421. <remarks>
  16422. <para>
  16423. You can add this filter to the end of a filter chain to
  16424. switch from the default "accept all unless instructed otherwise"
  16425. filtering behavior to a "deny all unless instructed otherwise"
  16426. behavior.
  16427. </para>
  16428. </remarks>
  16429. <author>Nicko Cadell</author>
  16430. <author>Gert Driesen</author>
  16431. </member>
  16432. <member name="T:log4net.Filter.FilterSkeleton">
  16433. <summary>
  16434. Subclass this type to implement customized logging event filtering
  16435. </summary>
  16436. <remarks>
  16437. <para>
  16438. Users should extend this class to implement customized logging
  16439. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  16440. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  16441. appenders, have built-in filtering rules. It is suggested that you
  16442. first use and understand the built-in rules before rushing to write
  16443. your own custom filters.
  16444. </para>
  16445. <para>
  16446. This abstract class assumes and also imposes that filters be
  16447. organized in a linear chain. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/>
  16448. method of each filter is called sequentially, in the order of their
  16449. addition to the chain.
  16450. </para>
  16451. <para>
  16452. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> method must return one
  16453. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  16454. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  16455. </para>
  16456. <para>
  16457. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  16458. immediately without consulting with the remaining filters.
  16459. </para>
  16460. <para>
  16461. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  16462. in the chain is consulted. If there are no more filters in the
  16463. chain, then the log event is logged. Thus, in the presence of no
  16464. filters, the default behavior is to log all logging events.
  16465. </para>
  16466. <para>
  16467. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  16468. event is logged without consulting the remaining filters.
  16469. </para>
  16470. <para>
  16471. The philosophy of log4net filters is largely inspired from the
  16472. Linux ipchains.
  16473. </para>
  16474. </remarks>
  16475. <author>Nicko Cadell</author>
  16476. <author>Gert Driesen</author>
  16477. </member>
  16478. <member name="T:log4net.Filter.IFilter">
  16479. <summary>
  16480. Implement this interface to provide customized logging event filtering
  16481. </summary>
  16482. <remarks>
  16483. <para>
  16484. Users should implement this interface to implement customized logging
  16485. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  16486. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  16487. appenders, have built-in filtering rules. It is suggested that you
  16488. first use and understand the built-in rules before rushing to write
  16489. your own custom filters.
  16490. </para>
  16491. <para>
  16492. This abstract class assumes and also imposes that filters be
  16493. organized in a linear chain. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  16494. method of each filter is called sequentially, in the order of their
  16495. addition to the chain.
  16496. </para>
  16497. <para>
  16498. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> method must return one
  16499. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  16500. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  16501. </para>
  16502. <para>
  16503. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  16504. immediately without consulting with the remaining filters.
  16505. </para>
  16506. <para>
  16507. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  16508. in the chain is consulted. If there are no more filters in the
  16509. chain, then the log event is logged. Thus, in the presence of no
  16510. filters, the default behavior is to log all logging events.
  16511. </para>
  16512. <para>
  16513. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  16514. event is logged without consulting the remaining filters.
  16515. </para>
  16516. <para>
  16517. The philosophy of log4net filters is largely inspired from the
  16518. Linux ipchains.
  16519. </para>
  16520. </remarks>
  16521. <author>Nicko Cadell</author>
  16522. <author>Gert Driesen</author>
  16523. </member>
  16524. <member name="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)">
  16525. <summary>
  16526. Decide if the logging event should be logged through an appender.
  16527. </summary>
  16528. <param name="loggingEvent">The LoggingEvent to decide upon</param>
  16529. <returns>The decision of the filter</returns>
  16530. <remarks>
  16531. <para>
  16532. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  16533. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  16534. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  16535. the event will be logged without consulting with other filters in
  16536. the chain.
  16537. </para>
  16538. </remarks>
  16539. </member>
  16540. <member name="P:log4net.Filter.IFilter.Next">
  16541. <summary>
  16542. Property to get and set the next filter
  16543. </summary>
  16544. <value>
  16545. The next filter in the chain
  16546. </value>
  16547. <remarks>
  16548. <para>
  16549. Filters are typically composed into chains. This property allows the next filter in
  16550. the chain to be accessed.
  16551. </para>
  16552. </remarks>
  16553. </member>
  16554. <member name="F:log4net.Filter.FilterSkeleton.m_next">
  16555. <summary>
  16556. Points to the next filter in the filter chain.
  16557. </summary>
  16558. <remarks>
  16559. <para>
  16560. See <see cref="P:log4net.Filter.FilterSkeleton.Next"/> for more information.
  16561. </para>
  16562. </remarks>
  16563. </member>
  16564. <member name="M:log4net.Filter.FilterSkeleton.ActivateOptions">
  16565. <summary>
  16566. Initialize the filter with the options set
  16567. </summary>
  16568. <remarks>
  16569. <para>
  16570. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16571. activation scheme. The <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> method must
  16572. be called on this object after the configuration properties have
  16573. been set. Until <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> is called this
  16574. object is in an undefined state and must not be used.
  16575. </para>
  16576. <para>
  16577. If any of the configuration properties are modified then
  16578. <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> must be called again.
  16579. </para>
  16580. <para>
  16581. Typically filter's options become active immediately on set,
  16582. however this method must still be called.
  16583. </para>
  16584. </remarks>
  16585. </member>
  16586. <member name="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)">
  16587. <summary>
  16588. Decide if the <see cref="T:log4net.Core.LoggingEvent"/> should be logged through an appender.
  16589. </summary>
  16590. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> to decide upon</param>
  16591. <returns>The decision of the filter</returns>
  16592. <remarks>
  16593. <para>
  16594. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  16595. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  16596. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  16597. the event will be logged without consulting with other filters in
  16598. the chain.
  16599. </para>
  16600. <para>
  16601. This method is marked <c>abstract</c> and must be implemented
  16602. in a subclass.
  16603. </para>
  16604. </remarks>
  16605. </member>
  16606. <member name="P:log4net.Filter.FilterSkeleton.Next">
  16607. <summary>
  16608. Property to get and set the next filter
  16609. </summary>
  16610. <value>
  16611. The next filter in the chain
  16612. </value>
  16613. <remarks>
  16614. <para>
  16615. Filters are typically composed into chains. This property allows the next filter in
  16616. the chain to be accessed.
  16617. </para>
  16618. </remarks>
  16619. </member>
  16620. <member name="M:log4net.Filter.DenyAllFilter.#ctor">
  16621. <summary>
  16622. Default constructor
  16623. </summary>
  16624. </member>
  16625. <member name="M:log4net.Filter.DenyAllFilter.Decide(log4net.Core.LoggingEvent)">
  16626. <summary>
  16627. Always returns the integer constant <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  16628. </summary>
  16629. <param name="loggingEvent">the LoggingEvent to filter</param>
  16630. <returns>Always returns <see cref="F:log4net.Filter.FilterDecision.Deny"/></returns>
  16631. <remarks>
  16632. <para>
  16633. Ignores the event being logged and just returns
  16634. <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This can be used to change the default filter
  16635. chain behavior from <see cref="F:log4net.Filter.FilterDecision.Accept"/> to <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This filter
  16636. should only be used as the last filter in the chain
  16637. as any further filters will be ignored!
  16638. </para>
  16639. </remarks>
  16640. </member>
  16641. <member name="T:log4net.Filter.FilterDecision">
  16642. <summary>
  16643. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  16644. </summary>
  16645. <remarks>
  16646. <para>
  16647. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  16648. </para>
  16649. </remarks>
  16650. </member>
  16651. <member name="F:log4net.Filter.FilterDecision.Deny">
  16652. <summary>
  16653. The log event must be dropped immediately without
  16654. consulting with the remaining filters, if any, in the chain.
  16655. </summary>
  16656. </member>
  16657. <member name="F:log4net.Filter.FilterDecision.Neutral">
  16658. <summary>
  16659. This filter is neutral with respect to the log event.
  16660. The remaining filters, if any, should be consulted for a final decision.
  16661. </summary>
  16662. </member>
  16663. <member name="F:log4net.Filter.FilterDecision.Accept">
  16664. <summary>
  16665. The log event must be logged immediately without
  16666. consulting with the remaining filters, if any, in the chain.
  16667. </summary>
  16668. </member>
  16669. <member name="T:log4net.Filter.LevelMatchFilter">
  16670. <summary>
  16671. This is a very simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  16672. </summary>
  16673. <remarks>
  16674. <para>
  16675. The filter admits two options <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> and
  16676. <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If there is an exact match between the value
  16677. of the <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> option and the <see cref="T:log4net.Core.Level"/> of the
  16678. <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
  16679. case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set
  16680. to <c>true</c>, if it is <c>false</c> then
  16681. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then
  16682. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  16683. </para>
  16684. </remarks>
  16685. <author>Nicko Cadell</author>
  16686. <author>Gert Driesen</author>
  16687. </member>
  16688. <member name="F:log4net.Filter.LevelMatchFilter.m_acceptOnMatch">
  16689. <summary>
  16690. flag to indicate if the filter should <see cref="F:log4net.Filter.FilterDecision.Accept"/> on a match
  16691. </summary>
  16692. </member>
  16693. <member name="F:log4net.Filter.LevelMatchFilter.m_levelToMatch">
  16694. <summary>
  16695. the <see cref="T:log4net.Core.Level"/> to match against
  16696. </summary>
  16697. </member>
  16698. <member name="M:log4net.Filter.LevelMatchFilter.#ctor">
  16699. <summary>
  16700. Default constructor
  16701. </summary>
  16702. </member>
  16703. <member name="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)">
  16704. <summary>
  16705. Tests if the <see cref="T:log4net.Core.Level"/> of the logging event matches that of the filter
  16706. </summary>
  16707. <param name="loggingEvent">the event to filter</param>
  16708. <returns>see remarks</returns>
  16709. <remarks>
  16710. <para>
  16711. If the <see cref="T:log4net.Core.Level"/> of the event matches the level of the
  16712. filter then the result of the function depends on the
  16713. value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then
  16714. the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it
  16715. will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then
  16716. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  16717. </para>
  16718. </remarks>
  16719. </member>
  16720. <member name="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch">
  16721. <summary>
  16722. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/>
  16723. </summary>
  16724. <remarks>
  16725. <para>
  16726. The <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> property is a flag that determines
  16727. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16728. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16729. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  16730. </para>
  16731. <para>
  16732. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16733. </para>
  16734. </remarks>
  16735. </member>
  16736. <member name="P:log4net.Filter.LevelMatchFilter.LevelToMatch">
  16737. <summary>
  16738. The <see cref="T:log4net.Core.Level"/> that the filter will match
  16739. </summary>
  16740. <remarks>
  16741. <para>
  16742. The level that this filter will attempt to match against the
  16743. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  16744. the result depends on the value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>.
  16745. </para>
  16746. </remarks>
  16747. </member>
  16748. <member name="T:log4net.Filter.LevelRangeFilter">
  16749. <summary>
  16750. This is a simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  16751. </summary>
  16752. <remarks>
  16753. <para>
  16754. The filter admits three options <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  16755. that determine the range of priorities that are matched, and
  16756. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. If there is a match between the range
  16757. of priorities and the <see cref="T:log4net.Core.Level"/> of the <see cref="T:log4net.Core.LoggingEvent"/>, then the
  16758. <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"/>
  16759. option value is set to <c>true</c>, if it is <c>false</c>
  16760. then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If there is no match, <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16761. </para>
  16762. </remarks>
  16763. <author>Nicko Cadell</author>
  16764. <author>Gert Driesen</author>
  16765. </member>
  16766. <member name="F:log4net.Filter.LevelRangeFilter.m_acceptOnMatch">
  16767. <summary>
  16768. Flag to indicate the behavior when matching a <see cref="T:log4net.Core.Level"/>
  16769. </summary>
  16770. </member>
  16771. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMin">
  16772. <summary>
  16773. the minimum <see cref="T:log4net.Core.Level"/> value to match
  16774. </summary>
  16775. </member>
  16776. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMax">
  16777. <summary>
  16778. the maximum <see cref="T:log4net.Core.Level"/> value to match
  16779. </summary>
  16780. </member>
  16781. <member name="M:log4net.Filter.LevelRangeFilter.#ctor">
  16782. <summary>
  16783. Default constructor
  16784. </summary>
  16785. </member>
  16786. <member name="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)">
  16787. <summary>
  16788. Check if the event should be logged.
  16789. </summary>
  16790. <param name="loggingEvent">the logging event to check</param>
  16791. <returns>see remarks</returns>
  16792. <remarks>
  16793. <para>
  16794. If the <see cref="T:log4net.Core.Level"/> of the logging event is outside the range
  16795. matched by this filter then <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  16796. is returned. If the <see cref="T:log4net.Core.Level"/> is matched then the value of
  16797. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> is checked. If it is true then
  16798. <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, otherwise
  16799. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned.
  16800. </para>
  16801. </remarks>
  16802. </member>
  16803. <member name="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch">
  16804. <summary>
  16805. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  16806. </summary>
  16807. <remarks>
  16808. <para>
  16809. The <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> property is a flag that determines
  16810. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16811. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16812. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  16813. </para>
  16814. <para>
  16815. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16816. </para>
  16817. </remarks>
  16818. </member>
  16819. <member name="P:log4net.Filter.LevelRangeFilter.LevelMin">
  16820. <summary>
  16821. Set the minimum matched <see cref="T:log4net.Core.Level"/>
  16822. </summary>
  16823. <remarks>
  16824. <para>
  16825. The minimum level that this filter will attempt to match against the
  16826. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  16827. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  16828. </para>
  16829. </remarks>
  16830. </member>
  16831. <member name="P:log4net.Filter.LevelRangeFilter.LevelMax">
  16832. <summary>
  16833. Sets the maximum matched <see cref="T:log4net.Core.Level"/>
  16834. </summary>
  16835. <remarks>
  16836. <para>
  16837. The maximum level that this filter will attempt to match against the
  16838. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  16839. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  16840. </para>
  16841. </remarks>
  16842. </member>
  16843. <member name="T:log4net.Filter.LoggerMatchFilter">
  16844. <summary>
  16845. Simple filter to match a string in the event's logger name.
  16846. </summary>
  16847. <remarks>
  16848. <para>
  16849. The works very similar to the <see cref="T:log4net.Filter.LevelMatchFilter"/>. It admits two
  16850. options <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> and <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. If the
  16851. <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <see cref="T:log4net.Core.LoggingEvent"/> starts
  16852. with the value of the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> option, then the
  16853. <see cref="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
  16854. case the <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> option value is set to <c>true</c>,
  16855. if it is <c>false</c> then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16856. </para>
  16857. </remarks>
  16858. <author>Daniel Cazzulino</author>
  16859. </member>
  16860. <member name="F:log4net.Filter.LoggerMatchFilter.m_acceptOnMatch">
  16861. <summary>
  16862. Flag to indicate the behavior when we have a match
  16863. </summary>
  16864. </member>
  16865. <member name="F:log4net.Filter.LoggerMatchFilter.m_loggerToMatch">
  16866. <summary>
  16867. The logger name string to substring match against the event
  16868. </summary>
  16869. </member>
  16870. <member name="M:log4net.Filter.LoggerMatchFilter.#ctor">
  16871. <summary>
  16872. Default constructor
  16873. </summary>
  16874. </member>
  16875. <member name="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)">
  16876. <summary>
  16877. Check if this filter should allow the event to be logged
  16878. </summary>
  16879. <param name="loggingEvent">the event being logged</param>
  16880. <returns>see remarks</returns>
  16881. <remarks>
  16882. <para>
  16883. The rendered message is matched against the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>.
  16884. If the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> equals the beginning of
  16885. the incoming <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> (<see cref="M:String.StartsWith(string)"/>)
  16886. then a match will have occurred. If no match occurs
  16887. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  16888. allowing other filters to check the event. If a match occurs then
  16889. the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> is checked. If it is
  16890. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  16891. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16892. </para>
  16893. </remarks>
  16894. </member>
  16895. <member name="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch">
  16896. <summary>
  16897. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>
  16898. </summary>
  16899. <remarks>
  16900. <para>
  16901. The <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> property is a flag that determines
  16902. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16903. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16904. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  16905. </para>
  16906. <para>
  16907. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16908. </para>
  16909. </remarks>
  16910. </member>
  16911. <member name="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch">
  16912. <summary>
  16913. The <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> that the filter will match
  16914. </summary>
  16915. <remarks>
  16916. <para>
  16917. This filter will attempt to match this value against logger name in
  16918. the following way. The match will be done against the beginning of the
  16919. logger name (using <see cref="M:String.StartsWith(string)"/>). The match is
  16920. case sensitive. If a match is found then
  16921. the result depends on the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>.
  16922. </para>
  16923. </remarks>
  16924. </member>
  16925. <member name="T:log4net.Filter.MdcFilter">
  16926. <summary>
  16927. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  16928. </summary>
  16929. <remarks>
  16930. <para>
  16931. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  16932. </para>
  16933. <para>
  16934. As the MDC has been replaced with layered properties the
  16935. <see cref="T:log4net.Filter.PropertyFilter"/> should be used instead.
  16936. </para>
  16937. </remarks>
  16938. <author>Nicko Cadell</author>
  16939. <author>Gert Driesen</author>
  16940. </member>
  16941. <member name="T:log4net.Filter.PropertyFilter">
  16942. <summary>
  16943. Simple filter to match a string an event property
  16944. </summary>
  16945. <remarks>
  16946. <para>
  16947. Simple filter to match a string in the value for a
  16948. specific event property
  16949. </para>
  16950. </remarks>
  16951. <author>Nicko Cadell</author>
  16952. </member>
  16953. <member name="T:log4net.Filter.StringMatchFilter">
  16954. <summary>
  16955. Simple filter to match a string in the rendered message
  16956. </summary>
  16957. <remarks>
  16958. <para>
  16959. Simple filter to match a string in the rendered message
  16960. </para>
  16961. </remarks>
  16962. <author>Nicko Cadell</author>
  16963. <author>Gert Driesen</author>
  16964. </member>
  16965. <member name="F:log4net.Filter.StringMatchFilter.m_acceptOnMatch">
  16966. <summary>
  16967. Flag to indicate the behavior when we have a match
  16968. </summary>
  16969. </member>
  16970. <member name="F:log4net.Filter.StringMatchFilter.m_stringToMatch">
  16971. <summary>
  16972. The string to substring match against the message
  16973. </summary>
  16974. </member>
  16975. <member name="F:log4net.Filter.StringMatchFilter.m_stringRegexToMatch">
  16976. <summary>
  16977. A string regex to match
  16978. </summary>
  16979. </member>
  16980. <member name="F:log4net.Filter.StringMatchFilter.m_regexToMatch">
  16981. <summary>
  16982. A regex object to match (generated from m_stringRegexToMatch)
  16983. </summary>
  16984. </member>
  16985. <member name="M:log4net.Filter.StringMatchFilter.#ctor">
  16986. <summary>
  16987. Default constructor
  16988. </summary>
  16989. </member>
  16990. <member name="M:log4net.Filter.StringMatchFilter.ActivateOptions">
  16991. <summary>
  16992. Initialize and precompile the Regex if required
  16993. </summary>
  16994. <remarks>
  16995. <para>
  16996. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16997. activation scheme. The <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> method must
  16998. be called on this object after the configuration properties have
  16999. been set. Until <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> is called this
  17000. object is in an undefined state and must not be used.
  17001. </para>
  17002. <para>
  17003. If any of the configuration properties are modified then
  17004. <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> must be called again.
  17005. </para>
  17006. </remarks>
  17007. </member>
  17008. <member name="M:log4net.Filter.StringMatchFilter.Decide(log4net.Core.LoggingEvent)">
  17009. <summary>
  17010. Check if this filter should allow the event to be logged
  17011. </summary>
  17012. <param name="loggingEvent">the event being logged</param>
  17013. <returns>see remarks</returns>
  17014. <remarks>
  17015. <para>
  17016. The rendered message is matched against the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  17017. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  17018. the message then a match will have occurred. If no match occurs
  17019. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  17020. allowing other filters to check the event. If a match occurs then
  17021. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  17022. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  17023. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  17024. </para>
  17025. </remarks>
  17026. </member>
  17027. <member name="P:log4net.Filter.StringMatchFilter.AcceptOnMatch">
  17028. <summary>
  17029. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  17030. </summary>
  17031. <remarks>
  17032. <para>
  17033. The <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> property is a flag that determines
  17034. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  17035. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  17036. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  17037. </para>
  17038. <para>
  17039. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  17040. </para>
  17041. </remarks>
  17042. </member>
  17043. <member name="P:log4net.Filter.StringMatchFilter.StringToMatch">
  17044. <summary>
  17045. Sets the static string to match
  17046. </summary>
  17047. <remarks>
  17048. <para>
  17049. The string that will be substring matched against
  17050. the rendered message. If the message contains this
  17051. string then the filter will match. If a match is found then
  17052. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  17053. </para>
  17054. <para>
  17055. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  17056. must be specified.
  17057. </para>
  17058. </remarks>
  17059. </member>
  17060. <member name="P:log4net.Filter.StringMatchFilter.RegexToMatch">
  17061. <summary>
  17062. Sets the regular expression to match
  17063. </summary>
  17064. <remarks>
  17065. <para>
  17066. The regular expression pattern that will be matched against
  17067. the rendered message. If the message matches this
  17068. pattern then the filter will match. If a match is found then
  17069. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  17070. </para>
  17071. <para>
  17072. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  17073. must be specified.
  17074. </para>
  17075. </remarks>
  17076. </member>
  17077. <member name="F:log4net.Filter.PropertyFilter.m_key">
  17078. <summary>
  17079. The key to use to lookup the string from the event properties
  17080. </summary>
  17081. </member>
  17082. <member name="M:log4net.Filter.PropertyFilter.#ctor">
  17083. <summary>
  17084. Default constructor
  17085. </summary>
  17086. </member>
  17087. <member name="M:log4net.Filter.PropertyFilter.Decide(log4net.Core.LoggingEvent)">
  17088. <summary>
  17089. Check if this filter should allow the event to be logged
  17090. </summary>
  17091. <param name="loggingEvent">the event being logged</param>
  17092. <returns>see remarks</returns>
  17093. <remarks>
  17094. <para>
  17095. The event property for the <see cref="P:log4net.Filter.PropertyFilter.Key"/> is matched against
  17096. the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  17097. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  17098. the property value then a match will have occurred. If no match occurs
  17099. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  17100. allowing other filters to check the event. If a match occurs then
  17101. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  17102. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  17103. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  17104. </para>
  17105. </remarks>
  17106. </member>
  17107. <member name="P:log4net.Filter.PropertyFilter.Key">
  17108. <summary>
  17109. The key to lookup in the event properties and then match against.
  17110. </summary>
  17111. <remarks>
  17112. <para>
  17113. The key name to use to lookup in the properties map of the
  17114. <see cref="T:log4net.Core.LoggingEvent"/>. The match will be performed against
  17115. the value of this property if it exists.
  17116. </para>
  17117. </remarks>
  17118. </member>
  17119. <member name="T:log4net.Filter.NdcFilter">
  17120. <summary>
  17121. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  17122. </summary>
  17123. <remarks>
  17124. <para>
  17125. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  17126. </para>
  17127. <para>
  17128. As the MDC has been replaced with named stacks stored in the
  17129. properties collections the <see cref="T:log4net.Filter.PropertyFilter"/> should
  17130. be used instead.
  17131. </para>
  17132. </remarks>
  17133. <author>Nicko Cadell</author>
  17134. <author>Gert Driesen</author>
  17135. </member>
  17136. <member name="M:log4net.Filter.NdcFilter.#ctor">
  17137. <summary>
  17138. Default constructor
  17139. </summary>
  17140. <remarks>
  17141. <para>
  17142. Sets the <see cref="P:log4net.Filter.PropertyFilter.Key"/> to <c>"NDC"</c>.
  17143. </para>
  17144. </remarks>
  17145. </member>
  17146. <member name="T:log4net.Layout.Pattern.AppDomainPatternConverter">
  17147. <summary>
  17148. Write the event appdomain name to the output
  17149. </summary>
  17150. <remarks>
  17151. <para>
  17152. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output writer.
  17153. </para>
  17154. </remarks>
  17155. <author>Daniel Cazzulino</author>
  17156. <author>Nicko Cadell</author>
  17157. </member>
  17158. <member name="T:log4net.Layout.Pattern.PatternLayoutConverter">
  17159. <summary>
  17160. Abstract class that provides the formatting functionality that
  17161. derived classes need.
  17162. </summary>
  17163. <remarks>
  17164. Conversion specifiers in a conversion patterns are parsed to
  17165. individual PatternConverters. Each of which is responsible for
  17166. converting a logging event in a converter specific manner.
  17167. </remarks>
  17168. <author>Nicko Cadell</author>
  17169. </member>
  17170. <member name="T:log4net.Util.PatternConverter">
  17171. <summary>
  17172. Abstract class that provides the formatting functionality that
  17173. derived classes need.
  17174. </summary>
  17175. <remarks>
  17176. <para>
  17177. Conversion specifiers in a conversion patterns are parsed to
  17178. individual PatternConverters. Each of which is responsible for
  17179. converting a logging event in a converter specific manner.
  17180. </para>
  17181. </remarks>
  17182. <author>Nicko Cadell</author>
  17183. <author>Gert Driesen</author>
  17184. </member>
  17185. <member name="F:log4net.Util.PatternConverter.c_renderBufferSize">
  17186. <summary>
  17187. Initial buffer size
  17188. </summary>
  17189. </member>
  17190. <member name="F:log4net.Util.PatternConverter.c_renderBufferMaxCapacity">
  17191. <summary>
  17192. Maximum buffer size before it is recycled
  17193. </summary>
  17194. </member>
  17195. <member name="M:log4net.Util.PatternConverter.#ctor">
  17196. <summary>
  17197. Protected constructor
  17198. </summary>
  17199. <remarks>
  17200. <para>
  17201. Initializes a new instance of the <see cref="T:log4net.Util.PatternConverter"/> class.
  17202. </para>
  17203. </remarks>
  17204. </member>
  17205. <member name="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)">
  17206. <summary>
  17207. Evaluate this pattern converter and write the output to a writer.
  17208. </summary>
  17209. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17210. <param name="state">The state object on which the pattern converter should be executed.</param>
  17211. <remarks>
  17212. <para>
  17213. Derived pattern converters must override this method in order to
  17214. convert conversion specifiers in the appropriate way.
  17215. </para>
  17216. </remarks>
  17217. </member>
  17218. <member name="M:log4net.Util.PatternConverter.SetNext(log4net.Util.PatternConverter)">
  17219. <summary>
  17220. Set the next pattern converter in the chains
  17221. </summary>
  17222. <param name="patternConverter">the pattern converter that should follow this converter in the chain</param>
  17223. <returns>the next converter</returns>
  17224. <remarks>
  17225. <para>
  17226. The PatternConverter can merge with its neighbor during this method (or a sub class).
  17227. Therefore the return value may or may not be the value of the argument passed in.
  17228. </para>
  17229. </remarks>
  17230. </member>
  17231. <member name="M:log4net.Util.PatternConverter.Format(System.IO.TextWriter,System.Object)">
  17232. <summary>
  17233. Write the pattern converter to the writer with appropriate formatting
  17234. </summary>
  17235. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17236. <param name="state">The state object on which the pattern converter should be executed.</param>
  17237. <remarks>
  17238. <para>
  17239. This method calls <see cref="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"/> to allow the subclass to perform
  17240. appropriate conversion of the pattern converter. If formatting options have
  17241. been specified via the <see cref="P:log4net.Util.PatternConverter.FormattingInfo"/> then this method will
  17242. apply those formattings before writing the output.
  17243. </para>
  17244. </remarks>
  17245. </member>
  17246. <member name="M:log4net.Util.PatternConverter.SpacePad(System.IO.TextWriter,System.Int32)">
  17247. <summary>
  17248. Fast space padding method.
  17249. </summary>
  17250. <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the spaces will be appended.</param>
  17251. <param name="length">The number of spaces to be padded.</param>
  17252. <remarks>
  17253. <para>
  17254. Fast space padding method.
  17255. </para>
  17256. </remarks>
  17257. </member>
  17258. <member name="F:log4net.Util.PatternConverter.m_option">
  17259. <summary>
  17260. The option string to the converter
  17261. </summary>
  17262. </member>
  17263. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionary)">
  17264. <summary>
  17265. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  17266. </summary>
  17267. <param name="writer">the writer to write to</param>
  17268. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  17269. <param name="value">the value to write to the writer</param>
  17270. <remarks>
  17271. <para>
  17272. Writes the <see cref="T:System.Collections.IDictionary"/> to a writer in the form:
  17273. </para>
  17274. <code>
  17275. {key1=value1, key2=value2, key3=value3}
  17276. </code>
  17277. <para>
  17278. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  17279. is not null then it is used to render the key and value to text, otherwise
  17280. the object's ToString method is called.
  17281. </para>
  17282. </remarks>
  17283. </member>
  17284. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionaryEnumerator)">
  17285. <summary>
  17286. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  17287. </summary>
  17288. <param name="writer">the writer to write to</param>
  17289. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  17290. <param name="value">the value to write to the writer</param>
  17291. <remarks>
  17292. <para>
  17293. Writes the <see cref="T:System.Collections.IDictionaryEnumerator"/> to a writer in the form:
  17294. </para>
  17295. <code>
  17296. {key1=value1, key2=value2, key3=value3}
  17297. </code>
  17298. <para>
  17299. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  17300. is not null then it is used to render the key and value to text, otherwise
  17301. the object's ToString method is called.
  17302. </para>
  17303. </remarks>
  17304. </member>
  17305. <member name="M:log4net.Util.PatternConverter.WriteObject(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Object)">
  17306. <summary>
  17307. Write an object to a <see cref="T:System.IO.TextWriter"/>
  17308. </summary>
  17309. <param name="writer">the writer to write to</param>
  17310. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  17311. <param name="value">the value to write to the writer</param>
  17312. <remarks>
  17313. <para>
  17314. Writes the Object to a writer. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  17315. is not null then it is used to render the object to text, otherwise
  17316. the object's ToString method is called.
  17317. </para>
  17318. </remarks>
  17319. </member>
  17320. <member name="P:log4net.Util.PatternConverter.Next">
  17321. <summary>
  17322. Get the next pattern converter in the chain
  17323. </summary>
  17324. <value>
  17325. the next pattern converter in the chain
  17326. </value>
  17327. <remarks>
  17328. <para>
  17329. Get the next pattern converter in the chain
  17330. </para>
  17331. </remarks>
  17332. </member>
  17333. <member name="P:log4net.Util.PatternConverter.FormattingInfo">
  17334. <summary>
  17335. Gets or sets the formatting info for this converter
  17336. </summary>
  17337. <value>
  17338. The formatting info for this converter
  17339. </value>
  17340. <remarks>
  17341. <para>
  17342. Gets or sets the formatting info for this converter
  17343. </para>
  17344. </remarks>
  17345. </member>
  17346. <member name="P:log4net.Util.PatternConverter.Option">
  17347. <summary>
  17348. Gets or sets the option value for this converter
  17349. </summary>
  17350. <summary>
  17351. The option for this converter
  17352. </summary>
  17353. <remarks>
  17354. <para>
  17355. Gets or sets the option value for this converter
  17356. </para>
  17357. </remarks>
  17358. </member>
  17359. <member name="P:log4net.Util.PatternConverter.Properties">
  17360. <summary>
  17361. </summary>
  17362. </member>
  17363. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.#ctor">
  17364. <summary>
  17365. Initializes a new instance of the <see cref="T:log4net.Layout.Pattern.PatternLayoutConverter"/> class.
  17366. </summary>
  17367. </member>
  17368. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17369. <summary>
  17370. Derived pattern converters must override this method in order to
  17371. convert conversion specifiers in the correct way.
  17372. </summary>
  17373. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17374. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17375. </member>
  17376. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,System.Object)">
  17377. <summary>
  17378. Derived pattern converters must override this method in order to
  17379. convert conversion specifiers in the correct way.
  17380. </summary>
  17381. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17382. <param name="state">The state object on which the pattern converter should be executed.</param>
  17383. </member>
  17384. <member name="F:log4net.Layout.Pattern.PatternLayoutConverter.m_ignoresException">
  17385. <summary>
  17386. Flag indicating if this converter handles exceptions
  17387. </summary>
  17388. <remarks>
  17389. <c>false</c> if this converter handles exceptions
  17390. </remarks>
  17391. </member>
  17392. <member name="P:log4net.Layout.Pattern.PatternLayoutConverter.IgnoresException">
  17393. <summary>
  17394. Flag indicating if this converter handles the logging event exception
  17395. </summary>
  17396. <value><c>false</c> if this converter handles the logging event exception</value>
  17397. <remarks>
  17398. <para>
  17399. If this converter handles the exception object contained within
  17400. <see cref="T:log4net.Core.LoggingEvent"/>, then this property should be set to
  17401. <c>false</c>. Otherwise, if the layout ignores the exception
  17402. object, then the property should be set to <c>true</c>.
  17403. </para>
  17404. <para>
  17405. Set this value to override a this default setting. The default
  17406. value is <c>true</c>, this converter does not handle the exception.
  17407. </para>
  17408. </remarks>
  17409. </member>
  17410. <member name="M:log4net.Layout.Pattern.AppDomainPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17411. <summary>
  17412. Write the event appdomain name to the output
  17413. </summary>
  17414. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17415. <param name="loggingEvent">the event being logged</param>
  17416. <remarks>
  17417. <para>
  17418. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output <paramref name="writer"/>.
  17419. </para>
  17420. </remarks>
  17421. </member>
  17422. <member name="T:log4net.Layout.Pattern.DatePatternConverter">
  17423. <summary>
  17424. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  17425. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  17426. </summary>
  17427. <remarks>
  17428. <para>
  17429. Render the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the writer as a string.
  17430. </para>
  17431. <para>
  17432. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  17433. the formatting of the date. The following values are allowed:
  17434. <list type="definition">
  17435. <listheader>
  17436. <term>Option value</term>
  17437. <description>Output</description>
  17438. </listheader>
  17439. <item>
  17440. <term>ISO8601</term>
  17441. <description>
  17442. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  17443. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  17444. </description>
  17445. </item>
  17446. <item>
  17447. <term>DATE</term>
  17448. <description>
  17449. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  17450. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  17451. </description>
  17452. </item>
  17453. <item>
  17454. <term>ABSOLUTE</term>
  17455. <description>
  17456. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  17457. Formats using the <c>"HH:mm:ss,yyyy"</c> for example, <c>"15:49:37,459"</c>.
  17458. </description>
  17459. </item>
  17460. <item>
  17461. <term>other</term>
  17462. <description>
  17463. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  17464. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  17465. <see cref="M:DateTime.ToString(string)"/> method.
  17466. For details on valid patterns see
  17467. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  17468. </description>
  17469. </item>
  17470. </list>
  17471. </para>
  17472. <para>
  17473. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> is in the local time zone and is rendered in that zone.
  17474. To output the time in Universal time see <see cref="T:log4net.Layout.Pattern.UtcDatePatternConverter"/>.
  17475. </para>
  17476. </remarks>
  17477. <author>Nicko Cadell</author>
  17478. </member>
  17479. <member name="F:log4net.Layout.Pattern.DatePatternConverter.m_dateFormatter">
  17480. <summary>
  17481. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  17482. </summary>
  17483. <remarks>
  17484. <para>
  17485. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  17486. </para>
  17487. </remarks>
  17488. </member>
  17489. <member name="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions">
  17490. <summary>
  17491. Initialize the converter pattern based on the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  17492. </summary>
  17493. <remarks>
  17494. <para>
  17495. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17496. activation scheme. The <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> method must
  17497. be called on this object after the configuration properties have
  17498. been set. Until <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> is called this
  17499. object is in an undefined state and must not be used.
  17500. </para>
  17501. <para>
  17502. If any of the configuration properties are modified then
  17503. <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> must be called again.
  17504. </para>
  17505. </remarks>
  17506. </member>
  17507. <member name="M:log4net.Layout.Pattern.DatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17508. <summary>
  17509. Convert the pattern into the rendered message
  17510. </summary>
  17511. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17512. <param name="loggingEvent">the event being logged</param>
  17513. <remarks>
  17514. <para>
  17515. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  17516. for it to render it to the writer.
  17517. </para>
  17518. <para>
  17519. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone.
  17520. </para>
  17521. </remarks>
  17522. </member>
  17523. <member name="F:log4net.Layout.Pattern.DatePatternConverter.declaringType">
  17524. <summary>
  17525. The fully qualified type of the DatePatternConverter class.
  17526. </summary>
  17527. <remarks>
  17528. Used by the internal logger to record the Type of the
  17529. log message.
  17530. </remarks>
  17531. </member>
  17532. <member name="T:log4net.Layout.Pattern.ExceptionPatternConverter">
  17533. <summary>
  17534. Write the exception text to the output
  17535. </summary>
  17536. <remarks>
  17537. <para>
  17538. If an exception object is stored in the logging event
  17539. it will be rendered into the pattern output with a
  17540. trailing newline.
  17541. </para>
  17542. <para>
  17543. If there is no exception then nothing will be output
  17544. and no trailing newline will be appended.
  17545. It is typical to put a newline before the exception
  17546. and to have the exception as the last data in the pattern.
  17547. </para>
  17548. </remarks>
  17549. <author>Nicko Cadell</author>
  17550. </member>
  17551. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.#ctor">
  17552. <summary>
  17553. Default constructor
  17554. </summary>
  17555. </member>
  17556. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17557. <summary>
  17558. Write the exception text to the output
  17559. </summary>
  17560. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17561. <param name="loggingEvent">the event being logged</param>
  17562. <remarks>
  17563. <para>
  17564. If an exception object is stored in the logging event
  17565. it will be rendered into the pattern output with a
  17566. trailing newline.
  17567. </para>
  17568. <para>
  17569. If there is no exception or the exception property specified
  17570. by the Option value does not exist then nothing will be output
  17571. and no trailing newline will be appended.
  17572. It is typical to put a newline before the exception
  17573. and to have the exception as the last data in the pattern.
  17574. </para>
  17575. <para>
  17576. Recognized values for the Option parameter are:
  17577. </para>
  17578. <list type="bullet">
  17579. <item>
  17580. <description>Message</description>
  17581. </item>
  17582. <item>
  17583. <description>Source</description>
  17584. </item>
  17585. <item>
  17586. <description>StackTrace</description>
  17587. </item>
  17588. <item>
  17589. <description>TargetSite</description>
  17590. </item>
  17591. <item>
  17592. <description>HelpLink</description>
  17593. </item>
  17594. </list>
  17595. </remarks>
  17596. </member>
  17597. <member name="T:log4net.Layout.Pattern.FileLocationPatternConverter">
  17598. <summary>
  17599. Writes the caller location file name to the output
  17600. </summary>
  17601. <remarks>
  17602. <para>
  17603. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  17604. the event to the output writer.
  17605. </para>
  17606. </remarks>
  17607. <author>Nicko Cadell</author>
  17608. </member>
  17609. <member name="M:log4net.Layout.Pattern.FileLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17610. <summary>
  17611. Write the caller location file name to the output
  17612. </summary>
  17613. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17614. <param name="loggingEvent">the event being logged</param>
  17615. <remarks>
  17616. <para>
  17617. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  17618. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  17619. </para>
  17620. </remarks>
  17621. </member>
  17622. <member name="T:log4net.Layout.Pattern.FullLocationPatternConverter">
  17623. <summary>
  17624. Write the caller location info to the output
  17625. </summary>
  17626. <remarks>
  17627. <para>
  17628. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  17629. </para>
  17630. </remarks>
  17631. <author>Nicko Cadell</author>
  17632. </member>
  17633. <member name="M:log4net.Layout.Pattern.FullLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17634. <summary>
  17635. Write the caller location info to the output
  17636. </summary>
  17637. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17638. <param name="loggingEvent">the event being logged</param>
  17639. <remarks>
  17640. <para>
  17641. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  17642. </para>
  17643. </remarks>
  17644. </member>
  17645. <member name="T:log4net.Layout.Pattern.IdentityPatternConverter">
  17646. <summary>
  17647. Writes the event identity to the output
  17648. </summary>
  17649. <remarks>
  17650. <para>
  17651. Writes the value of the <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  17652. the output writer.
  17653. </para>
  17654. </remarks>
  17655. <author>Daniel Cazzulino</author>
  17656. <author>Nicko Cadell</author>
  17657. </member>
  17658. <member name="M:log4net.Layout.Pattern.IdentityPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17659. <summary>
  17660. Writes the event identity to the output
  17661. </summary>
  17662. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17663. <param name="loggingEvent">the event being logged</param>
  17664. <remarks>
  17665. <para>
  17666. Writes the value of the <paramref name="loggingEvent"/>
  17667. <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  17668. the output <paramref name="writer"/>.
  17669. </para>
  17670. </remarks>
  17671. </member>
  17672. <member name="T:log4net.Layout.Pattern.LevelPatternConverter">
  17673. <summary>
  17674. Write the event level to the output
  17675. </summary>
  17676. <remarks>
  17677. <para>
  17678. Writes the display name of the event <see cref="P:log4net.Core.LoggingEvent.Level"/>
  17679. to the writer.
  17680. </para>
  17681. </remarks>
  17682. <author>Nicko Cadell</author>
  17683. </member>
  17684. <member name="M:log4net.Layout.Pattern.LevelPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17685. <summary>
  17686. Write the event level to the output
  17687. </summary>
  17688. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17689. <param name="loggingEvent">the event being logged</param>
  17690. <remarks>
  17691. <para>
  17692. Writes the <see cref="P:log4net.Core.Level.DisplayName"/> of the <paramref name="loggingEvent"/> <see cref="P:log4net.Core.LoggingEvent.Level"/>
  17693. to the <paramref name="writer"/>.
  17694. </para>
  17695. </remarks>
  17696. </member>
  17697. <member name="T:log4net.Layout.Pattern.LineLocationPatternConverter">
  17698. <summary>
  17699. Write the caller location line number to the output
  17700. </summary>
  17701. <remarks>
  17702. <para>
  17703. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  17704. the event to the output writer.
  17705. </para>
  17706. </remarks>
  17707. <author>Nicko Cadell</author>
  17708. </member>
  17709. <member name="M:log4net.Layout.Pattern.LineLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17710. <summary>
  17711. Write the caller location line number to the output
  17712. </summary>
  17713. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17714. <param name="loggingEvent">the event being logged</param>
  17715. <remarks>
  17716. <para>
  17717. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  17718. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  17719. </para>
  17720. </remarks>
  17721. </member>
  17722. <member name="T:log4net.Layout.Pattern.LoggerPatternConverter">
  17723. <summary>
  17724. Converter for logger name
  17725. </summary>
  17726. <remarks>
  17727. <para>
  17728. Outputs the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the event.
  17729. </para>
  17730. </remarks>
  17731. <author>Nicko Cadell</author>
  17732. </member>
  17733. <member name="T:log4net.Layout.Pattern.NamedPatternConverter">
  17734. <summary>
  17735. Converter to output and truncate <c>'.'</c> separated strings
  17736. </summary>
  17737. <remarks>
  17738. <para>
  17739. This abstract class supports truncating a <c>'.'</c> separated string
  17740. to show a specified number of elements from the right hand side.
  17741. This is used to truncate class names that are fully qualified.
  17742. </para>
  17743. <para>
  17744. Subclasses should override the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> method to
  17745. return the fully qualified string.
  17746. </para>
  17747. </remarks>
  17748. <author>Nicko Cadell</author>
  17749. </member>
  17750. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions">
  17751. <summary>
  17752. Initialize the converter
  17753. </summary>
  17754. <remarks>
  17755. <para>
  17756. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17757. activation scheme. The <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> method must
  17758. be called on this object after the configuration properties have
  17759. been set. Until <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> is called this
  17760. object is in an undefined state and must not be used.
  17761. </para>
  17762. <para>
  17763. If any of the configuration properties are modified then
  17764. <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> must be called again.
  17765. </para>
  17766. </remarks>
  17767. </member>
  17768. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17769. <summary>
  17770. Get the fully qualified string data
  17771. </summary>
  17772. <param name="loggingEvent">the event being logged</param>
  17773. <returns>the fully qualified name</returns>
  17774. <remarks>
  17775. <para>
  17776. Overridden by subclasses to get the fully qualified name before the
  17777. precision is applied to it.
  17778. </para>
  17779. <para>
  17780. Return the fully qualified <c>'.'</c> (dot/period) separated string.
  17781. </para>
  17782. </remarks>
  17783. </member>
  17784. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17785. <summary>
  17786. Convert the pattern to the rendered message
  17787. </summary>
  17788. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17789. <param name="loggingEvent">the event being logged</param>
  17790. <remarks>
  17791. Render the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> to the precision
  17792. specified by the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  17793. </remarks>
  17794. </member>
  17795. <member name="F:log4net.Layout.Pattern.NamedPatternConverter.declaringType">
  17796. <summary>
  17797. The fully qualified type of the NamedPatternConverter class.
  17798. </summary>
  17799. <remarks>
  17800. Used by the internal logger to record the Type of the
  17801. log message.
  17802. </remarks>
  17803. </member>
  17804. <member name="M:log4net.Layout.Pattern.LoggerPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17805. <summary>
  17806. Gets the fully qualified name of the logger
  17807. </summary>
  17808. <param name="loggingEvent">the event being logged</param>
  17809. <returns>The fully qualified logger name</returns>
  17810. <remarks>
  17811. <para>
  17812. Returns the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <paramref name="loggingEvent"/>.
  17813. </para>
  17814. </remarks>
  17815. </member>
  17816. <member name="T:log4net.Layout.Pattern.MessagePatternConverter">
  17817. <summary>
  17818. Writes the event message to the output
  17819. </summary>
  17820. <remarks>
  17821. <para>
  17822. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  17823. to write out the event message.
  17824. </para>
  17825. </remarks>
  17826. <author>Nicko Cadell</author>
  17827. </member>
  17828. <member name="M:log4net.Layout.Pattern.MessagePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17829. <summary>
  17830. Writes the event message to the output
  17831. </summary>
  17832. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17833. <param name="loggingEvent">the event being logged</param>
  17834. <remarks>
  17835. <para>
  17836. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  17837. to write out the event message.
  17838. </para>
  17839. </remarks>
  17840. </member>
  17841. <member name="T:log4net.Layout.Pattern.MethodLocationPatternConverter">
  17842. <summary>
  17843. Write the method name to the output
  17844. </summary>
  17845. <remarks>
  17846. <para>
  17847. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  17848. the output.
  17849. </para>
  17850. </remarks>
  17851. <author>Nicko Cadell</author>
  17852. </member>
  17853. <member name="M:log4net.Layout.Pattern.MethodLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17854. <summary>
  17855. Write the method name to the output
  17856. </summary>
  17857. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17858. <param name="loggingEvent">the event being logged</param>
  17859. <remarks>
  17860. <para>
  17861. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  17862. the output.
  17863. </para>
  17864. </remarks>
  17865. </member>
  17866. <member name="T:log4net.Layout.Pattern.NdcPatternConverter">
  17867. <summary>
  17868. Converter to include event NDC
  17869. </summary>
  17870. <remarks>
  17871. <para>
  17872. Outputs the value of the event property named <c>NDC</c>.
  17873. </para>
  17874. <para>
  17875. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  17876. </para>
  17877. </remarks>
  17878. <author>Nicko Cadell</author>
  17879. </member>
  17880. <member name="M:log4net.Layout.Pattern.NdcPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17881. <summary>
  17882. Write the event NDC to the output
  17883. </summary>
  17884. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17885. <param name="loggingEvent">the event being logged</param>
  17886. <remarks>
  17887. <para>
  17888. As the thread context stacks are now stored in named event properties
  17889. this converter simply looks up the value of the <c>NDC</c> property.
  17890. </para>
  17891. <para>
  17892. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  17893. </para>
  17894. </remarks>
  17895. </member>
  17896. <member name="T:log4net.Layout.Pattern.PropertyPatternConverter">
  17897. <summary>
  17898. Property pattern converter
  17899. </summary>
  17900. <remarks>
  17901. <para>
  17902. Writes out the value of a named property. The property name
  17903. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17904. property.
  17905. </para>
  17906. <para>
  17907. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  17908. then all the properties are written as key value pairs.
  17909. </para>
  17910. </remarks>
  17911. <author>Nicko Cadell</author>
  17912. </member>
  17913. <member name="M:log4net.Layout.Pattern.PropertyPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17914. <summary>
  17915. Write the property value to the output
  17916. </summary>
  17917. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17918. <param name="loggingEvent">the event being logged</param>
  17919. <remarks>
  17920. <para>
  17921. Writes out the value of a named property. The property name
  17922. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17923. property.
  17924. </para>
  17925. <para>
  17926. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  17927. then all the properties are written as key value pairs.
  17928. </para>
  17929. </remarks>
  17930. </member>
  17931. <member name="T:log4net.Layout.Pattern.RelativeTimePatternConverter">
  17932. <summary>
  17933. Converter to output the relative time of the event
  17934. </summary>
  17935. <remarks>
  17936. <para>
  17937. Converter to output the time of the event relative to the start of the program.
  17938. </para>
  17939. </remarks>
  17940. <author>Nicko Cadell</author>
  17941. </member>
  17942. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17943. <summary>
  17944. Write the relative time to the output
  17945. </summary>
  17946. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17947. <param name="loggingEvent">the event being logged</param>
  17948. <remarks>
  17949. <para>
  17950. Writes out the relative time of the event in milliseconds.
  17951. That is the number of milliseconds between the event <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  17952. and the <see cref="P:log4net.Core.LoggingEvent.StartTime"/>.
  17953. </para>
  17954. </remarks>
  17955. </member>
  17956. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.TimeDifferenceInMillis(System.DateTime,System.DateTime)">
  17957. <summary>
  17958. Helper method to get the time difference between two DateTime objects
  17959. </summary>
  17960. <param name="start">start time (in the current local time zone)</param>
  17961. <param name="end">end time (in the current local time zone)</param>
  17962. <returns>the time difference in milliseconds</returns>
  17963. </member>
  17964. <member name="T:log4net.Layout.Pattern.StackTraceDetailPatternConverter">
  17965. <summary>
  17966. Write the caller stack frames to the output
  17967. </summary>
  17968. <remarks>
  17969. <para>
  17970. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
  17971. type3.MethodCall3(type param,...) &gt; type2.MethodCall2(type param,...) &gt; type1.MethodCall1(type param,...)
  17972. </para>
  17973. </remarks>
  17974. <author>Adam Davies</author>
  17975. </member>
  17976. <member name="T:log4net.Layout.Pattern.StackTracePatternConverter">
  17977. <summary>
  17978. Write the caller stack frames to the output
  17979. </summary>
  17980. <remarks>
  17981. <para>
  17982. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
  17983. type3.MethodCall3 &gt; type2.MethodCall2 &gt; type1.MethodCall1
  17984. </para>
  17985. </remarks>
  17986. <author>Michael Cromwell</author>
  17987. </member>
  17988. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions">
  17989. <summary>
  17990. Initialize the converter
  17991. </summary>
  17992. <remarks>
  17993. <para>
  17994. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17995. activation scheme. The <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> method must
  17996. be called on this object after the configuration properties have
  17997. been set. Until <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> is called this
  17998. object is in an undefined state and must not be used.
  17999. </para>
  18000. <para>
  18001. If any of the configuration properties are modified then
  18002. <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> must be called again.
  18003. </para>
  18004. </remarks>
  18005. </member>
  18006. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18007. <summary>
  18008. Write the strack frames to the output
  18009. </summary>
  18010. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18011. <param name="loggingEvent">the event being logged</param>
  18012. <remarks>
  18013. <para>
  18014. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer.
  18015. </para>
  18016. </remarks>
  18017. </member>
  18018. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.GetMethodInformation(log4net.Core.MethodItem)">
  18019. <summary>
  18020. Returns the Name of the method
  18021. </summary>
  18022. <param name="method"></param>
  18023. <remarks>This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter</remarks>
  18024. <returns>string</returns>
  18025. </member>
  18026. <member name="F:log4net.Layout.Pattern.StackTracePatternConverter.declaringType">
  18027. <summary>
  18028. The fully qualified type of the StackTracePatternConverter class.
  18029. </summary>
  18030. <remarks>
  18031. Used by the internal logger to record the Type of the
  18032. log message.
  18033. </remarks>
  18034. </member>
  18035. <member name="F:log4net.Layout.Pattern.StackTraceDetailPatternConverter.declaringType">
  18036. <summary>
  18037. The fully qualified type of the StackTraceDetailPatternConverter class.
  18038. </summary>
  18039. <remarks>
  18040. Used by the internal logger to record the Type of the
  18041. log message.
  18042. </remarks>
  18043. </member>
  18044. <member name="T:log4net.Layout.Pattern.ThreadPatternConverter">
  18045. <summary>
  18046. Converter to include event thread name
  18047. </summary>
  18048. <remarks>
  18049. <para>
  18050. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the output.
  18051. </para>
  18052. </remarks>
  18053. <author>Nicko Cadell</author>
  18054. </member>
  18055. <member name="M:log4net.Layout.Pattern.ThreadPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18056. <summary>
  18057. Write the ThreadName to the output
  18058. </summary>
  18059. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18060. <param name="loggingEvent">the event being logged</param>
  18061. <remarks>
  18062. <para>
  18063. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the <paramref name="writer"/>.
  18064. </para>
  18065. </remarks>
  18066. </member>
  18067. <member name="T:log4net.Layout.Pattern.TypeNamePatternConverter">
  18068. <summary>
  18069. Pattern converter for the class name
  18070. </summary>
  18071. <remarks>
  18072. <para>
  18073. Outputs the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the event.
  18074. </para>
  18075. </remarks>
  18076. <author>Nicko Cadell</author>
  18077. </member>
  18078. <member name="M:log4net.Layout.Pattern.TypeNamePatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  18079. <summary>
  18080. Gets the fully qualified name of the class
  18081. </summary>
  18082. <param name="loggingEvent">the event being logged</param>
  18083. <returns>The fully qualified type name for the caller location</returns>
  18084. <remarks>
  18085. <para>
  18086. Returns the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the <paramref name="loggingEvent"/>.
  18087. </para>
  18088. </remarks>
  18089. </member>
  18090. <member name="T:log4net.Layout.Pattern.UserNamePatternConverter">
  18091. <summary>
  18092. Converter to include event user name
  18093. </summary>
  18094. <author>Douglas de la Torre</author>
  18095. <author>Nicko Cadell</author>
  18096. </member>
  18097. <member name="M:log4net.Layout.Pattern.UserNamePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18098. <summary>
  18099. Convert the pattern to the rendered message
  18100. </summary>
  18101. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18102. <param name="loggingEvent">the event being logged</param>
  18103. </member>
  18104. <member name="T:log4net.Layout.Pattern.UtcDatePatternConverter">
  18105. <summary>
  18106. Write the TimeStamp to the output
  18107. </summary>
  18108. <remarks>
  18109. <para>
  18110. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  18111. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  18112. </para>
  18113. <para>
  18114. Uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  18115. in Universal time.
  18116. </para>
  18117. <para>
  18118. See the <see cref="T:log4net.Layout.Pattern.DatePatternConverter"/> for details on the date pattern syntax.
  18119. </para>
  18120. </remarks>
  18121. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  18122. <author>Nicko Cadell</author>
  18123. </member>
  18124. <member name="M:log4net.Layout.Pattern.UtcDatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18125. <summary>
  18126. Write the TimeStamp to the output
  18127. </summary>
  18128. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  18129. <param name="loggingEvent">the event being logged</param>
  18130. <remarks>
  18131. <para>
  18132. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  18133. for it to render it to the writer.
  18134. </para>
  18135. <para>
  18136. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone, this is converted
  18137. to Universal time before it is rendered.
  18138. </para>
  18139. </remarks>
  18140. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  18141. </member>
  18142. <member name="F:log4net.Layout.Pattern.UtcDatePatternConverter.declaringType">
  18143. <summary>
  18144. The fully qualified type of the UtcDatePatternConverter class.
  18145. </summary>
  18146. <remarks>
  18147. Used by the internal logger to record the Type of the
  18148. log message.
  18149. </remarks>
  18150. </member>
  18151. <member name="T:log4net.Layout.DynamicPatternLayout">
  18152. <summary>
  18153. A flexible layout configurable with pattern string that re-evaluates on each call.
  18154. </summary>
  18155. <remarks>
  18156. <para>This class is built on <see cref="T:log4net.Layout.PatternLayout"></see> and provides all the
  18157. features and capabilities of PatternLayout. PatternLayout is a 'static' class
  18158. in that its layout is done once at configuration time. This class will recreate
  18159. the layout on each reference.</para>
  18160. <para>One important difference between PatternLayout and DynamicPatternLayout is the
  18161. treatment of the Header and Footer parameters in the configuration. The Header and Footer
  18162. parameters for DynamicPatternLayout must be syntactically in the form of a PatternString,
  18163. but should not be marked as type log4net.Util.PatternString. Doing so causes the
  18164. pattern to be statically converted at configuration time and causes DynamicPatternLayout
  18165. to perform the same as PatternLayout.</para>
  18166. <para>Please see <see cref="T:log4net.Layout.PatternLayout"/> for complete documentation.</para>
  18167. <example>
  18168. &lt;layout type="log4net.Layout.DynamicPatternLayout"&gt;
  18169. &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;
  18170. &lt;param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /&gt;
  18171. &lt;/layout&gt;
  18172. </example>
  18173. </remarks>
  18174. </member>
  18175. <member name="T:log4net.Layout.PatternLayout">
  18176. <summary>
  18177. A flexible layout configurable with pattern string.
  18178. </summary>
  18179. <remarks>
  18180. <para>
  18181. The goal of this class is to <see cref="M:PatternLayout.Format(TextWriter,LoggingEvent)"/> a
  18182. <see cref="T:log4net.Core.LoggingEvent"/> as a string. The results
  18183. depend on the <i>conversion pattern</i>.
  18184. </para>
  18185. <para>
  18186. The conversion pattern is closely related to the conversion
  18187. pattern of the printf function in C. A conversion pattern is
  18188. composed of literal text and format control expressions called
  18189. <i>conversion specifiers</i>.
  18190. </para>
  18191. <para>
  18192. <i>You are free to insert any literal text within the conversion
  18193. pattern.</i>
  18194. </para>
  18195. <para>
  18196. Each conversion specifier starts with a percent sign (%) and is
  18197. followed by optional <i>format modifiers</i> and a <i>conversion
  18198. pattern name</i>. The conversion pattern name specifies the type of
  18199. data, e.g. logger, level, date, thread name. The format
  18200. modifiers control such things as field width, padding, left and
  18201. right justification. The following is a simple example.
  18202. </para>
  18203. <para>
  18204. Let the conversion pattern be <b>"%-5level [%thread]: %message%newline"</b> and assume
  18205. that the log4net environment was set to use a PatternLayout. Then the
  18206. statements
  18207. </para>
  18208. <code lang="C#">
  18209. ILog log = LogManager.GetLogger(typeof(TestApp));
  18210. log.Debug("Message 1");
  18211. log.Warn("Message 2");
  18212. </code>
  18213. <para>would yield the output</para>
  18214. <code>
  18215. DEBUG [main]: Message 1
  18216. WARN [main]: Message 2
  18217. </code>
  18218. <para>
  18219. Note that there is no explicit separator between text and
  18220. conversion specifiers. The pattern parser knows when it has reached
  18221. the end of a conversion specifier when it reads a conversion
  18222. character. In the example above the conversion specifier
  18223. <b>%-5level</b> means the level of the logging event should be left
  18224. justified to a width of five characters.
  18225. </para>
  18226. <para>
  18227. The recognized conversion pattern names are:
  18228. </para>
  18229. <list type="table">
  18230. <listheader>
  18231. <term>Conversion Pattern Name</term>
  18232. <description>Effect</description>
  18233. </listheader>
  18234. <item>
  18235. <term>a</term>
  18236. <description>Equivalent to <b>appdomain</b></description>
  18237. </item>
  18238. <item>
  18239. <term>appdomain</term>
  18240. <description>
  18241. Used to output the friendly name of the AppDomain where the
  18242. logging event was generated.
  18243. </description>
  18244. </item>
  18245. <item>
  18246. <term>aspnet-cache</term>
  18247. <description>
  18248. <para>
  18249. 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>
  18250. </para>
  18251. <para>
  18252. This pattern is not available for Compact Framework or Client Profile assemblies.
  18253. </para>
  18254. </description>
  18255. </item>
  18256. <item>
  18257. <term>aspnet-context</term>
  18258. <description>
  18259. <para>
  18260. 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>
  18261. </para>
  18262. <para>
  18263. This pattern is not available for Compact Framework or Client Profile assemblies.
  18264. </para>
  18265. </description>
  18266. </item>
  18267. <item>
  18268. <term>aspnet-request</term>
  18269. <description>
  18270. <para>
  18271. 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>
  18272. </para>
  18273. <para>
  18274. This pattern is not available for Compact Framework or Client Profile assemblies.
  18275. </para>
  18276. </description>
  18277. </item>
  18278. <item>
  18279. <term>aspnet-session</term>
  18280. <description>
  18281. <para>
  18282. 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>
  18283. </para>
  18284. <para>
  18285. This pattern is not available for Compact Framework or Client Profile assemblies.
  18286. </para>
  18287. </description>
  18288. </item>
  18289. <item>
  18290. <term>c</term>
  18291. <description>Equivalent to <b>logger</b></description>
  18292. </item>
  18293. <item>
  18294. <term>C</term>
  18295. <description>Equivalent to <b>type</b></description>
  18296. </item>
  18297. <item>
  18298. <term>class</term>
  18299. <description>Equivalent to <b>type</b></description>
  18300. </item>
  18301. <item>
  18302. <term>d</term>
  18303. <description>Equivalent to <b>date</b></description>
  18304. </item>
  18305. <item>
  18306. <term>date</term>
  18307. <description>
  18308. <para>
  18309. Used to output the date of the logging event in the local time zone.
  18310. To output the date in universal time use the <c>%utcdate</c> pattern.
  18311. The date conversion
  18312. specifier may be followed by a <i>date format specifier</i> enclosed
  18313. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  18314. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  18315. given then ISO8601 format is
  18316. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  18317. </para>
  18318. <para>
  18319. The date format specifier admits the same syntax as the
  18320. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  18321. </para>
  18322. <para>
  18323. For better results it is recommended to use the log4net date
  18324. formatters. These can be specified using one of the strings
  18325. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  18326. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  18327. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  18328. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  18329. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  18330. </para>
  18331. <para>
  18332. These dedicated date formatters perform significantly
  18333. better than <see cref="M:DateTime.ToString(string)"/>.
  18334. </para>
  18335. </description>
  18336. </item>
  18337. <item>
  18338. <term>exception</term>
  18339. <description>
  18340. <para>
  18341. Used to output the exception passed in with the log message.
  18342. </para>
  18343. <para>
  18344. If an exception object is stored in the logging event
  18345. it will be rendered into the pattern output with a
  18346. trailing newline.
  18347. If there is no exception then nothing will be output
  18348. and no trailing newline will be appended.
  18349. It is typical to put a newline before the exception
  18350. and to have the exception as the last data in the pattern.
  18351. </para>
  18352. </description>
  18353. </item>
  18354. <item>
  18355. <term>F</term>
  18356. <description>Equivalent to <b>file</b></description>
  18357. </item>
  18358. <item>
  18359. <term>file</term>
  18360. <description>
  18361. <para>
  18362. Used to output the file name where the logging request was
  18363. issued.
  18364. </para>
  18365. <para>
  18366. <b>WARNING</b> Generating caller location information is
  18367. extremely slow. Its use should be avoided unless execution speed
  18368. is not an issue.
  18369. </para>
  18370. <para>
  18371. See the note below on the availability of caller location information.
  18372. </para>
  18373. </description>
  18374. </item>
  18375. <item>
  18376. <term>identity</term>
  18377. <description>
  18378. <para>
  18379. Used to output the user name for the currently active user
  18380. (Principal.Identity.Name).
  18381. </para>
  18382. <para>
  18383. <b>WARNING</b> Generating caller information is
  18384. extremely slow. Its use should be avoided unless execution speed
  18385. is not an issue.
  18386. </para>
  18387. </description>
  18388. </item>
  18389. <item>
  18390. <term>l</term>
  18391. <description>Equivalent to <b>location</b></description>
  18392. </item>
  18393. <item>
  18394. <term>L</term>
  18395. <description>Equivalent to <b>line</b></description>
  18396. </item>
  18397. <item>
  18398. <term>location</term>
  18399. <description>
  18400. <para>
  18401. Used to output location information of the caller which generated
  18402. the logging event.
  18403. </para>
  18404. <para>
  18405. The location information depends on the CLI implementation but
  18406. usually consists of the fully qualified name of the calling
  18407. method followed by the callers source the file name and line
  18408. number between parentheses.
  18409. </para>
  18410. <para>
  18411. The location information can be very useful. However, its
  18412. generation is <b>extremely</b> slow. Its use should be avoided
  18413. unless execution speed is not an issue.
  18414. </para>
  18415. <para>
  18416. See the note below on the availability of caller location information.
  18417. </para>
  18418. </description>
  18419. </item>
  18420. <item>
  18421. <term>level</term>
  18422. <description>
  18423. <para>
  18424. Used to output the level of the logging event.
  18425. </para>
  18426. </description>
  18427. </item>
  18428. <item>
  18429. <term>line</term>
  18430. <description>
  18431. <para>
  18432. Used to output the line number from where the logging request
  18433. was issued.
  18434. </para>
  18435. <para>
  18436. <b>WARNING</b> Generating caller location information is
  18437. extremely slow. Its use should be avoided unless execution speed
  18438. is not an issue.
  18439. </para>
  18440. <para>
  18441. See the note below on the availability of caller location information.
  18442. </para>
  18443. </description>
  18444. </item>
  18445. <item>
  18446. <term>logger</term>
  18447. <description>
  18448. <para>
  18449. Used to output the logger of the logging event. The
  18450. logger conversion specifier can be optionally followed by
  18451. <i>precision specifier</i>, that is a decimal constant in
  18452. brackets.
  18453. </para>
  18454. <para>
  18455. If a precision specifier is given, then only the corresponding
  18456. number of right most components of the logger name will be
  18457. printed. By default the logger name is printed in full.
  18458. </para>
  18459. <para>
  18460. For example, for the logger name "a.b.c" the pattern
  18461. <b>%logger{2}</b> will output "b.c".
  18462. </para>
  18463. </description>
  18464. </item>
  18465. <item>
  18466. <term>m</term>
  18467. <description>Equivalent to <b>message</b></description>
  18468. </item>
  18469. <item>
  18470. <term>M</term>
  18471. <description>Equivalent to <b>method</b></description>
  18472. </item>
  18473. <item>
  18474. <term>message</term>
  18475. <description>
  18476. <para>
  18477. Used to output the application supplied message associated with
  18478. the logging event.
  18479. </para>
  18480. </description>
  18481. </item>
  18482. <item>
  18483. <term>mdc</term>
  18484. <description>
  18485. <para>
  18486. The MDC (old name for the ThreadContext.Properties) is now part of the
  18487. combined event properties. This pattern is supported for compatibility
  18488. but is equivalent to <b>property</b>.
  18489. </para>
  18490. </description>
  18491. </item>
  18492. <item>
  18493. <term>method</term>
  18494. <description>
  18495. <para>
  18496. Used to output the method name where the logging request was
  18497. issued.
  18498. </para>
  18499. <para>
  18500. <b>WARNING</b> Generating caller location information is
  18501. extremely slow. Its use should be avoided unless execution speed
  18502. is not an issue.
  18503. </para>
  18504. <para>
  18505. See the note below on the availability of caller location information.
  18506. </para>
  18507. </description>
  18508. </item>
  18509. <item>
  18510. <term>n</term>
  18511. <description>Equivalent to <b>newline</b></description>
  18512. </item>
  18513. <item>
  18514. <term>newline</term>
  18515. <description>
  18516. <para>
  18517. Outputs the platform dependent line separator character or
  18518. characters.
  18519. </para>
  18520. <para>
  18521. This conversion pattern offers the same performance as using
  18522. non-portable line separator strings such as "\n", or "\r\n".
  18523. Thus, it is the preferred way of specifying a line separator.
  18524. </para>
  18525. </description>
  18526. </item>
  18527. <item>
  18528. <term>ndc</term>
  18529. <description>
  18530. <para>
  18531. Used to output the NDC (nested diagnostic context) associated
  18532. with the thread that generated the logging event.
  18533. </para>
  18534. </description>
  18535. </item>
  18536. <item>
  18537. <term>p</term>
  18538. <description>Equivalent to <b>level</b></description>
  18539. </item>
  18540. <item>
  18541. <term>P</term>
  18542. <description>Equivalent to <b>property</b></description>
  18543. </item>
  18544. <item>
  18545. <term>properties</term>
  18546. <description>Equivalent to <b>property</b></description>
  18547. </item>
  18548. <item>
  18549. <term>property</term>
  18550. <description>
  18551. <para>
  18552. Used to output the an event specific property. The key to
  18553. lookup must be specified within braces and directly following the
  18554. pattern specifier, e.g. <b>%property{user}</b> would include the value
  18555. from the property that is keyed by the string 'user'. Each property value
  18556. that is to be included in the log must be specified separately.
  18557. Properties are added to events by loggers or appenders. By default
  18558. the <c>log4net:HostName</c> property is set to the name of machine on
  18559. which the event was originally logged.
  18560. </para>
  18561. <para>
  18562. If no key is specified, e.g. <b>%property</b> then all the keys and their
  18563. values are printed in a comma separated list.
  18564. </para>
  18565. <para>
  18566. The properties of an event are combined from a number of different
  18567. contexts. These are listed below in the order in which they are searched.
  18568. </para>
  18569. <list type="definition">
  18570. <item>
  18571. <term>the event properties</term>
  18572. <description>
  18573. The event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  18574. properties are specific to this event only.
  18575. </description>
  18576. </item>
  18577. <item>
  18578. <term>the thread properties</term>
  18579. <description>
  18580. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  18581. thread. These properties are shared by all events logged on this thread.
  18582. </description>
  18583. </item>
  18584. <item>
  18585. <term>the global properties</term>
  18586. <description>
  18587. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  18588. properties are shared by all the threads in the AppDomain.
  18589. </description>
  18590. </item>
  18591. </list>
  18592. </description>
  18593. </item>
  18594. <item>
  18595. <term>r</term>
  18596. <description>Equivalent to <b>timestamp</b></description>
  18597. </item>
  18598. <item>
  18599. <term>stacktrace</term>
  18600. <description>
  18601. <para>
  18602. Used to output the stack trace of the logging event
  18603. The stack trace level specifier may be enclosed
  18604. between braces. For example, <b>%stacktrace{level}</b>.
  18605. If no stack trace level specifier is given then 1 is assumed
  18606. </para>
  18607. <para>
  18608. Output uses the format:
  18609. type3.MethodCall3 &gt; type2.MethodCall2 &gt; type1.MethodCall1
  18610. </para>
  18611. <para>
  18612. This pattern is not available for Compact Framework assemblies.
  18613. </para>
  18614. </description>
  18615. </item>
  18616. <item>
  18617. <term>stacktracedetail</term>
  18618. <description>
  18619. <para>
  18620. Used to output the stack trace of the logging event
  18621. The stack trace level specifier may be enclosed
  18622. between braces. For example, <b>%stacktracedetail{level}</b>.
  18623. If no stack trace level specifier is given then 1 is assumed
  18624. </para>
  18625. <para>
  18626. Output uses the format:
  18627. type3.MethodCall3(type param,...) &gt; type2.MethodCall2(type param,...) &gt; type1.MethodCall1(type param,...)
  18628. </para>
  18629. <para>
  18630. This pattern is not available for Compact Framework assemblies.
  18631. </para>
  18632. </description>
  18633. </item>
  18634. <item>
  18635. <term>t</term>
  18636. <description>Equivalent to <b>thread</b></description>
  18637. </item>
  18638. <item>
  18639. <term>timestamp</term>
  18640. <description>
  18641. <para>
  18642. Used to output the number of milliseconds elapsed since the start
  18643. of the application until the creation of the logging event.
  18644. </para>
  18645. </description>
  18646. </item>
  18647. <item>
  18648. <term>thread</term>
  18649. <description>
  18650. <para>
  18651. Used to output the name of the thread that generated the
  18652. logging event. Uses the thread number if no name is available.
  18653. </para>
  18654. </description>
  18655. </item>
  18656. <item>
  18657. <term>type</term>
  18658. <description>
  18659. <para>
  18660. Used to output the fully qualified type name of the caller
  18661. issuing the logging request. This conversion specifier
  18662. can be optionally followed by <i>precision specifier</i>, that
  18663. is a decimal constant in brackets.
  18664. </para>
  18665. <para>
  18666. If a precision specifier is given, then only the corresponding
  18667. number of right most components of the class name will be
  18668. printed. By default the class name is output in fully qualified form.
  18669. </para>
  18670. <para>
  18671. For example, for the class name "log4net.Layout.PatternLayout", the
  18672. pattern <b>%type{1}</b> will output "PatternLayout".
  18673. </para>
  18674. <para>
  18675. <b>WARNING</b> Generating the caller class information is
  18676. slow. Thus, its use should be avoided unless execution speed is
  18677. not an issue.
  18678. </para>
  18679. <para>
  18680. See the note below on the availability of caller location information.
  18681. </para>
  18682. </description>
  18683. </item>
  18684. <item>
  18685. <term>u</term>
  18686. <description>Equivalent to <b>identity</b></description>
  18687. </item>
  18688. <item>
  18689. <term>username</term>
  18690. <description>
  18691. <para>
  18692. Used to output the WindowsIdentity for the currently
  18693. active user.
  18694. </para>
  18695. <para>
  18696. <b>WARNING</b> Generating caller WindowsIdentity information is
  18697. extremely slow. Its use should be avoided unless execution speed
  18698. is not an issue.
  18699. </para>
  18700. </description>
  18701. </item>
  18702. <item>
  18703. <term>utcdate</term>
  18704. <description>
  18705. <para>
  18706. Used to output the date of the logging event in universal time.
  18707. The date conversion
  18708. specifier may be followed by a <i>date format specifier</i> enclosed
  18709. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  18710. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  18711. given then ISO8601 format is
  18712. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  18713. </para>
  18714. <para>
  18715. The date format specifier admits the same syntax as the
  18716. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  18717. </para>
  18718. <para>
  18719. For better results it is recommended to use the log4net date
  18720. formatters. These can be specified using one of the strings
  18721. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  18722. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  18723. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  18724. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  18725. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  18726. </para>
  18727. <para>
  18728. These dedicated date formatters perform significantly
  18729. better than <see cref="M:DateTime.ToString(string)"/>.
  18730. </para>
  18731. </description>
  18732. </item>
  18733. <item>
  18734. <term>w</term>
  18735. <description>Equivalent to <b>username</b></description>
  18736. </item>
  18737. <item>
  18738. <term>x</term>
  18739. <description>Equivalent to <b>ndc</b></description>
  18740. </item>
  18741. <item>
  18742. <term>X</term>
  18743. <description>Equivalent to <b>mdc</b></description>
  18744. </item>
  18745. <item>
  18746. <term>%</term>
  18747. <description>
  18748. <para>
  18749. The sequence %% outputs a single percent sign.
  18750. </para>
  18751. </description>
  18752. </item>
  18753. </list>
  18754. <para>
  18755. The single letter patterns are deprecated in favor of the
  18756. longer more descriptive pattern names.
  18757. </para>
  18758. <para>
  18759. By default the relevant information is output as is. However,
  18760. with the aid of format modifiers it is possible to change the
  18761. minimum field width, the maximum field width and justification.
  18762. </para>
  18763. <para>
  18764. The optional format modifier is placed between the percent sign
  18765. and the conversion pattern name.
  18766. </para>
  18767. <para>
  18768. The first optional format modifier is the <i>left justification
  18769. flag</i> which is just the minus (-) character. Then comes the
  18770. optional <i>minimum field width</i> modifier. This is a decimal
  18771. constant that represents the minimum number of characters to
  18772. output. If the data item requires fewer characters, it is padded on
  18773. either the left or the right until the minimum width is
  18774. reached. The default is to pad on the left (right justify) but you
  18775. can specify right padding with the left justification flag. The
  18776. padding character is space. If the data item is larger than the
  18777. minimum field width, the field is expanded to accommodate the
  18778. data. The value is never truncated.
  18779. </para>
  18780. <para>
  18781. This behavior can be changed using the <i>maximum field
  18782. width</i> modifier which is designated by a period followed by a
  18783. decimal constant. If the data item is longer than the maximum
  18784. field, then the extra characters are removed from the
  18785. <i>beginning</i> of the data item and not from the end. For
  18786. example, it the maximum field width is eight and the data item is
  18787. ten characters long, then the first two characters of the data item
  18788. are dropped. This behavior deviates from the printf function in C
  18789. where truncation is done from the end.
  18790. </para>
  18791. <para>
  18792. Below are various format modifier examples for the logger
  18793. conversion specifier.
  18794. </para>
  18795. <div class="tablediv">
  18796. <table class="dtTABLE" cellspacing="0">
  18797. <tr>
  18798. <th>Format modifier</th>
  18799. <th>left justify</th>
  18800. <th>minimum width</th>
  18801. <th>maximum width</th>
  18802. <th>comment</th>
  18803. </tr>
  18804. <tr>
  18805. <td align="center">%20logger</td>
  18806. <td align="center">false</td>
  18807. <td align="center">20</td>
  18808. <td align="center">none</td>
  18809. <td>
  18810. <para>
  18811. Left pad with spaces if the logger name is less than 20
  18812. characters long.
  18813. </para>
  18814. </td>
  18815. </tr>
  18816. <tr>
  18817. <td align="center">%-20logger</td>
  18818. <td align="center">true</td>
  18819. <td align="center">20</td>
  18820. <td align="center">none</td>
  18821. <td>
  18822. <para>
  18823. Right pad with spaces if the logger
  18824. name is less than 20 characters long.
  18825. </para>
  18826. </td>
  18827. </tr>
  18828. <tr>
  18829. <td align="center">%.30logger</td>
  18830. <td align="center">NA</td>
  18831. <td align="center">none</td>
  18832. <td align="center">30</td>
  18833. <td>
  18834. <para>
  18835. Truncate from the beginning if the logger
  18836. name is longer than 30 characters.
  18837. </para>
  18838. </td>
  18839. </tr>
  18840. <tr>
  18841. <td align="center"><nobr>%20.30logger</nobr></td>
  18842. <td align="center">false</td>
  18843. <td align="center">20</td>
  18844. <td align="center">30</td>
  18845. <td>
  18846. <para>
  18847. Left pad with spaces if the logger name is shorter than 20
  18848. characters. However, if logger name is longer than 30 characters,
  18849. then truncate from the beginning.
  18850. </para>
  18851. </td>
  18852. </tr>
  18853. <tr>
  18854. <td align="center">%-20.30logger</td>
  18855. <td align="center">true</td>
  18856. <td align="center">20</td>
  18857. <td align="center">30</td>
  18858. <td>
  18859. <para>
  18860. Right pad with spaces if the logger name is shorter than 20
  18861. characters. However, if logger name is longer than 30 characters,
  18862. then truncate from the beginning.
  18863. </para>
  18864. </td>
  18865. </tr>
  18866. </table>
  18867. </div>
  18868. <para>
  18869. <b>Note about caller location information.</b><br/>
  18870. The following patterns <c>%type %file %line %method %location %class %C %F %L %l %M</c>
  18871. all generate caller location information.
  18872. Location information uses the <c>System.Diagnostics.StackTrace</c> class to generate
  18873. a call stack. The caller's information is then extracted from this stack.
  18874. </para>
  18875. <note type="caution">
  18876. <para>
  18877. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  18878. .NET Compact Framework 1.0 therefore caller location information is not
  18879. available on that framework.
  18880. </para>
  18881. </note>
  18882. <note type="caution">
  18883. <para>
  18884. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  18885. </para>
  18886. <para>
  18887. "StackTrace information will be most informative with Debug build configurations.
  18888. By default, Debug builds include debug symbols, while Release builds do not. The
  18889. debug symbols contain most of the file, method name, line number, and column
  18890. information used in constructing StackFrame and StackTrace objects. StackTrace
  18891. might not report as many method calls as expected, due to code transformations
  18892. that occur during optimization."
  18893. </para>
  18894. <para>
  18895. This means that in a Release build the caller information may be incomplete or may
  18896. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  18897. </para>
  18898. </note>
  18899. <para>
  18900. Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/>
  18901. instance using the <see cref="M:AddConverter(string, Type)"/> method.
  18902. </para>
  18903. </remarks>
  18904. <example>
  18905. This is a more detailed pattern.
  18906. <code><b>%timestamp [%thread] %level %logger %ndc - %message%newline</b></code>
  18907. </example>
  18908. <example>
  18909. A similar pattern except that the relative time is
  18910. right padded if less than 6 digits, thread name is right padded if
  18911. less than 15 characters and truncated if longer and the logger
  18912. name is left padded if shorter than 30 characters and truncated if
  18913. longer.
  18914. <code><b>%-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline</b></code>
  18915. </example>
  18916. <author>Nicko Cadell</author>
  18917. <author>Gert Driesen</author>
  18918. <author>Douglas de la Torre</author>
  18919. <author>Daniel Cazzulino</author>
  18920. </member>
  18921. <member name="T:log4net.Layout.LayoutSkeleton">
  18922. <summary>
  18923. Extend this abstract class to create your own log layout format.
  18924. </summary>
  18925. <remarks>
  18926. <para>
  18927. This is the base implementation of the <see cref="T:log4net.Layout.ILayout"/>
  18928. interface. Most layout objects should extend this class.
  18929. </para>
  18930. </remarks>
  18931. <remarks>
  18932. <note type="inheritinfo">
  18933. <para>
  18934. Subclasses must implement the <see cref="M:Format(TextWriter,LoggingEvent)"/>
  18935. method.
  18936. </para>
  18937. <para>
  18938. Subclasses should set the <see cref="P:log4net.Layout.LayoutSkeleton.IgnoresException"/> in their default
  18939. constructor.
  18940. </para>
  18941. </note>
  18942. </remarks>
  18943. <author>Nicko Cadell</author>
  18944. <author>Gert Driesen</author>
  18945. </member>
  18946. <member name="T:log4net.Layout.ILayout">
  18947. <summary>
  18948. Interface implemented by layout objects
  18949. </summary>
  18950. <remarks>
  18951. <para>
  18952. An <see cref="T:log4net.Layout.ILayout"/> object is used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  18953. as text. The <see cref="M:Format(TextWriter,LoggingEvent)"/> method is called by an
  18954. appender to transform the <see cref="T:log4net.Core.LoggingEvent"/> into a string.
  18955. </para>
  18956. <para>
  18957. The layout can also supply <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  18958. text that is appender before any events and after all the events respectively.
  18959. </para>
  18960. </remarks>
  18961. <author>Nicko Cadell</author>
  18962. <author>Gert Driesen</author>
  18963. </member>
  18964. <member name="M:log4net.Layout.ILayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18965. <summary>
  18966. Implement this method to create your own layout format.
  18967. </summary>
  18968. <param name="writer">The TextWriter to write the formatted event to</param>
  18969. <param name="loggingEvent">The event to format</param>
  18970. <remarks>
  18971. <para>
  18972. This method is called by an appender to format
  18973. the <paramref name="loggingEvent"/> as text and output to a writer.
  18974. </para>
  18975. <para>
  18976. If the caller does not have a <see cref="T:System.IO.TextWriter"/> and prefers the
  18977. event to be formatted as a <see cref="T:System.String"/> then the following
  18978. code can be used to format the event into a <see cref="T:System.IO.StringWriter"/>.
  18979. </para>
  18980. <code lang="C#">
  18981. StringWriter writer = new StringWriter();
  18982. Layout.Format(writer, loggingEvent);
  18983. string formattedEvent = writer.ToString();
  18984. </code>
  18985. </remarks>
  18986. </member>
  18987. <member name="P:log4net.Layout.ILayout.ContentType">
  18988. <summary>
  18989. The content type output by this layout.
  18990. </summary>
  18991. <value>The content type</value>
  18992. <remarks>
  18993. <para>
  18994. The content type output by this layout.
  18995. </para>
  18996. <para>
  18997. This is a MIME type e.g. <c>"text/plain"</c>.
  18998. </para>
  18999. </remarks>
  19000. </member>
  19001. <member name="P:log4net.Layout.ILayout.Header">
  19002. <summary>
  19003. The header for the layout format.
  19004. </summary>
  19005. <value>the layout header</value>
  19006. <remarks>
  19007. <para>
  19008. The Header text will be appended before any logging events
  19009. are formatted and appended.
  19010. </para>
  19011. </remarks>
  19012. </member>
  19013. <member name="P:log4net.Layout.ILayout.Footer">
  19014. <summary>
  19015. The footer for the layout format.
  19016. </summary>
  19017. <value>the layout footer</value>
  19018. <remarks>
  19019. <para>
  19020. The Footer text will be appended after all the logging events
  19021. have been formatted and appended.
  19022. </para>
  19023. </remarks>
  19024. </member>
  19025. <member name="P:log4net.Layout.ILayout.IgnoresException">
  19026. <summary>
  19027. Flag indicating if this layout handle exceptions
  19028. </summary>
  19029. <value><c>false</c> if this layout handles exceptions</value>
  19030. <remarks>
  19031. <para>
  19032. If this layout handles the exception object contained within
  19033. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  19034. <c>false</c>. Otherwise, if the layout ignores the exception
  19035. object, then the layout should return <c>true</c>.
  19036. </para>
  19037. </remarks>
  19038. </member>
  19039. <member name="F:log4net.Layout.LayoutSkeleton.m_header">
  19040. <summary>
  19041. The header text
  19042. </summary>
  19043. <remarks>
  19044. <para>
  19045. See <see cref="P:log4net.Layout.LayoutSkeleton.Header"/> for more information.
  19046. </para>
  19047. </remarks>
  19048. </member>
  19049. <member name="F:log4net.Layout.LayoutSkeleton.m_footer">
  19050. <summary>
  19051. The footer text
  19052. </summary>
  19053. <remarks>
  19054. <para>
  19055. See <see cref="P:log4net.Layout.LayoutSkeleton.Footer"/> for more information.
  19056. </para>
  19057. </remarks>
  19058. </member>
  19059. <member name="F:log4net.Layout.LayoutSkeleton.m_ignoresException">
  19060. <summary>
  19061. Flag indicating if this layout handles exceptions
  19062. </summary>
  19063. <remarks>
  19064. <para>
  19065. <c>false</c> if this layout handles exceptions
  19066. </para>
  19067. </remarks>
  19068. </member>
  19069. <member name="M:log4net.Layout.LayoutSkeleton.#ctor">
  19070. <summary>
  19071. Empty default constructor
  19072. </summary>
  19073. <remarks>
  19074. <para>
  19075. Empty default constructor
  19076. </para>
  19077. </remarks>
  19078. </member>
  19079. <member name="M:log4net.Layout.LayoutSkeleton.ActivateOptions">
  19080. <summary>
  19081. Activate component options
  19082. </summary>
  19083. <remarks>
  19084. <para>
  19085. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19086. activation scheme. The <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> method must
  19087. be called on this object after the configuration properties have
  19088. been set. Until <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> is called this
  19089. object is in an undefined state and must not be used.
  19090. </para>
  19091. <para>
  19092. If any of the configuration properties are modified then
  19093. <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> must be called again.
  19094. </para>
  19095. <para>
  19096. This method must be implemented by the subclass.
  19097. </para>
  19098. </remarks>
  19099. </member>
  19100. <member name="M:log4net.Layout.LayoutSkeleton.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19101. <summary>
  19102. Implement this method to create your own layout format.
  19103. </summary>
  19104. <param name="writer">The TextWriter to write the formatted event to</param>
  19105. <param name="loggingEvent">The event to format</param>
  19106. <remarks>
  19107. <para>
  19108. This method is called by an appender to format
  19109. the <paramref name="loggingEvent"/> as text.
  19110. </para>
  19111. </remarks>
  19112. </member>
  19113. <member name="M:log4net.Layout.LayoutSkeleton.Format(log4net.Core.LoggingEvent)">
  19114. <summary>
  19115. Convenience method for easily formatting the logging event into a string variable.
  19116. </summary>
  19117. <param name="loggingEvent"></param>
  19118. <remarks>
  19119. Creates a new StringWriter instance to store the formatted logging event.
  19120. </remarks>
  19121. </member>
  19122. <member name="P:log4net.Layout.LayoutSkeleton.ContentType">
  19123. <summary>
  19124. The content type output by this layout.
  19125. </summary>
  19126. <value>The content type is <c>"text/plain"</c></value>
  19127. <remarks>
  19128. <para>
  19129. The content type output by this layout.
  19130. </para>
  19131. <para>
  19132. This base class uses the value <c>"text/plain"</c>.
  19133. To change this value a subclass must override this
  19134. property.
  19135. </para>
  19136. </remarks>
  19137. </member>
  19138. <member name="P:log4net.Layout.LayoutSkeleton.Header">
  19139. <summary>
  19140. The header for the layout format.
  19141. </summary>
  19142. <value>the layout header</value>
  19143. <remarks>
  19144. <para>
  19145. The Header text will be appended before any logging events
  19146. are formatted and appended.
  19147. </para>
  19148. </remarks>
  19149. </member>
  19150. <member name="P:log4net.Layout.LayoutSkeleton.Footer">
  19151. <summary>
  19152. The footer for the layout format.
  19153. </summary>
  19154. <value>the layout footer</value>
  19155. <remarks>
  19156. <para>
  19157. The Footer text will be appended after all the logging events
  19158. have been formatted and appended.
  19159. </para>
  19160. </remarks>
  19161. </member>
  19162. <member name="P:log4net.Layout.LayoutSkeleton.IgnoresException">
  19163. <summary>
  19164. Flag indicating if this layout handles exceptions
  19165. </summary>
  19166. <value><c>false</c> if this layout handles exceptions</value>
  19167. <remarks>
  19168. <para>
  19169. If this layout handles the exception object contained within
  19170. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  19171. <c>false</c>. Otherwise, if the layout ignores the exception
  19172. object, then the layout should return <c>true</c>.
  19173. </para>
  19174. <para>
  19175. Set this value to override a this default setting. The default
  19176. value is <c>true</c>, this layout does not handle the exception.
  19177. </para>
  19178. </remarks>
  19179. </member>
  19180. <member name="F:log4net.Layout.PatternLayout.DefaultConversionPattern">
  19181. <summary>
  19182. Default pattern string for log output.
  19183. </summary>
  19184. <remarks>
  19185. <para>
  19186. Default pattern string for log output.
  19187. Currently set to the string <b>"%message%newline"</b>
  19188. which just prints the application supplied message.
  19189. </para>
  19190. </remarks>
  19191. </member>
  19192. <member name="F:log4net.Layout.PatternLayout.DetailConversionPattern">
  19193. <summary>
  19194. A detailed conversion pattern
  19195. </summary>
  19196. <remarks>
  19197. <para>
  19198. A conversion pattern which includes Time, Thread, Logger, and Nested Context.
  19199. Current value is <b>%timestamp [%thread] %level %logger %ndc - %message%newline</b>.
  19200. </para>
  19201. </remarks>
  19202. </member>
  19203. <member name="F:log4net.Layout.PatternLayout.s_globalRulesRegistry">
  19204. <summary>
  19205. Internal map of converter identifiers to converter types.
  19206. </summary>
  19207. <remarks>
  19208. <para>
  19209. This static map is overridden by the m_converterRegistry instance map
  19210. </para>
  19211. </remarks>
  19212. </member>
  19213. <member name="F:log4net.Layout.PatternLayout.m_pattern">
  19214. <summary>
  19215. the pattern
  19216. </summary>
  19217. </member>
  19218. <member name="F:log4net.Layout.PatternLayout.m_head">
  19219. <summary>
  19220. the head of the pattern converter chain
  19221. </summary>
  19222. </member>
  19223. <member name="F:log4net.Layout.PatternLayout.m_instanceRulesRegistry">
  19224. <summary>
  19225. patterns defined on this PatternLayout only
  19226. </summary>
  19227. </member>
  19228. <member name="M:log4net.Layout.PatternLayout.#cctor">
  19229. <summary>
  19230. Initialize the global registry
  19231. </summary>
  19232. <remarks>
  19233. <para>
  19234. Defines the builtin global rules.
  19235. </para>
  19236. </remarks>
  19237. </member>
  19238. <member name="M:log4net.Layout.PatternLayout.#ctor">
  19239. <summary>
  19240. Constructs a PatternLayout using the DefaultConversionPattern
  19241. </summary>
  19242. <remarks>
  19243. <para>
  19244. The default pattern just produces the application supplied message.
  19245. </para>
  19246. <para>
  19247. Note to Inheritors: This constructor calls the virtual method
  19248. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  19249. aware that it will be called before your is called constructor.
  19250. </para>
  19251. <para>
  19252. As per the <see cref="T:log4net.Core.IOptionHandler"/> contract the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>
  19253. method must be called after the properties on this object have been
  19254. configured.
  19255. </para>
  19256. </remarks>
  19257. </member>
  19258. <member name="M:log4net.Layout.PatternLayout.#ctor(System.String)">
  19259. <summary>
  19260. Constructs a PatternLayout using the supplied conversion pattern
  19261. </summary>
  19262. <param name="pattern">the pattern to use</param>
  19263. <remarks>
  19264. <para>
  19265. Note to Inheritors: This constructor calls the virtual method
  19266. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  19267. aware that it will be called before your is called constructor.
  19268. </para>
  19269. <para>
  19270. When using this constructor the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method
  19271. need not be called. This may not be the case when using a subclass.
  19272. </para>
  19273. </remarks>
  19274. </member>
  19275. <member name="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)">
  19276. <summary>
  19277. Create the pattern parser instance
  19278. </summary>
  19279. <param name="pattern">the pattern to parse</param>
  19280. <returns>The <see cref="T:log4net.Util.PatternParser"/> that will format the event</returns>
  19281. <remarks>
  19282. <para>
  19283. Creates the <see cref="T:log4net.Util.PatternParser"/> used to parse the conversion string. Sets the
  19284. global and instance rules on the <see cref="T:log4net.Util.PatternParser"/>.
  19285. </para>
  19286. </remarks>
  19287. </member>
  19288. <member name="M:log4net.Layout.PatternLayout.ActivateOptions">
  19289. <summary>
  19290. Initialize layout options
  19291. </summary>
  19292. <remarks>
  19293. <para>
  19294. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19295. activation scheme. The <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method must
  19296. be called on this object after the configuration properties have
  19297. been set. Until <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> is called this
  19298. object is in an undefined state and must not be used.
  19299. </para>
  19300. <para>
  19301. If any of the configuration properties are modified then
  19302. <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> must be called again.
  19303. </para>
  19304. </remarks>
  19305. </member>
  19306. <member name="M:log4net.Layout.PatternLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19307. <summary>
  19308. Produces a formatted string as specified by the conversion pattern.
  19309. </summary>
  19310. <param name="loggingEvent">the event being logged</param>
  19311. <param name="writer">The TextWriter to write the formatted event to</param>
  19312. <remarks>
  19313. <para>
  19314. Parse the <see cref="T:log4net.Core.LoggingEvent"/> using the patter format
  19315. specified in the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> property.
  19316. </para>
  19317. </remarks>
  19318. </member>
  19319. <member name="M:log4net.Layout.PatternLayout.AddConverter(log4net.Util.ConverterInfo)">
  19320. <summary>
  19321. Add a converter to this PatternLayout
  19322. </summary>
  19323. <param name="converterInfo">the converter info</param>
  19324. <remarks>
  19325. <para>
  19326. This version of the method is used by the configurator.
  19327. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  19328. </para>
  19329. </remarks>
  19330. </member>
  19331. <member name="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)">
  19332. <summary>
  19333. Add a converter to this PatternLayout
  19334. </summary>
  19335. <param name="name">the name of the conversion pattern for this converter</param>
  19336. <param name="type">the type of the converter</param>
  19337. <remarks>
  19338. <para>
  19339. Add a named pattern converter to this instance. This
  19340. converter will be used in the formatting of the event.
  19341. This method must be called before <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>.
  19342. </para>
  19343. <para>
  19344. The <paramref name="type"/> specified must extend the
  19345. <see cref="T:log4net.Util.PatternConverter"/> type.
  19346. </para>
  19347. </remarks>
  19348. </member>
  19349. <member name="P:log4net.Layout.PatternLayout.ConversionPattern">
  19350. <summary>
  19351. The pattern formatting string
  19352. </summary>
  19353. <remarks>
  19354. <para>
  19355. The <b>ConversionPattern</b> option. This is the string which
  19356. controls formatting and consists of a mix of literal content and
  19357. conversion specifiers.
  19358. </para>
  19359. </remarks>
  19360. </member>
  19361. <member name="F:log4net.Layout.DynamicPatternLayout.m_headerPatternString">
  19362. <summary>
  19363. The header PatternString
  19364. </summary>
  19365. </member>
  19366. <member name="F:log4net.Layout.DynamicPatternLayout.m_footerPatternString">
  19367. <summary>
  19368. The footer PatternString
  19369. </summary>
  19370. </member>
  19371. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor">
  19372. <summary>
  19373. Constructs a DynamicPatternLayout using the DefaultConversionPattern
  19374. </summary>
  19375. <remarks>
  19376. <para>
  19377. The default pattern just produces the application supplied message.
  19378. </para>
  19379. </remarks>
  19380. </member>
  19381. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor(System.String)">
  19382. <summary>
  19383. Constructs a DynamicPatternLayout using the supplied conversion pattern
  19384. </summary>
  19385. <param name="pattern">the pattern to use</param>
  19386. <remarks>
  19387. </remarks>
  19388. </member>
  19389. <member name="P:log4net.Layout.DynamicPatternLayout.Header">
  19390. <summary>
  19391. The header for the layout format.
  19392. </summary>
  19393. <value>the layout header</value>
  19394. <remarks>
  19395. <para>
  19396. The Header text will be appended before any logging events
  19397. are formatted and appended.
  19398. </para>
  19399. The pattern will be formatted on each get operation.
  19400. </remarks>
  19401. </member>
  19402. <member name="P:log4net.Layout.DynamicPatternLayout.Footer">
  19403. <summary>
  19404. The footer for the layout format.
  19405. </summary>
  19406. <value>the layout footer</value>
  19407. <remarks>
  19408. <para>
  19409. The Footer text will be appended after all the logging events
  19410. have been formatted and appended.
  19411. </para>
  19412. The pattern will be formatted on each get operation.
  19413. </remarks>
  19414. </member>
  19415. <member name="T:log4net.Layout.ExceptionLayout">
  19416. <summary>
  19417. A Layout that renders only the Exception text from the logging event
  19418. </summary>
  19419. <remarks>
  19420. <para>
  19421. A Layout that renders only the Exception text from the logging event.
  19422. </para>
  19423. <para>
  19424. This Layout should only be used with appenders that utilize multiple
  19425. layouts (e.g. <see cref="T:log4net.Appender.AdoNetAppender"/>).
  19426. </para>
  19427. </remarks>
  19428. <author>Nicko Cadell</author>
  19429. <author>Gert Driesen</author>
  19430. </member>
  19431. <member name="M:log4net.Layout.ExceptionLayout.#ctor">
  19432. <summary>
  19433. Default constructor
  19434. </summary>
  19435. <remarks>
  19436. <para>
  19437. Constructs a ExceptionLayout
  19438. </para>
  19439. </remarks>
  19440. </member>
  19441. <member name="M:log4net.Layout.ExceptionLayout.ActivateOptions">
  19442. <summary>
  19443. Activate component options
  19444. </summary>
  19445. <remarks>
  19446. <para>
  19447. Part of the <see cref="T:log4net.Core.IOptionHandler"/> component activation
  19448. framework.
  19449. </para>
  19450. <para>
  19451. This method does nothing as options become effective immediately.
  19452. </para>
  19453. </remarks>
  19454. </member>
  19455. <member name="M:log4net.Layout.ExceptionLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19456. <summary>
  19457. Gets the exception text from the logging event
  19458. </summary>
  19459. <param name="writer">The TextWriter to write the formatted event to</param>
  19460. <param name="loggingEvent">the event being logged</param>
  19461. <remarks>
  19462. <para>
  19463. Write the exception string to the <see cref="T:System.IO.TextWriter"/>.
  19464. The exception string is retrieved from <see cref="M:LoggingEvent.GetExceptionString()"/>.
  19465. </para>
  19466. </remarks>
  19467. </member>
  19468. <member name="T:log4net.Layout.IRawLayout">
  19469. <summary>
  19470. Interface for raw layout objects
  19471. </summary>
  19472. <remarks>
  19473. <para>
  19474. Interface used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  19475. to an object.
  19476. </para>
  19477. <para>
  19478. This interface should not be confused with the
  19479. <see cref="T:log4net.Layout.ILayout"/> interface. This interface is used in
  19480. only certain specialized situations where a raw object is
  19481. required rather than a formatted string. The <see cref="T:log4net.Layout.ILayout"/>
  19482. is not generally useful than this interface.
  19483. </para>
  19484. </remarks>
  19485. <author>Nicko Cadell</author>
  19486. <author>Gert Driesen</author>
  19487. </member>
  19488. <member name="M:log4net.Layout.IRawLayout.Format(log4net.Core.LoggingEvent)">
  19489. <summary>
  19490. Implement this method to create your own layout format.
  19491. </summary>
  19492. <param name="loggingEvent">The event to format</param>
  19493. <returns>returns the formatted event</returns>
  19494. <remarks>
  19495. <para>
  19496. Implement this method to create your own layout format.
  19497. </para>
  19498. </remarks>
  19499. </member>
  19500. <member name="T:log4net.Layout.Layout2RawLayoutAdapter">
  19501. <summary>
  19502. Adapts any <see cref="T:log4net.Layout.ILayout"/> to a <see cref="T:log4net.Layout.IRawLayout"/>
  19503. </summary>
  19504. <remarks>
  19505. <para>
  19506. Where an <see cref="T:log4net.Layout.IRawLayout"/> is required this adapter
  19507. allows a <see cref="T:log4net.Layout.ILayout"/> to be specified.
  19508. </para>
  19509. </remarks>
  19510. <author>Nicko Cadell</author>
  19511. <author>Gert Driesen</author>
  19512. </member>
  19513. <member name="F:log4net.Layout.Layout2RawLayoutAdapter.m_layout">
  19514. <summary>
  19515. The layout to adapt
  19516. </summary>
  19517. </member>
  19518. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.#ctor(log4net.Layout.ILayout)">
  19519. <summary>
  19520. Construct a new adapter
  19521. </summary>
  19522. <param name="layout">the layout to adapt</param>
  19523. <remarks>
  19524. <para>
  19525. Create the adapter for the specified <paramref name="layout"/>.
  19526. </para>
  19527. </remarks>
  19528. </member>
  19529. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.Format(log4net.Core.LoggingEvent)">
  19530. <summary>
  19531. Format the logging event as an object.
  19532. </summary>
  19533. <param name="loggingEvent">The event to format</param>
  19534. <returns>returns the formatted event</returns>
  19535. <remarks>
  19536. <para>
  19537. Format the logging event as an object.
  19538. </para>
  19539. <para>
  19540. Uses the <see cref="T:log4net.Layout.ILayout"/> object supplied to
  19541. the constructor to perform the formatting.
  19542. </para>
  19543. </remarks>
  19544. </member>
  19545. <member name="T:log4net.Layout.RawLayoutConverter">
  19546. <summary>
  19547. Type converter for the <see cref="T:log4net.Layout.IRawLayout"/> interface
  19548. </summary>
  19549. <remarks>
  19550. <para>
  19551. Used to convert objects to the <see cref="T:log4net.Layout.IRawLayout"/> interface.
  19552. Supports converting from the <see cref="T:log4net.Layout.ILayout"/> interface to
  19553. the <see cref="T:log4net.Layout.IRawLayout"/> interface using the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>.
  19554. </para>
  19555. </remarks>
  19556. <author>Nicko Cadell</author>
  19557. <author>Gert Driesen</author>
  19558. </member>
  19559. <member name="T:log4net.Util.TypeConverters.IConvertFrom">
  19560. <summary>
  19561. Interface supported by type converters
  19562. </summary>
  19563. <remarks>
  19564. <para>
  19565. This interface supports conversion from arbitrary types
  19566. to a single target type. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  19567. </para>
  19568. </remarks>
  19569. <author>Nicko Cadell</author>
  19570. <author>Gert Driesen</author>
  19571. </member>
  19572. <member name="M:log4net.Util.TypeConverters.IConvertFrom.CanConvertFrom(System.Type)">
  19573. <summary>
  19574. Can the source type be converted to the type supported by this object
  19575. </summary>
  19576. <param name="sourceType">the type to convert</param>
  19577. <returns>true if the conversion is possible</returns>
  19578. <remarks>
  19579. <para>
  19580. Test if the <paramref name="sourceType"/> can be converted to the
  19581. type supported by this converter.
  19582. </para>
  19583. </remarks>
  19584. </member>
  19585. <member name="M:log4net.Util.TypeConverters.IConvertFrom.ConvertFrom(System.Object)">
  19586. <summary>
  19587. Convert the source object to the type supported by this object
  19588. </summary>
  19589. <param name="source">the object to convert</param>
  19590. <returns>the converted object</returns>
  19591. <remarks>
  19592. <para>
  19593. Converts the <paramref name="source"/> to the type supported
  19594. by this converter.
  19595. </para>
  19596. </remarks>
  19597. </member>
  19598. <member name="M:log4net.Layout.RawLayoutConverter.CanConvertFrom(System.Type)">
  19599. <summary>
  19600. Can the sourceType be converted to an <see cref="T:log4net.Layout.IRawLayout"/>
  19601. </summary>
  19602. <param name="sourceType">the source to be to be converted</param>
  19603. <returns><c>true</c> if the source type can be converted to <see cref="T:log4net.Layout.IRawLayout"/></returns>
  19604. <remarks>
  19605. <para>
  19606. Test if the <paramref name="sourceType"/> can be converted to a
  19607. <see cref="T:log4net.Layout.IRawLayout"/>. Only <see cref="T:log4net.Layout.ILayout"/> is supported
  19608. as the <paramref name="sourceType"/>.
  19609. </para>
  19610. </remarks>
  19611. </member>
  19612. <member name="M:log4net.Layout.RawLayoutConverter.ConvertFrom(System.Object)">
  19613. <summary>
  19614. Convert the value to a <see cref="T:log4net.Layout.IRawLayout"/> object
  19615. </summary>
  19616. <param name="source">the value to convert</param>
  19617. <returns>the <see cref="T:log4net.Layout.IRawLayout"/> object</returns>
  19618. <remarks>
  19619. <para>
  19620. Convert the <paramref name="source"/> object to a
  19621. <see cref="T:log4net.Layout.IRawLayout"/> object. If the <paramref name="source"/> object
  19622. is a <see cref="T:log4net.Layout.ILayout"/> then the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>
  19623. is used to adapt between the two interfaces, otherwise an
  19624. exception is thrown.
  19625. </para>
  19626. </remarks>
  19627. </member>
  19628. <member name="T:log4net.Layout.RawPropertyLayout">
  19629. <summary>
  19630. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  19631. </summary>
  19632. <remarks>
  19633. <para>
  19634. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  19635. </para>
  19636. </remarks>
  19637. <author>Nicko Cadell</author>
  19638. </member>
  19639. <member name="M:log4net.Layout.RawPropertyLayout.#ctor">
  19640. <summary>
  19641. Constructs a RawPropertyLayout
  19642. </summary>
  19643. </member>
  19644. <member name="M:log4net.Layout.RawPropertyLayout.Format(log4net.Core.LoggingEvent)">
  19645. <summary>
  19646. Lookup the property for <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>
  19647. </summary>
  19648. <param name="loggingEvent">The event to format</param>
  19649. <returns>returns property value</returns>
  19650. <remarks>
  19651. <para>
  19652. Looks up and returns the object value of the property
  19653. named <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>. If there is no property defined
  19654. with than name then <c>null</c> will be returned.
  19655. </para>
  19656. </remarks>
  19657. </member>
  19658. <member name="P:log4net.Layout.RawPropertyLayout.Key">
  19659. <summary>
  19660. The name of the value to lookup in the LoggingEvent Properties collection.
  19661. </summary>
  19662. <value>
  19663. Value to lookup in the LoggingEvent Properties collection
  19664. </value>
  19665. <remarks>
  19666. <para>
  19667. String name of the property to lookup in the <see cref="T:log4net.Core.LoggingEvent"/>.
  19668. </para>
  19669. </remarks>
  19670. </member>
  19671. <member name="T:log4net.Layout.RawTimeStampLayout">
  19672. <summary>
  19673. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19674. </summary>
  19675. <remarks>
  19676. <para>
  19677. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19678. </para>
  19679. </remarks>
  19680. <author>Nicko Cadell</author>
  19681. <author>Gert Driesen</author>
  19682. </member>
  19683. <member name="M:log4net.Layout.RawTimeStampLayout.#ctor">
  19684. <summary>
  19685. Constructs a RawTimeStampLayout
  19686. </summary>
  19687. </member>
  19688. <member name="M:log4net.Layout.RawTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  19689. <summary>
  19690. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19691. </summary>
  19692. <param name="loggingEvent">The event to format</param>
  19693. <returns>returns the time stamp</returns>
  19694. <remarks>
  19695. <para>
  19696. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19697. </para>
  19698. <para>
  19699. The time stamp is in local time. To format the time stamp
  19700. in universal time use <see cref="T:log4net.Layout.RawUtcTimeStampLayout"/>.
  19701. </para>
  19702. </remarks>
  19703. </member>
  19704. <member name="T:log4net.Layout.RawUtcTimeStampLayout">
  19705. <summary>
  19706. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19707. </summary>
  19708. <remarks>
  19709. <para>
  19710. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19711. </para>
  19712. </remarks>
  19713. <author>Nicko Cadell</author>
  19714. <author>Gert Driesen</author>
  19715. </member>
  19716. <member name="M:log4net.Layout.RawUtcTimeStampLayout.#ctor">
  19717. <summary>
  19718. Constructs a RawUtcTimeStampLayout
  19719. </summary>
  19720. </member>
  19721. <member name="M:log4net.Layout.RawUtcTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  19722. <summary>
  19723. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19724. </summary>
  19725. <param name="loggingEvent">The event to format</param>
  19726. <returns>returns the time stamp</returns>
  19727. <remarks>
  19728. <para>
  19729. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19730. </para>
  19731. <para>
  19732. The time stamp is in universal time. To format the time stamp
  19733. in local time use <see cref="T:log4net.Layout.RawTimeStampLayout"/>.
  19734. </para>
  19735. </remarks>
  19736. </member>
  19737. <member name="T:log4net.Layout.SimpleLayout">
  19738. <summary>
  19739. A very simple layout
  19740. </summary>
  19741. <remarks>
  19742. <para>
  19743. SimpleLayout consists of the level of the log statement,
  19744. followed by " - " and then the log message itself. For example,
  19745. <code>
  19746. DEBUG - Hello world
  19747. </code>
  19748. </para>
  19749. </remarks>
  19750. <author>Nicko Cadell</author>
  19751. <author>Gert Driesen</author>
  19752. </member>
  19753. <member name="M:log4net.Layout.SimpleLayout.#ctor">
  19754. <summary>
  19755. Constructs a SimpleLayout
  19756. </summary>
  19757. </member>
  19758. <member name="M:log4net.Layout.SimpleLayout.ActivateOptions">
  19759. <summary>
  19760. Initialize layout options
  19761. </summary>
  19762. <remarks>
  19763. <para>
  19764. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19765. activation scheme. The <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> method must
  19766. be called on this object after the configuration properties have
  19767. been set. Until <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> is called this
  19768. object is in an undefined state and must not be used.
  19769. </para>
  19770. <para>
  19771. If any of the configuration properties are modified then
  19772. <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> must be called again.
  19773. </para>
  19774. </remarks>
  19775. </member>
  19776. <member name="M:log4net.Layout.SimpleLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19777. <summary>
  19778. Produces a simple formatted output.
  19779. </summary>
  19780. <param name="loggingEvent">the event being logged</param>
  19781. <param name="writer">The TextWriter to write the formatted event to</param>
  19782. <remarks>
  19783. <para>
  19784. Formats the event as the level of the even,
  19785. followed by " - " and then the log message itself. The
  19786. output is terminated by a newline.
  19787. </para>
  19788. </remarks>
  19789. </member>
  19790. <member name="T:log4net.Layout.XmlLayout">
  19791. <summary>
  19792. Layout that formats the log events as XML elements.
  19793. </summary>
  19794. <remarks>
  19795. <para>
  19796. The output of the <see cref="T:log4net.Layout.XmlLayout"/> consists of a series of
  19797. log4net:event elements. It does not output a complete well-formed XML
  19798. file. The output is designed to be included as an <em>external entity</em>
  19799. in a separate file to form a correct XML file.
  19800. </para>
  19801. <para>
  19802. For example, if <c>abc</c> is the name of the file where
  19803. the <see cref="T:log4net.Layout.XmlLayout"/> output goes, then a well-formed XML file would
  19804. be:
  19805. </para>
  19806. <code lang="XML">
  19807. &lt;?xml version="1.0" ?&gt;
  19808. &lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
  19809. &lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
  19810. &amp;data;
  19811. &lt;/log4net:events&gt;
  19812. </code>
  19813. <para>
  19814. This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout"/>
  19815. and the appender where it is embedded.
  19816. </para>
  19817. <para>
  19818. The <c>version</c> attribute helps components to correctly
  19819. interpret output generated by <see cref="T:log4net.Layout.XmlLayout"/>. The value of
  19820. this attribute should be "1.2" for release 1.2 and later.
  19821. </para>
  19822. <para>
  19823. Alternatively the <c>Header</c> and <c>Footer</c> properties can be
  19824. configured to output the correct XML header, open tag and close tag.
  19825. When setting the <c>Header</c> and <c>Footer</c> properties it is essential
  19826. that the underlying data store not be appendable otherwise the data
  19827. will become invalid XML.
  19828. </para>
  19829. </remarks>
  19830. <author>Nicko Cadell</author>
  19831. <author>Gert Driesen</author>
  19832. </member>
  19833. <member name="T:log4net.Layout.XmlLayoutBase">
  19834. <summary>
  19835. Layout that formats the log events as XML elements.
  19836. </summary>
  19837. <remarks>
  19838. <para>
  19839. This is an abstract class that must be subclassed by an implementation
  19840. to conform to a specific schema.
  19841. </para>
  19842. <para>
  19843. Deriving classes must implement the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method.
  19844. </para>
  19845. </remarks>
  19846. <author>Nicko Cadell</author>
  19847. <author>Gert Driesen</author>
  19848. </member>
  19849. <member name="M:log4net.Layout.XmlLayoutBase.#ctor">
  19850. <summary>
  19851. Protected constructor to support subclasses
  19852. </summary>
  19853. <remarks>
  19854. <para>
  19855. Initializes a new instance of the <see cref="T:log4net.Layout.XmlLayoutBase"/> class
  19856. with no location info.
  19857. </para>
  19858. </remarks>
  19859. </member>
  19860. <member name="M:log4net.Layout.XmlLayoutBase.#ctor(System.Boolean)">
  19861. <summary>
  19862. Protected constructor to support subclasses
  19863. </summary>
  19864. <remarks>
  19865. <para>
  19866. The <paramref name="locationInfo" /> parameter determines whether
  19867. location information will be output by the layout. If
  19868. <paramref name="locationInfo" /> is set to <c>true</c>, then the
  19869. file name and line number of the statement at the origin of the log
  19870. statement will be output.
  19871. </para>
  19872. <para>
  19873. If you are embedding this layout within an SMTPAppender
  19874. then make sure to set the <b>LocationInfo</b> option of that
  19875. appender as well.
  19876. </para>
  19877. </remarks>
  19878. </member>
  19879. <member name="M:log4net.Layout.XmlLayoutBase.ActivateOptions">
  19880. <summary>
  19881. Initialize layout options
  19882. </summary>
  19883. <remarks>
  19884. <para>
  19885. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19886. activation scheme. The <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> method must
  19887. be called on this object after the configuration properties have
  19888. been set. Until <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> is called this
  19889. object is in an undefined state and must not be used.
  19890. </para>
  19891. <para>
  19892. If any of the configuration properties are modified then
  19893. <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> must be called again.
  19894. </para>
  19895. </remarks>
  19896. </member>
  19897. <member name="M:log4net.Layout.XmlLayoutBase.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19898. <summary>
  19899. Produces a formatted string.
  19900. </summary>
  19901. <param name="loggingEvent">The event being logged.</param>
  19902. <param name="writer">The TextWriter to write the formatted event to</param>
  19903. <remarks>
  19904. <para>
  19905. Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>.
  19906. </para>
  19907. <para>
  19908. This method creates an <see cref="T:System.Xml.XmlTextWriter"/> that writes to the
  19909. <paramref name="writer"/>. The <see cref="T:System.Xml.XmlTextWriter"/> is passed
  19910. to the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the
  19911. <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method.
  19912. </para>
  19913. </remarks>
  19914. </member>
  19915. <member name="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  19916. <summary>
  19917. Does the actual writing of the XML.
  19918. </summary>
  19919. <param name="writer">The writer to use to output the event to.</param>
  19920. <param name="loggingEvent">The event to write.</param>
  19921. <remarks>
  19922. <para>
  19923. Subclasses should override this method to format
  19924. the <see cref="T:log4net.Core.LoggingEvent"/> as XML.
  19925. </para>
  19926. </remarks>
  19927. </member>
  19928. <member name="F:log4net.Layout.XmlLayoutBase.m_locationInfo">
  19929. <summary>
  19930. Flag to indicate if location information should be included in
  19931. the XML events.
  19932. </summary>
  19933. </member>
  19934. <member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement">
  19935. <summary>
  19936. The string to replace invalid chars with
  19937. </summary>
  19938. </member>
  19939. <member name="P:log4net.Layout.XmlLayoutBase.LocationInfo">
  19940. <summary>
  19941. Gets a value indicating whether to include location information in
  19942. the XML events.
  19943. </summary>
  19944. <value>
  19945. <c>true</c> if location information should be included in the XML
  19946. events; otherwise, <c>false</c>.
  19947. </value>
  19948. <remarks>
  19949. <para>
  19950. If <see cref="P:log4net.Layout.XmlLayoutBase.LocationInfo"/> is set to <c>true</c>, then the file
  19951. name and line number of the statement at the origin of the log
  19952. statement will be output.
  19953. </para>
  19954. <para>
  19955. If you are embedding this layout within an <c>SMTPAppender</c>
  19956. then make sure to set the <b>LocationInfo</b> option of that
  19957. appender as well.
  19958. </para>
  19959. </remarks>
  19960. </member>
  19961. <member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement">
  19962. <summary>
  19963. The string to replace characters that can not be expressed in XML with.
  19964. <remarks>
  19965. <para>
  19966. Not all characters may be expressed in XML. This property contains the
  19967. string to replace those that can not with. This defaults to a ?. Set it
  19968. to the empty string to simply remove offending characters. For more
  19969. details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
  19970. Character replacement will occur in the log message, the property names
  19971. and the property values.
  19972. </para>
  19973. </remarks>
  19974. </summary>
  19975. </member>
  19976. <member name="P:log4net.Layout.XmlLayoutBase.ContentType">
  19977. <summary>
  19978. Gets the content type output by this layout.
  19979. </summary>
  19980. <value>
  19981. As this is the XML layout, the value is always <c>"text/xml"</c>.
  19982. </value>
  19983. <remarks>
  19984. <para>
  19985. As this is the XML layout, the value is always <c>"text/xml"</c>.
  19986. </para>
  19987. </remarks>
  19988. </member>
  19989. <member name="M:log4net.Layout.XmlLayout.#ctor">
  19990. <summary>
  19991. Constructs an XmlLayout
  19992. </summary>
  19993. </member>
  19994. <member name="M:log4net.Layout.XmlLayout.#ctor(System.Boolean)">
  19995. <summary>
  19996. Constructs an XmlLayout.
  19997. </summary>
  19998. <remarks>
  19999. <para>
  20000. The <b>LocationInfo</b> option takes a boolean value. By
  20001. default, it is set to false which means there will be no location
  20002. information output by this layout. If the the option is set to
  20003. true, then the file name and line number of the statement
  20004. at the origin of the log statement will be output.
  20005. </para>
  20006. <para>
  20007. If you are embedding this layout within an SmtpAppender
  20008. then make sure to set the <b>LocationInfo</b> option of that
  20009. appender as well.
  20010. </para>
  20011. </remarks>
  20012. </member>
  20013. <member name="M:log4net.Layout.XmlLayout.ActivateOptions">
  20014. <summary>
  20015. Initialize layout options
  20016. </summary>
  20017. <remarks>
  20018. <para>
  20019. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  20020. activation scheme. The <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> method must
  20021. be called on this object after the configuration properties have
  20022. been set. Until <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> is called this
  20023. object is in an undefined state and must not be used.
  20024. </para>
  20025. <para>
  20026. If any of the configuration properties are modified then
  20027. <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> must be called again.
  20028. </para>
  20029. <para>
  20030. Builds a cache of the element names
  20031. </para>
  20032. </remarks>
  20033. </member>
  20034. <member name="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  20035. <summary>
  20036. Does the actual writing of the XML.
  20037. </summary>
  20038. <param name="writer">The writer to use to output the event to.</param>
  20039. <param name="loggingEvent">The event to write.</param>
  20040. <remarks>
  20041. <para>
  20042. Override the base class <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method
  20043. to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>.
  20044. </para>
  20045. </remarks>
  20046. </member>
  20047. <member name="F:log4net.Layout.XmlLayout.m_prefix">
  20048. <summary>
  20049. The prefix to use for all generated element names
  20050. </summary>
  20051. </member>
  20052. <member name="P:log4net.Layout.XmlLayout.Prefix">
  20053. <summary>
  20054. The prefix to use for all element names
  20055. </summary>
  20056. <remarks>
  20057. <para>
  20058. The default prefix is <b>log4net</b>. Set this property
  20059. to change the prefix. If the prefix is set to an empty string
  20060. then no prefix will be written.
  20061. </para>
  20062. </remarks>
  20063. </member>
  20064. <member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage">
  20065. <summary>
  20066. Set whether or not to base64 encode the message.
  20067. </summary>
  20068. <remarks>
  20069. <para>
  20070. By default the log message will be written as text to the xml
  20071. output. This can cause problems when the message contains binary
  20072. data. By setting this to true the contents of the message will be
  20073. base64 encoded. If this is set then invalid character replacement
  20074. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  20075. on the log message.
  20076. </para>
  20077. </remarks>
  20078. </member>
  20079. <member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties">
  20080. <summary>
  20081. Set whether or not to base64 encode the property values.
  20082. </summary>
  20083. <remarks>
  20084. <para>
  20085. By default the properties will be written as text to the xml
  20086. output. This can cause problems when one or more properties contain
  20087. binary data. By setting this to true the values of the properties
  20088. will be base64 encoded. If this is set then invalid character replacement
  20089. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  20090. on the property values.
  20091. </para>
  20092. </remarks>
  20093. </member>
  20094. <member name="T:log4net.Layout.XmlLayoutSchemaLog4j">
  20095. <summary>
  20096. Layout that formats the log events as XML elements compatible with the log4j schema
  20097. </summary>
  20098. <remarks>
  20099. <para>
  20100. Formats the log events according to the http://logging.apache.org/log4j schema.
  20101. </para>
  20102. </remarks>
  20103. <author>Nicko Cadell</author>
  20104. </member>
  20105. <member name="F:log4net.Layout.XmlLayoutSchemaLog4j.s_date1970">
  20106. <summary>
  20107. The 1st of January 1970 in UTC
  20108. </summary>
  20109. </member>
  20110. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor">
  20111. <summary>
  20112. Constructs an XMLLayoutSchemaLog4j
  20113. </summary>
  20114. </member>
  20115. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor(System.Boolean)">
  20116. <summary>
  20117. Constructs an XMLLayoutSchemaLog4j.
  20118. </summary>
  20119. <remarks>
  20120. <para>
  20121. The <b>LocationInfo</b> option takes a boolean value. By
  20122. default, it is set to false which means there will be no location
  20123. information output by this layout. If the the option is set to
  20124. true, then the file name and line number of the statement
  20125. at the origin of the log statement will be output.
  20126. </para>
  20127. <para>
  20128. If you are embedding this layout within an SMTPAppender
  20129. then make sure to set the <b>LocationInfo</b> option of that
  20130. appender as well.
  20131. </para>
  20132. </remarks>
  20133. </member>
  20134. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  20135. <summary>
  20136. Actually do the writing of the xml
  20137. </summary>
  20138. <param name="writer">the writer to use</param>
  20139. <param name="loggingEvent">the event to write</param>
  20140. <remarks>
  20141. <para>
  20142. Generate XML that is compatible with the log4j schema.
  20143. </para>
  20144. </remarks>
  20145. </member>
  20146. <member name="P:log4net.Layout.XmlLayoutSchemaLog4j.Version">
  20147. <summary>
  20148. The version of the log4j schema to use.
  20149. </summary>
  20150. <remarks>
  20151. <para>
  20152. Only version 1.2 of the log4j schema is supported.
  20153. </para>
  20154. </remarks>
  20155. </member>
  20156. <member name="T:log4net.ObjectRenderer.DefaultRenderer">
  20157. <summary>
  20158. The default object Renderer.
  20159. </summary>
  20160. <remarks>
  20161. <para>
  20162. The default renderer supports rendering objects and collections to strings.
  20163. </para>
  20164. <para>
  20165. See the <see cref="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"/> method for details of the output.
  20166. </para>
  20167. </remarks>
  20168. <author>Nicko Cadell</author>
  20169. <author>Gert Driesen</author>
  20170. </member>
  20171. <member name="T:log4net.ObjectRenderer.IObjectRenderer">
  20172. <summary>
  20173. Implement this interface in order to render objects as strings
  20174. </summary>
  20175. <remarks>
  20176. <para>
  20177. Certain types require special case conversion to
  20178. string form. This conversion is done by an object renderer.
  20179. Object renderers implement the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>
  20180. interface.
  20181. </para>
  20182. </remarks>
  20183. <author>Nicko Cadell</author>
  20184. <author>Gert Driesen</author>
  20185. </member>
  20186. <member name="M:log4net.ObjectRenderer.IObjectRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  20187. <summary>
  20188. Render the object <paramref name="obj"/> to a string
  20189. </summary>
  20190. <param name="rendererMap">The map used to lookup renderers</param>
  20191. <param name="obj">The object to render</param>
  20192. <param name="writer">The writer to render to</param>
  20193. <remarks>
  20194. <para>
  20195. Render the object <paramref name="obj"/> to a
  20196. string.
  20197. </para>
  20198. <para>
  20199. The <paramref name="rendererMap"/> parameter is
  20200. provided to lookup and render other objects. This is
  20201. very useful where <paramref name="obj"/> contains
  20202. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object, TextWriter)"/>
  20203. method can be used to render these objects.
  20204. </para>
  20205. </remarks>
  20206. </member>
  20207. <member name="M:log4net.ObjectRenderer.DefaultRenderer.#ctor">
  20208. <summary>
  20209. Default constructor
  20210. </summary>
  20211. <remarks>
  20212. <para>
  20213. Default constructor
  20214. </para>
  20215. </remarks>
  20216. </member>
  20217. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  20218. <summary>
  20219. Render the object <paramref name="obj"/> to a string
  20220. </summary>
  20221. <param name="rendererMap">The map used to lookup renderers</param>
  20222. <param name="obj">The object to render</param>
  20223. <param name="writer">The writer to render to</param>
  20224. <remarks>
  20225. <para>
  20226. Render the object <paramref name="obj"/> to a string.
  20227. </para>
  20228. <para>
  20229. The <paramref name="rendererMap"/> parameter is
  20230. provided to lookup and render other objects. This is
  20231. very useful where <paramref name="obj"/> contains
  20232. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object)"/>
  20233. method can be used to render these objects.
  20234. </para>
  20235. <para>
  20236. The default renderer supports rendering objects to strings as follows:
  20237. </para>
  20238. <list type="table">
  20239. <listheader>
  20240. <term>Value</term>
  20241. <description>Rendered String</description>
  20242. </listheader>
  20243. <item>
  20244. <term><c>null</c></term>
  20245. <description>
  20246. <para>"(null)"</para>
  20247. </description>
  20248. </item>
  20249. <item>
  20250. <term><see cref="T:System.Array"/></term>
  20251. <description>
  20252. <para>
  20253. For a one dimensional array this is the
  20254. array type name, an open brace, followed by a comma
  20255. separated list of the elements (using the appropriate
  20256. renderer), followed by a close brace.
  20257. </para>
  20258. <para>
  20259. For example: <c>int[] {1, 2, 3}</c>.
  20260. </para>
  20261. <para>
  20262. If the array is not one dimensional the
  20263. <c>Array.ToString()</c> is returned.
  20264. </para>
  20265. </description>
  20266. </item>
  20267. <item>
  20268. <term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> &amp; <see cref="T:System.Collections.IEnumerator"/></term>
  20269. <description>
  20270. <para>
  20271. Rendered as an open brace, followed by a comma
  20272. separated list of the elements (using the appropriate
  20273. renderer), followed by a close brace.
  20274. </para>
  20275. <para>
  20276. For example: <c>{a, b, c}</c>.
  20277. </para>
  20278. <para>
  20279. All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses,
  20280. or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface.
  20281. </para>
  20282. </description>
  20283. </item>
  20284. <item>
  20285. <term><see cref="T:System.Collections.DictionaryEntry"/></term>
  20286. <description>
  20287. <para>
  20288. Rendered as the key, an equals sign ('='), and the value (using the appropriate
  20289. renderer).
  20290. </para>
  20291. <para>
  20292. For example: <c>key=value</c>.
  20293. </para>
  20294. </description>
  20295. </item>
  20296. <item>
  20297. <term>other</term>
  20298. <description>
  20299. <para><c>Object.ToString()</c></para>
  20300. </description>
  20301. </item>
  20302. </list>
  20303. </remarks>
  20304. </member>
  20305. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderArray(log4net.ObjectRenderer.RendererMap,System.Array,System.IO.TextWriter)">
  20306. <summary>
  20307. Render the array argument into a string
  20308. </summary>
  20309. <param name="rendererMap">The map used to lookup renderers</param>
  20310. <param name="array">the array to render</param>
  20311. <param name="writer">The writer to render to</param>
  20312. <remarks>
  20313. <para>
  20314. For a one dimensional array this is the
  20315. array type name, an open brace, followed by a comma
  20316. separated list of the elements (using the appropriate
  20317. renderer), followed by a close brace. For example:
  20318. <c>int[] {1, 2, 3}</c>.
  20319. </para>
  20320. <para>
  20321. If the array is not one dimensional the
  20322. <c>Array.ToString()</c> is returned.
  20323. </para>
  20324. </remarks>
  20325. </member>
  20326. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)">
  20327. <summary>
  20328. Render the enumerator argument into a string
  20329. </summary>
  20330. <param name="rendererMap">The map used to lookup renderers</param>
  20331. <param name="enumerator">the enumerator to render</param>
  20332. <param name="writer">The writer to render to</param>
  20333. <remarks>
  20334. <para>
  20335. Rendered as an open brace, followed by a comma
  20336. separated list of the elements (using the appropriate
  20337. renderer), followed by a close brace. For example:
  20338. <c>{a, b, c}</c>.
  20339. </para>
  20340. </remarks>
  20341. </member>
  20342. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderDictionaryEntry(log4net.ObjectRenderer.RendererMap,System.Collections.DictionaryEntry,System.IO.TextWriter)">
  20343. <summary>
  20344. Render the DictionaryEntry argument into a string
  20345. </summary>
  20346. <param name="rendererMap">The map used to lookup renderers</param>
  20347. <param name="entry">the DictionaryEntry to render</param>
  20348. <param name="writer">The writer to render to</param>
  20349. <remarks>
  20350. <para>
  20351. Render the key, an equals sign ('='), and the value (using the appropriate
  20352. renderer). For example: <c>key=value</c>.
  20353. </para>
  20354. </remarks>
  20355. </member>
  20356. <member name="T:log4net.ObjectRenderer.RendererMap">
  20357. <summary>
  20358. Map class objects to an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  20359. </summary>
  20360. <remarks>
  20361. <para>
  20362. Maintains a mapping between types that require special
  20363. rendering and the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> that
  20364. is used to render them.
  20365. </para>
  20366. <para>
  20367. The <see cref="M:FindAndRender(object)"/> method is used to render an
  20368. <c>object</c> using the appropriate renderers defined in this map.
  20369. </para>
  20370. </remarks>
  20371. <author>Nicko Cadell</author>
  20372. <author>Gert Driesen</author>
  20373. </member>
  20374. <member name="M:log4net.ObjectRenderer.RendererMap.#ctor">
  20375. <summary>
  20376. Default Constructor
  20377. </summary>
  20378. <remarks>
  20379. <para>
  20380. Default constructor.
  20381. </para>
  20382. </remarks>
  20383. </member>
  20384. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)">
  20385. <summary>
  20386. Render <paramref name="obj"/> using the appropriate renderer.
  20387. </summary>
  20388. <param name="obj">the object to render to a string</param>
  20389. <returns>the object rendered as a string</returns>
  20390. <remarks>
  20391. <para>
  20392. This is a convenience method used to render an object to a string.
  20393. The alternative method <see cref="M:FindAndRender(object,TextWriter)"/>
  20394. should be used when streaming output to a <see cref="T:System.IO.TextWriter"/>.
  20395. </para>
  20396. </remarks>
  20397. </member>
  20398. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)">
  20399. <summary>
  20400. Render <paramref name="obj"/> using the appropriate renderer.
  20401. </summary>
  20402. <param name="obj">the object to render to a string</param>
  20403. <param name="writer">The writer to render to</param>
  20404. <remarks>
  20405. <para>
  20406. Find the appropriate renderer for the type of the
  20407. <paramref name="obj"/> parameter. This is accomplished by calling the
  20408. <see cref="M:Get(Type)"/> method. Once a renderer is found, it is
  20409. applied on the object <paramref name="obj"/> and the result is returned
  20410. as a <see cref="T:System.String"/>.
  20411. </para>
  20412. </remarks>
  20413. </member>
  20414. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)">
  20415. <summary>
  20416. Gets the renderer for the specified object type
  20417. </summary>
  20418. <param name="obj">the object to lookup the renderer for</param>
  20419. <returns>the renderer for <paramref name="obj"/></returns>
  20420. <remarks>
  20421. <param>
  20422. Gets the renderer for the specified object type.
  20423. </param>
  20424. <param>
  20425. Syntactic sugar method that calls <see cref="M:Get(Type)"/>
  20426. with the type of the object parameter.
  20427. </param>
  20428. </remarks>
  20429. </member>
  20430. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)">
  20431. <summary>
  20432. Gets the renderer for the specified type
  20433. </summary>
  20434. <param name="type">the type to lookup the renderer for</param>
  20435. <returns>the renderer for the specified type</returns>
  20436. <remarks>
  20437. <para>
  20438. Returns the renderer for the specified type.
  20439. If no specific renderer has been defined the
  20440. <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> will be returned.
  20441. </para>
  20442. </remarks>
  20443. </member>
  20444. <member name="M:log4net.ObjectRenderer.RendererMap.SearchTypeAndInterfaces(System.Type)">
  20445. <summary>
  20446. Internal function to recursively search interfaces
  20447. </summary>
  20448. <param name="type">the type to lookup the renderer for</param>
  20449. <returns>the renderer for the specified type</returns>
  20450. </member>
  20451. <member name="M:log4net.ObjectRenderer.RendererMap.Clear">
  20452. <summary>
  20453. Clear the map of renderers
  20454. </summary>
  20455. <remarks>
  20456. <para>
  20457. Clear the custom renderers defined by using
  20458. <see cref="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"/>. The <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/>
  20459. cannot be removed.
  20460. </para>
  20461. </remarks>
  20462. </member>
  20463. <member name="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  20464. <summary>
  20465. Register an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> for <paramref name="typeToRender"/>.
  20466. </summary>
  20467. <param name="typeToRender">the type that will be rendered by <paramref name="renderer"/></param>
  20468. <param name="renderer">the renderer for <paramref name="typeToRender"/></param>
  20469. <remarks>
  20470. <para>
  20471. Register an object renderer for a specific source type.
  20472. This renderer will be returned from a call to <see cref="M:Get(Type)"/>
  20473. specifying the same <paramref name="typeToRender"/> as an argument.
  20474. </para>
  20475. </remarks>
  20476. </member>
  20477. <member name="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer">
  20478. <summary>
  20479. Get the default renderer instance
  20480. </summary>
  20481. <value>the default renderer</value>
  20482. <remarks>
  20483. <para>
  20484. Get the default renderer
  20485. </para>
  20486. </remarks>
  20487. </member>
  20488. <member name="T:log4net.Plugin.IPlugin">
  20489. <summary>
  20490. Interface implemented by logger repository plugins.
  20491. </summary>
  20492. <remarks>
  20493. <para>
  20494. Plugins define additional behavior that can be associated
  20495. with a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  20496. The <see cref="T:log4net.Plugin.PluginMap"/> held by the <see cref="P:log4net.Repository.ILoggerRepository.PluginMap"/>
  20497. property is used to store the plugins for a repository.
  20498. </para>
  20499. <para>
  20500. The <c>log4net.Config.PluginAttribute</c> can be used to
  20501. attach plugins to repositories created using configuration
  20502. attributes.
  20503. </para>
  20504. </remarks>
  20505. <author>Nicko Cadell</author>
  20506. <author>Gert Driesen</author>
  20507. </member>
  20508. <member name="M:log4net.Plugin.IPlugin.Attach(log4net.Repository.ILoggerRepository)">
  20509. <summary>
  20510. Attaches the plugin to the specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  20511. </summary>
  20512. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  20513. <remarks>
  20514. <para>
  20515. A plugin may only be attached to a single repository.
  20516. </para>
  20517. <para>
  20518. This method is called when the plugin is attached to the repository.
  20519. </para>
  20520. </remarks>
  20521. </member>
  20522. <member name="M:log4net.Plugin.IPlugin.Shutdown">
  20523. <summary>
  20524. Is called when the plugin is to shutdown.
  20525. </summary>
  20526. <remarks>
  20527. <para>
  20528. This method is called to notify the plugin that
  20529. it should stop operating and should detach from
  20530. the repository.
  20531. </para>
  20532. </remarks>
  20533. </member>
  20534. <member name="P:log4net.Plugin.IPlugin.Name">
  20535. <summary>
  20536. Gets the name of the plugin.
  20537. </summary>
  20538. <value>
  20539. The name of the plugin.
  20540. </value>
  20541. <remarks>
  20542. <para>
  20543. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  20544. keyed by name. Each plugin instance attached to a
  20545. repository must be a unique name.
  20546. </para>
  20547. </remarks>
  20548. </member>
  20549. <member name="T:log4net.Plugin.PluginCollection">
  20550. <summary>
  20551. A strongly-typed collection of <see cref="T:log4net.Plugin.IPlugin"/> objects.
  20552. </summary>
  20553. <author>Nicko Cadell</author>
  20554. </member>
  20555. <member name="M:log4net.Plugin.PluginCollection.ReadOnly(log4net.Plugin.PluginCollection)">
  20556. <summary>
  20557. Creates a read-only wrapper for a <c>PluginCollection</c> instance.
  20558. </summary>
  20559. <param name="list">list to create a readonly wrapper arround</param>
  20560. <returns>
  20561. A <c>PluginCollection</c> wrapper that is read-only.
  20562. </returns>
  20563. </member>
  20564. <member name="M:log4net.Plugin.PluginCollection.#ctor">
  20565. <summary>
  20566. Initializes a new instance of the <c>PluginCollection</c> class
  20567. that is empty and has the default initial capacity.
  20568. </summary>
  20569. </member>
  20570. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Int32)">
  20571. <summary>
  20572. Initializes a new instance of the <c>PluginCollection</c> class
  20573. that has the specified initial capacity.
  20574. </summary>
  20575. <param name="capacity">
  20576. The number of elements that the new <c>PluginCollection</c> is initially capable of storing.
  20577. </param>
  20578. </member>
  20579. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection)">
  20580. <summary>
  20581. Initializes a new instance of the <c>PluginCollection</c> class
  20582. that contains elements copied from the specified <c>PluginCollection</c>.
  20583. </summary>
  20584. <param name="c">The <c>PluginCollection</c> whose elements are copied to the new collection.</param>
  20585. </member>
  20586. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.IPlugin[])">
  20587. <summary>
  20588. Initializes a new instance of the <c>PluginCollection</c> class
  20589. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> array.
  20590. </summary>
  20591. <param name="a">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements are copied to the new list.</param>
  20592. </member>
  20593. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Collections.ICollection)">
  20594. <summary>
  20595. Initializes a new instance of the <c>PluginCollection</c> class
  20596. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> collection.
  20597. </summary>
  20598. <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements are copied to the new list.</param>
  20599. </member>
  20600. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection.Tag)">
  20601. <summary>
  20602. Allow subclasses to avoid our default constructors
  20603. </summary>
  20604. <param name="tag"></param>
  20605. <exclude/>
  20606. </member>
  20607. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[])">
  20608. <summary>
  20609. Copies the entire <c>PluginCollection</c> to a one-dimensional
  20610. <see cref="T:log4net.Plugin.IPlugin"/> array.
  20611. </summary>
  20612. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  20613. </member>
  20614. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[],System.Int32)">
  20615. <summary>
  20616. Copies the entire <c>PluginCollection</c> to a one-dimensional
  20617. <see cref="T:log4net.Plugin.IPlugin"/> array, starting at the specified index of the target array.
  20618. </summary>
  20619. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  20620. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  20621. </member>
  20622. <member name="M:log4net.Plugin.PluginCollection.Add(log4net.Plugin.IPlugin)">
  20623. <summary>
  20624. Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the end of the <c>PluginCollection</c>.
  20625. </summary>
  20626. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to be added to the end of the <c>PluginCollection</c>.</param>
  20627. <returns>The index at which the value has been added.</returns>
  20628. </member>
  20629. <member name="M:log4net.Plugin.PluginCollection.Clear">
  20630. <summary>
  20631. Removes all elements from the <c>PluginCollection</c>.
  20632. </summary>
  20633. </member>
  20634. <member name="M:log4net.Plugin.PluginCollection.Clone">
  20635. <summary>
  20636. Creates a shallow copy of the <see cref="T:log4net.Plugin.PluginCollection"/>.
  20637. </summary>
  20638. <returns>A new <see cref="T:log4net.Plugin.PluginCollection"/> with a shallow copy of the collection data.</returns>
  20639. </member>
  20640. <member name="M:log4net.Plugin.PluginCollection.Contains(log4net.Plugin.IPlugin)">
  20641. <summary>
  20642. Determines whether a given <see cref="T:log4net.Plugin.IPlugin"/> is in the <c>PluginCollection</c>.
  20643. </summary>
  20644. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to check for.</param>
  20645. <returns><c>true</c> if <paramref name="item"/> is found in the <c>PluginCollection</c>; otherwise, <c>false</c>.</returns>
  20646. </member>
  20647. <member name="M:log4net.Plugin.PluginCollection.IndexOf(log4net.Plugin.IPlugin)">
  20648. <summary>
  20649. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Plugin.IPlugin"/>
  20650. in the <c>PluginCollection</c>.
  20651. </summary>
  20652. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to locate in the <c>PluginCollection</c>.</param>
  20653. <returns>
  20654. The zero-based index of the first occurrence of <paramref name="item"/>
  20655. in the entire <c>PluginCollection</c>, if found; otherwise, -1.
  20656. </returns>
  20657. </member>
  20658. <member name="M:log4net.Plugin.PluginCollection.Insert(System.Int32,log4net.Plugin.IPlugin)">
  20659. <summary>
  20660. Inserts an element into the <c>PluginCollection</c> at the specified index.
  20661. </summary>
  20662. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  20663. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to insert.</param>
  20664. <exception cref="T:System.ArgumentOutOfRangeException">
  20665. <para><paramref name="index"/> is less than zero</para>
  20666. <para>-or-</para>
  20667. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20668. </exception>
  20669. </member>
  20670. <member name="M:log4net.Plugin.PluginCollection.Remove(log4net.Plugin.IPlugin)">
  20671. <summary>
  20672. Removes the first occurrence of a specific <see cref="T:log4net.Plugin.IPlugin"/> from the <c>PluginCollection</c>.
  20673. </summary>
  20674. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the <c>PluginCollection</c>.</param>
  20675. <exception cref="T:System.ArgumentException">
  20676. The specified <see cref="T:log4net.Plugin.IPlugin"/> was not found in the <c>PluginCollection</c>.
  20677. </exception>
  20678. </member>
  20679. <member name="M:log4net.Plugin.PluginCollection.RemoveAt(System.Int32)">
  20680. <summary>
  20681. Removes the element at the specified index of the <c>PluginCollection</c>.
  20682. </summary>
  20683. <param name="index">The zero-based index of the element to remove.</param>
  20684. <exception cref="T:System.ArgumentOutOfRangeException">
  20685. <para><paramref name="index"/> is less than zero.</para>
  20686. <para>-or-</para>
  20687. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20688. </exception>
  20689. </member>
  20690. <member name="M:log4net.Plugin.PluginCollection.GetEnumerator">
  20691. <summary>
  20692. Returns an enumerator that can iterate through the <c>PluginCollection</c>.
  20693. </summary>
  20694. <returns>An <see cref="T:log4net.Plugin.PluginCollection.Enumerator"/> for the entire <c>PluginCollection</c>.</returns>
  20695. </member>
  20696. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.PluginCollection)">
  20697. <summary>
  20698. Adds the elements of another <c>PluginCollection</c> to the current <c>PluginCollection</c>.
  20699. </summary>
  20700. <param name="x">The <c>PluginCollection</c> whose elements should be added to the end of the current <c>PluginCollection</c>.</param>
  20701. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  20702. </member>
  20703. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.IPlugin[])">
  20704. <summary>
  20705. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> array to the current <c>PluginCollection</c>.
  20706. </summary>
  20707. <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>
  20708. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  20709. </member>
  20710. <member name="M:log4net.Plugin.PluginCollection.AddRange(System.Collections.ICollection)">
  20711. <summary>
  20712. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> collection to the current <c>PluginCollection</c>.
  20713. </summary>
  20714. <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>
  20715. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  20716. </member>
  20717. <member name="M:log4net.Plugin.PluginCollection.TrimToSize">
  20718. <summary>
  20719. Sets the capacity to the actual number of elements.
  20720. </summary>
  20721. </member>
  20722. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32)">
  20723. <exception cref="T:System.ArgumentOutOfRangeException">
  20724. <para><paramref name="i"/> is less than zero.</para>
  20725. <para>-or-</para>
  20726. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20727. </exception>
  20728. </member>
  20729. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32,System.Boolean)">
  20730. <exception cref="T:System.ArgumentOutOfRangeException">
  20731. <para><paramref name="i"/> is less than zero.</para>
  20732. <para>-or-</para>
  20733. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20734. </exception>
  20735. </member>
  20736. <member name="P:log4net.Plugin.PluginCollection.Count">
  20737. <summary>
  20738. Gets the number of elements actually contained in the <c>PluginCollection</c>.
  20739. </summary>
  20740. </member>
  20741. <member name="P:log4net.Plugin.PluginCollection.IsSynchronized">
  20742. <summary>
  20743. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  20744. </summary>
  20745. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  20746. </member>
  20747. <member name="P:log4net.Plugin.PluginCollection.SyncRoot">
  20748. <summary>
  20749. Gets an object that can be used to synchronize access to the collection.
  20750. </summary>
  20751. <value>
  20752. An object that can be used to synchronize access to the collection.
  20753. </value>
  20754. </member>
  20755. <member name="P:log4net.Plugin.PluginCollection.Item(System.Int32)">
  20756. <summary>
  20757. Gets or sets the <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  20758. </summary>
  20759. <value>
  20760. The <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  20761. </value>
  20762. <param name="index">The zero-based index of the element to get or set.</param>
  20763. <exception cref="T:System.ArgumentOutOfRangeException">
  20764. <para><paramref name="index"/> is less than zero.</para>
  20765. <para>-or-</para>
  20766. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20767. </exception>
  20768. </member>
  20769. <member name="P:log4net.Plugin.PluginCollection.IsFixedSize">
  20770. <summary>
  20771. Gets a value indicating whether the collection has a fixed size.
  20772. </summary>
  20773. <value><c>true</c> if the collection has a fixed size; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  20774. </member>
  20775. <member name="P:log4net.Plugin.PluginCollection.IsReadOnly">
  20776. <summary>
  20777. Gets a value indicating whether the IList is read-only.
  20778. </summary>
  20779. <value><c>true</c> if the collection is read-only; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  20780. </member>
  20781. <member name="P:log4net.Plugin.PluginCollection.Capacity">
  20782. <summary>
  20783. Gets or sets the number of elements the <c>PluginCollection</c> can contain.
  20784. </summary>
  20785. <value>
  20786. The number of elements the <c>PluginCollection</c> can contain.
  20787. </value>
  20788. </member>
  20789. <member name="T:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator">
  20790. <summary>
  20791. Supports type-safe iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  20792. </summary>
  20793. <exclude/>
  20794. </member>
  20795. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.MoveNext">
  20796. <summary>
  20797. Advances the enumerator to the next element in the collection.
  20798. </summary>
  20799. <returns>
  20800. <c>true</c> if the enumerator was successfully advanced to the next element;
  20801. <c>false</c> if the enumerator has passed the end of the collection.
  20802. </returns>
  20803. <exception cref="T:System.InvalidOperationException">
  20804. The collection was modified after the enumerator was created.
  20805. </exception>
  20806. </member>
  20807. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Reset">
  20808. <summary>
  20809. Sets the enumerator to its initial position, before the first element in the collection.
  20810. </summary>
  20811. </member>
  20812. <member name="P:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Current">
  20813. <summary>
  20814. Gets the current element in the collection.
  20815. </summary>
  20816. </member>
  20817. <member name="T:log4net.Plugin.PluginCollection.Tag">
  20818. <summary>
  20819. Type visible only to our subclasses
  20820. Used to access protected constructor
  20821. </summary>
  20822. <exclude/>
  20823. </member>
  20824. <member name="F:log4net.Plugin.PluginCollection.Tag.Default">
  20825. <summary>
  20826. A value
  20827. </summary>
  20828. </member>
  20829. <member name="T:log4net.Plugin.PluginCollection.Enumerator">
  20830. <summary>
  20831. Supports simple iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  20832. </summary>
  20833. <exclude/>
  20834. </member>
  20835. <member name="M:log4net.Plugin.PluginCollection.Enumerator.#ctor(log4net.Plugin.PluginCollection)">
  20836. <summary>
  20837. Initializes a new instance of the <c>Enumerator</c> class.
  20838. </summary>
  20839. <param name="tc"></param>
  20840. </member>
  20841. <member name="M:log4net.Plugin.PluginCollection.Enumerator.MoveNext">
  20842. <summary>
  20843. Advances the enumerator to the next element in the collection.
  20844. </summary>
  20845. <returns>
  20846. <c>true</c> if the enumerator was successfully advanced to the next element;
  20847. <c>false</c> if the enumerator has passed the end of the collection.
  20848. </returns>
  20849. <exception cref="T:System.InvalidOperationException">
  20850. The collection was modified after the enumerator was created.
  20851. </exception>
  20852. </member>
  20853. <member name="M:log4net.Plugin.PluginCollection.Enumerator.Reset">
  20854. <summary>
  20855. Sets the enumerator to its initial position, before the first element in the collection.
  20856. </summary>
  20857. </member>
  20858. <member name="P:log4net.Plugin.PluginCollection.Enumerator.Current">
  20859. <summary>
  20860. Gets the current element in the collection.
  20861. </summary>
  20862. <value>
  20863. The current element in the collection.
  20864. </value>
  20865. </member>
  20866. <member name="T:log4net.Plugin.PluginCollection.ReadOnlyPluginCollection">
  20867. <exclude/>
  20868. </member>
  20869. <member name="T:log4net.Plugin.PluginMap">
  20870. <summary>
  20871. Map of repository plugins.
  20872. </summary>
  20873. <remarks>
  20874. <para>
  20875. This class is a name keyed map of the plugins that are
  20876. attached to a repository.
  20877. </para>
  20878. </remarks>
  20879. <author>Nicko Cadell</author>
  20880. <author>Gert Driesen</author>
  20881. </member>
  20882. <member name="M:log4net.Plugin.PluginMap.#ctor(log4net.Repository.ILoggerRepository)">
  20883. <summary>
  20884. Constructor
  20885. </summary>
  20886. <param name="repository">The repository that the plugins should be attached to.</param>
  20887. <remarks>
  20888. <para>
  20889. Initialize a new instance of the <see cref="T:log4net.Plugin.PluginMap"/> class with a
  20890. repository that the plugins should be attached to.
  20891. </para>
  20892. </remarks>
  20893. </member>
  20894. <member name="M:log4net.Plugin.PluginMap.Add(log4net.Plugin.IPlugin)">
  20895. <summary>
  20896. Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the map.
  20897. </summary>
  20898. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to add to the map.</param>
  20899. <remarks>
  20900. <para>
  20901. The <see cref="T:log4net.Plugin.IPlugin"/> will be attached to the repository when added.
  20902. </para>
  20903. <para>
  20904. If there already exists a plugin with the same name
  20905. attached to the repository then the old plugin will
  20906. be <see cref="M:log4net.Plugin.IPlugin.Shutdown"/> and replaced with
  20907. the new plugin.
  20908. </para>
  20909. </remarks>
  20910. </member>
  20911. <member name="M:log4net.Plugin.PluginMap.Remove(log4net.Plugin.IPlugin)">
  20912. <summary>
  20913. Removes a <see cref="T:log4net.Plugin.IPlugin"/> from the map.
  20914. </summary>
  20915. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the map.</param>
  20916. <remarks>
  20917. <para>
  20918. Remove a specific plugin from this map.
  20919. </para>
  20920. </remarks>
  20921. </member>
  20922. <member name="P:log4net.Plugin.PluginMap.Item(System.String)">
  20923. <summary>
  20924. Gets a <see cref="T:log4net.Plugin.IPlugin"/> by name.
  20925. </summary>
  20926. <param name="name">The name of the <see cref="T:log4net.Plugin.IPlugin"/> to lookup.</param>
  20927. <returns>
  20928. The <see cref="T:log4net.Plugin.IPlugin"/> from the map with the name specified, or
  20929. <c>null</c> if no plugin is found.
  20930. </returns>
  20931. <remarks>
  20932. <para>
  20933. Lookup a plugin by name. If the plugin is not found <c>null</c>
  20934. will be returned.
  20935. </para>
  20936. </remarks>
  20937. </member>
  20938. <member name="P:log4net.Plugin.PluginMap.AllPlugins">
  20939. <summary>
  20940. Gets all possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.
  20941. </summary>
  20942. <value>All possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.</value>
  20943. <remarks>
  20944. <para>
  20945. Get a collection of all the plugins defined in this map.
  20946. </para>
  20947. </remarks>
  20948. </member>
  20949. <member name="T:log4net.Plugin.PluginSkeleton">
  20950. <summary>
  20951. Base implementation of <see cref="T:log4net.Plugin.IPlugin"/>
  20952. </summary>
  20953. <remarks>
  20954. <para>
  20955. Default abstract implementation of the <see cref="T:log4net.Plugin.IPlugin"/>
  20956. interface. This base class can be used by implementors
  20957. of the <see cref="T:log4net.Plugin.IPlugin"/> interface.
  20958. </para>
  20959. </remarks>
  20960. <author>Nicko Cadell</author>
  20961. <author>Gert Driesen</author>
  20962. </member>
  20963. <member name="M:log4net.Plugin.PluginSkeleton.#ctor(System.String)">
  20964. <summary>
  20965. Constructor
  20966. </summary>
  20967. <param name="name">the name of the plugin</param>
  20968. <remarks>
  20969. Initializes a new Plugin with the specified name.
  20970. </remarks>
  20971. </member>
  20972. <member name="M:log4net.Plugin.PluginSkeleton.Attach(log4net.Repository.ILoggerRepository)">
  20973. <summary>
  20974. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  20975. </summary>
  20976. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  20977. <remarks>
  20978. <para>
  20979. A plugin may only be attached to a single repository.
  20980. </para>
  20981. <para>
  20982. This method is called when the plugin is attached to the repository.
  20983. </para>
  20984. </remarks>
  20985. </member>
  20986. <member name="M:log4net.Plugin.PluginSkeleton.Shutdown">
  20987. <summary>
  20988. Is called when the plugin is to shutdown.
  20989. </summary>
  20990. <remarks>
  20991. <para>
  20992. This method is called to notify the plugin that
  20993. it should stop operating and should detach from
  20994. the repository.
  20995. </para>
  20996. </remarks>
  20997. </member>
  20998. <member name="F:log4net.Plugin.PluginSkeleton.m_name">
  20999. <summary>
  21000. The name of this plugin.
  21001. </summary>
  21002. </member>
  21003. <member name="F:log4net.Plugin.PluginSkeleton.m_repository">
  21004. <summary>
  21005. The repository this plugin is attached to.
  21006. </summary>
  21007. </member>
  21008. <member name="P:log4net.Plugin.PluginSkeleton.Name">
  21009. <summary>
  21010. Gets or sets the name of the plugin.
  21011. </summary>
  21012. <value>
  21013. The name of the plugin.
  21014. </value>
  21015. <remarks>
  21016. <para>
  21017. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  21018. keyed by name. Each plugin instance attached to a
  21019. repository must be a unique name.
  21020. </para>
  21021. <para>
  21022. The name of the plugin must not change one the
  21023. plugin has been attached to a repository.
  21024. </para>
  21025. </remarks>
  21026. </member>
  21027. <member name="P:log4net.Plugin.PluginSkeleton.LoggerRepository">
  21028. <summary>
  21029. The repository for this plugin
  21030. </summary>
  21031. <value>
  21032. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is attached to.
  21033. </value>
  21034. <remarks>
  21035. <para>
  21036. Gets or sets the <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is
  21037. attached to.
  21038. </para>
  21039. </remarks>
  21040. </member>
  21041. <member name="T:log4net.Plugin.RemoteLoggingServerPlugin">
  21042. <summary>
  21043. Plugin that listens for events from the <see cref="T:log4net.Appender.RemotingAppender"/>
  21044. </summary>
  21045. <remarks>
  21046. <para>
  21047. This plugin publishes an instance of <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  21048. on a specified <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/>. This listens for logging events delivered from
  21049. a remote <see cref="T:log4net.Appender.RemotingAppender"/>.
  21050. </para>
  21051. <para>
  21052. When an event is received it is relogged within the attached repository
  21053. as if it had been raised locally.
  21054. </para>
  21055. </remarks>
  21056. <author>Nicko Cadell</author>
  21057. <author>Gert Driesen</author>
  21058. </member>
  21059. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor">
  21060. <summary>
  21061. Default constructor
  21062. </summary>
  21063. <remarks>
  21064. <para>
  21065. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class.
  21066. </para>
  21067. <para>
  21068. The <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> property must be set.
  21069. </para>
  21070. </remarks>
  21071. </member>
  21072. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor(System.String)">
  21073. <summary>
  21074. Construct with sink Uri.
  21075. </summary>
  21076. <param name="sinkUri">The name to publish the sink under in the remoting infrastructure.
  21077. See <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> for more details.</param>
  21078. <remarks>
  21079. <para>
  21080. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class
  21081. with specified name.
  21082. </para>
  21083. </remarks>
  21084. </member>
  21085. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Attach(log4net.Repository.ILoggerRepository)">
  21086. <summary>
  21087. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21088. </summary>
  21089. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  21090. <remarks>
  21091. <para>
  21092. A plugin may only be attached to a single repository.
  21093. </para>
  21094. <para>
  21095. This method is called when the plugin is attached to the repository.
  21096. </para>
  21097. </remarks>
  21098. </member>
  21099. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Shutdown">
  21100. <summary>
  21101. Is called when the plugin is to shutdown.
  21102. </summary>
  21103. <remarks>
  21104. <para>
  21105. When the plugin is shutdown the remote logging
  21106. sink is disconnected.
  21107. </para>
  21108. </remarks>
  21109. </member>
  21110. <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.declaringType">
  21111. <summary>
  21112. The fully qualified type of the RemoteLoggingServerPlugin class.
  21113. </summary>
  21114. <remarks>
  21115. Used by the internal logger to record the Type of the
  21116. log message.
  21117. </remarks>
  21118. </member>
  21119. <member name="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri">
  21120. <summary>
  21121. Gets or sets the URI of this sink.
  21122. </summary>
  21123. <value>
  21124. The URI of this sink.
  21125. </value>
  21126. <remarks>
  21127. <para>
  21128. This is the name under which the object is marshaled.
  21129. <see cref="M:RemotingServices.Marshal(MarshalByRefObject,String,Type)"/>
  21130. </para>
  21131. </remarks>
  21132. </member>
  21133. <member name="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl">
  21134. <summary>
  21135. Delivers <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  21136. </summary>
  21137. <remarks>
  21138. <para>
  21139. Internal class used to listen for logging events
  21140. and deliver them to the local repository.
  21141. </para>
  21142. </remarks>
  21143. </member>
  21144. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.#ctor(log4net.Repository.ILoggerRepository)">
  21145. <summary>
  21146. Constructor
  21147. </summary>
  21148. <param name="repository">The repository to log to.</param>
  21149. <remarks>
  21150. <para>
  21151. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl"/> for the
  21152. specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21153. </para>
  21154. </remarks>
  21155. </member>
  21156. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.LogEvents(log4net.Core.LoggingEvent[])">
  21157. <summary>
  21158. Logs the events to the repository.
  21159. </summary>
  21160. <param name="events">The events to log.</param>
  21161. <remarks>
  21162. <para>
  21163. The events passed are logged to the <see cref="T:log4net.Repository.ILoggerRepository"/>
  21164. </para>
  21165. </remarks>
  21166. </member>
  21167. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.InitializeLifetimeService">
  21168. <summary>
  21169. Obtains a lifetime service object to control the lifetime
  21170. policy for this instance.
  21171. </summary>
  21172. <returns><c>null</c> to indicate that this instance should live forever.</returns>
  21173. <remarks>
  21174. <para>
  21175. Obtains a lifetime service object to control the lifetime
  21176. policy for this instance. This object should live forever
  21177. therefore this implementation returns <c>null</c>.
  21178. </para>
  21179. </remarks>
  21180. </member>
  21181. <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.m_repository">
  21182. <summary>
  21183. The underlying <see cref="T:log4net.Repository.ILoggerRepository"/> that events should
  21184. be logged to.
  21185. </summary>
  21186. </member>
  21187. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory">
  21188. <summary>
  21189. Default implementation of <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  21190. </summary>
  21191. <remarks>
  21192. <para>
  21193. This default implementation of the <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  21194. interface is used to create the default subclass
  21195. of the <see cref="T:log4net.Repository.Hierarchy.Logger"/> object.
  21196. </para>
  21197. </remarks>
  21198. <author>Nicko Cadell</author>
  21199. <author>Gert Driesen</author>
  21200. </member>
  21201. <member name="T:log4net.Repository.Hierarchy.ILoggerFactory">
  21202. <summary>
  21203. Interface abstracts creation of <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances
  21204. </summary>
  21205. <remarks>
  21206. <para>
  21207. This interface is used by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to
  21208. create new <see cref="T:log4net.Repository.Hierarchy.Logger"/> objects.
  21209. </para>
  21210. <para>
  21211. The <see cref="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"/> method is called
  21212. to create a named <see cref="T:log4net.Repository.Hierarchy.Logger"/>.
  21213. </para>
  21214. <para>
  21215. Implement this interface to create new subclasses of <see cref="T:log4net.Repository.Hierarchy.Logger"/>.
  21216. </para>
  21217. </remarks>
  21218. <author>Nicko Cadell</author>
  21219. <author>Gert Driesen</author>
  21220. </member>
  21221. <member name="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  21222. <summary>
  21223. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance
  21224. </summary>
  21225. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21226. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21227. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns>
  21228. <remarks>
  21229. <para>
  21230. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the
  21231. specified name.
  21232. </para>
  21233. <para>
  21234. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  21235. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  21236. </para>
  21237. <para>
  21238. If the <paramref name="name"/> is <c>null</c> then the root logger
  21239. must be returned.
  21240. </para>
  21241. </remarks>
  21242. </member>
  21243. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.#ctor">
  21244. <summary>
  21245. Default constructor
  21246. </summary>
  21247. <remarks>
  21248. <para>
  21249. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> class.
  21250. </para>
  21251. </remarks>
  21252. </member>
  21253. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  21254. <summary>
  21255. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance
  21256. </summary>
  21257. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21258. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21259. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns>
  21260. <remarks>
  21261. <para>
  21262. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the
  21263. specified name.
  21264. </para>
  21265. <para>
  21266. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  21267. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  21268. </para>
  21269. <para>
  21270. If the <paramref name="name"/> is <c>null</c> then the root logger
  21271. must be returned.
  21272. </para>
  21273. </remarks>
  21274. </member>
  21275. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl">
  21276. <summary>
  21277. Default internal subclass of <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  21278. </summary>
  21279. <remarks>
  21280. <para>
  21281. This subclass has no additional behavior over the
  21282. <see cref="T:log4net.Repository.Hierarchy.Logger"/> class but does allow instances
  21283. to be created.
  21284. </para>
  21285. </remarks>
  21286. </member>
  21287. <member name="T:log4net.Repository.Hierarchy.Logger">
  21288. <summary>
  21289. Implementation of <see cref="T:log4net.Core.ILogger"/> used by <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>
  21290. </summary>
  21291. <remarks>
  21292. <para>
  21293. Internal class used to provide implementation of <see cref="T:log4net.Core.ILogger"/>
  21294. interface. Applications should use <see cref="T:log4net.LogManager"/> to get
  21295. logger instances.
  21296. </para>
  21297. <para>
  21298. This is one of the central classes in the log4net implementation. One of the
  21299. distinctive features of log4net are hierarchical loggers and their
  21300. evaluation. The <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> organizes the <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  21301. instances into a rooted tree hierarchy.
  21302. </para>
  21303. <para>
  21304. The <see cref="T:log4net.Repository.Hierarchy.Logger"/> class is abstract. Only concrete subclasses of
  21305. <see cref="T:log4net.Repository.Hierarchy.Logger"/> can be created. The <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  21306. is used to create instances of this type for the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  21307. </para>
  21308. </remarks>
  21309. <author>Nicko Cadell</author>
  21310. <author>Gert Driesen</author>
  21311. <author>Aspi Havewala</author>
  21312. <author>Douglas de la Torre</author>
  21313. </member>
  21314. <member name="M:log4net.Repository.Hierarchy.Logger.#ctor(System.String)">
  21315. <summary>
  21316. This constructor created a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance and
  21317. sets its name.
  21318. </summary>
  21319. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21320. <remarks>
  21321. <para>
  21322. This constructor is protected and designed to be used by
  21323. a subclass that is not abstract.
  21324. </para>
  21325. <para>
  21326. Loggers are constructed by <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  21327. objects. See <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> for the default
  21328. logger creator.
  21329. </para>
  21330. </remarks>
  21331. </member>
  21332. <member name="M:log4net.Repository.Hierarchy.Logger.AddAppender(log4net.Appender.IAppender)">
  21333. <summary>
  21334. Add <paramref name="newAppender"/> to the list of appenders of this
  21335. Logger instance.
  21336. </summary>
  21337. <param name="newAppender">An appender to add to this logger</param>
  21338. <remarks>
  21339. <para>
  21340. Add <paramref name="newAppender"/> to the list of appenders of this
  21341. Logger instance.
  21342. </para>
  21343. <para>
  21344. If <paramref name="newAppender"/> is already in the list of
  21345. appenders, then it won't be added again.
  21346. </para>
  21347. </remarks>
  21348. </member>
  21349. <member name="M:log4net.Repository.Hierarchy.Logger.GetAppender(System.String)">
  21350. <summary>
  21351. Look for the appender named as <c>name</c>
  21352. </summary>
  21353. <param name="name">The name of the appender to lookup</param>
  21354. <returns>The appender with the name specified, or <c>null</c>.</returns>
  21355. <remarks>
  21356. <para>
  21357. Returns the named appender, or null if the appender is not found.
  21358. </para>
  21359. </remarks>
  21360. </member>
  21361. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAllAppenders">
  21362. <summary>
  21363. Remove all previously added appenders from this Logger instance.
  21364. </summary>
  21365. <remarks>
  21366. <para>
  21367. Remove all previously added appenders from this Logger instance.
  21368. </para>
  21369. <para>
  21370. This is useful when re-reading configuration information.
  21371. </para>
  21372. </remarks>
  21373. </member>
  21374. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(log4net.Appender.IAppender)">
  21375. <summary>
  21376. Remove the appender passed as parameter form the list of appenders.
  21377. </summary>
  21378. <param name="appender">The appender to remove</param>
  21379. <returns>The appender removed from the list</returns>
  21380. <remarks>
  21381. <para>
  21382. Remove the appender passed as parameter form the list of appenders.
  21383. The appender removed is not closed.
  21384. If you are discarding the appender you must call
  21385. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  21386. </para>
  21387. </remarks>
  21388. </member>
  21389. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(System.String)">
  21390. <summary>
  21391. Remove the appender passed as parameter form the list of appenders.
  21392. </summary>
  21393. <param name="name">The name of the appender to remove</param>
  21394. <returns>The appender removed from the list</returns>
  21395. <remarks>
  21396. <para>
  21397. Remove the named appender passed as parameter form the list of appenders.
  21398. The appender removed is not closed.
  21399. If you are discarding the appender you must call
  21400. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  21401. </para>
  21402. </remarks>
  21403. </member>
  21404. <member name="M:log4net.Repository.Hierarchy.Logger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  21405. <summary>
  21406. This generic form is intended to be used by wrappers.
  21407. </summary>
  21408. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  21409. the stack boundary into the logging system for this call.</param>
  21410. <param name="level">The level of the message to be logged.</param>
  21411. <param name="message">The message object to log.</param>
  21412. <param name="exception">The exception to log, including its stack trace.</param>
  21413. <remarks>
  21414. <para>
  21415. Generate a logging event for the specified <paramref name="level"/> using
  21416. the <paramref name="message"/> and <paramref name="exception"/>.
  21417. </para>
  21418. <para>
  21419. This method must not throw any exception to the caller.
  21420. </para>
  21421. </remarks>
  21422. </member>
  21423. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)">
  21424. <summary>
  21425. This is the most generic printing method that is intended to be used
  21426. by wrappers.
  21427. </summary>
  21428. <param name="logEvent">The event being logged.</param>
  21429. <remarks>
  21430. <para>
  21431. Logs the specified logging event through this logger.
  21432. </para>
  21433. <para>
  21434. This method must not throw any exception to the caller.
  21435. </para>
  21436. </remarks>
  21437. </member>
  21438. <member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)">
  21439. <summary>
  21440. Checks if this logger is enabled for a given <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> passed as parameter.
  21441. </summary>
  21442. <param name="level">The level to check.</param>
  21443. <returns>
  21444. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  21445. </returns>
  21446. <remarks>
  21447. <para>
  21448. Test if this logger is going to log events of the specified <paramref name="level"/>.
  21449. </para>
  21450. <para>
  21451. This method must not throw any exception to the caller.
  21452. </para>
  21453. </remarks>
  21454. </member>
  21455. <member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)">
  21456. <summary>
  21457. Deliver the <see cref="T:log4net.Core.LoggingEvent"/> to the attached appenders.
  21458. </summary>
  21459. <param name="loggingEvent">The event to log.</param>
  21460. <remarks>
  21461. <para>
  21462. Call the appenders in the hierarchy starting at
  21463. <c>this</c>. If no appenders could be found, emit a
  21464. warning.
  21465. </para>
  21466. <para>
  21467. This method calls all the appenders inherited from the
  21468. hierarchy circumventing any evaluation of whether to log or not
  21469. to log the particular log request.
  21470. </para>
  21471. </remarks>
  21472. </member>
  21473. <member name="M:log4net.Repository.Hierarchy.Logger.CloseNestedAppenders">
  21474. <summary>
  21475. Closes all attached appenders implementing the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  21476. </summary>
  21477. <remarks>
  21478. <para>
  21479. Used to ensure that the appenders are correctly shutdown.
  21480. </para>
  21481. </remarks>
  21482. </member>
  21483. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.Level,System.Object,System.Exception)">
  21484. <summary>
  21485. This is the most generic printing method. This generic form is intended to be used by wrappers
  21486. </summary>
  21487. <param name="level">The level of the message to be logged.</param>
  21488. <param name="message">The message object to log.</param>
  21489. <param name="exception">The exception to log, including its stack trace.</param>
  21490. <remarks>
  21491. <para>
  21492. Generate a logging event for the specified <paramref name="level"/> using
  21493. the <paramref name="message"/>.
  21494. </para>
  21495. </remarks>
  21496. </member>
  21497. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  21498. <summary>
  21499. Creates a new logging event and logs the event without further checks.
  21500. </summary>
  21501. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  21502. the stack boundary into the logging system for this call.</param>
  21503. <param name="level">The level of the message to be logged.</param>
  21504. <param name="message">The message object to log.</param>
  21505. <param name="exception">The exception to log, including its stack trace.</param>
  21506. <remarks>
  21507. <para>
  21508. Generates a logging event and delivers it to the attached
  21509. appenders.
  21510. </para>
  21511. </remarks>
  21512. </member>
  21513. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(log4net.Core.LoggingEvent)">
  21514. <summary>
  21515. Creates a new logging event and logs the event without further checks.
  21516. </summary>
  21517. <param name="logEvent">The event being logged.</param>
  21518. <remarks>
  21519. <para>
  21520. Delivers the logging event to the attached appenders.
  21521. </para>
  21522. </remarks>
  21523. </member>
  21524. <member name="F:log4net.Repository.Hierarchy.Logger.declaringType">
  21525. <summary>
  21526. The fully qualified type of the Logger class.
  21527. </summary>
  21528. </member>
  21529. <member name="F:log4net.Repository.Hierarchy.Logger.m_name">
  21530. <summary>
  21531. The name of this logger.
  21532. </summary>
  21533. </member>
  21534. <member name="F:log4net.Repository.Hierarchy.Logger.m_level">
  21535. <summary>
  21536. The assigned level of this logger.
  21537. </summary>
  21538. <remarks>
  21539. <para>
  21540. The <c>level</c> variable need not be
  21541. assigned a value in which case it is inherited
  21542. form the hierarchy.
  21543. </para>
  21544. </remarks>
  21545. </member>
  21546. <member name="F:log4net.Repository.Hierarchy.Logger.m_parent">
  21547. <summary>
  21548. The parent of this logger.
  21549. </summary>
  21550. <remarks>
  21551. <para>
  21552. The parent of this logger.
  21553. All loggers have at least one ancestor which is the root logger.
  21554. </para>
  21555. </remarks>
  21556. </member>
  21557. <member name="F:log4net.Repository.Hierarchy.Logger.m_hierarchy">
  21558. <summary>
  21559. Loggers need to know what Hierarchy they are in.
  21560. </summary>
  21561. <remarks>
  21562. <para>
  21563. Loggers need to know what Hierarchy they are in.
  21564. The hierarchy that this logger is a member of is stored
  21565. here.
  21566. </para>
  21567. </remarks>
  21568. </member>
  21569. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderAttachedImpl">
  21570. <summary>
  21571. Helper implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  21572. </summary>
  21573. </member>
  21574. <member name="F:log4net.Repository.Hierarchy.Logger.m_additive">
  21575. <summary>
  21576. Flag indicating if child loggers inherit their parents appenders
  21577. </summary>
  21578. <remarks>
  21579. <para>
  21580. Additivity is set to true by default, that is children inherit
  21581. the appenders of their ancestors by default. If this variable is
  21582. set to <c>false</c> then the appenders found in the
  21583. ancestors of this logger are not used. However, the children
  21584. of this logger will inherit its appenders, unless the children
  21585. have their additivity flag set to <c>false</c> too. See
  21586. the user manual for more details.
  21587. </para>
  21588. </remarks>
  21589. </member>
  21590. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderLock">
  21591. <summary>
  21592. Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl
  21593. </summary>
  21594. </member>
  21595. <member name="P:log4net.Repository.Hierarchy.Logger.Parent">
  21596. <summary>
  21597. Gets or sets the parent logger in the hierarchy.
  21598. </summary>
  21599. <value>
  21600. The parent logger in the hierarchy.
  21601. </value>
  21602. <remarks>
  21603. <para>
  21604. Part of the Composite pattern that makes the hierarchy.
  21605. The hierarchy is parent linked rather than child linked.
  21606. </para>
  21607. </remarks>
  21608. </member>
  21609. <member name="P:log4net.Repository.Hierarchy.Logger.Additivity">
  21610. <summary>
  21611. Gets or sets a value indicating if child loggers inherit their parent's appenders.
  21612. </summary>
  21613. <value>
  21614. <c>true</c> if child loggers inherit their parent's appenders.
  21615. </value>
  21616. <remarks>
  21617. <para>
  21618. Additivity is set to <c>true</c> by default, that is children inherit
  21619. the appenders of their ancestors by default. If this variable is
  21620. set to <c>false</c> then the appenders found in the
  21621. ancestors of this logger are not used. However, the children
  21622. of this logger will inherit its appenders, unless the children
  21623. have their additivity flag set to <c>false</c> too. See
  21624. the user manual for more details.
  21625. </para>
  21626. </remarks>
  21627. </member>
  21628. <member name="P:log4net.Repository.Hierarchy.Logger.EffectiveLevel">
  21629. <summary>
  21630. Gets the effective level for this logger.
  21631. </summary>
  21632. <returns>The nearest level in the logger hierarchy.</returns>
  21633. <remarks>
  21634. <para>
  21635. Starting from this logger, searches the logger hierarchy for a
  21636. non-null level and returns it. Otherwise, returns the level of the
  21637. root logger.
  21638. </para>
  21639. <para>The Logger class is designed so that this method executes as
  21640. quickly as possible.</para>
  21641. </remarks>
  21642. </member>
  21643. <member name="P:log4net.Repository.Hierarchy.Logger.Hierarchy">
  21644. <summary>
  21645. Gets or sets the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> where this
  21646. <c>Logger</c> instance is attached to.
  21647. </summary>
  21648. <value>The hierarchy that this logger belongs to.</value>
  21649. <remarks>
  21650. <para>
  21651. This logger must be attached to a single <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  21652. </para>
  21653. </remarks>
  21654. </member>
  21655. <member name="P:log4net.Repository.Hierarchy.Logger.Level">
  21656. <summary>
  21657. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>, if any, for this Logger.
  21658. </summary>
  21659. <value>
  21660. The <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> of this logger.
  21661. </value>
  21662. <remarks>
  21663. <para>
  21664. The assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> can be <c>null</c>.
  21665. </para>
  21666. </remarks>
  21667. </member>
  21668. <member name="P:log4net.Repository.Hierarchy.Logger.Appenders">
  21669. <summary>
  21670. Get the appenders contained in this logger as an
  21671. <see cref="T:System.Collections.ICollection"/>.
  21672. </summary>
  21673. <returns>A collection of the appenders in this logger</returns>
  21674. <remarks>
  21675. <para>
  21676. Get the appenders contained in this logger as an
  21677. <see cref="T:System.Collections.ICollection"/>. If no appenders
  21678. can be found, then a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  21679. </para>
  21680. </remarks>
  21681. </member>
  21682. <member name="P:log4net.Repository.Hierarchy.Logger.Name">
  21683. <summary>
  21684. Gets the logger name.
  21685. </summary>
  21686. <value>
  21687. The name of the logger.
  21688. </value>
  21689. <remarks>
  21690. <para>
  21691. The name of this logger
  21692. </para>
  21693. </remarks>
  21694. </member>
  21695. <member name="P:log4net.Repository.Hierarchy.Logger.Repository">
  21696. <summary>
  21697. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  21698. <c>Logger</c> instance is attached to.
  21699. </summary>
  21700. <value>
  21701. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
  21702. </value>
  21703. <remarks>
  21704. <para>
  21705. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  21706. <c>Logger</c> instance is attached to.
  21707. </para>
  21708. </remarks>
  21709. </member>
  21710. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl.#ctor(System.String)">
  21711. <summary>
  21712. Construct a new Logger
  21713. </summary>
  21714. <param name="name">the name of the logger</param>
  21715. <remarks>
  21716. <para>
  21717. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl"/> class
  21718. with the specified name.
  21719. </para>
  21720. </remarks>
  21721. </member>
  21722. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventHandler">
  21723. <summary>
  21724. Delegate used to handle logger creation event notifications.
  21725. </summary>
  21726. <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>
  21727. <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>
  21728. <remarks>
  21729. <para>
  21730. Delegate used to handle logger creation event notifications.
  21731. </para>
  21732. </remarks>
  21733. </member>
  21734. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs">
  21735. <summary>
  21736. Provides data for the <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event.
  21737. </summary>
  21738. <remarks>
  21739. <para>
  21740. A <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event is raised every time a
  21741. <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> is created.
  21742. </para>
  21743. </remarks>
  21744. </member>
  21745. <member name="F:log4net.Repository.Hierarchy.LoggerCreationEventArgs.m_log">
  21746. <summary>
  21747. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> created
  21748. </summary>
  21749. </member>
  21750. <member name="M:log4net.Repository.Hierarchy.LoggerCreationEventArgs.#ctor(log4net.Repository.Hierarchy.Logger)">
  21751. <summary>
  21752. Constructor
  21753. </summary>
  21754. <param name="log">The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.</param>
  21755. <remarks>
  21756. <para>
  21757. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event argument
  21758. class,with the specified <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/>.
  21759. </para>
  21760. </remarks>
  21761. </member>
  21762. <member name="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger">
  21763. <summary>
  21764. Gets the <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  21765. </summary>
  21766. <value>
  21767. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  21768. </value>
  21769. <remarks>
  21770. <para>
  21771. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  21772. </para>
  21773. </remarks>
  21774. </member>
  21775. <member name="T:log4net.Repository.Hierarchy.Hierarchy">
  21776. <summary>
  21777. Hierarchical organization of loggers
  21778. </summary>
  21779. <remarks>
  21780. <para>
  21781. <i>The casual user should not have to deal with this class
  21782. directly.</i>
  21783. </para>
  21784. <para>
  21785. This class is specialized in retrieving loggers by name and
  21786. also maintaining the logger hierarchy. Implements the
  21787. <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21788. </para>
  21789. <para>
  21790. The structure of the logger hierarchy is maintained by the
  21791. <see cref="M:GetLogger(string)"/> method. The hierarchy is such that children
  21792. link to their parent but parents do not have any references to their
  21793. children. Moreover, loggers can be instantiated in any order, in
  21794. particular descendant before ancestor.
  21795. </para>
  21796. <para>
  21797. In case a descendant is created before a particular ancestor,
  21798. then it creates a provision node for the ancestor and adds itself
  21799. to the provision node. Other descendants of the same ancestor add
  21800. themselves to the previously created provision node.
  21801. </para>
  21802. </remarks>
  21803. <author>Nicko Cadell</author>
  21804. <author>Gert Driesen</author>
  21805. </member>
  21806. <member name="T:log4net.Repository.LoggerRepositorySkeleton">
  21807. <summary>
  21808. Base implementation of <see cref="T:log4net.Repository.ILoggerRepository"/>
  21809. </summary>
  21810. <remarks>
  21811. <para>
  21812. Default abstract implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21813. </para>
  21814. <para>
  21815. Skeleton implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21816. All <see cref="T:log4net.Repository.ILoggerRepository"/> types can extend this type.
  21817. </para>
  21818. </remarks>
  21819. <author>Nicko Cadell</author>
  21820. <author>Gert Driesen</author>
  21821. </member>
  21822. <member name="T:log4net.Repository.ILoggerRepository">
  21823. <summary>
  21824. Interface implemented by logger repositories.
  21825. </summary>
  21826. <remarks>
  21827. <para>
  21828. This interface is implemented by logger repositories. e.g.
  21829. <see cref="N:log4net.Repository.Hierarchy"/>.
  21830. </para>
  21831. <para>
  21832. This interface is used by the <see cref="T:log4net.LogManager"/>
  21833. to obtain <see cref="T:log4net.ILog"/> interfaces.
  21834. </para>
  21835. </remarks>
  21836. <author>Nicko Cadell</author>
  21837. <author>Gert Driesen</author>
  21838. </member>
  21839. <member name="M:log4net.Repository.ILoggerRepository.Exists(System.String)">
  21840. <summary>
  21841. Check if the named logger exists in the repository. If so return
  21842. its reference, otherwise returns <c>null</c>.
  21843. </summary>
  21844. <param name="name">The name of the logger to lookup</param>
  21845. <returns>The Logger object with the name specified</returns>
  21846. <remarks>
  21847. <para>
  21848. If the names logger exists it is returned, otherwise
  21849. <c>null</c> is returned.
  21850. </para>
  21851. </remarks>
  21852. </member>
  21853. <member name="M:log4net.Repository.ILoggerRepository.GetCurrentLoggers">
  21854. <summary>
  21855. Returns all the currently defined loggers as an Array.
  21856. </summary>
  21857. <returns>All the defined loggers</returns>
  21858. <remarks>
  21859. <para>
  21860. Returns all the currently defined loggers as an Array.
  21861. </para>
  21862. </remarks>
  21863. </member>
  21864. <member name="M:log4net.Repository.ILoggerRepository.GetLogger(System.String)">
  21865. <summary>
  21866. Returns a named logger instance
  21867. </summary>
  21868. <param name="name">The name of the logger to retrieve</param>
  21869. <returns>The logger object with the name specified</returns>
  21870. <remarks>
  21871. <para>
  21872. Returns a named logger instance.
  21873. </para>
  21874. <para>
  21875. If a logger of that name already exists, then it will be
  21876. returned. Otherwise, a new logger will be instantiated and
  21877. then linked with its existing ancestors as well as children.
  21878. </para>
  21879. </remarks>
  21880. </member>
  21881. <member name="M:log4net.Repository.ILoggerRepository.Shutdown">
  21882. <summary>Shutdown the repository</summary>
  21883. <remarks>
  21884. <para>
  21885. Shutting down a repository will <i>safely</i> close and remove
  21886. all appenders in all loggers including the root logger.
  21887. </para>
  21888. <para>
  21889. Some appenders need to be closed before the
  21890. application exists. Otherwise, pending logging events might be
  21891. lost.
  21892. </para>
  21893. <para>
  21894. The <see cref="M:Shutdown()"/> method is careful to close nested
  21895. appenders before closing regular appenders. This is allows
  21896. configurations where a regular appender is attached to a logger
  21897. and again to a nested appender.
  21898. </para>
  21899. </remarks>
  21900. </member>
  21901. <member name="M:log4net.Repository.ILoggerRepository.ResetConfiguration">
  21902. <summary>
  21903. Reset the repositories configuration to a default state
  21904. </summary>
  21905. <remarks>
  21906. <para>
  21907. Reset all values contained in this instance to their
  21908. default state.
  21909. </para>
  21910. <para>
  21911. Existing loggers are not removed. They are just reset.
  21912. </para>
  21913. <para>
  21914. This method should be used sparingly and with care as it will
  21915. block all logging until it is completed.
  21916. </para>
  21917. </remarks>
  21918. </member>
  21919. <member name="M:log4net.Repository.ILoggerRepository.Log(log4net.Core.LoggingEvent)">
  21920. <summary>
  21921. Log the <see cref="T:log4net.Core.LoggingEvent"/> through this repository.
  21922. </summary>
  21923. <param name="logEvent">the event to log</param>
  21924. <remarks>
  21925. <para>
  21926. This method should not normally be used to log.
  21927. The <see cref="T:log4net.ILog"/> interface should be used
  21928. for routine logging. This interface can be obtained
  21929. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  21930. </para>
  21931. <para>
  21932. The <c>logEvent</c> is delivered to the appropriate logger and
  21933. that logger is then responsible for logging the event.
  21934. </para>
  21935. </remarks>
  21936. </member>
  21937. <member name="M:log4net.Repository.ILoggerRepository.GetAppenders">
  21938. <summary>
  21939. Returns all the Appenders that are configured as an Array.
  21940. </summary>
  21941. <returns>All the Appenders</returns>
  21942. <remarks>
  21943. <para>
  21944. Returns all the Appenders that are configured as an Array.
  21945. </para>
  21946. </remarks>
  21947. </member>
  21948. <member name="P:log4net.Repository.ILoggerRepository.Name">
  21949. <summary>
  21950. The name of the repository
  21951. </summary>
  21952. <value>
  21953. The name of the repository
  21954. </value>
  21955. <remarks>
  21956. <para>
  21957. The name of the repository.
  21958. </para>
  21959. </remarks>
  21960. </member>
  21961. <member name="P:log4net.Repository.ILoggerRepository.RendererMap">
  21962. <summary>
  21963. RendererMap accesses the object renderer map for this repository.
  21964. </summary>
  21965. <value>
  21966. RendererMap accesses the object renderer map for this repository.
  21967. </value>
  21968. <remarks>
  21969. <para>
  21970. RendererMap accesses the object renderer map for this repository.
  21971. </para>
  21972. <para>
  21973. The RendererMap holds a mapping between types and
  21974. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  21975. </para>
  21976. </remarks>
  21977. </member>
  21978. <member name="P:log4net.Repository.ILoggerRepository.PluginMap">
  21979. <summary>
  21980. The plugin map for this repository.
  21981. </summary>
  21982. <value>
  21983. The plugin map for this repository.
  21984. </value>
  21985. <remarks>
  21986. <para>
  21987. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  21988. that have been attached to this repository.
  21989. </para>
  21990. </remarks>
  21991. </member>
  21992. <member name="P:log4net.Repository.ILoggerRepository.LevelMap">
  21993. <summary>
  21994. Get the level map for the Repository.
  21995. </summary>
  21996. <remarks>
  21997. <para>
  21998. Get the level map for the Repository.
  21999. </para>
  22000. <para>
  22001. The level map defines the mappings between
  22002. level names and <see cref="T:log4net.Core.Level"/> objects in
  22003. this repository.
  22004. </para>
  22005. </remarks>
  22006. </member>
  22007. <member name="P:log4net.Repository.ILoggerRepository.Threshold">
  22008. <summary>
  22009. The threshold for all events in this repository
  22010. </summary>
  22011. <value>
  22012. The threshold for all events in this repository
  22013. </value>
  22014. <remarks>
  22015. <para>
  22016. The threshold for all events in this repository.
  22017. </para>
  22018. </remarks>
  22019. </member>
  22020. <member name="P:log4net.Repository.ILoggerRepository.Configured">
  22021. <summary>
  22022. Flag indicates if this repository has been configured.
  22023. </summary>
  22024. <value>
  22025. Flag indicates if this repository has been configured.
  22026. </value>
  22027. <remarks>
  22028. <para>
  22029. Flag indicates if this repository has been configured.
  22030. </para>
  22031. </remarks>
  22032. </member>
  22033. <member name="P:log4net.Repository.ILoggerRepository.ConfigurationMessages">
  22034. <summary>
  22035. Collection of internal messages captured during the most
  22036. recent configuration process.
  22037. </summary>
  22038. </member>
  22039. <member name="E:log4net.Repository.ILoggerRepository.ShutdownEvent">
  22040. <summary>
  22041. Event to notify that the repository has been shutdown.
  22042. </summary>
  22043. <value>
  22044. Event to notify that the repository has been shutdown.
  22045. </value>
  22046. <remarks>
  22047. <para>
  22048. Event raised when the repository has been shutdown.
  22049. </para>
  22050. </remarks>
  22051. </member>
  22052. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationReset">
  22053. <summary>
  22054. Event to notify that the repository has had its configuration reset.
  22055. </summary>
  22056. <value>
  22057. Event to notify that the repository has had its configuration reset.
  22058. </value>
  22059. <remarks>
  22060. <para>
  22061. Event raised when the repository's configuration has been
  22062. reset to default.
  22063. </para>
  22064. </remarks>
  22065. </member>
  22066. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationChanged">
  22067. <summary>
  22068. Event to notify that the repository has had its configuration changed.
  22069. </summary>
  22070. <value>
  22071. Event to notify that the repository has had its configuration changed.
  22072. </value>
  22073. <remarks>
  22074. <para>
  22075. Event raised when the repository's configuration has been changed.
  22076. </para>
  22077. </remarks>
  22078. </member>
  22079. <member name="P:log4net.Repository.ILoggerRepository.Properties">
  22080. <summary>
  22081. Repository specific properties
  22082. </summary>
  22083. <value>
  22084. Repository specific properties
  22085. </value>
  22086. <remarks>
  22087. <para>
  22088. These properties can be specified on a repository specific basis.
  22089. </para>
  22090. </remarks>
  22091. </member>
  22092. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor">
  22093. <summary>
  22094. Default Constructor
  22095. </summary>
  22096. <remarks>
  22097. <para>
  22098. Initializes the repository with default (empty) properties.
  22099. </para>
  22100. </remarks>
  22101. </member>
  22102. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor(log4net.Util.PropertiesDictionary)">
  22103. <summary>
  22104. Construct the repository using specific properties
  22105. </summary>
  22106. <param name="properties">the properties to set for this repository</param>
  22107. <remarks>
  22108. <para>
  22109. Initializes the repository with specified properties.
  22110. </para>
  22111. </remarks>
  22112. </member>
  22113. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Exists(System.String)">
  22114. <summary>
  22115. Test if logger exists
  22116. </summary>
  22117. <param name="name">The name of the logger to lookup</param>
  22118. <returns>The Logger object with the name specified</returns>
  22119. <remarks>
  22120. <para>
  22121. Check if the named logger exists in the repository. If so return
  22122. its reference, otherwise returns <c>null</c>.
  22123. </para>
  22124. </remarks>
  22125. </member>
  22126. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetCurrentLoggers">
  22127. <summary>
  22128. Returns all the currently defined loggers in the repository
  22129. </summary>
  22130. <returns>All the defined loggers</returns>
  22131. <remarks>
  22132. <para>
  22133. Returns all the currently defined loggers in the repository as an Array.
  22134. </para>
  22135. </remarks>
  22136. </member>
  22137. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetLogger(System.String)">
  22138. <summary>
  22139. Return a new logger instance
  22140. </summary>
  22141. <param name="name">The name of the logger to retrieve</param>
  22142. <returns>The logger object with the name specified</returns>
  22143. <remarks>
  22144. <para>
  22145. Return a new logger instance.
  22146. </para>
  22147. <para>
  22148. If a logger of that name already exists, then it will be
  22149. returned. Otherwise, a new logger will be instantiated and
  22150. then linked with its existing ancestors as well as children.
  22151. </para>
  22152. </remarks>
  22153. </member>
  22154. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Shutdown">
  22155. <summary>
  22156. Shutdown the repository
  22157. </summary>
  22158. <remarks>
  22159. <para>
  22160. Shutdown the repository. Can be overridden in a subclass.
  22161. This base class implementation notifies the <see cref="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"/>
  22162. listeners and all attached plugins of the shutdown event.
  22163. </para>
  22164. </remarks>
  22165. </member>
  22166. <member name="M:log4net.Repository.LoggerRepositorySkeleton.ResetConfiguration">
  22167. <summary>
  22168. Reset the repositories configuration to a default state
  22169. </summary>
  22170. <remarks>
  22171. <para>
  22172. Reset all values contained in this instance to their
  22173. default state.
  22174. </para>
  22175. <para>
  22176. Existing loggers are not removed. They are just reset.
  22177. </para>
  22178. <para>
  22179. This method should be used sparingly and with care as it will
  22180. block all logging until it is completed.
  22181. </para>
  22182. </remarks>
  22183. </member>
  22184. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Log(log4net.Core.LoggingEvent)">
  22185. <summary>
  22186. Log the logEvent through this repository.
  22187. </summary>
  22188. <param name="logEvent">the event to log</param>
  22189. <remarks>
  22190. <para>
  22191. This method should not normally be used to log.
  22192. The <see cref="T:log4net.ILog"/> interface should be used
  22193. for routine logging. This interface can be obtained
  22194. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  22195. </para>
  22196. <para>
  22197. The <c>logEvent</c> is delivered to the appropriate logger and
  22198. that logger is then responsible for logging the event.
  22199. </para>
  22200. </remarks>
  22201. </member>
  22202. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetAppenders">
  22203. <summary>
  22204. Returns all the Appenders that are configured as an Array.
  22205. </summary>
  22206. <returns>All the Appenders</returns>
  22207. <remarks>
  22208. <para>
  22209. Returns all the Appenders that are configured as an Array.
  22210. </para>
  22211. </remarks>
  22212. </member>
  22213. <member name="F:log4net.Repository.LoggerRepositorySkeleton.declaringType">
  22214. <summary>
  22215. The fully qualified type of the LoggerRepositorySkeleton class.
  22216. </summary>
  22217. <remarks>
  22218. Used by the internal logger to record the Type of the
  22219. log message.
  22220. </remarks>
  22221. </member>
  22222. <member name="M:log4net.Repository.LoggerRepositorySkeleton.AddRenderer(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  22223. <summary>
  22224. Adds an object renderer for a specific class.
  22225. </summary>
  22226. <param name="typeToRender">The type that will be rendered by the renderer supplied.</param>
  22227. <param name="rendererInstance">The object renderer used to render the object.</param>
  22228. <remarks>
  22229. <para>
  22230. Adds an object renderer for a specific class.
  22231. </para>
  22232. </remarks>
  22233. </member>
  22234. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnShutdown(System.EventArgs)">
  22235. <summary>
  22236. Notify the registered listeners that the repository is shutting down
  22237. </summary>
  22238. <param name="e">Empty EventArgs</param>
  22239. <remarks>
  22240. <para>
  22241. Notify any listeners that this repository is shutting down.
  22242. </para>
  22243. </remarks>
  22244. </member>
  22245. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationReset(System.EventArgs)">
  22246. <summary>
  22247. Notify the registered listeners that the repository has had its configuration reset
  22248. </summary>
  22249. <param name="e">Empty EventArgs</param>
  22250. <remarks>
  22251. <para>
  22252. Notify any listeners that this repository's configuration has been reset.
  22253. </para>
  22254. </remarks>
  22255. </member>
  22256. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationChanged(System.EventArgs)">
  22257. <summary>
  22258. Notify the registered listeners that the repository has had its configuration changed
  22259. </summary>
  22260. <param name="e">Empty EventArgs</param>
  22261. <remarks>
  22262. <para>
  22263. Notify any listeners that this repository's configuration has changed.
  22264. </para>
  22265. </remarks>
  22266. </member>
  22267. <member name="M:log4net.Repository.LoggerRepositorySkeleton.RaiseConfigurationChanged(System.EventArgs)">
  22268. <summary>
  22269. Raise a configuration changed event on this repository
  22270. </summary>
  22271. <param name="e">EventArgs.Empty</param>
  22272. <remarks>
  22273. <para>
  22274. Applications that programmatically change the configuration of the repository should
  22275. raise this event notification to notify listeners.
  22276. </para>
  22277. </remarks>
  22278. </member>
  22279. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Flush(System.Int32)">
  22280. <summary>
  22281. Flushes all configured Appenders that implement <see cref="T:log4net.Appender.IFlushable"/>.
  22282. </summary>
  22283. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed,
  22284. or <see cref="F:System.Threading.Timeout.Infinite"/> to wait indefinitely.</param>
  22285. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  22286. </member>
  22287. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Name">
  22288. <summary>
  22289. The name of the repository
  22290. </summary>
  22291. <value>
  22292. The string name of the repository
  22293. </value>
  22294. <remarks>
  22295. <para>
  22296. The name of this repository. The name is
  22297. used to store and lookup the repositories
  22298. stored by the <see cref="T:log4net.Core.IRepositorySelector"/>.
  22299. </para>
  22300. </remarks>
  22301. </member>
  22302. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Threshold">
  22303. <summary>
  22304. The threshold for all events in this repository
  22305. </summary>
  22306. <value>
  22307. The threshold for all events in this repository
  22308. </value>
  22309. <remarks>
  22310. <para>
  22311. The threshold for all events in this repository
  22312. </para>
  22313. </remarks>
  22314. </member>
  22315. <member name="P:log4net.Repository.LoggerRepositorySkeleton.RendererMap">
  22316. <summary>
  22317. RendererMap accesses the object renderer map for this repository.
  22318. </summary>
  22319. <value>
  22320. RendererMap accesses the object renderer map for this repository.
  22321. </value>
  22322. <remarks>
  22323. <para>
  22324. RendererMap accesses the object renderer map for this repository.
  22325. </para>
  22326. <para>
  22327. The RendererMap holds a mapping between types and
  22328. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  22329. </para>
  22330. </remarks>
  22331. </member>
  22332. <member name="P:log4net.Repository.LoggerRepositorySkeleton.PluginMap">
  22333. <summary>
  22334. The plugin map for this repository.
  22335. </summary>
  22336. <value>
  22337. The plugin map for this repository.
  22338. </value>
  22339. <remarks>
  22340. <para>
  22341. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  22342. that have been attached to this repository.
  22343. </para>
  22344. </remarks>
  22345. </member>
  22346. <member name="P:log4net.Repository.LoggerRepositorySkeleton.LevelMap">
  22347. <summary>
  22348. Get the level map for the Repository.
  22349. </summary>
  22350. <remarks>
  22351. <para>
  22352. Get the level map for the Repository.
  22353. </para>
  22354. <para>
  22355. The level map defines the mappings between
  22356. level names and <see cref="T:log4net.Core.Level"/> objects in
  22357. this repository.
  22358. </para>
  22359. </remarks>
  22360. </member>
  22361. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Configured">
  22362. <summary>
  22363. Flag indicates if this repository has been configured.
  22364. </summary>
  22365. <value>
  22366. Flag indicates if this repository has been configured.
  22367. </value>
  22368. <remarks>
  22369. <para>
  22370. Flag indicates if this repository has been configured.
  22371. </para>
  22372. </remarks>
  22373. </member>
  22374. <member name="P:log4net.Repository.LoggerRepositorySkeleton.ConfigurationMessages">
  22375. <summary>
  22376. Contains a list of internal messages captures during the
  22377. last configuration.
  22378. </summary>
  22379. </member>
  22380. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent">
  22381. <summary>
  22382. Event to notify that the repository has been shutdown.
  22383. </summary>
  22384. <value>
  22385. Event to notify that the repository has been shutdown.
  22386. </value>
  22387. <remarks>
  22388. <para>
  22389. Event raised when the repository has been shutdown.
  22390. </para>
  22391. </remarks>
  22392. </member>
  22393. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationReset">
  22394. <summary>
  22395. Event to notify that the repository has had its configuration reset.
  22396. </summary>
  22397. <value>
  22398. Event to notify that the repository has had its configuration reset.
  22399. </value>
  22400. <remarks>
  22401. <para>
  22402. Event raised when the repository's configuration has been
  22403. reset to default.
  22404. </para>
  22405. </remarks>
  22406. </member>
  22407. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationChanged">
  22408. <summary>
  22409. Event to notify that the repository has had its configuration changed.
  22410. </summary>
  22411. <value>
  22412. Event to notify that the repository has had its configuration changed.
  22413. </value>
  22414. <remarks>
  22415. <para>
  22416. Event raised when the repository's configuration has been changed.
  22417. </para>
  22418. </remarks>
  22419. </member>
  22420. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Properties">
  22421. <summary>
  22422. Repository specific properties
  22423. </summary>
  22424. <value>
  22425. Repository specific properties
  22426. </value>
  22427. <remarks>
  22428. These properties can be specified on a repository specific basis
  22429. </remarks>
  22430. </member>
  22431. <member name="T:log4net.Repository.IBasicRepositoryConfigurator">
  22432. <summary>
  22433. Basic Configurator interface for repositories
  22434. </summary>
  22435. <remarks>
  22436. <para>
  22437. Interface used by basic configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>
  22438. with a default <see cref="T:log4net.Appender.IAppender"/>.
  22439. </para>
  22440. <para>
  22441. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  22442. configuration by the <see cref="T:log4net.Config.BasicConfigurator"/>.
  22443. </para>
  22444. </remarks>
  22445. <author>Nicko Cadell</author>
  22446. <author>Gert Driesen</author>
  22447. </member>
  22448. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender)">
  22449. <summary>
  22450. Initialize the repository using the specified appender
  22451. </summary>
  22452. <param name="appender">the appender to use to log all logging events</param>
  22453. <remarks>
  22454. <para>
  22455. Configure the repository to route all logging events to the
  22456. specified appender.
  22457. </para>
  22458. </remarks>
  22459. </member>
  22460. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender[])">
  22461. <summary>
  22462. Initialize the repository using the specified appenders
  22463. </summary>
  22464. <param name="appenders">the appenders to use to log all logging events</param>
  22465. <remarks>
  22466. <para>
  22467. Configure the repository to route all logging events to the
  22468. specified appenders.
  22469. </para>
  22470. </remarks>
  22471. </member>
  22472. <member name="T:log4net.Repository.IXmlRepositoryConfigurator">
  22473. <summary>
  22474. Configure repository using XML
  22475. </summary>
  22476. <remarks>
  22477. <para>
  22478. Interface used by Xml configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  22479. </para>
  22480. <para>
  22481. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  22482. configuration by the <see cref="T:log4net.Config.XmlConfigurator"/>.
  22483. </para>
  22484. </remarks>
  22485. <author>Nicko Cadell</author>
  22486. <author>Gert Driesen</author>
  22487. </member>
  22488. <member name="M:log4net.Repository.IXmlRepositoryConfigurator.Configure(System.Xml.XmlElement)">
  22489. <summary>
  22490. Initialize the repository using the specified config
  22491. </summary>
  22492. <param name="element">the element containing the root of the config</param>
  22493. <remarks>
  22494. <para>
  22495. The schema for the XML configuration data is defined by
  22496. the implementation.
  22497. </para>
  22498. </remarks>
  22499. </member>
  22500. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor">
  22501. <summary>
  22502. Default constructor
  22503. </summary>
  22504. <remarks>
  22505. <para>
  22506. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class.
  22507. </para>
  22508. </remarks>
  22509. </member>
  22510. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary)">
  22511. <summary>
  22512. Construct with properties
  22513. </summary>
  22514. <param name="properties">The properties to pass to this repository.</param>
  22515. <remarks>
  22516. <para>
  22517. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class.
  22518. </para>
  22519. </remarks>
  22520. </member>
  22521. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Repository.Hierarchy.ILoggerFactory)">
  22522. <summary>
  22523. Construct with a logger factory
  22524. </summary>
  22525. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  22526. <remarks>
  22527. <para>
  22528. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with
  22529. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>.
  22530. </para>
  22531. </remarks>
  22532. </member>
  22533. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary,log4net.Repository.Hierarchy.ILoggerFactory)">
  22534. <summary>
  22535. Construct with properties and a logger factory
  22536. </summary>
  22537. <param name="properties">The properties to pass to this repository.</param>
  22538. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  22539. <remarks>
  22540. <para>
  22541. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with
  22542. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>.
  22543. </para>
  22544. </remarks>
  22545. </member>
  22546. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Exists(System.String)">
  22547. <summary>
  22548. Test if a logger exists
  22549. </summary>
  22550. <param name="name">The name of the logger to lookup</param>
  22551. <returns>The Logger object with the name specified</returns>
  22552. <remarks>
  22553. <para>
  22554. Check if the named logger exists in the hierarchy. If so return
  22555. its reference, otherwise returns <c>null</c>.
  22556. </para>
  22557. </remarks>
  22558. </member>
  22559. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetCurrentLoggers">
  22560. <summary>
  22561. Returns all the currently defined loggers in the hierarchy as an Array
  22562. </summary>
  22563. <returns>All the defined loggers</returns>
  22564. <remarks>
  22565. <para>
  22566. Returns all the currently defined loggers in the hierarchy as an Array.
  22567. The root logger is <b>not</b> included in the returned
  22568. enumeration.
  22569. </para>
  22570. </remarks>
  22571. </member>
  22572. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String)">
  22573. <summary>
  22574. Return a new logger instance named as the first parameter using
  22575. the default factory.
  22576. </summary>
  22577. <remarks>
  22578. <para>
  22579. Return a new logger instance named as the first parameter using
  22580. the default factory.
  22581. </para>
  22582. <para>
  22583. If a logger of that name already exists, then it will be
  22584. returned. Otherwise, a new logger will be instantiated and
  22585. then linked with its existing ancestors as well as children.
  22586. </para>
  22587. </remarks>
  22588. <param name="name">The name of the logger to retrieve</param>
  22589. <returns>The logger object with the name specified</returns>
  22590. </member>
  22591. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Shutdown">
  22592. <summary>
  22593. Shutting down a hierarchy will <i>safely</i> close and remove
  22594. all appenders in all loggers including the root logger.
  22595. </summary>
  22596. <remarks>
  22597. <para>
  22598. Shutting down a hierarchy will <i>safely</i> close and remove
  22599. all appenders in all loggers including the root logger.
  22600. </para>
  22601. <para>
  22602. Some appenders need to be closed before the
  22603. application exists. Otherwise, pending logging events might be
  22604. lost.
  22605. </para>
  22606. <para>
  22607. The <c>Shutdown</c> method is careful to close nested
  22608. appenders before closing regular appenders. This is allows
  22609. configurations where a regular appender is attached to a logger
  22610. and again to a nested appender.
  22611. </para>
  22612. </remarks>
  22613. </member>
  22614. <member name="M:log4net.Repository.Hierarchy.Hierarchy.ResetConfiguration">
  22615. <summary>
  22616. Reset all values contained in this hierarchy instance to their default.
  22617. </summary>
  22618. <remarks>
  22619. <para>
  22620. Reset all values contained in this hierarchy instance to their
  22621. default. This removes all appenders from all loggers, sets
  22622. the level of all non-root loggers to <c>null</c>,
  22623. sets their additivity flag to <c>true</c> and sets the level
  22624. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  22625. message disabling is set its default "off" value.
  22626. </para>
  22627. <para>
  22628. Existing loggers are not removed. They are just reset.
  22629. </para>
  22630. <para>
  22631. This method should be used sparingly and with care as it will
  22632. block all logging until it is completed.
  22633. </para>
  22634. </remarks>
  22635. </member>
  22636. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Log(log4net.Core.LoggingEvent)">
  22637. <summary>
  22638. Log the logEvent through this hierarchy.
  22639. </summary>
  22640. <param name="logEvent">the event to log</param>
  22641. <remarks>
  22642. <para>
  22643. This method should not normally be used to log.
  22644. The <see cref="T:log4net.ILog"/> interface should be used
  22645. for routine logging. This interface can be obtained
  22646. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  22647. </para>
  22648. <para>
  22649. The <c>logEvent</c> is delivered to the appropriate logger and
  22650. that logger is then responsible for logging the event.
  22651. </para>
  22652. </remarks>
  22653. </member>
  22654. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetAppenders">
  22655. <summary>
  22656. Returns all the Appenders that are currently configured
  22657. </summary>
  22658. <returns>An array containing all the currently configured appenders</returns>
  22659. <remarks>
  22660. <para>
  22661. Returns all the <see cref="T:log4net.Appender.IAppender"/> instances that are currently configured.
  22662. All the loggers are searched for appenders. The appenders may also be containers
  22663. for appenders and these are also searched for additional loggers.
  22664. </para>
  22665. <para>
  22666. The list returned is unordered but does not contain duplicates.
  22667. </para>
  22668. </remarks>
  22669. </member>
  22670. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppender(System.Collections.ArrayList,log4net.Appender.IAppender)">
  22671. <summary>
  22672. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/>.
  22673. The appender may also be a container.
  22674. </summary>
  22675. <param name="appenderList"></param>
  22676. <param name="appender"></param>
  22677. </member>
  22678. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppenders(System.Collections.ArrayList,log4net.Core.IAppenderAttachable)">
  22679. <summary>
  22680. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/> container
  22681. </summary>
  22682. <param name="appenderList"></param>
  22683. <param name="container"></param>
  22684. </member>
  22685. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender)">
  22686. <summary>
  22687. Initialize the log4net system using the specified appender
  22688. </summary>
  22689. <param name="appender">the appender to use to log all logging events</param>
  22690. </member>
  22691. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender[])">
  22692. <summary>
  22693. Initialize the log4net system using the specified appenders
  22694. </summary>
  22695. <param name="appenders">the appenders to use to log all logging events</param>
  22696. </member>
  22697. <member name="M:log4net.Repository.Hierarchy.Hierarchy.BasicRepositoryConfigure(log4net.Appender.IAppender[])">
  22698. <summary>
  22699. Initialize the log4net system using the specified appenders
  22700. </summary>
  22701. <param name="appenders">the appenders to use to log all logging events</param>
  22702. <remarks>
  22703. <para>
  22704. This method provides the same functionality as the
  22705. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  22706. on this object, but it is protected and therefore can be called by subclasses.
  22707. </para>
  22708. </remarks>
  22709. </member>
  22710. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IXmlRepositoryConfigurator#Configure(System.Xml.XmlElement)">
  22711. <summary>
  22712. Initialize the log4net system using the specified config
  22713. </summary>
  22714. <param name="element">the element containing the root of the config</param>
  22715. </member>
  22716. <member name="M:log4net.Repository.Hierarchy.Hierarchy.XmlRepositoryConfigure(System.Xml.XmlElement)">
  22717. <summary>
  22718. Initialize the log4net system using the specified config
  22719. </summary>
  22720. <param name="element">the element containing the root of the config</param>
  22721. <remarks>
  22722. <para>
  22723. This method provides the same functionality as the
  22724. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  22725. on this object, but it is protected and therefore can be called by subclasses.
  22726. </para>
  22727. </remarks>
  22728. </member>
  22729. <member name="M:log4net.Repository.Hierarchy.Hierarchy.IsDisabled(log4net.Core.Level)">
  22730. <summary>
  22731. Test if this hierarchy is disabled for the specified <see cref="T:log4net.Core.Level"/>.
  22732. </summary>
  22733. <param name="level">The level to check against.</param>
  22734. <returns>
  22735. <c>true</c> if the repository is disabled for the level argument, <c>false</c> otherwise.
  22736. </returns>
  22737. <remarks>
  22738. <para>
  22739. If this hierarchy has not been configured then this method will
  22740. always return <c>true</c>.
  22741. </para>
  22742. <para>
  22743. This method will return <c>true</c> if this repository is
  22744. disabled for <c>level</c> object passed as parameter and
  22745. <c>false</c> otherwise.
  22746. </para>
  22747. <para>
  22748. See also the <see cref="P:log4net.Repository.ILoggerRepository.Threshold"/> property.
  22749. </para>
  22750. </remarks>
  22751. </member>
  22752. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Clear">
  22753. <summary>
  22754. Clear all logger definitions from the internal hashtable
  22755. </summary>
  22756. <remarks>
  22757. <para>
  22758. This call will clear all logger definitions from the internal
  22759. hashtable. Invoking this method will irrevocably mess up the
  22760. logger hierarchy.
  22761. </para>
  22762. <para>
  22763. You should <b>really</b> know what you are doing before
  22764. invoking this method.
  22765. </para>
  22766. </remarks>
  22767. </member>
  22768. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String,log4net.Repository.Hierarchy.ILoggerFactory)">
  22769. <summary>
  22770. Return a new logger instance named as the first parameter using
  22771. <paramref name="factory"/>.
  22772. </summary>
  22773. <param name="name">The name of the logger to retrieve</param>
  22774. <param name="factory">The factory that will make the new logger instance</param>
  22775. <returns>The logger object with the name specified</returns>
  22776. <remarks>
  22777. <para>
  22778. If a logger of that name already exists, then it will be
  22779. returned. Otherwise, a new logger will be instantiated by the
  22780. <paramref name="factory"/> parameter and linked with its existing
  22781. ancestors as well as children.
  22782. </para>
  22783. </remarks>
  22784. </member>
  22785. <member name="M:log4net.Repository.Hierarchy.Hierarchy.OnLoggerCreationEvent(log4net.Repository.Hierarchy.Logger)">
  22786. <summary>
  22787. Sends a logger creation event to all registered listeners
  22788. </summary>
  22789. <param name="logger">The newly created logger</param>
  22790. <remarks>
  22791. Raises the logger creation event.
  22792. </remarks>
  22793. </member>
  22794. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateParents(log4net.Repository.Hierarchy.Logger)">
  22795. <summary>
  22796. Updates all the parents of the specified logger
  22797. </summary>
  22798. <param name="log">The logger to update the parents for</param>
  22799. <remarks>
  22800. <para>
  22801. This method loops through all the <i>potential</i> parents of
  22802. <paramref name="log"/>. There 3 possible cases:
  22803. </para>
  22804. <list type="number">
  22805. <item>
  22806. <term>No entry for the potential parent of <paramref name="log"/> exists</term>
  22807. <description>
  22808. We create a ProvisionNode for this potential
  22809. parent and insert <paramref name="log"/> in that provision node.
  22810. </description>
  22811. </item>
  22812. <item>
  22813. <term>The entry is of type Logger for the potential parent.</term>
  22814. <description>
  22815. The entry is <paramref name="log"/>'s nearest existing parent. We
  22816. update <paramref name="log"/>'s parent field with this entry. We also break from
  22817. he loop because updating our parent's parent is our parent's
  22818. responsibility.
  22819. </description>
  22820. </item>
  22821. <item>
  22822. <term>The entry is of type ProvisionNode for this potential parent.</term>
  22823. <description>
  22824. We add <paramref name="log"/> to the list of children for this
  22825. potential parent.
  22826. </description>
  22827. </item>
  22828. </list>
  22829. </remarks>
  22830. </member>
  22831. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateChildren(log4net.Repository.Hierarchy.ProvisionNode,log4net.Repository.Hierarchy.Logger)">
  22832. <summary>
  22833. Replace a <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> with a <see cref="T:log4net.Repository.Hierarchy.Logger"/> in the hierarchy.
  22834. </summary>
  22835. <param name="pn"></param>
  22836. <param name="log"></param>
  22837. <remarks>
  22838. <para>
  22839. We update the links for all the children that placed themselves
  22840. in the provision node 'pn'. The second argument 'log' is a
  22841. reference for the newly created Logger, parent of all the
  22842. children in 'pn'.
  22843. </para>
  22844. <para>
  22845. We loop on all the children 'c' in 'pn'.
  22846. </para>
  22847. <para>
  22848. If the child 'c' has been already linked to a child of
  22849. 'log' then there is no need to update 'c'.
  22850. </para>
  22851. <para>
  22852. Otherwise, we set log's parent field to c's parent and set
  22853. c's parent field to log.
  22854. </para>
  22855. </remarks>
  22856. </member>
  22857. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddLevel(log4net.Repository.Hierarchy.Hierarchy.LevelEntry)">
  22858. <summary>
  22859. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22860. </summary>
  22861. <param name="levelEntry">the level values</param>
  22862. <remarks>
  22863. <para>
  22864. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22865. </para>
  22866. <para>
  22867. Supports setting levels via the configuration file.
  22868. </para>
  22869. </remarks>
  22870. </member>
  22871. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Util.PropertyEntry)">
  22872. <summary>
  22873. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22874. </summary>
  22875. <param name="propertyEntry">the property value</param>
  22876. <remarks>
  22877. <para>
  22878. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument.
  22879. </para>
  22880. <para>
  22881. Supports setting property values via the configuration file.
  22882. </para>
  22883. </remarks>
  22884. </member>
  22885. <member name="F:log4net.Repository.Hierarchy.Hierarchy.declaringType">
  22886. <summary>
  22887. The fully qualified type of the Hierarchy class.
  22888. </summary>
  22889. <remarks>
  22890. Used by the internal logger to record the Type of the
  22891. log message.
  22892. </remarks>
  22893. </member>
  22894. <member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent">
  22895. <summary>
  22896. Event used to notify that a logger has been created.
  22897. </summary>
  22898. <remarks>
  22899. <para>
  22900. Event raised when a logger is created.
  22901. </para>
  22902. </remarks>
  22903. </member>
  22904. <member name="P:log4net.Repository.Hierarchy.Hierarchy.EmittedNoAppenderWarning">
  22905. <summary>
  22906. Has no appender warning been emitted
  22907. </summary>
  22908. <remarks>
  22909. <para>
  22910. Flag to indicate if we have already issued a warning
  22911. about not having an appender warning.
  22912. </para>
  22913. </remarks>
  22914. </member>
  22915. <member name="P:log4net.Repository.Hierarchy.Hierarchy.Root">
  22916. <summary>
  22917. Get the root of this hierarchy
  22918. </summary>
  22919. <remarks>
  22920. <para>
  22921. Get the root of this hierarchy.
  22922. </para>
  22923. </remarks>
  22924. </member>
  22925. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LoggerFactory">
  22926. <summary>
  22927. Gets or sets the default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/> instance.
  22928. </summary>
  22929. <value>The default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/></value>
  22930. <remarks>
  22931. <para>
  22932. The logger factory is used to create logger instances.
  22933. </para>
  22934. </remarks>
  22935. </member>
  22936. <member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry">
  22937. <summary>
  22938. A class to hold the value, name and display name for a level
  22939. </summary>
  22940. <remarks>
  22941. <para>
  22942. A class to hold the value, name and display name for a level
  22943. </para>
  22944. </remarks>
  22945. </member>
  22946. <member name="M:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.ToString">
  22947. <summary>
  22948. Override <c>Object.ToString</c> to return sensible debug info
  22949. </summary>
  22950. <returns>string info about this object</returns>
  22951. </member>
  22952. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Value">
  22953. <summary>
  22954. Value of the level
  22955. </summary>
  22956. <remarks>
  22957. <para>
  22958. If the value is not set (defaults to -1) the value will be looked
  22959. up for the current level with the same name.
  22960. </para>
  22961. </remarks>
  22962. </member>
  22963. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Name">
  22964. <summary>
  22965. Name of the level
  22966. </summary>
  22967. <value>
  22968. The name of the level
  22969. </value>
  22970. <remarks>
  22971. <para>
  22972. The name of the level.
  22973. </para>
  22974. </remarks>
  22975. </member>
  22976. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.DisplayName">
  22977. <summary>
  22978. Display name for the level
  22979. </summary>
  22980. <value>
  22981. The display name of the level
  22982. </value>
  22983. <remarks>
  22984. <para>
  22985. The display name of the level.
  22986. </para>
  22987. </remarks>
  22988. </member>
  22989. <member name="T:log4net.Repository.Hierarchy.LoggerKey">
  22990. <summary>
  22991. Used internally to accelerate hash table searches.
  22992. </summary>
  22993. <remarks>
  22994. <para>
  22995. Internal class used to improve performance of
  22996. string keyed hashtables.
  22997. </para>
  22998. <para>
  22999. The hashcode of the string is cached for reuse.
  23000. The string is stored as an interned value.
  23001. When comparing two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> objects for equality
  23002. the reference equality of the interned strings is compared.
  23003. </para>
  23004. </remarks>
  23005. <author>Nicko Cadell</author>
  23006. <author>Gert Driesen</author>
  23007. </member>
  23008. <member name="M:log4net.Repository.Hierarchy.LoggerKey.#ctor(System.String)">
  23009. <summary>
  23010. Construct key with string name
  23011. </summary>
  23012. <remarks>
  23013. <para>
  23014. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> class
  23015. with the specified name.
  23016. </para>
  23017. <para>
  23018. Stores the hashcode of the string and interns
  23019. the string key to optimize comparisons.
  23020. </para>
  23021. <note>
  23022. The Compact Framework 1.0 the <see cref="M:System.String.Intern(System.String)"/>
  23023. method does not work. On the Compact Framework
  23024. the string keys are not interned nor are they
  23025. compared by reference.
  23026. </note>
  23027. </remarks>
  23028. <param name="name">The name of the logger.</param>
  23029. </member>
  23030. <member name="M:log4net.Repository.Hierarchy.LoggerKey.GetHashCode">
  23031. <summary>
  23032. Returns a hash code for the current instance.
  23033. </summary>
  23034. <returns>A hash code for the current instance.</returns>
  23035. <remarks>
  23036. <para>
  23037. Returns the cached hashcode.
  23038. </para>
  23039. </remarks>
  23040. </member>
  23041. <member name="M:log4net.Repository.Hierarchy.LoggerKey.Equals(System.Object)">
  23042. <summary>
  23043. Determines whether two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> instances
  23044. are equal.
  23045. </summary>
  23046. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>.</param>
  23047. <returns>
  23048. <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>.
  23049. </returns>
  23050. <remarks>
  23051. <para>
  23052. Compares the references of the interned strings.
  23053. </para>
  23054. </remarks>
  23055. </member>
  23056. <member name="T:log4net.Repository.Hierarchy.ProvisionNode">
  23057. <summary>
  23058. Provision nodes are used where no logger instance has been specified
  23059. </summary>
  23060. <remarks>
  23061. <para>
  23062. <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> instances are used in the
  23063. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> when there is no specified
  23064. <see cref="T:log4net.Repository.Hierarchy.Logger"/> for that node.
  23065. </para>
  23066. <para>
  23067. A provision node holds a list of child loggers on behalf of
  23068. a logger that does not exist.
  23069. </para>
  23070. </remarks>
  23071. <author>Nicko Cadell</author>
  23072. <author>Gert Driesen</author>
  23073. </member>
  23074. <member name="M:log4net.Repository.Hierarchy.ProvisionNode.#ctor(log4net.Repository.Hierarchy.Logger)">
  23075. <summary>
  23076. Create a new provision node with child node
  23077. </summary>
  23078. <param name="log">A child logger to add to this node.</param>
  23079. <remarks>
  23080. <para>
  23081. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> class
  23082. with the specified child logger.
  23083. </para>
  23084. </remarks>
  23085. </member>
  23086. <member name="T:log4net.Repository.Hierarchy.RootLogger">
  23087. <summary>
  23088. The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> sits at the root of the logger hierarchy tree.
  23089. </summary>
  23090. <remarks>
  23091. <para>
  23092. The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> is a regular <see cref="T:log4net.Repository.Hierarchy.Logger"/> except
  23093. that it provides several guarantees.
  23094. </para>
  23095. <para>
  23096. First, it cannot be assigned a <c>null</c>
  23097. level. Second, since the root logger cannot have a parent, the
  23098. <see cref="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"/> property always returns the value of the
  23099. level field without walking the hierarchy.
  23100. </para>
  23101. </remarks>
  23102. <author>Nicko Cadell</author>
  23103. <author>Gert Driesen</author>
  23104. </member>
  23105. <member name="M:log4net.Repository.Hierarchy.RootLogger.#ctor(log4net.Core.Level)">
  23106. <summary>
  23107. Construct a <see cref="T:log4net.Repository.Hierarchy.RootLogger"/>
  23108. </summary>
  23109. <param name="level">The level to assign to the root logger.</param>
  23110. <remarks>
  23111. <para>
  23112. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> class with
  23113. the specified logging level.
  23114. </para>
  23115. <para>
  23116. The root logger names itself as "root". However, the root
  23117. logger cannot be retrieved by name.
  23118. </para>
  23119. </remarks>
  23120. </member>
  23121. <member name="F:log4net.Repository.Hierarchy.RootLogger.declaringType">
  23122. <summary>
  23123. The fully qualified type of the RootLogger class.
  23124. </summary>
  23125. <remarks>
  23126. Used by the internal logger to record the Type of the
  23127. log message.
  23128. </remarks>
  23129. </member>
  23130. <member name="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel">
  23131. <summary>
  23132. Gets the assigned level value without walking the logger hierarchy.
  23133. </summary>
  23134. <value>The assigned level value without walking the logger hierarchy.</value>
  23135. <remarks>
  23136. <para>
  23137. Because the root logger cannot have a parent and its level
  23138. must not be <c>null</c> this property just returns the
  23139. value of <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>.
  23140. </para>
  23141. </remarks>
  23142. </member>
  23143. <member name="P:log4net.Repository.Hierarchy.RootLogger.Level">
  23144. <summary>
  23145. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> for the root logger.
  23146. </summary>
  23147. <value>
  23148. The <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> of the root logger.
  23149. </value>
  23150. <remarks>
  23151. <para>
  23152. Setting the level of the root logger to a <c>null</c> reference
  23153. may have catastrophic results. We prevent this here.
  23154. </para>
  23155. </remarks>
  23156. </member>
  23157. <member name="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator">
  23158. <summary>
  23159. Initializes the log4net environment using an XML DOM.
  23160. </summary>
  23161. <remarks>
  23162. <para>
  23163. Configures a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> using an XML DOM.
  23164. </para>
  23165. </remarks>
  23166. <author>Nicko Cadell</author>
  23167. <author>Gert Driesen</author>
  23168. </member>
  23169. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.#ctor(log4net.Repository.Hierarchy.Hierarchy)">
  23170. <summary>
  23171. Construct the configurator for a hierarchy
  23172. </summary>
  23173. <param name="hierarchy">The hierarchy to build.</param>
  23174. <remarks>
  23175. <para>
  23176. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator"/> class
  23177. with the specified <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  23178. </para>
  23179. </remarks>
  23180. </member>
  23181. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.Configure(System.Xml.XmlElement)">
  23182. <summary>
  23183. Configure the hierarchy by parsing a DOM tree of XML elements.
  23184. </summary>
  23185. <param name="element">The root element to parse.</param>
  23186. <remarks>
  23187. <para>
  23188. Configure the hierarchy by parsing a DOM tree of XML elements.
  23189. </para>
  23190. </remarks>
  23191. </member>
  23192. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindAppenderByReference(System.Xml.XmlElement)">
  23193. <summary>
  23194. Parse appenders by IDREF.
  23195. </summary>
  23196. <param name="appenderRef">The appender ref element.</param>
  23197. <returns>The instance of the appender that the ref refers to.</returns>
  23198. <remarks>
  23199. <para>
  23200. Parse an XML element that represents an appender and return
  23201. the appender.
  23202. </para>
  23203. </remarks>
  23204. </member>
  23205. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseAppender(System.Xml.XmlElement)">
  23206. <summary>
  23207. Parses an appender element.
  23208. </summary>
  23209. <param name="appenderElement">The appender element.</param>
  23210. <returns>The appender instance or <c>null</c> when parsing failed.</returns>
  23211. <remarks>
  23212. <para>
  23213. Parse an XML element that represents an appender and return
  23214. the appender instance.
  23215. </para>
  23216. </remarks>
  23217. </member>
  23218. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLogger(System.Xml.XmlElement)">
  23219. <summary>
  23220. Parses a logger element.
  23221. </summary>
  23222. <param name="loggerElement">The logger element.</param>
  23223. <remarks>
  23224. <para>
  23225. Parse an XML element that represents a logger.
  23226. </para>
  23227. </remarks>
  23228. </member>
  23229. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRoot(System.Xml.XmlElement)">
  23230. <summary>
  23231. Parses the root logger element.
  23232. </summary>
  23233. <param name="rootElement">The root element.</param>
  23234. <remarks>
  23235. <para>
  23236. Parse an XML element that represents the root logger.
  23237. </para>
  23238. </remarks>
  23239. </member>
  23240. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseChildrenOfLoggerElement(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  23241. <summary>
  23242. Parses the children of a logger element.
  23243. </summary>
  23244. <param name="catElement">The category element.</param>
  23245. <param name="log">The logger instance.</param>
  23246. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  23247. <remarks>
  23248. <para>
  23249. Parse the child elements of a &lt;logger&gt; element.
  23250. </para>
  23251. </remarks>
  23252. </member>
  23253. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRenderer(System.Xml.XmlElement)">
  23254. <summary>
  23255. Parses an object renderer.
  23256. </summary>
  23257. <param name="element">The renderer element.</param>
  23258. <remarks>
  23259. <para>
  23260. Parse an XML element that represents a renderer.
  23261. </para>
  23262. </remarks>
  23263. </member>
  23264. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLevel(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  23265. <summary>
  23266. Parses a level element.
  23267. </summary>
  23268. <param name="element">The level element.</param>
  23269. <param name="log">The logger object to set the level on.</param>
  23270. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  23271. <remarks>
  23272. <para>
  23273. Parse an XML element that represents a level.
  23274. </para>
  23275. </remarks>
  23276. </member>
  23277. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.SetParameter(System.Xml.XmlElement,System.Object)">
  23278. <summary>
  23279. Sets a parameter on an object.
  23280. </summary>
  23281. <param name="element">The parameter element.</param>
  23282. <param name="target">The object to set the parameter on.</param>
  23283. <remarks>
  23284. The parameter name must correspond to a writable property
  23285. on the object. The value of the parameter is a string,
  23286. therefore this function will attempt to set a string
  23287. property first. If unable to set a string property it
  23288. will inspect the property and its argument type. It will
  23289. attempt to call a static method called <c>Parse</c> on the
  23290. type of the property. This method will take a single
  23291. string argument and return a value that can be used to
  23292. set the property.
  23293. </remarks>
  23294. </member>
  23295. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)">
  23296. <summary>
  23297. Test if an element has no attributes or child elements
  23298. </summary>
  23299. <param name="element">the element to inspect</param>
  23300. <returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns>
  23301. </member>
  23302. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)">
  23303. <summary>
  23304. Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>.
  23305. </summary>
  23306. <param name="type">the type to inspect</param>
  23307. <returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns>
  23308. </member>
  23309. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)">
  23310. <summary>
  23311. Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied
  23312. </summary>
  23313. <param name="targetType">the type that has the method</param>
  23314. <param name="name">the name of the method</param>
  23315. <returns>the method info found</returns>
  23316. <remarks>
  23317. <para>
  23318. The method must be a public instance method on the <paramref name="targetType"/>.
  23319. The method must be named <paramref name="name"/> or "Add" followed by <paramref name="name"/>.
  23320. The method must take a single parameter.
  23321. </para>
  23322. </remarks>
  23323. </member>
  23324. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ConvertStringTo(System.Type,System.String)">
  23325. <summary>
  23326. Converts a string value to a target type.
  23327. </summary>
  23328. <param name="type">The type of object to convert the string to.</param>
  23329. <param name="value">The string value to use as the value of the object.</param>
  23330. <returns>
  23331. <para>
  23332. An object of type <paramref name="type"/> with value <paramref name="value"/> or
  23333. <c>null</c> when the conversion could not be performed.
  23334. </para>
  23335. </returns>
  23336. </member>
  23337. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.CreateObjectFromXml(System.Xml.XmlElement,System.Type,System.Type)">
  23338. <summary>
  23339. Creates an object as specified in XML.
  23340. </summary>
  23341. <param name="element">The XML element that contains the definition of the object.</param>
  23342. <param name="defaultTargetType">The object type to use if not explicitly specified.</param>
  23343. <param name="typeConstraint">The type that the returned object must be or must inherit from.</param>
  23344. <returns>The object or <c>null</c></returns>
  23345. <remarks>
  23346. <para>
  23347. Parse an XML element and create an object instance based on the configuration
  23348. data.
  23349. </para>
  23350. <para>
  23351. The type of the instance may be specified in the XML. If not
  23352. specified then the <paramref name="defaultTargetType"/> is used
  23353. as the type. However the type is specified it must support the
  23354. <paramref name="typeConstraint"/> type.
  23355. </para>
  23356. </remarks>
  23357. </member>
  23358. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_appenderBag">
  23359. <summary>
  23360. key: appenderName, value: appender.
  23361. </summary>
  23362. </member>
  23363. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_hierarchy">
  23364. <summary>
  23365. The Hierarchy being configured.
  23366. </summary>
  23367. </member>
  23368. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.declaringType">
  23369. <summary>
  23370. The fully qualified type of the XmlHierarchyConfigurator class.
  23371. </summary>
  23372. <remarks>
  23373. Used by the internal logger to record the Type of the
  23374. log message.
  23375. </remarks>
  23376. </member>
  23377. <member name="T:log4net.Repository.ConfigurationChangedEventArgs">
  23378. <summary>
  23379. </summary>
  23380. </member>
  23381. <member name="M:log4net.Repository.ConfigurationChangedEventArgs.#ctor(System.Collections.ICollection)">
  23382. <summary>
  23383. </summary>
  23384. <param name="configurationMessages"></param>
  23385. </member>
  23386. <member name="P:log4net.Repository.ConfigurationChangedEventArgs.ConfigurationMessages">
  23387. <summary>
  23388. </summary>
  23389. </member>
  23390. <member name="T:log4net.Repository.LoggerRepositoryShutdownEventHandler">
  23391. <summary>
  23392. Delegate used to handle logger repository shutdown event notifications
  23393. </summary>
  23394. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down.</param>
  23395. <param name="e">Empty event args</param>
  23396. <remarks>
  23397. <para>
  23398. Delegate used to handle logger repository shutdown event notifications.
  23399. </para>
  23400. </remarks>
  23401. </member>
  23402. <member name="T:log4net.Repository.LoggerRepositoryConfigurationResetEventHandler">
  23403. <summary>
  23404. Delegate used to handle logger repository configuration reset event notifications
  23405. </summary>
  23406. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration reset.</param>
  23407. <param name="e">Empty event args</param>
  23408. <remarks>
  23409. <para>
  23410. Delegate used to handle logger repository configuration reset event notifications.
  23411. </para>
  23412. </remarks>
  23413. </member>
  23414. <member name="T:log4net.Repository.LoggerRepositoryConfigurationChangedEventHandler">
  23415. <summary>
  23416. Delegate used to handle event notifications for logger repository configuration changes.
  23417. </summary>
  23418. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration changed.</param>
  23419. <param name="e">Empty event arguments.</param>
  23420. <remarks>
  23421. <para>
  23422. Delegate used to handle event notifications for logger repository configuration changes.
  23423. </para>
  23424. </remarks>
  23425. </member>
  23426. <member name="T:log4net.Util.PatternStringConverters.AppDomainPatternConverter">
  23427. <summary>
  23428. Write the name of the current AppDomain to the output
  23429. </summary>
  23430. <remarks>
  23431. <para>
  23432. Write the name of the current AppDomain to the output writer
  23433. </para>
  23434. </remarks>
  23435. <author>Nicko Cadell</author>
  23436. </member>
  23437. <member name="M:log4net.Util.PatternStringConverters.AppDomainPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23438. <summary>
  23439. Write the name of the current AppDomain to the output
  23440. </summary>
  23441. <param name="writer">the writer to write to</param>
  23442. <param name="state">null, state is not set</param>
  23443. <remarks>
  23444. <para>
  23445. Writes name of the current AppDomain to the output <paramref name="writer"/>.
  23446. </para>
  23447. </remarks>
  23448. </member>
  23449. <member name="T:log4net.Util.PatternStringConverters.AppSettingPatternConverter">
  23450. <summary>
  23451. AppSetting pattern converter
  23452. </summary>
  23453. <remarks>
  23454. <para>
  23455. This pattern converter reads appSettings from the application configuration file.
  23456. </para>
  23457. <para>
  23458. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  23459. lookup a single appSettings value. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  23460. then all appSettings will be dumped as a list of key value pairs.
  23461. </para>
  23462. <para>
  23463. A typical use is to specify a base directory for log files, e.g.
  23464. <example>
  23465. <![CDATA[
  23466. <log4net>
  23467. <appender name="MyAppender" type="log4net.Appender.RollingFileAppender">
  23468. <file type="log4net.Util.PatternString" value="appsetting{LogDirectory}MyApp.log"/>
  23469. ...
  23470. </appender>
  23471. </log4net>
  23472. ]]>
  23473. </example>
  23474. </para>
  23475. </remarks>
  23476. </member>
  23477. <member name="M:log4net.Util.PatternStringConverters.AppSettingPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23478. <summary>
  23479. Write the property value to the output
  23480. </summary>
  23481. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23482. <param name="state">null, state is not set</param>
  23483. <remarks>
  23484. <para>
  23485. Writes out the value of a named property. The property name
  23486. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23487. property.
  23488. </para>
  23489. <para>
  23490. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  23491. then all the properties are written as key value pairs.
  23492. </para>
  23493. </remarks>
  23494. </member>
  23495. <member name="T:log4net.Util.PatternStringConverters.DatePatternConverter">
  23496. <summary>
  23497. Write the current date to the output
  23498. </summary>
  23499. <remarks>
  23500. <para>
  23501. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  23502. the current date and time to the writer as a string.
  23503. </para>
  23504. <para>
  23505. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  23506. the formatting of the date. The following values are allowed:
  23507. <list type="definition">
  23508. <listheader>
  23509. <term>Option value</term>
  23510. <description>Output</description>
  23511. </listheader>
  23512. <item>
  23513. <term>ISO8601</term>
  23514. <description>
  23515. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  23516. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  23517. </description>
  23518. </item>
  23519. <item>
  23520. <term>DATE</term>
  23521. <description>
  23522. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  23523. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  23524. </description>
  23525. </item>
  23526. <item>
  23527. <term>ABSOLUTE</term>
  23528. <description>
  23529. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  23530. Formats using the <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  23531. </description>
  23532. </item>
  23533. <item>
  23534. <term>other</term>
  23535. <description>
  23536. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  23537. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  23538. <see cref="M:DateTime.ToString(string)"/> method.
  23539. For details on valid patterns see
  23540. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  23541. </description>
  23542. </item>
  23543. </list>
  23544. </para>
  23545. <para>
  23546. The date and time is in the local time zone and is rendered in that zone.
  23547. To output the time in Universal time see <see cref="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"/>.
  23548. </para>
  23549. </remarks>
  23550. <author>Nicko Cadell</author>
  23551. </member>
  23552. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.m_dateFormatter">
  23553. <summary>
  23554. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  23555. </summary>
  23556. <remarks>
  23557. <para>
  23558. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  23559. </para>
  23560. </remarks>
  23561. </member>
  23562. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions">
  23563. <summary>
  23564. Initialize the converter options
  23565. </summary>
  23566. <remarks>
  23567. <para>
  23568. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  23569. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> method must
  23570. be called on this object after the configuration properties have
  23571. been set. Until <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> is called this
  23572. object is in an undefined state and must not be used.
  23573. </para>
  23574. <para>
  23575. If any of the configuration properties are modified then
  23576. <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> must be called again.
  23577. </para>
  23578. </remarks>
  23579. </member>
  23580. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23581. <summary>
  23582. Write the current date to the output
  23583. </summary>
  23584. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23585. <param name="state">null, state is not set</param>
  23586. <remarks>
  23587. <para>
  23588. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  23589. for it to render it to the writer.
  23590. </para>
  23591. <para>
  23592. The date and time passed is in the local time zone.
  23593. </para>
  23594. </remarks>
  23595. </member>
  23596. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.declaringType">
  23597. <summary>
  23598. The fully qualified type of the DatePatternConverter class.
  23599. </summary>
  23600. <remarks>
  23601. Used by the internal logger to record the Type of the
  23602. log message.
  23603. </remarks>
  23604. </member>
  23605. <member name="T:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter">
  23606. <summary>
  23607. Write an <see cref="T:System.Environment.SpecialFolder"/> folder path to the output
  23608. </summary>
  23609. <remarks>
  23610. <para>
  23611. Write an special path environment folder path to the output writer.
  23612. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  23613. the name of the variable to output. <see cref="P:log4net.Util.PatternConverter.Option"/>
  23614. should be a value in the <see cref="T:System.Environment.SpecialFolder"/> enumeration.
  23615. </para>
  23616. </remarks>
  23617. <author>Ron Grabowski</author>
  23618. </member>
  23619. <member name="M:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23620. <summary>
  23621. Write an special path environment folder path to the output
  23622. </summary>
  23623. <param name="writer">the writer to write to</param>
  23624. <param name="state">null, state is not set</param>
  23625. <remarks>
  23626. <para>
  23627. Writes the special path environment folder path to the output <paramref name="writer"/>.
  23628. The name of the special path environment folder path to output must be set
  23629. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23630. property.
  23631. </para>
  23632. </remarks>
  23633. </member>
  23634. <member name="F:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.declaringType">
  23635. <summary>
  23636. The fully qualified type of the EnvironmentFolderPathPatternConverter class.
  23637. </summary>
  23638. <remarks>
  23639. Used by the internal logger to record the Type of the
  23640. log message.
  23641. </remarks>
  23642. </member>
  23643. <member name="T:log4net.Util.PatternStringConverters.EnvironmentPatternConverter">
  23644. <summary>
  23645. Write an environment variable to the output
  23646. </summary>
  23647. <remarks>
  23648. <para>
  23649. Write an environment variable to the output writer.
  23650. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  23651. the name of the variable to output.
  23652. </para>
  23653. </remarks>
  23654. <author>Nicko Cadell</author>
  23655. </member>
  23656. <member name="M:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23657. <summary>
  23658. Write an environment variable to the output
  23659. </summary>
  23660. <param name="writer">the writer to write to</param>
  23661. <param name="state">null, state is not set</param>
  23662. <remarks>
  23663. <para>
  23664. Writes the environment variable to the output <paramref name="writer"/>.
  23665. The name of the environment variable to output must be set
  23666. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23667. property.
  23668. </para>
  23669. </remarks>
  23670. </member>
  23671. <member name="F:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.declaringType">
  23672. <summary>
  23673. The fully qualified type of the EnvironmentPatternConverter class.
  23674. </summary>
  23675. <remarks>
  23676. Used by the internal logger to record the Type of the
  23677. log message.
  23678. </remarks>
  23679. </member>
  23680. <member name="T:log4net.Util.PatternStringConverters.IdentityPatternConverter">
  23681. <summary>
  23682. Write the current thread identity to the output
  23683. </summary>
  23684. <remarks>
  23685. <para>
  23686. Write the current thread identity to the output writer
  23687. </para>
  23688. </remarks>
  23689. <author>Nicko Cadell</author>
  23690. </member>
  23691. <member name="M:log4net.Util.PatternStringConverters.IdentityPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23692. <summary>
  23693. Write the current thread identity to the output
  23694. </summary>
  23695. <param name="writer">the writer to write to</param>
  23696. <param name="state">null, state is not set</param>
  23697. <remarks>
  23698. <para>
  23699. Writes the current thread identity to the output <paramref name="writer"/>.
  23700. </para>
  23701. </remarks>
  23702. </member>
  23703. <member name="F:log4net.Util.PatternStringConverters.IdentityPatternConverter.declaringType">
  23704. <summary>
  23705. The fully qualified type of the IdentityPatternConverter class.
  23706. </summary>
  23707. <remarks>
  23708. Used by the internal logger to record the Type of the
  23709. log message.
  23710. </remarks>
  23711. </member>
  23712. <member name="T:log4net.Util.PatternStringConverters.LiteralPatternConverter">
  23713. <summary>
  23714. Pattern converter for literal string instances in the pattern
  23715. </summary>
  23716. <remarks>
  23717. <para>
  23718. Writes the literal string value specified in the
  23719. <see cref="P:log4net.Util.PatternConverter.Option"/> property to
  23720. the output.
  23721. </para>
  23722. </remarks>
  23723. <author>Nicko Cadell</author>
  23724. </member>
  23725. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.SetNext(log4net.Util.PatternConverter)">
  23726. <summary>
  23727. Set the next converter in the chain
  23728. </summary>
  23729. <param name="pc">The next pattern converter in the chain</param>
  23730. <returns>The next pattern converter</returns>
  23731. <remarks>
  23732. <para>
  23733. Special case the building of the pattern converter chain
  23734. for <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> instances. Two adjacent
  23735. literals in the pattern can be represented by a single combined
  23736. pattern converter. This implementation detects when a
  23737. <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> is added to the chain
  23738. after this converter and combines its value with this converter's
  23739. literal value.
  23740. </para>
  23741. </remarks>
  23742. </member>
  23743. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Format(System.IO.TextWriter,System.Object)">
  23744. <summary>
  23745. Write the literal to the output
  23746. </summary>
  23747. <param name="writer">the writer to write to</param>
  23748. <param name="state">null, not set</param>
  23749. <remarks>
  23750. <para>
  23751. Override the formatting behavior to ignore the FormattingInfo
  23752. because we have a literal instead.
  23753. </para>
  23754. <para>
  23755. Writes the value of <see cref="P:log4net.Util.PatternConverter.Option"/>
  23756. to the output <paramref name="writer"/>.
  23757. </para>
  23758. </remarks>
  23759. </member>
  23760. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23761. <summary>
  23762. Convert this pattern into the rendered message
  23763. </summary>
  23764. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23765. <param name="state">null, not set</param>
  23766. <remarks>
  23767. <para>
  23768. This method is not used.
  23769. </para>
  23770. </remarks>
  23771. </member>
  23772. <member name="T:log4net.Util.PatternStringConverters.NewLinePatternConverter">
  23773. <summary>
  23774. Writes a newline to the output
  23775. </summary>
  23776. <remarks>
  23777. <para>
  23778. Writes the system dependent line terminator to the output.
  23779. This behavior can be overridden by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>:
  23780. </para>
  23781. <list type="definition">
  23782. <listheader>
  23783. <term>Option Value</term>
  23784. <description>Output</description>
  23785. </listheader>
  23786. <item>
  23787. <term>DOS</term>
  23788. <description>DOS or Windows line terminator <c>"\r\n"</c></description>
  23789. </item>
  23790. <item>
  23791. <term>UNIX</term>
  23792. <description>UNIX line terminator <c>"\n"</c></description>
  23793. </item>
  23794. </list>
  23795. </remarks>
  23796. <author>Nicko Cadell</author>
  23797. </member>
  23798. <member name="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions">
  23799. <summary>
  23800. Initialize the converter
  23801. </summary>
  23802. <remarks>
  23803. <para>
  23804. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  23805. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> method must
  23806. be called on this object after the configuration properties have
  23807. been set. Until <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> is called this
  23808. object is in an undefined state and must not be used.
  23809. </para>
  23810. <para>
  23811. If any of the configuration properties are modified then
  23812. <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> must be called again.
  23813. </para>
  23814. </remarks>
  23815. </member>
  23816. <member name="T:log4net.Util.PatternStringConverters.ProcessIdPatternConverter">
  23817. <summary>
  23818. Write the current process ID to the output
  23819. </summary>
  23820. <remarks>
  23821. <para>
  23822. Write the current process ID to the output writer
  23823. </para>
  23824. </remarks>
  23825. <author>Nicko Cadell</author>
  23826. </member>
  23827. <member name="M:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23828. <summary>
  23829. Write the current process ID to the output
  23830. </summary>
  23831. <param name="writer">the writer to write to</param>
  23832. <param name="state">null, state is not set</param>
  23833. <remarks>
  23834. <para>
  23835. Write the current process ID to the output <paramref name="writer"/>.
  23836. </para>
  23837. </remarks>
  23838. </member>
  23839. <member name="F:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.declaringType">
  23840. <summary>
  23841. The fully qualified type of the ProcessIdPatternConverter class.
  23842. </summary>
  23843. <remarks>
  23844. Used by the internal logger to record the Type of the
  23845. log message.
  23846. </remarks>
  23847. </member>
  23848. <member name="T:log4net.Util.PatternStringConverters.PropertyPatternConverter">
  23849. <summary>
  23850. Property pattern converter
  23851. </summary>
  23852. <remarks>
  23853. <para>
  23854. This pattern converter reads the thread and global properties.
  23855. The thread properties take priority over global properties.
  23856. See <see cref="P:log4net.ThreadContext.Properties"/> for details of the
  23857. thread properties. See <see cref="P:log4net.GlobalContext.Properties"/> for
  23858. details of the global properties.
  23859. </para>
  23860. <para>
  23861. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  23862. lookup a single property. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  23863. then all properties will be dumped as a list of key value pairs.
  23864. </para>
  23865. </remarks>
  23866. <author>Nicko Cadell</author>
  23867. </member>
  23868. <member name="M:log4net.Util.PatternStringConverters.PropertyPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23869. <summary>
  23870. Write the property value to the output
  23871. </summary>
  23872. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23873. <param name="state">null, state is not set</param>
  23874. <remarks>
  23875. <para>
  23876. Writes out the value of a named property. The property name
  23877. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23878. property.
  23879. </para>
  23880. <para>
  23881. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  23882. then all the properties are written as key value pairs.
  23883. </para>
  23884. </remarks>
  23885. </member>
  23886. <member name="T:log4net.Util.PatternStringConverters.RandomStringPatternConverter">
  23887. <summary>
  23888. A Pattern converter that generates a string of random characters
  23889. </summary>
  23890. <remarks>
  23891. <para>
  23892. The converter generates a string of random characters. By default
  23893. the string is length 4. This can be changed by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23894. to the string value of the length required.
  23895. </para>
  23896. <para>
  23897. The random characters in the string are limited to uppercase letters
  23898. and numbers only.
  23899. </para>
  23900. <para>
  23901. The random number generator used by this class is not cryptographically secure.
  23902. </para>
  23903. </remarks>
  23904. <author>Nicko Cadell</author>
  23905. </member>
  23906. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.s_random">
  23907. <summary>
  23908. Shared random number generator
  23909. </summary>
  23910. </member>
  23911. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.m_length">
  23912. <summary>
  23913. Length of random string to generate. Default length 4.
  23914. </summary>
  23915. </member>
  23916. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions">
  23917. <summary>
  23918. Initialize the converter options
  23919. </summary>
  23920. <remarks>
  23921. <para>
  23922. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  23923. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> method must
  23924. be called on this object after the configuration properties have
  23925. been set. Until <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> is called this
  23926. object is in an undefined state and must not be used.
  23927. </para>
  23928. <para>
  23929. If any of the configuration properties are modified then
  23930. <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> must be called again.
  23931. </para>
  23932. </remarks>
  23933. </member>
  23934. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23935. <summary>
  23936. Write a randoim string to the output
  23937. </summary>
  23938. <param name="writer">the writer to write to</param>
  23939. <param name="state">null, state is not set</param>
  23940. <remarks>
  23941. <para>
  23942. Write a randoim string to the output <paramref name="writer"/>.
  23943. </para>
  23944. </remarks>
  23945. </member>
  23946. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.declaringType">
  23947. <summary>
  23948. The fully qualified type of the RandomStringPatternConverter class.
  23949. </summary>
  23950. <remarks>
  23951. Used by the internal logger to record the Type of the
  23952. log message.
  23953. </remarks>
  23954. </member>
  23955. <member name="T:log4net.Util.PatternStringConverters.UserNamePatternConverter">
  23956. <summary>
  23957. Write the current threads username to the output
  23958. </summary>
  23959. <remarks>
  23960. <para>
  23961. Write the current threads username to the output writer
  23962. </para>
  23963. </remarks>
  23964. <author>Nicko Cadell</author>
  23965. </member>
  23966. <member name="M:log4net.Util.PatternStringConverters.UserNamePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23967. <summary>
  23968. Write the current threads username to the output
  23969. </summary>
  23970. <param name="writer">the writer to write to</param>
  23971. <param name="state">null, state is not set</param>
  23972. <remarks>
  23973. <para>
  23974. Write the current threads username to the output <paramref name="writer"/>.
  23975. </para>
  23976. </remarks>
  23977. </member>
  23978. <member name="F:log4net.Util.PatternStringConverters.UserNamePatternConverter.declaringType">
  23979. <summary>
  23980. The fully qualified type of the UserNamePatternConverter class.
  23981. </summary>
  23982. <remarks>
  23983. Used by the internal logger to record the Type of the
  23984. log message.
  23985. </remarks>
  23986. </member>
  23987. <member name="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter">
  23988. <summary>
  23989. Write the UTC date time to the output
  23990. </summary>
  23991. <remarks>
  23992. <para>
  23993. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  23994. the current date and time in Universal time.
  23995. </para>
  23996. <para>
  23997. See the <see cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> for details on the date pattern syntax.
  23998. </para>
  23999. </remarks>
  24000. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  24001. <author>Nicko Cadell</author>
  24002. </member>
  24003. <member name="M:log4net.Util.PatternStringConverters.UtcDatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  24004. <summary>
  24005. Write the current date and time to the output
  24006. </summary>
  24007. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  24008. <param name="state">null, state is not set</param>
  24009. <remarks>
  24010. <para>
  24011. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  24012. for it to render it to the writer.
  24013. </para>
  24014. <para>
  24015. The date is in Universal time when it is rendered.
  24016. </para>
  24017. </remarks>
  24018. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  24019. </member>
  24020. <member name="F:log4net.Util.PatternStringConverters.UtcDatePatternConverter.declaringType">
  24021. <summary>
  24022. The fully qualified type of the UtcDatePatternConverter class.
  24023. </summary>
  24024. <remarks>
  24025. Used by the internal logger to record the Type of the
  24026. log message.
  24027. </remarks>
  24028. </member>
  24029. <member name="T:log4net.Util.TypeConverters.BooleanConverter">
  24030. <summary>
  24031. Type converter for Boolean.
  24032. </summary>
  24033. <remarks>
  24034. <para>
  24035. Supports conversion from string to <c>bool</c> type.
  24036. </para>
  24037. </remarks>
  24038. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24039. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24040. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24041. <author>Nicko Cadell</author>
  24042. <author>Gert Driesen</author>
  24043. </member>
  24044. <member name="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)">
  24045. <summary>
  24046. Can the source type be converted to the type supported by this object
  24047. </summary>
  24048. <param name="sourceType">the type to convert</param>
  24049. <returns>true if the conversion is possible</returns>
  24050. <remarks>
  24051. <para>
  24052. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24053. the <see cref="T:System.String"/> type.
  24054. </para>
  24055. </remarks>
  24056. </member>
  24057. <member name="M:log4net.Util.TypeConverters.BooleanConverter.ConvertFrom(System.Object)">
  24058. <summary>
  24059. Convert the source object to the type supported by this object
  24060. </summary>
  24061. <param name="source">the object to convert</param>
  24062. <returns>the converted object</returns>
  24063. <remarks>
  24064. <para>
  24065. Uses the <see cref="M:System.Boolean.Parse(System.String)"/> method to convert the
  24066. <see cref="T:System.String"/> argument to a <see cref="T:System.Boolean"/>.
  24067. </para>
  24068. </remarks>
  24069. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24070. The <paramref name="source"/> object cannot be converted to the
  24071. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"/>
  24072. method.
  24073. </exception>
  24074. </member>
  24075. <member name="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24076. <summary>
  24077. Exception base type for conversion errors.
  24078. </summary>
  24079. <remarks>
  24080. <para>
  24081. This type extends <see cref="T:System.ApplicationException"/>. It
  24082. does not add any new functionality but does differentiate the
  24083. type of exception being thrown.
  24084. </para>
  24085. </remarks>
  24086. <author>Nicko Cadell</author>
  24087. <author>Gert Driesen</author>
  24088. </member>
  24089. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor">
  24090. <summary>
  24091. Constructor
  24092. </summary>
  24093. <remarks>
  24094. <para>
  24095. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  24096. </para>
  24097. </remarks>
  24098. </member>
  24099. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String)">
  24100. <summary>
  24101. Constructor
  24102. </summary>
  24103. <param name="message">A message to include with the exception.</param>
  24104. <remarks>
  24105. <para>
  24106. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
  24107. with the specified message.
  24108. </para>
  24109. </remarks>
  24110. </member>
  24111. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String,System.Exception)">
  24112. <summary>
  24113. Constructor
  24114. </summary>
  24115. <param name="message">A message to include with the exception.</param>
  24116. <param name="innerException">A nested exception to include.</param>
  24117. <remarks>
  24118. <para>
  24119. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
  24120. with the specified message and inner exception.
  24121. </para>
  24122. </remarks>
  24123. </member>
  24124. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  24125. <summary>
  24126. Serialization constructor
  24127. </summary>
  24128. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
  24129. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  24130. <remarks>
  24131. <para>
  24132. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
  24133. with serialized data.
  24134. </para>
  24135. </remarks>
  24136. </member>
  24137. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object)">
  24138. <summary>
  24139. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  24140. </summary>
  24141. <param name="destinationType">The conversion destination type.</param>
  24142. <param name="sourceValue">The value to convert.</param>
  24143. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns>
  24144. <remarks>
  24145. <para>
  24146. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  24147. </para>
  24148. </remarks>
  24149. </member>
  24150. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object,System.Exception)">
  24151. <summary>
  24152. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  24153. </summary>
  24154. <param name="destinationType">The conversion destination type.</param>
  24155. <param name="sourceValue">The value to convert.</param>
  24156. <param name="innerException">A nested exception to include.</param>
  24157. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns>
  24158. <remarks>
  24159. <para>
  24160. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  24161. </para>
  24162. </remarks>
  24163. </member>
  24164. <member name="T:log4net.Util.TypeConverters.ConverterRegistry">
  24165. <summary>
  24166. Register of type converters for specific types.
  24167. </summary>
  24168. <remarks>
  24169. <para>
  24170. Maintains a registry of type converters used to convert between
  24171. types.
  24172. </para>
  24173. <para>
  24174. Use the <see cref="M:AddConverter(Type, object)"/> and
  24175. <see cref="M:AddConverter(Type, Type)"/> methods to register new converters.
  24176. 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
  24177. lookup appropriate converters to use.
  24178. </para>
  24179. </remarks>
  24180. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24181. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24182. <author>Nicko Cadell</author>
  24183. <author>Gert Driesen</author>
  24184. </member>
  24185. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#ctor">
  24186. <summary>
  24187. Private constructor
  24188. </summary>
  24189. <remarks>
  24190. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> class.
  24191. </remarks>
  24192. </member>
  24193. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#cctor">
  24194. <summary>
  24195. Static constructor.
  24196. </summary>
  24197. <remarks>
  24198. <para>
  24199. This constructor defines the intrinsic type converters.
  24200. </para>
  24201. </remarks>
  24202. </member>
  24203. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)">
  24204. <summary>
  24205. Adds a converter for a specific type.
  24206. </summary>
  24207. <param name="destinationType">The type being converted to.</param>
  24208. <param name="converter">The type converter to use to convert to the destination type.</param>
  24209. <remarks>
  24210. <para>
  24211. Adds a converter instance for a specific type.
  24212. </para>
  24213. </remarks>
  24214. </member>
  24215. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)">
  24216. <summary>
  24217. Adds a converter for a specific type.
  24218. </summary>
  24219. <param name="destinationType">The type being converted to.</param>
  24220. <param name="converterType">The type of the type converter to use to convert to the destination type.</param>
  24221. <remarks>
  24222. <para>
  24223. Adds a converter <see cref="T:System.Type"/> for a specific type.
  24224. </para>
  24225. </remarks>
  24226. </member>
  24227. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)">
  24228. <summary>
  24229. Gets the type converter to use to convert values to the destination type.
  24230. </summary>
  24231. <param name="sourceType">The type being converted from.</param>
  24232. <param name="destinationType">The type being converted to.</param>
  24233. <returns>
  24234. The type converter instance to use for type conversions or <c>null</c>
  24235. if no type converter is found.
  24236. </returns>
  24237. <remarks>
  24238. <para>
  24239. Gets the type converter to use to convert values to the destination type.
  24240. </para>
  24241. </remarks>
  24242. </member>
  24243. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)">
  24244. <summary>
  24245. Gets the type converter to use to convert values to the destination type.
  24246. </summary>
  24247. <param name="destinationType">The type being converted to.</param>
  24248. <returns>
  24249. The type converter instance to use for type conversions or <c>null</c>
  24250. if no type converter is found.
  24251. </returns>
  24252. <remarks>
  24253. <para>
  24254. Gets the type converter to use to convert values to the destination type.
  24255. </para>
  24256. </remarks>
  24257. </member>
  24258. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConverterFromAttribute(System.Type)">
  24259. <summary>
  24260. Lookups the type converter to use as specified by the attributes on the
  24261. destination type.
  24262. </summary>
  24263. <param name="destinationType">The type being converted to.</param>
  24264. <returns>
  24265. The type converter instance to use for type conversions or <c>null</c>
  24266. if no type converter is found.
  24267. </returns>
  24268. </member>
  24269. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.CreateConverterInstance(System.Type)">
  24270. <summary>
  24271. Creates the instance of the type converter.
  24272. </summary>
  24273. <param name="converterType">The type of the type converter.</param>
  24274. <returns>
  24275. The type converter instance to use for type conversions or <c>null</c>
  24276. if no type converter is found.
  24277. </returns>
  24278. <remarks>
  24279. <para>
  24280. The type specified for the type converter must implement
  24281. the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> or <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces
  24282. and must have a public default (no argument) constructor.
  24283. </para>
  24284. </remarks>
  24285. </member>
  24286. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.declaringType">
  24287. <summary>
  24288. The fully qualified type of the ConverterRegistry class.
  24289. </summary>
  24290. <remarks>
  24291. Used by the internal logger to record the Type of the
  24292. log message.
  24293. </remarks>
  24294. </member>
  24295. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.s_type2converter">
  24296. <summary>
  24297. Mapping from <see cref="T:System.Type"/> to type converter.
  24298. </summary>
  24299. </member>
  24300. <member name="T:log4net.Util.TypeConverters.EncodingConverter">
  24301. <summary>
  24302. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  24303. </summary>
  24304. <remarks>
  24305. <para>
  24306. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  24307. </para>
  24308. </remarks>
  24309. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24310. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24311. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24312. <author>Nicko Cadell</author>
  24313. <author>Gert Driesen</author>
  24314. </member>
  24315. <member name="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)">
  24316. <summary>
  24317. Can the source type be converted to the type supported by this object
  24318. </summary>
  24319. <param name="sourceType">the type to convert</param>
  24320. <returns>true if the conversion is possible</returns>
  24321. <remarks>
  24322. <para>
  24323. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24324. the <see cref="T:System.String"/> type.
  24325. </para>
  24326. </remarks>
  24327. </member>
  24328. <member name="M:log4net.Util.TypeConverters.EncodingConverter.ConvertFrom(System.Object)">
  24329. <summary>
  24330. Overrides the ConvertFrom method of IConvertFrom.
  24331. </summary>
  24332. <param name="source">the object to convert to an encoding</param>
  24333. <returns>the encoding</returns>
  24334. <remarks>
  24335. <para>
  24336. Uses the <see cref="M:Encoding.GetEncoding(string)"/> method to
  24337. convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
  24338. </para>
  24339. </remarks>
  24340. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24341. The <paramref name="source"/> object cannot be converted to the
  24342. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"/>
  24343. method.
  24344. </exception>
  24345. </member>
  24346. <member name="T:log4net.Util.TypeConverters.IConvertTo">
  24347. <summary>
  24348. Interface supported by type converters
  24349. </summary>
  24350. <remarks>
  24351. <para>
  24352. This interface supports conversion from a single type to arbitrary types.
  24353. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  24354. </para>
  24355. </remarks>
  24356. <author>Nicko Cadell</author>
  24357. </member>
  24358. <member name="M:log4net.Util.TypeConverters.IConvertTo.CanConvertTo(System.Type)">
  24359. <summary>
  24360. Returns whether this converter can convert the object to the specified type
  24361. </summary>
  24362. <param name="targetType">A Type that represents the type you want to convert to</param>
  24363. <returns>true if the conversion is possible</returns>
  24364. <remarks>
  24365. <para>
  24366. Test if the type supported by this converter can be converted to the
  24367. <paramref name="targetType"/>.
  24368. </para>
  24369. </remarks>
  24370. </member>
  24371. <member name="M:log4net.Util.TypeConverters.IConvertTo.ConvertTo(System.Object,System.Type)">
  24372. <summary>
  24373. Converts the given value object to the specified type, using the arguments
  24374. </summary>
  24375. <param name="source">the object to convert</param>
  24376. <param name="targetType">The Type to convert the value parameter to</param>
  24377. <returns>the converted object</returns>
  24378. <remarks>
  24379. <para>
  24380. Converts the <paramref name="source"/> (which must be of the type supported
  24381. by this converter) to the <paramref name="targetType"/> specified..
  24382. </para>
  24383. </remarks>
  24384. </member>
  24385. <member name="T:log4net.Util.TypeConverters.IPAddressConverter">
  24386. <summary>
  24387. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  24388. </summary>
  24389. <remarks>
  24390. <para>
  24391. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  24392. </para>
  24393. </remarks>
  24394. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24395. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24396. <author>Nicko Cadell</author>
  24397. </member>
  24398. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)">
  24399. <summary>
  24400. Can the source type be converted to the type supported by this object
  24401. </summary>
  24402. <param name="sourceType">the type to convert</param>
  24403. <returns>true if the conversion is possible</returns>
  24404. <remarks>
  24405. <para>
  24406. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24407. the <see cref="T:System.String"/> type.
  24408. </para>
  24409. </remarks>
  24410. </member>
  24411. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.ConvertFrom(System.Object)">
  24412. <summary>
  24413. Overrides the ConvertFrom method of IConvertFrom.
  24414. </summary>
  24415. <param name="source">the object to convert to an IPAddress</param>
  24416. <returns>the IPAddress</returns>
  24417. <remarks>
  24418. <para>
  24419. Uses the <see cref="M:System.Net.IPAddress.Parse(System.String)"/> method to convert the
  24420. <see cref="T:System.String"/> argument to an <see cref="T:System.Net.IPAddress"/>.
  24421. If that fails then the string is resolved as a DNS hostname.
  24422. </para>
  24423. </remarks>
  24424. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24425. The <paramref name="source"/> object cannot be converted to the
  24426. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"/>
  24427. method.
  24428. </exception>
  24429. </member>
  24430. <member name="F:log4net.Util.TypeConverters.IPAddressConverter.validIpAddressChars">
  24431. <summary>
  24432. Valid characters in an IPv4 or IPv6 address string. (Does not support subnets)
  24433. </summary>
  24434. </member>
  24435. <member name="T:log4net.Util.TypeConverters.PatternLayoutConverter">
  24436. <summary>
  24437. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  24438. </summary>
  24439. <remarks>
  24440. <para>
  24441. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  24442. </para>
  24443. <para>
  24444. The string is used as the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>
  24445. of the <see cref="T:log4net.Layout.PatternLayout"/>.
  24446. </para>
  24447. </remarks>
  24448. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24449. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24450. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24451. <author>Nicko Cadell</author>
  24452. </member>
  24453. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)">
  24454. <summary>
  24455. Can the source type be converted to the type supported by this object
  24456. </summary>
  24457. <param name="sourceType">the type to convert</param>
  24458. <returns>true if the conversion is possible</returns>
  24459. <remarks>
  24460. <para>
  24461. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24462. the <see cref="T:System.String"/> type.
  24463. </para>
  24464. </remarks>
  24465. </member>
  24466. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.ConvertFrom(System.Object)">
  24467. <summary>
  24468. Overrides the ConvertFrom method of IConvertFrom.
  24469. </summary>
  24470. <param name="source">the object to convert to a PatternLayout</param>
  24471. <returns>the PatternLayout</returns>
  24472. <remarks>
  24473. <para>
  24474. Creates and returns a new <see cref="T:log4net.Layout.PatternLayout"/> using
  24475. the <paramref name="source"/> <see cref="T:System.String"/> as the
  24476. <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>.
  24477. </para>
  24478. </remarks>
  24479. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24480. The <paramref name="source"/> object cannot be converted to the
  24481. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"/>
  24482. method.
  24483. </exception>
  24484. </member>
  24485. <member name="T:log4net.Util.TypeConverters.PatternStringConverter">
  24486. <summary>
  24487. Convert between string and <see cref="T:log4net.Util.PatternString"/>
  24488. </summary>
  24489. <remarks>
  24490. <para>
  24491. Supports conversion from string to <see cref="T:log4net.Util.PatternString"/> type,
  24492. and from a <see cref="T:log4net.Util.PatternString"/> type to a string.
  24493. </para>
  24494. <para>
  24495. The string is used as the <see cref="P:log4net.Util.PatternString.ConversionPattern"/>
  24496. of the <see cref="T:log4net.Util.PatternString"/>.
  24497. </para>
  24498. </remarks>
  24499. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24500. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24501. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24502. <author>Nicko Cadell</author>
  24503. </member>
  24504. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)">
  24505. <summary>
  24506. Can the target type be converted to the type supported by this object
  24507. </summary>
  24508. <param name="targetType">A <see cref="T:System.Type"/> that represents the type you want to convert to</param>
  24509. <returns>true if the conversion is possible</returns>
  24510. <remarks>
  24511. <para>
  24512. Returns <c>true</c> if the <paramref name="targetType"/> is
  24513. assignable from a <see cref="T:System.String"/> type.
  24514. </para>
  24515. </remarks>
  24516. </member>
  24517. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertTo(System.Object,System.Type)">
  24518. <summary>
  24519. Converts the given value object to the specified type, using the arguments
  24520. </summary>
  24521. <param name="source">the object to convert</param>
  24522. <param name="targetType">The Type to convert the value parameter to</param>
  24523. <returns>the converted object</returns>
  24524. <remarks>
  24525. <para>
  24526. Uses the <see cref="M:PatternString.Format()"/> method to convert the
  24527. <see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>.
  24528. </para>
  24529. </remarks>
  24530. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24531. The <paramref name="source"/> object cannot be converted to the
  24532. <paramref name="targetType"/>. To check for this condition use the
  24533. <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"/> method.
  24534. </exception>
  24535. </member>
  24536. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)">
  24537. <summary>
  24538. Can the source type be converted to the type supported by this object
  24539. </summary>
  24540. <param name="sourceType">the type to convert</param>
  24541. <returns>true if the conversion is possible</returns>
  24542. <remarks>
  24543. <para>
  24544. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24545. the <see cref="T:System.String"/> type.
  24546. </para>
  24547. </remarks>
  24548. </member>
  24549. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertFrom(System.Object)">
  24550. <summary>
  24551. Overrides the ConvertFrom method of IConvertFrom.
  24552. </summary>
  24553. <param name="source">the object to convert to a PatternString</param>
  24554. <returns>the PatternString</returns>
  24555. <remarks>
  24556. <para>
  24557. Creates and returns a new <see cref="T:log4net.Util.PatternString"/> using
  24558. the <paramref name="source"/> <see cref="T:System.String"/> as the
  24559. <see cref="P:log4net.Util.PatternString.ConversionPattern"/>.
  24560. </para>
  24561. </remarks>
  24562. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24563. The <paramref name="source"/> object cannot be converted to the
  24564. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"/>
  24565. method.
  24566. </exception>
  24567. </member>
  24568. <member name="T:log4net.Util.TypeConverters.TypeConverter">
  24569. <summary>
  24570. Supports conversion from string to <see cref="T:System.Type"/> type.
  24571. </summary>
  24572. <remarks>
  24573. <para>
  24574. Supports conversion from string to <see cref="T:System.Type"/> type.
  24575. </para>
  24576. </remarks>
  24577. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24578. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24579. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24580. <author>Nicko Cadell</author>
  24581. </member>
  24582. <member name="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)">
  24583. <summary>
  24584. Can the source type be converted to the type supported by this object
  24585. </summary>
  24586. <param name="sourceType">the type to convert</param>
  24587. <returns>true if the conversion is possible</returns>
  24588. <remarks>
  24589. <para>
  24590. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24591. the <see cref="T:System.String"/> type.
  24592. </para>
  24593. </remarks>
  24594. </member>
  24595. <member name="M:log4net.Util.TypeConverters.TypeConverter.ConvertFrom(System.Object)">
  24596. <summary>
  24597. Overrides the ConvertFrom method of IConvertFrom.
  24598. </summary>
  24599. <param name="source">the object to convert to a Type</param>
  24600. <returns>the Type</returns>
  24601. <remarks>
  24602. <para>
  24603. Uses the <see cref="M:Type.GetType(string,bool)"/> method to convert the
  24604. <see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>.
  24605. Additional effort is made to locate partially specified types
  24606. by searching the loaded assemblies.
  24607. </para>
  24608. </remarks>
  24609. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24610. The <paramref name="source"/> object cannot be converted to the
  24611. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"/>
  24612. method.
  24613. </exception>
  24614. </member>
  24615. <member name="T:log4net.Util.TypeConverters.TypeConverterAttribute">
  24616. <summary>
  24617. Attribute used to associate a type converter
  24618. </summary>
  24619. <remarks>
  24620. <para>
  24621. Class and Interface level attribute that specifies a type converter
  24622. to use with the associated type.
  24623. </para>
  24624. <para>
  24625. To associate a type converter with a target type apply a
  24626. <c>TypeConverterAttribute</c> to the target type. Specify the
  24627. type of the type converter on the attribute.
  24628. </para>
  24629. </remarks>
  24630. <author>Nicko Cadell</author>
  24631. <author>Gert Driesen</author>
  24632. </member>
  24633. <member name="F:log4net.Util.TypeConverters.TypeConverterAttribute.m_typeName">
  24634. <summary>
  24635. The string type name of the type converter
  24636. </summary>
  24637. </member>
  24638. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor">
  24639. <summary>
  24640. Default constructor
  24641. </summary>
  24642. <remarks>
  24643. <para>
  24644. Default constructor
  24645. </para>
  24646. </remarks>
  24647. </member>
  24648. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.String)">
  24649. <summary>
  24650. Create a new type converter attribute for the specified type name
  24651. </summary>
  24652. <param name="typeName">The string type name of the type converter</param>
  24653. <remarks>
  24654. <para>
  24655. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24656. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  24657. </para>
  24658. </remarks>
  24659. </member>
  24660. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.Type)">
  24661. <summary>
  24662. Create a new type converter attribute for the specified type
  24663. </summary>
  24664. <param name="converterType">The type of the type converter</param>
  24665. <remarks>
  24666. <para>
  24667. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24668. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  24669. </para>
  24670. </remarks>
  24671. </member>
  24672. <member name="P:log4net.Util.TypeConverters.TypeConverterAttribute.ConverterTypeName">
  24673. <summary>
  24674. The string type name of the type converter
  24675. </summary>
  24676. <value>
  24677. The string type name of the type converter
  24678. </value>
  24679. <remarks>
  24680. <para>
  24681. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24682. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  24683. </para>
  24684. </remarks>
  24685. </member>
  24686. <member name="T:log4net.Util.AppenderAttachedImpl">
  24687. <summary>
  24688. A straightforward implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  24689. </summary>
  24690. <remarks>
  24691. <para>
  24692. This is the default implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/>
  24693. interface. Implementors of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  24694. should aggregate an instance of this type.
  24695. </para>
  24696. </remarks>
  24697. <author>Nicko Cadell</author>
  24698. <author>Gert Driesen</author>
  24699. </member>
  24700. <member name="M:log4net.Util.AppenderAttachedImpl.#ctor">
  24701. <summary>
  24702. Constructor
  24703. </summary>
  24704. <remarks>
  24705. <para>
  24706. Initializes a new instance of the <see cref="T:log4net.Util.AppenderAttachedImpl"/> class.
  24707. </para>
  24708. </remarks>
  24709. </member>
  24710. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent)">
  24711. <summary>
  24712. Append on on all attached appenders.
  24713. </summary>
  24714. <param name="loggingEvent">The event being logged.</param>
  24715. <returns>The number of appenders called.</returns>
  24716. <remarks>
  24717. <para>
  24718. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
  24719. attached appenders.
  24720. </para>
  24721. </remarks>
  24722. </member>
  24723. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])">
  24724. <summary>
  24725. Append on on all attached appenders.
  24726. </summary>
  24727. <param name="loggingEvents">The array of events being logged.</param>
  24728. <returns>The number of appenders called.</returns>
  24729. <remarks>
  24730. <para>
  24731. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
  24732. attached appenders.
  24733. </para>
  24734. </remarks>
  24735. </member>
  24736. <member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])">
  24737. <summary>
  24738. Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with
  24739. the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied.
  24740. </summary>
  24741. <param name="appender">The appender</param>
  24742. <param name="loggingEvents">The events</param>
  24743. <remarks>
  24744. <para>
  24745. If the <paramref name="appender"/> supports the <see cref="T:log4net.Appender.IBulkAppender"/>
  24746. interface then the <paramref name="loggingEvents"/> will be passed
  24747. through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/>
  24748. objects in the array will be passed one at a time.
  24749. </para>
  24750. </remarks>
  24751. </member>
  24752. <member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)">
  24753. <summary>
  24754. Attaches an appender.
  24755. </summary>
  24756. <param name="newAppender">The appender to add.</param>
  24757. <remarks>
  24758. <para>
  24759. If the appender is already in the list it won't be added again.
  24760. </para>
  24761. </remarks>
  24762. </member>
  24763. <member name="M:log4net.Util.AppenderAttachedImpl.GetAppender(System.String)">
  24764. <summary>
  24765. Gets an attached appender with the specified name.
  24766. </summary>
  24767. <param name="name">The name of the appender to get.</param>
  24768. <returns>
  24769. The appender with the name specified, or <c>null</c> if no appender with the
  24770. specified name is found.
  24771. </returns>
  24772. <remarks>
  24773. <para>
  24774. Lookup an attached appender by name.
  24775. </para>
  24776. </remarks>
  24777. </member>
  24778. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAllAppenders">
  24779. <summary>
  24780. Removes all attached appenders.
  24781. </summary>
  24782. <remarks>
  24783. <para>
  24784. Removes and closes all attached appenders
  24785. </para>
  24786. </remarks>
  24787. </member>
  24788. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(log4net.Appender.IAppender)">
  24789. <summary>
  24790. Removes the specified appender from the list of attached appenders.
  24791. </summary>
  24792. <param name="appender">The appender to remove.</param>
  24793. <returns>The appender removed from the list</returns>
  24794. <remarks>
  24795. <para>
  24796. The appender removed is not closed.
  24797. If you are discarding the appender you must call
  24798. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  24799. </para>
  24800. </remarks>
  24801. </member>
  24802. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(System.String)">
  24803. <summary>
  24804. Removes the appender with the specified name from the list of appenders.
  24805. </summary>
  24806. <param name="name">The name of the appender to remove.</param>
  24807. <returns>The appender removed from the list</returns>
  24808. <remarks>
  24809. <para>
  24810. The appender removed is not closed.
  24811. If you are discarding the appender you must call
  24812. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  24813. </para>
  24814. </remarks>
  24815. </member>
  24816. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderList">
  24817. <summary>
  24818. List of appenders
  24819. </summary>
  24820. </member>
  24821. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderArray">
  24822. <summary>
  24823. Array of appenders, used to cache the m_appenderList
  24824. </summary>
  24825. </member>
  24826. <member name="F:log4net.Util.AppenderAttachedImpl.declaringType">
  24827. <summary>
  24828. The fully qualified type of the AppenderAttachedImpl class.
  24829. </summary>
  24830. <remarks>
  24831. Used by the internal logger to record the Type of the
  24832. log message.
  24833. </remarks>
  24834. </member>
  24835. <member name="P:log4net.Util.AppenderAttachedImpl.Appenders">
  24836. <summary>
  24837. Gets all attached appenders.
  24838. </summary>
  24839. <returns>
  24840. A collection of attached appenders, or <c>null</c> if there
  24841. are no attached appenders.
  24842. </returns>
  24843. <remarks>
  24844. <para>
  24845. The read only collection of all currently attached appenders.
  24846. </para>
  24847. </remarks>
  24848. </member>
  24849. <member name="T:log4net.Util.CompositeProperties">
  24850. <summary>
  24851. This class aggregates several PropertiesDictionary collections together.
  24852. </summary>
  24853. <remarks>
  24854. <para>
  24855. Provides a dictionary style lookup over an ordered list of
  24856. <see cref="T:log4net.Util.PropertiesDictionary"/> collections.
  24857. </para>
  24858. </remarks>
  24859. <author>Nicko Cadell</author>
  24860. </member>
  24861. <member name="M:log4net.Util.CompositeProperties.#ctor">
  24862. <summary>
  24863. Constructor
  24864. </summary>
  24865. <remarks>
  24866. <para>
  24867. Initializes a new instance of the <see cref="T:log4net.Util.CompositeProperties"/> class.
  24868. </para>
  24869. </remarks>
  24870. </member>
  24871. <member name="M:log4net.Util.CompositeProperties.Add(log4net.Util.ReadOnlyPropertiesDictionary)">
  24872. <summary>
  24873. Add a Properties Dictionary to this composite collection
  24874. </summary>
  24875. <param name="properties">the properties to add</param>
  24876. <remarks>
  24877. <para>
  24878. Properties dictionaries added first take precedence over dictionaries added
  24879. later.
  24880. </para>
  24881. </remarks>
  24882. </member>
  24883. <member name="M:log4net.Util.CompositeProperties.Flatten">
  24884. <summary>
  24885. Flatten this composite collection into a single properties dictionary
  24886. </summary>
  24887. <returns>the flattened dictionary</returns>
  24888. <remarks>
  24889. <para>
  24890. Reduces the collection of ordered dictionaries to a single dictionary
  24891. containing the resultant values for the keys.
  24892. </para>
  24893. </remarks>
  24894. </member>
  24895. <member name="P:log4net.Util.CompositeProperties.Item(System.String)">
  24896. <summary>
  24897. Gets the value of a property
  24898. </summary>
  24899. <value>
  24900. The value for the property with the specified key
  24901. </value>
  24902. <remarks>
  24903. <para>
  24904. Looks up the value for the <paramref name="key"/> specified.
  24905. The <see cref="T:log4net.Util.PropertiesDictionary"/> collections are searched
  24906. in the order in which they were added to this collection. The value
  24907. returned is the value held by the first collection that contains
  24908. the specified key.
  24909. </para>
  24910. <para>
  24911. If none of the collections contain the specified key then
  24912. <c>null</c> is returned.
  24913. </para>
  24914. </remarks>
  24915. </member>
  24916. <member name="T:log4net.Util.ContextPropertiesBase">
  24917. <summary>
  24918. Base class for Context Properties implementations
  24919. </summary>
  24920. <remarks>
  24921. <para>
  24922. This class defines a basic property get set accessor
  24923. </para>
  24924. </remarks>
  24925. <author>Nicko Cadell</author>
  24926. </member>
  24927. <member name="P:log4net.Util.ContextPropertiesBase.Item(System.String)">
  24928. <summary>
  24929. Gets or sets the value of a property
  24930. </summary>
  24931. <value>
  24932. The value for the property with the specified key
  24933. </value>
  24934. <remarks>
  24935. <para>
  24936. Gets or sets the value of a property
  24937. </para>
  24938. </remarks>
  24939. </member>
  24940. <member name="T:log4net.Util.ConverterInfo">
  24941. <summary>
  24942. Wrapper class used to map converter names to converter types
  24943. </summary>
  24944. <remarks>
  24945. <para>
  24946. Pattern converter info class used during configuration by custom
  24947. PatternString and PatternLayer converters.
  24948. </para>
  24949. </remarks>
  24950. </member>
  24951. <member name="M:log4net.Util.ConverterInfo.#ctor">
  24952. <summary>
  24953. default constructor
  24954. </summary>
  24955. </member>
  24956. <member name="M:log4net.Util.ConverterInfo.AddProperty(log4net.Util.PropertyEntry)">
  24957. <summary>
  24958. </summary>
  24959. <param name="entry"></param>
  24960. </member>
  24961. <member name="P:log4net.Util.ConverterInfo.Name">
  24962. <summary>
  24963. Gets or sets the name of the conversion pattern
  24964. </summary>
  24965. <remarks>
  24966. <para>
  24967. The name of the pattern in the format string
  24968. </para>
  24969. </remarks>
  24970. </member>
  24971. <member name="P:log4net.Util.ConverterInfo.Type">
  24972. <summary>
  24973. Gets or sets the type of the converter
  24974. </summary>
  24975. <remarks>
  24976. <para>
  24977. The value specified must extend the
  24978. <see cref="T:log4net.Util.PatternConverter"/> type.
  24979. </para>
  24980. </remarks>
  24981. </member>
  24982. <member name="P:log4net.Util.ConverterInfo.Properties">
  24983. <summary>
  24984. </summary>
  24985. </member>
  24986. <member name="T:log4net.Util.CountingQuietTextWriter">
  24987. <summary>
  24988. Subclass of <see cref="T:log4net.Util.QuietTextWriter"/> that maintains a count of
  24989. the number of bytes written.
  24990. </summary>
  24991. <remarks>
  24992. <para>
  24993. This writer counts the number of bytes written.
  24994. </para>
  24995. </remarks>
  24996. <author>Nicko Cadell</author>
  24997. <author>Gert Driesen</author>
  24998. </member>
  24999. <member name="T:log4net.Util.QuietTextWriter">
  25000. <summary>
  25001. <see cref="T:System.IO.TextWriter"/> that does not leak exceptions
  25002. </summary>
  25003. <remarks>
  25004. <para>
  25005. <see cref="T:log4net.Util.QuietTextWriter"/> does not throw exceptions when things go wrong.
  25006. Instead, it delegates error handling to its <see cref="T:log4net.Core.IErrorHandler"/>.
  25007. </para>
  25008. </remarks>
  25009. <author>Nicko Cadell</author>
  25010. <author>Gert Driesen</author>
  25011. </member>
  25012. <member name="T:log4net.Util.TextWriterAdapter">
  25013. <summary>
  25014. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  25015. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  25016. </summary>
  25017. <remarks>
  25018. <para>
  25019. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  25020. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  25021. </para>
  25022. </remarks>
  25023. <author>Nicko Cadell</author>
  25024. </member>
  25025. <member name="F:log4net.Util.TextWriterAdapter.m_writer">
  25026. <summary>
  25027. The writer to forward messages to
  25028. </summary>
  25029. </member>
  25030. <member name="M:log4net.Util.TextWriterAdapter.#ctor(System.IO.TextWriter)">
  25031. <summary>
  25032. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  25033. messages to a <see cref="T:System.IO.TextWriter"/>.
  25034. </summary>
  25035. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to forward to</param>
  25036. <remarks>
  25037. <para>
  25038. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  25039. messages to a <see cref="T:System.IO.TextWriter"/>.
  25040. </para>
  25041. </remarks>
  25042. </member>
  25043. <member name="M:log4net.Util.TextWriterAdapter.Close">
  25044. <summary>
  25045. Closes the writer and releases any system resources associated with the writer
  25046. </summary>
  25047. <remarks>
  25048. <para>
  25049. </para>
  25050. </remarks>
  25051. </member>
  25052. <member name="M:log4net.Util.TextWriterAdapter.Dispose(System.Boolean)">
  25053. <summary>
  25054. Dispose this writer
  25055. </summary>
  25056. <param name="disposing">flag indicating if we are being disposed</param>
  25057. <remarks>
  25058. <para>
  25059. Dispose this writer
  25060. </para>
  25061. </remarks>
  25062. </member>
  25063. <member name="M:log4net.Util.TextWriterAdapter.Flush">
  25064. <summary>
  25065. Flushes any buffered output
  25066. </summary>
  25067. <remarks>
  25068. <para>
  25069. Clears all buffers for the writer and causes any buffered data to be written
  25070. to the underlying device
  25071. </para>
  25072. </remarks>
  25073. </member>
  25074. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char)">
  25075. <summary>
  25076. Writes a character to the wrapped TextWriter
  25077. </summary>
  25078. <param name="value">the value to write to the TextWriter</param>
  25079. <remarks>
  25080. <para>
  25081. Writes a character to the wrapped TextWriter
  25082. </para>
  25083. </remarks>
  25084. </member>
  25085. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char[],System.Int32,System.Int32)">
  25086. <summary>
  25087. Writes a character buffer to the wrapped TextWriter
  25088. </summary>
  25089. <param name="buffer">the data buffer</param>
  25090. <param name="index">the start index</param>
  25091. <param name="count">the number of characters to write</param>
  25092. <remarks>
  25093. <para>
  25094. Writes a character buffer to the wrapped TextWriter
  25095. </para>
  25096. </remarks>
  25097. </member>
  25098. <member name="M:log4net.Util.TextWriterAdapter.Write(System.String)">
  25099. <summary>
  25100. Writes a string to the wrapped TextWriter
  25101. </summary>
  25102. <param name="value">the value to write to the TextWriter</param>
  25103. <remarks>
  25104. <para>
  25105. Writes a string to the wrapped TextWriter
  25106. </para>
  25107. </remarks>
  25108. </member>
  25109. <member name="P:log4net.Util.TextWriterAdapter.Writer">
  25110. <summary>
  25111. Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>.
  25112. </summary>
  25113. <value>
  25114. The underlying <see cref="T:System.IO.TextWriter"/>.
  25115. </value>
  25116. <remarks>
  25117. <para>
  25118. Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>.
  25119. </para>
  25120. </remarks>
  25121. </member>
  25122. <member name="P:log4net.Util.TextWriterAdapter.Encoding">
  25123. <summary>
  25124. The Encoding in which the output is written
  25125. </summary>
  25126. <value>
  25127. The <see cref="P:log4net.Util.TextWriterAdapter.Encoding"/>
  25128. </value>
  25129. <remarks>
  25130. <para>
  25131. The Encoding in which the output is written
  25132. </para>
  25133. </remarks>
  25134. </member>
  25135. <member name="P:log4net.Util.TextWriterAdapter.FormatProvider">
  25136. <summary>
  25137. Gets an object that controls formatting
  25138. </summary>
  25139. <value>
  25140. The format provider
  25141. </value>
  25142. <remarks>
  25143. <para>
  25144. Gets an object that controls formatting
  25145. </para>
  25146. </remarks>
  25147. </member>
  25148. <member name="P:log4net.Util.TextWriterAdapter.NewLine">
  25149. <summary>
  25150. Gets or sets the line terminator string used by the TextWriter
  25151. </summary>
  25152. <value>
  25153. The line terminator to use
  25154. </value>
  25155. <remarks>
  25156. <para>
  25157. Gets or sets the line terminator string used by the TextWriter
  25158. </para>
  25159. </remarks>
  25160. </member>
  25161. <member name="M:log4net.Util.QuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  25162. <summary>
  25163. Constructor
  25164. </summary>
  25165. <param name="writer">the writer to actually write to</param>
  25166. <param name="errorHandler">the error handler to report error to</param>
  25167. <remarks>
  25168. <para>
  25169. Create a new QuietTextWriter using a writer and error handler
  25170. </para>
  25171. </remarks>
  25172. </member>
  25173. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char)">
  25174. <summary>
  25175. Writes a character to the underlying writer
  25176. </summary>
  25177. <param name="value">the char to write</param>
  25178. <remarks>
  25179. <para>
  25180. Writes a character to the underlying writer
  25181. </para>
  25182. </remarks>
  25183. </member>
  25184. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  25185. <summary>
  25186. Writes a buffer to the underlying writer
  25187. </summary>
  25188. <param name="buffer">the buffer to write</param>
  25189. <param name="index">the start index to write from</param>
  25190. <param name="count">the number of characters to write</param>
  25191. <remarks>
  25192. <para>
  25193. Writes a buffer to the underlying writer
  25194. </para>
  25195. </remarks>
  25196. </member>
  25197. <member name="M:log4net.Util.QuietTextWriter.Write(System.String)">
  25198. <summary>
  25199. Writes a string to the output.
  25200. </summary>
  25201. <param name="value">The string data to write to the output.</param>
  25202. <remarks>
  25203. <para>
  25204. Writes a string to the output.
  25205. </para>
  25206. </remarks>
  25207. </member>
  25208. <member name="M:log4net.Util.QuietTextWriter.Close">
  25209. <summary>
  25210. Closes the underlying output writer.
  25211. </summary>
  25212. <remarks>
  25213. <para>
  25214. Closes the underlying output writer.
  25215. </para>
  25216. </remarks>
  25217. </member>
  25218. <member name="F:log4net.Util.QuietTextWriter.m_errorHandler">
  25219. <summary>
  25220. The error handler instance to pass all errors to
  25221. </summary>
  25222. </member>
  25223. <member name="F:log4net.Util.QuietTextWriter.m_closed">
  25224. <summary>
  25225. Flag to indicate if this writer is closed
  25226. </summary>
  25227. </member>
  25228. <member name="P:log4net.Util.QuietTextWriter.ErrorHandler">
  25229. <summary>
  25230. Gets or sets the error handler that all errors are passed to.
  25231. </summary>
  25232. <value>
  25233. The error handler that all errors are passed to.
  25234. </value>
  25235. <remarks>
  25236. <para>
  25237. Gets or sets the error handler that all errors are passed to.
  25238. </para>
  25239. </remarks>
  25240. </member>
  25241. <member name="P:log4net.Util.QuietTextWriter.Closed">
  25242. <summary>
  25243. Gets a value indicating whether this writer is closed.
  25244. </summary>
  25245. <value>
  25246. <c>true</c> if this writer is closed, otherwise <c>false</c>.
  25247. </value>
  25248. <remarks>
  25249. <para>
  25250. Gets a value indicating whether this writer is closed.
  25251. </para>
  25252. </remarks>
  25253. </member>
  25254. <member name="M:log4net.Util.CountingQuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  25255. <summary>
  25256. Constructor
  25257. </summary>
  25258. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to actually write to.</param>
  25259. <param name="errorHandler">The <see cref="T:log4net.Core.IErrorHandler"/> to report errors to.</param>
  25260. <remarks>
  25261. <para>
  25262. Creates a new instance of the <see cref="T:log4net.Util.CountingQuietTextWriter"/> class
  25263. with the specified <see cref="T:System.IO.TextWriter"/> and <see cref="T:log4net.Core.IErrorHandler"/>.
  25264. </para>
  25265. </remarks>
  25266. </member>
  25267. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)">
  25268. <summary>
  25269. Writes a character to the underlying writer and counts the number of bytes written.
  25270. </summary>
  25271. <param name="value">the char to write</param>
  25272. <remarks>
  25273. <para>
  25274. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  25275. the number of bytes written.
  25276. </para>
  25277. </remarks>
  25278. </member>
  25279. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  25280. <summary>
  25281. Writes a buffer to the underlying writer and counts the number of bytes written.
  25282. </summary>
  25283. <param name="buffer">the buffer to write</param>
  25284. <param name="index">the start index to write from</param>
  25285. <param name="count">the number of characters to write</param>
  25286. <remarks>
  25287. <para>
  25288. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  25289. the number of bytes written.
  25290. </para>
  25291. </remarks>
  25292. </member>
  25293. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)">
  25294. <summary>
  25295. Writes a string to the output and counts the number of bytes written.
  25296. </summary>
  25297. <param name="str">The string data to write to the output.</param>
  25298. <remarks>
  25299. <para>
  25300. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  25301. the number of bytes written.
  25302. </para>
  25303. </remarks>
  25304. </member>
  25305. <member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes">
  25306. <summary>
  25307. Total number of bytes written.
  25308. </summary>
  25309. </member>
  25310. <member name="P:log4net.Util.CountingQuietTextWriter.Count">
  25311. <summary>
  25312. Gets or sets the total number of bytes written.
  25313. </summary>
  25314. <value>
  25315. The total number of bytes written.
  25316. </value>
  25317. <remarks>
  25318. <para>
  25319. Gets or sets the total number of bytes written.
  25320. </para>
  25321. </remarks>
  25322. </member>
  25323. <member name="T:log4net.Util.CyclicBuffer">
  25324. <summary>
  25325. A fixed size rolling buffer of logging events.
  25326. </summary>
  25327. <remarks>
  25328. <para>
  25329. An array backed fixed size leaky bucket.
  25330. </para>
  25331. </remarks>
  25332. <author>Nicko Cadell</author>
  25333. <author>Gert Driesen</author>
  25334. </member>
  25335. <member name="M:log4net.Util.CyclicBuffer.#ctor(System.Int32)">
  25336. <summary>
  25337. Constructor
  25338. </summary>
  25339. <param name="maxSize">The maximum number of logging events in the buffer.</param>
  25340. <remarks>
  25341. <para>
  25342. Initializes a new instance of the <see cref="T:log4net.Util.CyclicBuffer"/> class with
  25343. the specified maximum number of buffered logging events.
  25344. </para>
  25345. </remarks>
  25346. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="maxSize"/> argument is not a positive integer.</exception>
  25347. </member>
  25348. <member name="M:log4net.Util.CyclicBuffer.Append(log4net.Core.LoggingEvent)">
  25349. <summary>
  25350. Appends a <paramref name="loggingEvent"/> to the buffer.
  25351. </summary>
  25352. <param name="loggingEvent">The event to append to the buffer.</param>
  25353. <returns>The event discarded from the buffer, if the buffer is full, otherwise <c>null</c>.</returns>
  25354. <remarks>
  25355. <para>
  25356. Append an event to the buffer. If the buffer still contains free space then
  25357. <c>null</c> is returned. If the buffer is full then an event will be dropped
  25358. to make space for the new event, the event dropped is returned.
  25359. </para>
  25360. </remarks>
  25361. </member>
  25362. <member name="M:log4net.Util.CyclicBuffer.PopOldest">
  25363. <summary>
  25364. Get and remove the oldest event in the buffer.
  25365. </summary>
  25366. <returns>The oldest logging event in the buffer</returns>
  25367. <remarks>
  25368. <para>
  25369. Gets the oldest (first) logging event in the buffer and removes it
  25370. from the buffer.
  25371. </para>
  25372. </remarks>
  25373. </member>
  25374. <member name="M:log4net.Util.CyclicBuffer.PopAll">
  25375. <summary>
  25376. Pops all the logging events from the buffer into an array.
  25377. </summary>
  25378. <returns>An array of all the logging events in the buffer.</returns>
  25379. <remarks>
  25380. <para>
  25381. Get all the events in the buffer and clear the buffer.
  25382. </para>
  25383. </remarks>
  25384. </member>
  25385. <member name="M:log4net.Util.CyclicBuffer.Clear">
  25386. <summary>
  25387. Clear the buffer
  25388. </summary>
  25389. <remarks>
  25390. <para>
  25391. Clear the buffer of all events. The events in the buffer are lost.
  25392. </para>
  25393. </remarks>
  25394. </member>
  25395. <member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)">
  25396. <summary>
  25397. Gets the <paramref name="i"/>th oldest event currently in the buffer.
  25398. </summary>
  25399. <value>The <paramref name="i"/>th oldest event currently in the buffer.</value>
  25400. <remarks>
  25401. <para>
  25402. If <paramref name="i"/> is outside the range 0 to the number of events
  25403. currently in the buffer, then <c>null</c> is returned.
  25404. </para>
  25405. </remarks>
  25406. </member>
  25407. <member name="P:log4net.Util.CyclicBuffer.MaxSize">
  25408. <summary>
  25409. Gets the maximum size of the buffer.
  25410. </summary>
  25411. <value>The maximum size of the buffer.</value>
  25412. <remarks>
  25413. <para>
  25414. Gets the maximum size of the buffer
  25415. </para>
  25416. </remarks>
  25417. </member>
  25418. <member name="P:log4net.Util.CyclicBuffer.Length">
  25419. <summary>
  25420. Gets the number of logging events in the buffer.
  25421. </summary>
  25422. <value>The number of logging events in the buffer.</value>
  25423. <remarks>
  25424. <para>
  25425. This number is guaranteed to be in the range 0 to <see cref="P:log4net.Util.CyclicBuffer.MaxSize"/>
  25426. (inclusive).
  25427. </para>
  25428. </remarks>
  25429. </member>
  25430. <member name="T:log4net.Util.EmptyCollection">
  25431. <summary>
  25432. An always empty <see cref="T:System.Collections.ICollection"/>.
  25433. </summary>
  25434. <remarks>
  25435. <para>
  25436. A singleton implementation of the <see cref="T:System.Collections.ICollection"/>
  25437. interface that always represents an empty collection.
  25438. </para>
  25439. </remarks>
  25440. <author>Nicko Cadell</author>
  25441. <author>Gert Driesen</author>
  25442. </member>
  25443. <member name="M:log4net.Util.EmptyCollection.#ctor">
  25444. <summary>
  25445. Initializes a new instance of the <see cref="T:log4net.Util.EmptyCollection"/> class.
  25446. </summary>
  25447. <remarks>
  25448. <para>
  25449. Uses a private access modifier to enforce the singleton pattern.
  25450. </para>
  25451. </remarks>
  25452. </member>
  25453. <member name="M:log4net.Util.EmptyCollection.CopyTo(System.Array,System.Int32)">
  25454. <summary>
  25455. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  25456. <see cref="T:System.Array"/>, starting at a particular Array index.
  25457. </summary>
  25458. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  25459. that is the destination of the elements copied from
  25460. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  25461. indexing.</param>
  25462. <param name="index">The zero-based index in array at which
  25463. copying begins.</param>
  25464. <remarks>
  25465. <para>
  25466. As the collection is empty no values are copied into the array.
  25467. </para>
  25468. </remarks>
  25469. </member>
  25470. <member name="M:log4net.Util.EmptyCollection.GetEnumerator">
  25471. <summary>
  25472. Returns an enumerator that can iterate through a collection.
  25473. </summary>
  25474. <returns>
  25475. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25476. iterate through the collection.
  25477. </returns>
  25478. <remarks>
  25479. <para>
  25480. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25481. </para>
  25482. </remarks>
  25483. </member>
  25484. <member name="F:log4net.Util.EmptyCollection.s_instance">
  25485. <summary>
  25486. The singleton instance of the empty collection.
  25487. </summary>
  25488. </member>
  25489. <member name="P:log4net.Util.EmptyCollection.Instance">
  25490. <summary>
  25491. Gets the singleton instance of the empty collection.
  25492. </summary>
  25493. <returns>The singleton instance of the empty collection.</returns>
  25494. <remarks>
  25495. <para>
  25496. Gets the singleton instance of the empty collection.
  25497. </para>
  25498. </remarks>
  25499. </member>
  25500. <member name="P:log4net.Util.EmptyCollection.IsSynchronized">
  25501. <summary>
  25502. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  25503. </summary>
  25504. <value>
  25505. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  25506. </value>
  25507. <remarks>
  25508. <para>
  25509. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <c>true</c>.
  25510. </para>
  25511. </remarks>
  25512. </member>
  25513. <member name="P:log4net.Util.EmptyCollection.Count">
  25514. <summary>
  25515. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25516. </summary>
  25517. <value>
  25518. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25519. </value>
  25520. <remarks>
  25521. <para>
  25522. As the collection is empty the <see cref="P:log4net.Util.EmptyCollection.Count"/> is always <c>0</c>.
  25523. </para>
  25524. </remarks>
  25525. </member>
  25526. <member name="P:log4net.Util.EmptyCollection.SyncRoot">
  25527. <summary>
  25528. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25529. </summary>
  25530. <value>
  25531. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25532. </value>
  25533. <remarks>
  25534. <para>
  25535. As the collection is empty and thread safe and synchronized this instance is also
  25536. the <see cref="P:log4net.Util.EmptyCollection.SyncRoot"/> object.
  25537. </para>
  25538. </remarks>
  25539. </member>
  25540. <member name="T:log4net.Util.EmptyDictionary">
  25541. <summary>
  25542. An always empty <see cref="T:System.Collections.IDictionary"/>.
  25543. </summary>
  25544. <remarks>
  25545. <para>
  25546. A singleton implementation of the <see cref="T:System.Collections.IDictionary"/>
  25547. interface that always represents an empty collection.
  25548. </para>
  25549. </remarks>
  25550. <author>Nicko Cadell</author>
  25551. <author>Gert Driesen</author>
  25552. </member>
  25553. <member name="M:log4net.Util.EmptyDictionary.#ctor">
  25554. <summary>
  25555. Initializes a new instance of the <see cref="T:log4net.Util.EmptyDictionary"/> class.
  25556. </summary>
  25557. <remarks>
  25558. <para>
  25559. Uses a private access modifier to enforce the singleton pattern.
  25560. </para>
  25561. </remarks>
  25562. </member>
  25563. <member name="M:log4net.Util.EmptyDictionary.CopyTo(System.Array,System.Int32)">
  25564. <summary>
  25565. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  25566. <see cref="T:System.Array"/>, starting at a particular Array index.
  25567. </summary>
  25568. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  25569. that is the destination of the elements copied from
  25570. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  25571. indexing.</param>
  25572. <param name="index">The zero-based index in array at which
  25573. copying begins.</param>
  25574. <remarks>
  25575. <para>
  25576. As the collection is empty no values are copied into the array.
  25577. </para>
  25578. </remarks>
  25579. </member>
  25580. <member name="M:log4net.Util.EmptyDictionary.System#Collections#IEnumerable#GetEnumerator">
  25581. <summary>
  25582. Returns an enumerator that can iterate through a collection.
  25583. </summary>
  25584. <returns>
  25585. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25586. iterate through the collection.
  25587. </returns>
  25588. <remarks>
  25589. <para>
  25590. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25591. </para>
  25592. </remarks>
  25593. </member>
  25594. <member name="M:log4net.Util.EmptyDictionary.Add(System.Object,System.Object)">
  25595. <summary>
  25596. Adds an element with the provided key and value to the
  25597. <see cref="T:log4net.Util.EmptyDictionary"/>.
  25598. </summary>
  25599. <param name="key">The <see cref="T:System.Object"/> to use as the key of the element to add.</param>
  25600. <param name="value">The <see cref="T:System.Object"/> to use as the value of the element to add.</param>
  25601. <remarks>
  25602. <para>
  25603. As the collection is empty no new values can be added. A <see cref="T:System.InvalidOperationException"/>
  25604. is thrown if this method is called.
  25605. </para>
  25606. </remarks>
  25607. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25608. </member>
  25609. <member name="M:log4net.Util.EmptyDictionary.Clear">
  25610. <summary>
  25611. Removes all elements from the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25612. </summary>
  25613. <remarks>
  25614. <para>
  25615. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  25616. is thrown if this method is called.
  25617. </para>
  25618. </remarks>
  25619. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25620. </member>
  25621. <member name="M:log4net.Util.EmptyDictionary.Contains(System.Object)">
  25622. <summary>
  25623. Determines whether the <see cref="T:log4net.Util.EmptyDictionary"/> contains an element
  25624. with the specified key.
  25625. </summary>
  25626. <param name="key">The key to locate in the <see cref="T:log4net.Util.EmptyDictionary"/>.</param>
  25627. <returns><c>false</c></returns>
  25628. <remarks>
  25629. <para>
  25630. As the collection is empty the <see cref="M:log4net.Util.EmptyDictionary.Contains(System.Object)"/> method always returns <c>false</c>.
  25631. </para>
  25632. </remarks>
  25633. </member>
  25634. <member name="M:log4net.Util.EmptyDictionary.GetEnumerator">
  25635. <summary>
  25636. Returns an enumerator that can iterate through a collection.
  25637. </summary>
  25638. <returns>
  25639. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25640. iterate through the collection.
  25641. </returns>
  25642. <remarks>
  25643. <para>
  25644. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25645. </para>
  25646. </remarks>
  25647. </member>
  25648. <member name="M:log4net.Util.EmptyDictionary.Remove(System.Object)">
  25649. <summary>
  25650. Removes the element with the specified key from the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25651. </summary>
  25652. <param name="key">The key of the element to remove.</param>
  25653. <remarks>
  25654. <para>
  25655. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  25656. is thrown if this method is called.
  25657. </para>
  25658. </remarks>
  25659. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25660. </member>
  25661. <member name="F:log4net.Util.EmptyDictionary.s_instance">
  25662. <summary>
  25663. The singleton instance of the empty dictionary.
  25664. </summary>
  25665. </member>
  25666. <member name="P:log4net.Util.EmptyDictionary.Instance">
  25667. <summary>
  25668. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25669. </summary>
  25670. <returns>The singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.</returns>
  25671. <remarks>
  25672. <para>
  25673. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25674. </para>
  25675. </remarks>
  25676. </member>
  25677. <member name="P:log4net.Util.EmptyDictionary.IsSynchronized">
  25678. <summary>
  25679. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  25680. </summary>
  25681. <value>
  25682. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  25683. </value>
  25684. <remarks>
  25685. <para>
  25686. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <b>true</b>.
  25687. </para>
  25688. </remarks>
  25689. </member>
  25690. <member name="P:log4net.Util.EmptyDictionary.Count">
  25691. <summary>
  25692. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>
  25693. </summary>
  25694. <value>
  25695. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25696. </value>
  25697. <remarks>
  25698. <para>
  25699. As the collection is empty the <see cref="P:log4net.Util.EmptyDictionary.Count"/> is always <c>0</c>.
  25700. </para>
  25701. </remarks>
  25702. </member>
  25703. <member name="P:log4net.Util.EmptyDictionary.SyncRoot">
  25704. <summary>
  25705. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25706. </summary>
  25707. <value>
  25708. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25709. </value>
  25710. <remarks>
  25711. <para>
  25712. As the collection is empty and thread safe and synchronized this instance is also
  25713. the <see cref="P:log4net.Util.EmptyDictionary.SyncRoot"/> object.
  25714. </para>
  25715. </remarks>
  25716. </member>
  25717. <member name="P:log4net.Util.EmptyDictionary.IsFixedSize">
  25718. <summary>
  25719. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> has a fixed size.
  25720. </summary>
  25721. <value><c>true</c></value>
  25722. <remarks>
  25723. <para>
  25724. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsFixedSize"/> always returns <c>true</c>.
  25725. </para>
  25726. </remarks>
  25727. </member>
  25728. <member name="P:log4net.Util.EmptyDictionary.IsReadOnly">
  25729. <summary>
  25730. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> is read-only.
  25731. </summary>
  25732. <value><c>true</c></value>
  25733. <remarks>
  25734. <para>
  25735. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsReadOnly"/> always returns <c>true</c>.
  25736. </para>
  25737. </remarks>
  25738. </member>
  25739. <member name="P:log4net.Util.EmptyDictionary.Keys">
  25740. <summary>
  25741. Gets an <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25742. </summary>
  25743. <value>An <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value>
  25744. <remarks>
  25745. <para>
  25746. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  25747. </para>
  25748. </remarks>
  25749. </member>
  25750. <member name="P:log4net.Util.EmptyDictionary.Values">
  25751. <summary>
  25752. Gets an <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25753. </summary>
  25754. <value>An <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value>
  25755. <remarks>
  25756. <para>
  25757. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  25758. </para>
  25759. </remarks>
  25760. </member>
  25761. <member name="P:log4net.Util.EmptyDictionary.Item(System.Object)">
  25762. <summary>
  25763. Gets or sets the element with the specified key.
  25764. </summary>
  25765. <param name="key">The key of the element to get or set.</param>
  25766. <value><c>null</c></value>
  25767. <remarks>
  25768. <para>
  25769. As the collection is empty no values can be looked up or stored.
  25770. If the index getter is called then <c>null</c> is returned.
  25771. A <see cref="T:System.InvalidOperationException"/> is thrown if the setter is called.
  25772. </para>
  25773. </remarks>
  25774. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25775. </member>
  25776. <member name="T:log4net.Util.FormattingInfo">
  25777. <summary>
  25778. Contain the information obtained when parsing formatting modifiers
  25779. in conversion modifiers.
  25780. </summary>
  25781. <remarks>
  25782. <para>
  25783. Holds the formatting information extracted from the format string by
  25784. the <see cref="T:log4net.Util.PatternParser"/>. This is used by the <see cref="T:log4net.Util.PatternConverter"/>
  25785. objects when rendering the output.
  25786. </para>
  25787. </remarks>
  25788. <author>Nicko Cadell</author>
  25789. <author>Gert Driesen</author>
  25790. </member>
  25791. <member name="M:log4net.Util.FormattingInfo.#ctor">
  25792. <summary>
  25793. Defaut Constructor
  25794. </summary>
  25795. <remarks>
  25796. <para>
  25797. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class.
  25798. </para>
  25799. </remarks>
  25800. </member>
  25801. <member name="M:log4net.Util.FormattingInfo.#ctor(System.Int32,System.Int32,System.Boolean)">
  25802. <summary>
  25803. Constructor
  25804. </summary>
  25805. <remarks>
  25806. <para>
  25807. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class
  25808. with the specified parameters.
  25809. </para>
  25810. </remarks>
  25811. </member>
  25812. <member name="P:log4net.Util.FormattingInfo.Min">
  25813. <summary>
  25814. Gets or sets the minimum value.
  25815. </summary>
  25816. <value>
  25817. The minimum value.
  25818. </value>
  25819. <remarks>
  25820. <para>
  25821. Gets or sets the minimum value.
  25822. </para>
  25823. </remarks>
  25824. </member>
  25825. <member name="P:log4net.Util.FormattingInfo.Max">
  25826. <summary>
  25827. Gets or sets the maximum value.
  25828. </summary>
  25829. <value>
  25830. The maximum value.
  25831. </value>
  25832. <remarks>
  25833. <para>
  25834. Gets or sets the maximum value.
  25835. </para>
  25836. </remarks>
  25837. </member>
  25838. <member name="P:log4net.Util.FormattingInfo.LeftAlign">
  25839. <summary>
  25840. Gets or sets a flag indicating whether left align is enabled
  25841. or not.
  25842. </summary>
  25843. <value>
  25844. A flag indicating whether left align is enabled or not.
  25845. </value>
  25846. <remarks>
  25847. <para>
  25848. Gets or sets a flag indicating whether left align is enabled or not.
  25849. </para>
  25850. </remarks>
  25851. </member>
  25852. <member name="T:log4net.Util.GlobalContextProperties">
  25853. <summary>
  25854. Implementation of Properties collection for the <see cref="T:log4net.GlobalContext"/>
  25855. </summary>
  25856. <remarks>
  25857. <para>
  25858. This class implements a properties collection that is thread safe and supports both
  25859. storing properties and capturing a read only copy of the current propertied.
  25860. </para>
  25861. <para>
  25862. This class is optimized to the scenario where the properties are read frequently
  25863. and are modified infrequently.
  25864. </para>
  25865. </remarks>
  25866. <author>Nicko Cadell</author>
  25867. </member>
  25868. <member name="F:log4net.Util.GlobalContextProperties.m_readOnlyProperties">
  25869. <summary>
  25870. The read only copy of the properties.
  25871. </summary>
  25872. <remarks>
  25873. <para>
  25874. This variable is declared <c>volatile</c> to prevent the compiler and JIT from
  25875. reordering reads and writes of this thread performed on different threads.
  25876. </para>
  25877. </remarks>
  25878. </member>
  25879. <member name="F:log4net.Util.GlobalContextProperties.m_syncRoot">
  25880. <summary>
  25881. Lock object used to synchronize updates within this instance
  25882. </summary>
  25883. </member>
  25884. <member name="M:log4net.Util.GlobalContextProperties.#ctor">
  25885. <summary>
  25886. Constructor
  25887. </summary>
  25888. <remarks>
  25889. <para>
  25890. Initializes a new instance of the <see cref="T:log4net.Util.GlobalContextProperties"/> class.
  25891. </para>
  25892. </remarks>
  25893. </member>
  25894. <member name="M:log4net.Util.GlobalContextProperties.Remove(System.String)">
  25895. <summary>
  25896. Remove a property from the global context
  25897. </summary>
  25898. <param name="key">the key for the entry to remove</param>
  25899. <remarks>
  25900. <para>
  25901. Removing an entry from the global context properties is relatively expensive compared
  25902. with reading a value.
  25903. </para>
  25904. </remarks>
  25905. </member>
  25906. <member name="M:log4net.Util.GlobalContextProperties.Clear">
  25907. <summary>
  25908. Clear the global context properties
  25909. </summary>
  25910. </member>
  25911. <member name="M:log4net.Util.GlobalContextProperties.GetReadOnlyProperties">
  25912. <summary>
  25913. Get a readonly immutable copy of the properties
  25914. </summary>
  25915. <returns>the current global context properties</returns>
  25916. <remarks>
  25917. <para>
  25918. This implementation is fast because the GlobalContextProperties class
  25919. stores a readonly copy of the properties.
  25920. </para>
  25921. </remarks>
  25922. </member>
  25923. <member name="P:log4net.Util.GlobalContextProperties.Item(System.String)">
  25924. <summary>
  25925. Gets or sets the value of a property
  25926. </summary>
  25927. <value>
  25928. The value for the property with the specified key
  25929. </value>
  25930. <remarks>
  25931. <para>
  25932. Reading the value for a key is faster than setting the value.
  25933. When the value is written a new read only copy of
  25934. the properties is created.
  25935. </para>
  25936. </remarks>
  25937. </member>
  25938. <member name="T:log4net.Util.ILogExtensions">
  25939. <summary>
  25940. The static class ILogExtensions contains a set of widely used
  25941. methods that ease the interaction with the ILog interface implementations.
  25942. </summary>
  25943. <remarks>
  25944. <para>
  25945. This class contains methods for logging at different levels and checks the
  25946. properties for determining if those logging levels are enabled in the current
  25947. configuration.
  25948. </para>
  25949. </remarks>
  25950. <example>Simple example of logging messages
  25951. <code lang="C#">
  25952. using log4net.Util;
  25953. ILog log = LogManager.GetLogger("application-log");
  25954. log.InfoExt("Application Start");
  25955. log.DebugExt("This is a debug message");
  25956. </code>
  25957. </example>
  25958. </member>
  25959. <member name="F:log4net.Util.ILogExtensions.declaringType">
  25960. <summary>
  25961. The fully qualified type of the Logger class.
  25962. </summary>
  25963. </member>
  25964. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object})">
  25965. <summary>
  25966. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25967. </summary>
  25968. <param name="logger">The logger on which the message is logged.</param>
  25969. <param name="callback">The lambda expression that gets the object to log.</param>
  25970. <remarks>
  25971. <para>
  25972. This method first checks if this logger is <c>INFO</c>
  25973. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  25974. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25975. implementation. If this logger is <c>INFO</c> enabled, then it converts
  25976. the message object (retrieved by invocation of the provided callback) to a
  25977. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  25978. It then proceeds to call all the registered appenders in this logger
  25979. and also higher in the hierarchy depending on the value of
  25980. the additivity flag.
  25981. </para>
  25982. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25983. to this method will print the name of the <see cref="T:System.Exception"/>
  25984. but no stack trace. To print a stack trace use the
  25985. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  25986. </para>
  25987. </remarks>
  25988. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25989. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25990. </member>
  25991. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  25992. <summary>
  25993. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  25994. the stack trace of the <see cref="T:System.Exception"/> passed
  25995. as a parameter.
  25996. </summary>
  25997. <param name="logger">The logger on which the message is logged.</param>
  25998. <param name="callback">The lambda expression that gets the object to log.</param>
  25999. <param name="exception">The exception to log, including its stack trace.</param>
  26000. <remarks>
  26001. <para>
  26002. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26003. </para>
  26004. </remarks>
  26005. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26006. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26007. </member>
  26008. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)">
  26009. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> //TODO
  26010. <summary>
  26011. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26012. </summary>
  26013. <param name="logger">The logger on which the message is logged.</param>
  26014. <param name="message">The message object to log.</param>
  26015. <remarks>
  26016. <para>
  26017. This method first checks if this logger is <c>INFO</c>
  26018. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  26019. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26020. implementation. If this logger is <c>INFO</c> enabled, then it converts
  26021. the message object (passed as parameter) to a string by invoking the appropriate
  26022. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26023. proceeds to call all the registered appenders in this logger
  26024. and also higher in the hierarchy depending on the value of
  26025. the additivity flag.
  26026. </para>
  26027. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26028. to this method will print the name of the <see cref="T:System.Exception"/>
  26029. but no stack trace. To print a stack trace use the
  26030. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26031. </para>
  26032. </remarks>
  26033. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26034. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26035. </member>
  26036. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)">
  26037. <summary>
  26038. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  26039. the stack trace of the <see cref="T:System.Exception"/> passed
  26040. as a parameter.
  26041. </summary>
  26042. <param name="logger">The logger on which the message is logged.</param>
  26043. <param name="message">The message object to log.</param>
  26044. <param name="exception">The exception to log, including its stack trace.</param>
  26045. <remarks>
  26046. <para>
  26047. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26048. </para>
  26049. </remarks>
  26050. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26051. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26052. </member>
  26053. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object)">
  26054. <summary>
  26055. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26056. </summary>
  26057. <param name="logger">The logger on which the message is logged.</param>
  26058. <param name="format">A String containing zero or more format items</param>
  26059. <param name="arg0">An Object to format</param>
  26060. <remarks>
  26061. <para>
  26062. The message is formatted using the <c>String.Format</c> method. See
  26063. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26064. of the formatting.
  26065. </para>
  26066. <para>
  26067. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26068. 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)"/>
  26069. methods instead.
  26070. </para>
  26071. </remarks>
  26072. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26073. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26074. </member>
  26075. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object[])">
  26076. <summary>
  26077. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26078. </summary>
  26079. <param name="logger">The logger on which the message is logged.</param>
  26080. <param name="format">A String containing zero or more format items</param>
  26081. <param name="args">An Object array containing zero or more objects to format</param>
  26082. <remarks>
  26083. <para>
  26084. The message is formatted using the <c>String.Format</c> method. See
  26085. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26086. of the formatting.
  26087. </para>
  26088. <para>
  26089. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26090. 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)"/>
  26091. methods instead.
  26092. </para>
  26093. </remarks>
  26094. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26095. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26096. </member>
  26097. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26098. <summary>
  26099. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26100. </summary>
  26101. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26102. <param name="logger">The logger on which the message is logged.</param>
  26103. <param name="format">A String containing zero or more format items</param>
  26104. <param name="args">An Object array containing zero or more objects to format</param>
  26105. <remarks>
  26106. <para>
  26107. The message is formatted using the <c>String.Format</c> method. See
  26108. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26109. of the formatting.
  26110. </para>
  26111. <para>
  26112. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26113. 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)"/>
  26114. methods instead.
  26115. </para>
  26116. </remarks>
  26117. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26118. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26119. </member>
  26120. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26121. <summary>
  26122. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26123. </summary>
  26124. <param name="logger">The logger on which the message is logged.</param>
  26125. <param name="format">A String containing zero or more format items</param>
  26126. <param name="arg0">An Object to format</param>
  26127. <param name="arg1">An Object to format</param>
  26128. <remarks>
  26129. <para>
  26130. The message is formatted using the <c>String.Format</c> method. See
  26131. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26132. of the formatting.
  26133. </para>
  26134. <para>
  26135. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26136. 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)"/>
  26137. methods instead.
  26138. </para>
  26139. </remarks>
  26140. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26141. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26142. </member>
  26143. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26144. <summary>
  26145. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  26146. </summary>
  26147. <param name="logger">The logger on which the message is logged.</param>
  26148. <param name="format">A String containing zero or more format items</param>
  26149. <param name="arg0">An Object to format</param>
  26150. <param name="arg1">An Object to format</param>
  26151. <param name="arg2">An Object to format</param>
  26152. <remarks>
  26153. <para>
  26154. The message is formatted using the <c>String.Format</c> method. See
  26155. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26156. of the formatting.
  26157. </para>
  26158. <para>
  26159. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26160. 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)"/>
  26161. methods instead.
  26162. </para>
  26163. </remarks>
  26164. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  26165. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  26166. </member>
  26167. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object})">
  26168. <summary>
  26169. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  26170. </summary>
  26171. <param name="logger">The logger on which the message is logged.</param>
  26172. <param name="callback">The lambda expression that gets the object to log.</param>
  26173. <remarks>
  26174. <para>
  26175. This method first checks if this logger is <c>INFO</c>
  26176. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  26177. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26178. implementation. If this logger is <c>INFO</c> enabled, then it converts
  26179. the message object (retrieved by invocation of the provided callback) to a
  26180. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26181. It then proceeds to call all the registered appenders in this logger
  26182. and also higher in the hierarchy depending on the value of
  26183. the additivity flag.
  26184. </para>
  26185. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26186. to this method will print the name of the <see cref="T:System.Exception"/>
  26187. but no stack trace. To print a stack trace use the
  26188. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26189. </para>
  26190. </remarks>
  26191. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26192. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26193. </member>
  26194. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26195. <summary>
  26196. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  26197. the stack trace of the <see cref="T:System.Exception"/> passed
  26198. as a parameter.
  26199. </summary>
  26200. <param name="logger">The logger on which the message is logged.</param>
  26201. <param name="callback">The lambda expression that gets the object to log.</param>
  26202. <param name="exception">The exception to log, including its stack trace.</param>
  26203. <remarks>
  26204. <para>
  26205. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26206. </para>
  26207. </remarks>
  26208. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26209. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26210. </member>
  26211. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)">
  26212. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> //TODO
  26213. <summary>
  26214. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  26215. </summary>
  26216. <param name="logger">The logger on which the message is logged.</param>
  26217. <param name="message">The message object to log.</param>
  26218. <remarks>
  26219. <para>
  26220. This method first checks if this logger is <c>INFO</c>
  26221. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  26222. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26223. implementation. If this logger is <c>INFO</c> enabled, then it converts
  26224. the message object (passed as parameter) to a string by invoking the appropriate
  26225. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26226. proceeds to call all the registered appenders in this logger
  26227. and also higher in the hierarchy depending on the value of
  26228. the additivity flag.
  26229. </para>
  26230. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26231. to this method will print the name of the <see cref="T:System.Exception"/>
  26232. but no stack trace. To print a stack trace use the
  26233. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26234. </para>
  26235. </remarks>
  26236. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26237. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26238. </member>
  26239. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)">
  26240. <summary>
  26241. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  26242. the stack trace of the <see cref="T:System.Exception"/> passed
  26243. as a parameter.
  26244. </summary>
  26245. <param name="logger">The logger on which the message is logged.</param>
  26246. <param name="message">The message object to log.</param>
  26247. <param name="exception">The exception to log, including its stack trace.</param>
  26248. <remarks>
  26249. <para>
  26250. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26251. </para>
  26252. </remarks>
  26253. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26254. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26255. </member>
  26256. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object)">
  26257. <summary>
  26258. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  26259. </summary>
  26260. <param name="logger">The logger on which the message is logged.</param>
  26261. <param name="format">A String containing zero or more format items</param>
  26262. <param name="arg0">An Object to format</param>
  26263. <remarks>
  26264. <para>
  26265. The message is formatted using the <c>String.Format</c> method. See
  26266. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26267. of the formatting.
  26268. </para>
  26269. <para>
  26270. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26271. 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)"/>
  26272. methods instead.
  26273. </para>
  26274. </remarks>
  26275. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26276. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26277. </member>
  26278. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object[])">
  26279. <summary>
  26280. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  26281. </summary>
  26282. <param name="logger">The logger on which the message is logged.</param>
  26283. <param name="format">A String containing zero or more format items</param>
  26284. <param name="args">An Object array containing zero or more objects to format</param>
  26285. <remarks>
  26286. <para>
  26287. The message is formatted using the <c>String.Format</c> method. See
  26288. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26289. of the formatting.
  26290. </para>
  26291. <para>
  26292. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26293. 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)"/>
  26294. methods instead.
  26295. </para>
  26296. </remarks>
  26297. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26298. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26299. </member>
  26300. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26301. <summary>
  26302. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  26303. </summary>
  26304. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26305. <param name="logger">The logger on which the message is logged.</param>
  26306. <param name="format">A String containing zero or more format items</param>
  26307. <param name="args">An Object array containing zero or more objects to format</param>
  26308. <remarks>
  26309. <para>
  26310. The message is formatted using the <c>String.Format</c> method. See
  26311. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26312. of the formatting.
  26313. </para>
  26314. <para>
  26315. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26316. 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)"/>
  26317. methods instead.
  26318. </para>
  26319. </remarks>
  26320. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26321. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26322. </member>
  26323. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26324. <summary>
  26325. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  26326. </summary>
  26327. <param name="logger">The logger on which the message is logged.</param>
  26328. <param name="format">A String containing zero or more format items</param>
  26329. <param name="arg0">An Object to format</param>
  26330. <param name="arg1">An Object to format</param>
  26331. <remarks>
  26332. <para>
  26333. The message is formatted using the <c>String.Format</c> method. See
  26334. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26335. of the formatting.
  26336. </para>
  26337. <para>
  26338. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26339. 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)"/>
  26340. methods instead.
  26341. </para>
  26342. </remarks>
  26343. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26344. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26345. </member>
  26346. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26347. <summary>
  26348. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  26349. </summary>
  26350. <param name="logger">The logger on which the message is logged.</param>
  26351. <param name="format">A String containing zero or more format items</param>
  26352. <param name="arg0">An Object to format</param>
  26353. <param name="arg1">An Object to format</param>
  26354. <param name="arg2">An Object to format</param>
  26355. <remarks>
  26356. <para>
  26357. The message is formatted using the <c>String.Format</c> method. See
  26358. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26359. of the formatting.
  26360. </para>
  26361. <para>
  26362. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26363. 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)"/>
  26364. methods instead.
  26365. </para>
  26366. </remarks>
  26367. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  26368. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  26369. </member>
  26370. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object})">
  26371. <summary>
  26372. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26373. </summary>
  26374. <param name="logger">The logger on which the message is logged.</param>
  26375. <param name="callback">The lambda expression that gets the object to log.</param>
  26376. <remarks>
  26377. <para>
  26378. This method first checks if this logger is <c>WARN</c>
  26379. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  26380. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26381. implementation. If this logger is <c>WARN</c> enabled, then it converts
  26382. the message object (retrieved by invocation of the provided callback) to a
  26383. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26384. It then proceeds to call all the registered appenders in this logger
  26385. and also higher in the hierarchy depending on the value of
  26386. the additivity flag.
  26387. </para>
  26388. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26389. to this method will print the name of the <see cref="T:System.Exception"/>
  26390. but no stack trace. To print a stack trace use the
  26391. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26392. </para>
  26393. </remarks>
  26394. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26395. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26396. </member>
  26397. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26398. <summary>
  26399. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  26400. the stack trace of the <see cref="T:System.Exception"/> passed
  26401. as a parameter.
  26402. </summary>
  26403. <param name="logger">The logger on which the message is logged.</param>
  26404. <param name="callback">The lambda expression that gets the object to log.</param>
  26405. <param name="exception">The exception to log, including its stack trace.</param>
  26406. <remarks>
  26407. <para>
  26408. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26409. </para>
  26410. </remarks>
  26411. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26412. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26413. </member>
  26414. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)">
  26415. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> //TODO
  26416. <summary>
  26417. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26418. </summary>
  26419. <param name="logger">The logger on which the message is logged.</param>
  26420. <param name="message">The message object to log.</param>
  26421. <remarks>
  26422. <para>
  26423. This method first checks if this logger is <c>WARN</c>
  26424. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  26425. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26426. implementation. If this logger is <c>WARN</c> enabled, then it converts
  26427. the message object (passed as parameter) to a string by invoking the appropriate
  26428. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26429. proceeds to call all the registered appenders in this logger
  26430. and also higher in the hierarchy depending on the value of
  26431. the additivity flag.
  26432. </para>
  26433. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26434. to this method will print the name of the <see cref="T:System.Exception"/>
  26435. but no stack trace. To print a stack trace use the
  26436. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26437. </para>
  26438. </remarks>
  26439. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26440. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26441. </member>
  26442. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)">
  26443. <summary>
  26444. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  26445. the stack trace of the <see cref="T:System.Exception"/> passed
  26446. as a parameter.
  26447. </summary>
  26448. <param name="logger">The logger on which the message is logged.</param>
  26449. <param name="message">The message object to log.</param>
  26450. <param name="exception">The exception to log, including its stack trace.</param>
  26451. <remarks>
  26452. <para>
  26453. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26454. </para>
  26455. </remarks>
  26456. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26457. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26458. </member>
  26459. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object)">
  26460. <summary>
  26461. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26462. </summary>
  26463. <param name="logger">The logger on which the message is logged.</param>
  26464. <param name="format">A String containing zero or more format items</param>
  26465. <param name="arg0">An Object to format</param>
  26466. <remarks>
  26467. <para>
  26468. The message is formatted using the <c>String.Format</c> method. See
  26469. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26470. of the formatting.
  26471. </para>
  26472. <para>
  26473. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26474. 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)"/>
  26475. methods instead.
  26476. </para>
  26477. </remarks>
  26478. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26479. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26480. </member>
  26481. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object[])">
  26482. <summary>
  26483. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26484. </summary>
  26485. <param name="logger">The logger on which the message is logged.</param>
  26486. <param name="format">A String containing zero or more format items</param>
  26487. <param name="args">An Object array containing zero or more objects to format</param>
  26488. <remarks>
  26489. <para>
  26490. The message is formatted using the <c>String.Format</c> method. See
  26491. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26492. of the formatting.
  26493. </para>
  26494. <para>
  26495. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26496. 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)"/>
  26497. methods instead.
  26498. </para>
  26499. </remarks>
  26500. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26501. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26502. </member>
  26503. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26504. <summary>
  26505. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26506. </summary>
  26507. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26508. <param name="logger">The logger on which the message is logged.</param>
  26509. <param name="format">A String containing zero or more format items</param>
  26510. <param name="args">An Object array containing zero or more objects to format</param>
  26511. <remarks>
  26512. <para>
  26513. The message is formatted using the <c>String.Format</c> method. See
  26514. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26515. of the formatting.
  26516. </para>
  26517. <para>
  26518. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26519. 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)"/>
  26520. methods instead.
  26521. </para>
  26522. </remarks>
  26523. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26524. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26525. </member>
  26526. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26527. <summary>
  26528. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26529. </summary>
  26530. <param name="logger">The logger on which the message is logged.</param>
  26531. <param name="format">A String containing zero or more format items</param>
  26532. <param name="arg0">An Object to format</param>
  26533. <param name="arg1">An Object to format</param>
  26534. <remarks>
  26535. <para>
  26536. The message is formatted using the <c>String.Format</c> method. See
  26537. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26538. of the formatting.
  26539. </para>
  26540. <para>
  26541. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26542. 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)"/>
  26543. methods instead.
  26544. </para>
  26545. </remarks>
  26546. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26547. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26548. </member>
  26549. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26550. <summary>
  26551. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26552. </summary>
  26553. <param name="logger">The logger on which the message is logged.</param>
  26554. <param name="format">A String containing zero or more format items</param>
  26555. <param name="arg0">An Object to format</param>
  26556. <param name="arg1">An Object to format</param>
  26557. <param name="arg2">An Object to format</param>
  26558. <remarks>
  26559. <para>
  26560. The message is formatted using the <c>String.Format</c> method. See
  26561. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26562. of the formatting.
  26563. </para>
  26564. <para>
  26565. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26566. 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)"/>
  26567. methods instead.
  26568. </para>
  26569. </remarks>
  26570. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26571. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26572. </member>
  26573. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object})">
  26574. <summary>
  26575. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  26576. </summary>
  26577. <param name="logger">The logger on which the message is logged.</param>
  26578. <param name="callback">The lambda expression that gets the object to log.</param>
  26579. <remarks>
  26580. <para>
  26581. This method first checks if this logger is <c>ERROR</c>
  26582. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  26583. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26584. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  26585. the message object (retrieved by invocation of the provided callback) to a
  26586. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26587. It then proceeds to call all the registered appenders in this logger
  26588. and also higher in the hierarchy depending on the value of
  26589. the additivity flag.
  26590. </para>
  26591. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26592. to this method will print the name of the <see cref="T:System.Exception"/>
  26593. but no stack trace. To print a stack trace use the
  26594. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26595. </para>
  26596. </remarks>
  26597. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26598. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26599. </member>
  26600. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26601. <summary>
  26602. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  26603. the stack trace of the <see cref="T:System.Exception"/> passed
  26604. as a parameter.
  26605. </summary>
  26606. <param name="logger">The logger on which the message is logged.</param>
  26607. <param name="callback">The lambda expression that gets the object to log.</param>
  26608. <param name="exception">The exception to log, including its stack trace.</param>
  26609. <remarks>
  26610. <para>
  26611. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26612. </para>
  26613. </remarks>
  26614. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26615. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26616. </member>
  26617. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)">
  26618. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> //TODO
  26619. <summary>
  26620. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  26621. </summary>
  26622. <param name="logger">The logger on which the message is logged.</param>
  26623. <param name="message">The message object to log.</param>
  26624. <remarks>
  26625. <para>
  26626. This method first checks if this logger is <c>ERROR</c>
  26627. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  26628. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26629. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  26630. the message object (passed as parameter) to a string by invoking the appropriate
  26631. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26632. proceeds to call all the registered appenders in this logger
  26633. and also higher in the hierarchy depending on the value of
  26634. the additivity flag.
  26635. </para>
  26636. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26637. to this method will print the name of the <see cref="T:System.Exception"/>
  26638. but no stack trace. To print a stack trace use the
  26639. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26640. </para>
  26641. </remarks>
  26642. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26643. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26644. </member>
  26645. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)">
  26646. <summary>
  26647. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  26648. the stack trace of the <see cref="T:System.Exception"/> passed
  26649. as a parameter.
  26650. </summary>
  26651. <param name="logger">The logger on which the message is logged.</param>
  26652. <param name="message">The message object to log.</param>
  26653. <param name="exception">The exception to log, including its stack trace.</param>
  26654. <remarks>
  26655. <para>
  26656. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26657. </para>
  26658. </remarks>
  26659. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26660. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26661. </member>
  26662. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object)">
  26663. <summary>
  26664. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26665. </summary>
  26666. <param name="logger">The logger on which the message is logged.</param>
  26667. <param name="format">A String containing zero or more format items</param>
  26668. <param name="arg0">An Object to format</param>
  26669. <remarks>
  26670. <para>
  26671. The message is formatted using the <c>String.Format</c> method. See
  26672. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26673. of the formatting.
  26674. </para>
  26675. <para>
  26676. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26677. 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)"/>
  26678. methods instead.
  26679. </para>
  26680. </remarks>
  26681. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26682. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26683. </member>
  26684. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object[])">
  26685. <summary>
  26686. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26687. </summary>
  26688. <param name="logger">The logger on which the message is logged.</param>
  26689. <param name="format">A String containing zero or more format items</param>
  26690. <param name="args">An Object array containing zero or more objects to format</param>
  26691. <remarks>
  26692. <para>
  26693. The message is formatted using the <c>String.Format</c> method. See
  26694. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26695. of the formatting.
  26696. </para>
  26697. <para>
  26698. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26699. 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)"/>
  26700. methods instead.
  26701. </para>
  26702. </remarks>
  26703. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26704. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26705. </member>
  26706. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26707. <summary>
  26708. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26709. </summary>
  26710. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26711. <param name="logger">The logger on which the message is logged.</param>
  26712. <param name="format">A String containing zero or more format items</param>
  26713. <param name="args">An Object array containing zero or more objects to format</param>
  26714. <remarks>
  26715. <para>
  26716. The message is formatted using the <c>String.Format</c> method. See
  26717. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26718. of the formatting.
  26719. </para>
  26720. <para>
  26721. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26722. 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)"/>
  26723. methods instead.
  26724. </para>
  26725. </remarks>
  26726. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26727. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26728. </member>
  26729. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26730. <summary>
  26731. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26732. </summary>
  26733. <param name="logger">The logger on which the message is logged.</param>
  26734. <param name="format">A String containing zero or more format items</param>
  26735. <param name="arg0">An Object to format</param>
  26736. <param name="arg1">An Object to format</param>
  26737. <remarks>
  26738. <para>
  26739. The message is formatted using the <c>String.Format</c> method. See
  26740. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26741. of the formatting.
  26742. </para>
  26743. <para>
  26744. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26745. 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)"/>
  26746. methods instead.
  26747. </para>
  26748. </remarks>
  26749. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26750. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26751. </member>
  26752. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26753. <summary>
  26754. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26755. </summary>
  26756. <param name="logger">The logger on which the message is logged.</param>
  26757. <param name="format">A String containing zero or more format items</param>
  26758. <param name="arg0">An Object to format</param>
  26759. <param name="arg1">An Object to format</param>
  26760. <param name="arg2">An Object to format</param>
  26761. <remarks>
  26762. <para>
  26763. The message is formatted using the <c>String.Format</c> method. See
  26764. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26765. of the formatting.
  26766. </para>
  26767. <para>
  26768. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26769. 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)"/>
  26770. methods instead.
  26771. </para>
  26772. </remarks>
  26773. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26774. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26775. </member>
  26776. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object})">
  26777. <summary>
  26778. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26779. </summary>
  26780. <param name="logger">The logger on which the message is logged.</param>
  26781. <param name="callback">The lambda expression that gets the object to log.</param>
  26782. <remarks>
  26783. <para>
  26784. This method first checks if this logger is <c>FATAL</c>
  26785. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  26786. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26787. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  26788. the message object (retrieved by invocation of the provided callback) to a
  26789. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26790. It then proceeds to call all the registered appenders in this logger
  26791. and also higher in the hierarchy depending on the value of
  26792. the additivity flag.
  26793. </para>
  26794. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26795. to this method will print the name of the <see cref="T:System.Exception"/>
  26796. but no stack trace. To print a stack trace use the
  26797. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26798. </para>
  26799. </remarks>
  26800. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26801. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26802. </member>
  26803. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26804. <summary>
  26805. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  26806. the stack trace of the <see cref="T:System.Exception"/> passed
  26807. as a parameter.
  26808. </summary>
  26809. <param name="logger">The logger on which the message is logged.</param>
  26810. <param name="callback">The lambda expression that gets the object to log.</param>
  26811. <param name="exception">The exception to log, including its stack trace.</param>
  26812. <remarks>
  26813. <para>
  26814. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26815. </para>
  26816. </remarks>
  26817. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26818. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26819. </member>
  26820. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)">
  26821. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> //TODO
  26822. <summary>
  26823. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26824. </summary>
  26825. <param name="logger">The logger on which the message is logged.</param>
  26826. <param name="message">The message object to log.</param>
  26827. <remarks>
  26828. <para>
  26829. This method first checks if this logger is <c>FATAL</c>
  26830. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  26831. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26832. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  26833. the message object (passed as parameter) to a string by invoking the appropriate
  26834. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26835. proceeds to call all the registered appenders in this logger
  26836. and also higher in the hierarchy depending on the value of
  26837. the additivity flag.
  26838. </para>
  26839. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26840. to this method will print the name of the <see cref="T:System.Exception"/>
  26841. but no stack trace. To print a stack trace use the
  26842. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26843. </para>
  26844. </remarks>
  26845. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26846. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26847. </member>
  26848. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)">
  26849. <summary>
  26850. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  26851. the stack trace of the <see cref="T:System.Exception"/> passed
  26852. as a parameter.
  26853. </summary>
  26854. <param name="logger">The logger on which the message is logged.</param>
  26855. <param name="message">The message object to log.</param>
  26856. <param name="exception">The exception to log, including its stack trace.</param>
  26857. <remarks>
  26858. <para>
  26859. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26860. </para>
  26861. </remarks>
  26862. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26863. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26864. </member>
  26865. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object)">
  26866. <summary>
  26867. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26868. </summary>
  26869. <param name="logger">The logger on which the message is logged.</param>
  26870. <param name="format">A String containing zero or more format items</param>
  26871. <param name="arg0">An Object to format</param>
  26872. <remarks>
  26873. <para>
  26874. The message is formatted using the <c>String.Format</c> method. See
  26875. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26876. of the formatting.
  26877. </para>
  26878. <para>
  26879. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26880. 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)"/>
  26881. methods instead.
  26882. </para>
  26883. </remarks>
  26884. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26885. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26886. </member>
  26887. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object[])">
  26888. <summary>
  26889. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26890. </summary>
  26891. <param name="logger">The logger on which the message is logged.</param>
  26892. <param name="format">A String containing zero or more format items</param>
  26893. <param name="args">An Object array containing zero or more objects to format</param>
  26894. <remarks>
  26895. <para>
  26896. The message is formatted using the <c>String.Format</c> method. See
  26897. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26898. of the formatting.
  26899. </para>
  26900. <para>
  26901. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26902. 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)"/>
  26903. methods instead.
  26904. </para>
  26905. </remarks>
  26906. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26907. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26908. </member>
  26909. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26910. <summary>
  26911. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26912. </summary>
  26913. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26914. <param name="logger">The logger on which the message is logged.</param>
  26915. <param name="format">A String containing zero or more format items</param>
  26916. <param name="args">An Object array containing zero or more objects to format</param>
  26917. <remarks>
  26918. <para>
  26919. The message is formatted using the <c>String.Format</c> method. See
  26920. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26921. of the formatting.
  26922. </para>
  26923. <para>
  26924. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26925. 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)"/>
  26926. methods instead.
  26927. </para>
  26928. </remarks>
  26929. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26930. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26931. </member>
  26932. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26933. <summary>
  26934. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26935. </summary>
  26936. <param name="logger">The logger on which the message is logged.</param>
  26937. <param name="format">A String containing zero or more format items</param>
  26938. <param name="arg0">An Object to format</param>
  26939. <param name="arg1">An Object to format</param>
  26940. <remarks>
  26941. <para>
  26942. The message is formatted using the <c>String.Format</c> method. See
  26943. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26944. of the formatting.
  26945. </para>
  26946. <para>
  26947. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26948. 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)"/>
  26949. methods instead.
  26950. </para>
  26951. </remarks>
  26952. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26953. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26954. </member>
  26955. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26956. <summary>
  26957. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26958. </summary>
  26959. <param name="logger">The logger on which the message is logged.</param>
  26960. <param name="format">A String containing zero or more format items</param>
  26961. <param name="arg0">An Object to format</param>
  26962. <param name="arg1">An Object to format</param>
  26963. <param name="arg2">An Object to format</param>
  26964. <remarks>
  26965. <para>
  26966. The message is formatted using the <c>String.Format</c> method. See
  26967. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26968. of the formatting.
  26969. </para>
  26970. <para>
  26971. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26972. 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)"/>
  26973. methods instead.
  26974. </para>
  26975. </remarks>
  26976. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26977. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26978. </member>
  26979. <member name="T:log4net.Util.LevelMapping">
  26980. <summary>
  26981. Manages a mapping from levels to <see cref="T:log4net.Util.LevelMappingEntry"/>
  26982. </summary>
  26983. <remarks>
  26984. <para>
  26985. Manages an ordered mapping from <see cref="T:log4net.Core.Level"/> instances
  26986. to <see cref="T:log4net.Util.LevelMappingEntry"/> subclasses.
  26987. </para>
  26988. </remarks>
  26989. <author>Nicko Cadell</author>
  26990. </member>
  26991. <member name="M:log4net.Util.LevelMapping.#ctor">
  26992. <summary>
  26993. Default constructor
  26994. </summary>
  26995. <remarks>
  26996. <para>
  26997. Initialise a new instance of <see cref="T:log4net.Util.LevelMapping"/>.
  26998. </para>
  26999. </remarks>
  27000. </member>
  27001. <member name="M:log4net.Util.LevelMapping.Add(log4net.Util.LevelMappingEntry)">
  27002. <summary>
  27003. Add a <see cref="T:log4net.Util.LevelMappingEntry"/> to this mapping
  27004. </summary>
  27005. <param name="entry">the entry to add</param>
  27006. <remarks>
  27007. <para>
  27008. If a <see cref="T:log4net.Util.LevelMappingEntry"/> has previously been added
  27009. for the same <see cref="T:log4net.Core.Level"/> then that entry will be
  27010. overwritten.
  27011. </para>
  27012. </remarks>
  27013. </member>
  27014. <member name="M:log4net.Util.LevelMapping.Lookup(log4net.Core.Level)">
  27015. <summary>
  27016. Lookup the mapping for the specified level
  27017. </summary>
  27018. <param name="level">the level to lookup</param>
  27019. <returns>the <see cref="T:log4net.Util.LevelMappingEntry"/> for the level or <c>null</c> if no mapping found</returns>
  27020. <remarks>
  27021. <para>
  27022. Lookup the value for the specified level. Finds the nearest
  27023. mapping value for the level that is equal to or less than the
  27024. <paramref name="level"/> specified.
  27025. </para>
  27026. <para>
  27027. If no mapping could be found then <c>null</c> is returned.
  27028. </para>
  27029. </remarks>
  27030. </member>
  27031. <member name="M:log4net.Util.LevelMapping.ActivateOptions">
  27032. <summary>
  27033. Initialize options
  27034. </summary>
  27035. <remarks>
  27036. <para>
  27037. Caches the sorted list of <see cref="T:log4net.Util.LevelMappingEntry"/> in an array
  27038. </para>
  27039. </remarks>
  27040. </member>
  27041. <member name="T:log4net.Util.LogicalThreadContextProperties">
  27042. <summary>
  27043. Implementation of Properties collection for the <see cref="T:log4net.LogicalThreadContext"/>
  27044. </summary>
  27045. <remarks>
  27046. <para>
  27047. Class implements a collection of properties that is specific to each thread.
  27048. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  27049. </para>
  27050. <para>
  27051. This class stores its properties in a slot on the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> named
  27052. <c>log4net.Util.LogicalThreadContextProperties</c>.
  27053. </para>
  27054. <para>
  27055. For .NET Standard 1.3 this class uses
  27056. System.Threading.AsyncLocal rather than <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>.
  27057. </para>
  27058. <para>
  27059. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  27060. <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
  27061. <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  27062. If the calling code does not have this permission then this context will be disabled.
  27063. It will not store any property values set on it.
  27064. </para>
  27065. </remarks>
  27066. <author>Nicko Cadell</author>
  27067. </member>
  27068. <member name="F:log4net.Util.LogicalThreadContextProperties.m_disabled">
  27069. <summary>
  27070. Flag used to disable this context if we don't have permission to access the CallContext.
  27071. </summary>
  27072. </member>
  27073. <member name="M:log4net.Util.LogicalThreadContextProperties.#ctor">
  27074. <summary>
  27075. Constructor
  27076. </summary>
  27077. <remarks>
  27078. <para>
  27079. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextProperties"/> class.
  27080. </para>
  27081. </remarks>
  27082. </member>
  27083. <member name="M:log4net.Util.LogicalThreadContextProperties.Remove(System.String)">
  27084. <summary>
  27085. Remove a property
  27086. </summary>
  27087. <param name="key">the key for the entry to remove</param>
  27088. <remarks>
  27089. <para>
  27090. Remove the value for the specified <paramref name="key"/> from the context.
  27091. </para>
  27092. </remarks>
  27093. </member>
  27094. <member name="M:log4net.Util.LogicalThreadContextProperties.Clear">
  27095. <summary>
  27096. Clear all the context properties
  27097. </summary>
  27098. <remarks>
  27099. <para>
  27100. Clear all the context properties
  27101. </para>
  27102. </remarks>
  27103. </member>
  27104. <member name="M:log4net.Util.LogicalThreadContextProperties.GetProperties(System.Boolean)">
  27105. <summary>
  27106. Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread.
  27107. </summary>
  27108. <param name="create">create the dictionary if it does not exist, otherwise return null if is does not exist</param>
  27109. <returns>the properties for this thread</returns>
  27110. <remarks>
  27111. <para>
  27112. The collection returned is only to be used on the calling thread. If the
  27113. caller needs to share the collection between different threads then the
  27114. caller must clone the collection before doings so.
  27115. </para>
  27116. </remarks>
  27117. </member>
  27118. <member name="M:log4net.Util.LogicalThreadContextProperties.GetLogicalProperties">
  27119. <summary>
  27120. Gets the call context get data.
  27121. </summary>
  27122. <returns>The peroperties dictionary stored in the call context</returns>
  27123. <remarks>
  27124. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.GetData(System.String)"/> has a
  27125. security link demand, therfore we must put the method call in a seperate method
  27126. that we can wrap in an exception handler.
  27127. </remarks>
  27128. </member>
  27129. <member name="M:log4net.Util.LogicalThreadContextProperties.SetLogicalProperties(log4net.Util.PropertiesDictionary)">
  27130. <summary>
  27131. Sets the call context data.
  27132. </summary>
  27133. <param name="properties">The properties.</param>
  27134. <remarks>
  27135. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.SetData(System.String,System.Object)"/> has a
  27136. security link demand, therfore we must put the method call in a seperate method
  27137. that we can wrap in an exception handler.
  27138. </remarks>
  27139. </member>
  27140. <member name="F:log4net.Util.LogicalThreadContextProperties.declaringType">
  27141. <summary>
  27142. The fully qualified type of the LogicalThreadContextProperties class.
  27143. </summary>
  27144. <remarks>
  27145. Used by the internal logger to record the Type of the
  27146. log message.
  27147. </remarks>
  27148. </member>
  27149. <member name="P:log4net.Util.LogicalThreadContextProperties.Item(System.String)">
  27150. <summary>
  27151. Gets or sets the value of a property
  27152. </summary>
  27153. <value>
  27154. The value for the property with the specified key
  27155. </value>
  27156. <remarks>
  27157. <para>
  27158. Get or set the property value for the <paramref name="key"/> specified.
  27159. </para>
  27160. </remarks>
  27161. </member>
  27162. <member name="T:log4net.Util.TwoArgAction`2">
  27163. <summary>
  27164. Delegate type used for LogicalThreadContextStack's callbacks.
  27165. </summary>
  27166. </member>
  27167. <member name="T:log4net.Util.LogicalThreadContextStack">
  27168. <summary>
  27169. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  27170. </summary>
  27171. <remarks>
  27172. <para>
  27173. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  27174. </para>
  27175. </remarks>
  27176. <author>Nicko Cadell</author>
  27177. </member>
  27178. <member name="F:log4net.Util.LogicalThreadContextStack.m_stack">
  27179. <summary>
  27180. The stack store.
  27181. </summary>
  27182. </member>
  27183. <member name="F:log4net.Util.LogicalThreadContextStack.m_propertyKey">
  27184. <summary>
  27185. The name of this <see cref="T:log4net.Util.LogicalThreadContextStack"/> within the
  27186. <see cref="T:log4net.Util.LogicalThreadContextProperties"/>.
  27187. </summary>
  27188. </member>
  27189. <member name="F:log4net.Util.LogicalThreadContextStack.m_registerNew">
  27190. <summary>
  27191. The callback used to let the <see cref="T:log4net.Util.LogicalThreadContextStacks"/> register a
  27192. new instance of a <see cref="T:log4net.Util.LogicalThreadContextStack"/>.
  27193. </summary>
  27194. </member>
  27195. <member name="M:log4net.Util.LogicalThreadContextStack.#ctor(System.String,log4net.Util.TwoArgAction{System.String,log4net.Util.LogicalThreadContextStack})">
  27196. <summary>
  27197. Internal constructor
  27198. </summary>
  27199. <remarks>
  27200. <para>
  27201. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack"/> class.
  27202. </para>
  27203. </remarks>
  27204. </member>
  27205. <member name="M:log4net.Util.LogicalThreadContextStack.Clear">
  27206. <summary>
  27207. Clears all the contextual information held in this stack.
  27208. </summary>
  27209. <remarks>
  27210. <para>
  27211. Clears all the contextual information held in this stack.
  27212. Only call this if you think that this thread is being reused after
  27213. a previous call execution which may not have completed correctly.
  27214. You do not need to use this method if you always guarantee to call
  27215. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  27216. returned from <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  27217. for example by using the <c>using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  27218. syntax.
  27219. </para>
  27220. </remarks>
  27221. </member>
  27222. <member name="M:log4net.Util.LogicalThreadContextStack.Pop">
  27223. <summary>
  27224. Removes the top context from this stack.
  27225. </summary>
  27226. <returns>The message in the context that was removed from the top of this stack.</returns>
  27227. <remarks>
  27228. <para>
  27229. Remove the top context from this stack, and return
  27230. it to the caller. If this stack is empty then an
  27231. empty string (not <see langword="null"/>) is returned.
  27232. </para>
  27233. </remarks>
  27234. </member>
  27235. <member name="M:log4net.Util.LogicalThreadContextStack.Push(System.String)">
  27236. <summary>
  27237. Pushes a new context message into this stack.
  27238. </summary>
  27239. <param name="message">The new context message.</param>
  27240. <returns>
  27241. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  27242. </returns>
  27243. <remarks>
  27244. <para>
  27245. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  27246. is returned that can be used to clean up this stack. This
  27247. can be easily combined with the <c>using</c> keyword to scope the
  27248. context.
  27249. </para>
  27250. </remarks>
  27251. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  27252. <code lang="C#">
  27253. using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))
  27254. {
  27255. log.Warn("This should have an ThreadContext Stack message");
  27256. }
  27257. </code>
  27258. </example>
  27259. </member>
  27260. <member name="M:log4net.Util.LogicalThreadContextStack.GetFullMessage">
  27261. <summary>
  27262. Gets the current context information for this stack.
  27263. </summary>
  27264. <returns>The current context information.</returns>
  27265. </member>
  27266. <member name="M:log4net.Util.LogicalThreadContextStack.ToString">
  27267. <summary>
  27268. Gets the current context information for this stack.
  27269. </summary>
  27270. <returns>Gets the current context information</returns>
  27271. <remarks>
  27272. <para>
  27273. Gets the current context information for this stack.
  27274. </para>
  27275. </remarks>
  27276. </member>
  27277. <member name="M:log4net.Util.LogicalThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  27278. <summary>
  27279. Get a portable version of this object
  27280. </summary>
  27281. <returns>the portable instance of this object</returns>
  27282. <remarks>
  27283. <para>
  27284. Get a cross thread portable version of this object
  27285. </para>
  27286. </remarks>
  27287. </member>
  27288. <member name="P:log4net.Util.LogicalThreadContextStack.Count">
  27289. <summary>
  27290. The number of messages in the stack
  27291. </summary>
  27292. <value>
  27293. The current number of messages in the stack
  27294. </value>
  27295. <remarks>
  27296. <para>
  27297. The current number of messages in the stack. That is
  27298. the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> has been called
  27299. minus the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Pop"/> has been called.
  27300. </para>
  27301. </remarks>
  27302. </member>
  27303. <member name="P:log4net.Util.LogicalThreadContextStack.InternalStack">
  27304. <summary>
  27305. Gets and sets the internal stack used by this <see cref="T:log4net.Util.LogicalThreadContextStack"/>
  27306. </summary>
  27307. <value>The internal storage stack</value>
  27308. <remarks>
  27309. <para>
  27310. This property is provided only to support backward compatability
  27311. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  27312. be modified.
  27313. </para>
  27314. </remarks>
  27315. </member>
  27316. <member name="T:log4net.Util.LogicalThreadContextStack.StackFrame">
  27317. <summary>
  27318. Inner class used to represent a single context frame in the stack.
  27319. </summary>
  27320. <remarks>
  27321. <para>
  27322. Inner class used to represent a single context frame in the stack.
  27323. </para>
  27324. </remarks>
  27325. </member>
  27326. <member name="M:log4net.Util.LogicalThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.LogicalThreadContextStack.StackFrame)">
  27327. <summary>
  27328. Constructor
  27329. </summary>
  27330. <param name="message">The message for this context.</param>
  27331. <param name="parent">The parent context in the chain.</param>
  27332. <remarks>
  27333. <para>
  27334. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.StackFrame"/> class
  27335. with the specified message and parent context.
  27336. </para>
  27337. </remarks>
  27338. </member>
  27339. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.Message">
  27340. <summary>
  27341. Get the message.
  27342. </summary>
  27343. <value>The message.</value>
  27344. <remarks>
  27345. <para>
  27346. Get the message.
  27347. </para>
  27348. </remarks>
  27349. </member>
  27350. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.FullMessage">
  27351. <summary>
  27352. Gets the full text of the context down to the root level.
  27353. </summary>
  27354. <value>
  27355. The full text of the context down to the root level.
  27356. </value>
  27357. <remarks>
  27358. <para>
  27359. Gets the full text of the context down to the root level.
  27360. </para>
  27361. </remarks>
  27362. </member>
  27363. <member name="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame">
  27364. <summary>
  27365. Struct returned from the <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> method.
  27366. </summary>
  27367. <remarks>
  27368. <para>
  27369. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  27370. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  27371. </para>
  27372. </remarks>
  27373. </member>
  27374. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_frameDepth">
  27375. <summary>
  27376. The depth to trim the stack to when this instance is disposed
  27377. </summary>
  27378. </member>
  27379. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_logicalThreadContextStack">
  27380. <summary>
  27381. The outer LogicalThreadContextStack.
  27382. </summary>
  27383. </member>
  27384. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.#ctor(log4net.Util.LogicalThreadContextStack,System.Int32)">
  27385. <summary>
  27386. Constructor
  27387. </summary>
  27388. <param name="logicalThreadContextStack">The internal stack used by the ThreadContextStack.</param>
  27389. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  27390. <remarks>
  27391. <para>
  27392. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame"/> class with
  27393. the specified stack and return depth.
  27394. </para>
  27395. </remarks>
  27396. </member>
  27397. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.Dispose">
  27398. <summary>
  27399. Returns the stack to the correct depth.
  27400. </summary>
  27401. <remarks>
  27402. <para>
  27403. Returns the stack to the correct depth.
  27404. </para>
  27405. </remarks>
  27406. </member>
  27407. <member name="T:log4net.Util.LogicalThreadContextStacks">
  27408. <summary>
  27409. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  27410. </summary>
  27411. <remarks>
  27412. <para>
  27413. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  27414. </para>
  27415. </remarks>
  27416. <author>Nicko Cadell</author>
  27417. </member>
  27418. <member name="M:log4net.Util.LogicalThreadContextStacks.#ctor(log4net.Util.LogicalThreadContextProperties)">
  27419. <summary>
  27420. Internal constructor
  27421. </summary>
  27422. <remarks>
  27423. <para>
  27424. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks"/> class.
  27425. </para>
  27426. </remarks>
  27427. </member>
  27428. <member name="F:log4net.Util.LogicalThreadContextStacks.declaringType">
  27429. <summary>
  27430. The fully qualified type of the ThreadContextStacks class.
  27431. </summary>
  27432. <remarks>
  27433. Used by the internal logger to record the Type of the
  27434. log message.
  27435. </remarks>
  27436. </member>
  27437. <member name="P:log4net.Util.LogicalThreadContextStacks.Item(System.String)">
  27438. <summary>
  27439. Gets the named thread context stack
  27440. </summary>
  27441. <value>
  27442. The named stack
  27443. </value>
  27444. <remarks>
  27445. <para>
  27446. Gets the named thread context stack
  27447. </para>
  27448. </remarks>
  27449. </member>
  27450. <member name="T:log4net.Util.LogReceivedEventHandler">
  27451. <summary>
  27452. </summary>
  27453. <param name="source"></param>
  27454. <param name="e"></param>
  27455. </member>
  27456. <member name="T:log4net.Util.LogLog">
  27457. <summary>
  27458. Outputs log statements from within the log4net assembly.
  27459. </summary>
  27460. <remarks>
  27461. <para>
  27462. Log4net components cannot make log4net logging calls. However, it is
  27463. sometimes useful for the user to learn about what log4net is
  27464. doing.
  27465. </para>
  27466. <para>
  27467. All log4net internal debug calls go to the standard output stream
  27468. whereas internal error messages are sent to the standard error output
  27469. stream.
  27470. </para>
  27471. </remarks>
  27472. <author>Nicko Cadell</author>
  27473. <author>Gert Driesen</author>
  27474. </member>
  27475. <member name="M:log4net.Util.LogLog.ToString">
  27476. <summary>
  27477. Formats Prefix, Source, and Message in the same format as the value
  27478. sent to Console.Out and Trace.Write.
  27479. </summary>
  27480. <returns></returns>
  27481. </member>
  27482. <member name="M:log4net.Util.LogLog.#ctor(System.Type,System.String,System.String,System.Exception)">
  27483. <summary>
  27484. Initializes a new instance of the <see cref="T:log4net.Util.LogLog"/> class.
  27485. </summary>
  27486. <param name="source"></param>
  27487. <param name="prefix"></param>
  27488. <param name="message"></param>
  27489. <param name="exception"></param>
  27490. </member>
  27491. <member name="M:log4net.Util.LogLog.#cctor">
  27492. <summary>
  27493. Static constructor that initializes logging by reading
  27494. settings from the application configuration file.
  27495. </summary>
  27496. <remarks>
  27497. <para>
  27498. The <c>log4net.Internal.Debug</c> application setting
  27499. controls internal debugging. This setting should be set
  27500. to <c>true</c> to enable debugging.
  27501. </para>
  27502. <para>
  27503. The <c>log4net.Internal.Quiet</c> application setting
  27504. suppresses all internal logging including error messages.
  27505. This setting should be set to <c>true</c> to enable message
  27506. suppression.
  27507. </para>
  27508. </remarks>
  27509. </member>
  27510. <member name="M:log4net.Util.LogLog.OnLogReceived(System.Type,System.String,System.String,System.Exception)">
  27511. <summary>
  27512. Raises the LogReceived event when an internal messages is received.
  27513. </summary>
  27514. <param name="source"></param>
  27515. <param name="prefix"></param>
  27516. <param name="message"></param>
  27517. <param name="exception"></param>
  27518. </member>
  27519. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String)">
  27520. <summary>
  27521. Writes log4net internal debug messages to the
  27522. standard output stream.
  27523. </summary>
  27524. <param name="source"></param>
  27525. <param name="message">The message to log.</param>
  27526. <remarks>
  27527. <para>
  27528. All internal debug messages are prepended with
  27529. the string "log4net: ".
  27530. </para>
  27531. </remarks>
  27532. </member>
  27533. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String,System.Exception)">
  27534. <summary>
  27535. Writes log4net internal debug messages to the
  27536. standard output stream.
  27537. </summary>
  27538. <param name="source">The Type that generated this message.</param>
  27539. <param name="message">The message to log.</param>
  27540. <param name="exception">An exception to log.</param>
  27541. <remarks>
  27542. <para>
  27543. All internal debug messages are prepended with
  27544. the string "log4net: ".
  27545. </para>
  27546. </remarks>
  27547. </member>
  27548. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String)">
  27549. <summary>
  27550. Writes log4net internal warning messages to the
  27551. standard error stream.
  27552. </summary>
  27553. <param name="source">The Type that generated this message.</param>
  27554. <param name="message">The message to log.</param>
  27555. <remarks>
  27556. <para>
  27557. All internal warning messages are prepended with
  27558. the string "log4net:WARN ".
  27559. </para>
  27560. </remarks>
  27561. </member>
  27562. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String,System.Exception)">
  27563. <summary>
  27564. Writes log4net internal warning messages to the
  27565. standard error stream.
  27566. </summary>
  27567. <param name="source">The Type that generated this message.</param>
  27568. <param name="message">The message to log.</param>
  27569. <param name="exception">An exception to log.</param>
  27570. <remarks>
  27571. <para>
  27572. All internal warning messages are prepended with
  27573. the string "log4net:WARN ".
  27574. </para>
  27575. </remarks>
  27576. </member>
  27577. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String)">
  27578. <summary>
  27579. Writes log4net internal error messages to the
  27580. standard error stream.
  27581. </summary>
  27582. <param name="source">The Type that generated this message.</param>
  27583. <param name="message">The message to log.</param>
  27584. <remarks>
  27585. <para>
  27586. All internal error messages are prepended with
  27587. the string "log4net:ERROR ".
  27588. </para>
  27589. </remarks>
  27590. </member>
  27591. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String,System.Exception)">
  27592. <summary>
  27593. Writes log4net internal error messages to the
  27594. standard error stream.
  27595. </summary>
  27596. <param name="source">The Type that generated this message.</param>
  27597. <param name="message">The message to log.</param>
  27598. <param name="exception">An exception to log.</param>
  27599. <remarks>
  27600. <para>
  27601. All internal debug messages are prepended with
  27602. the string "log4net:ERROR ".
  27603. </para>
  27604. </remarks>
  27605. </member>
  27606. <member name="M:log4net.Util.LogLog.EmitOutLine(System.String)">
  27607. <summary>
  27608. Writes output to the standard output stream.
  27609. </summary>
  27610. <param name="message">The message to log.</param>
  27611. <remarks>
  27612. <para>
  27613. Writes to both Console.Out and System.Diagnostics.Trace.
  27614. Note that the System.Diagnostics.Trace is not supported
  27615. on the Compact Framework.
  27616. </para>
  27617. <para>
  27618. If the AppDomain is not configured with a config file then
  27619. the call to System.Diagnostics.Trace may fail. This is only
  27620. an issue if you are programmatically creating your own AppDomains.
  27621. </para>
  27622. </remarks>
  27623. </member>
  27624. <member name="M:log4net.Util.LogLog.EmitErrorLine(System.String)">
  27625. <summary>
  27626. Writes output to the standard error stream.
  27627. </summary>
  27628. <param name="message">The message to log.</param>
  27629. <remarks>
  27630. <para>
  27631. Writes to both Console.Error and System.Diagnostics.Trace.
  27632. Note that the System.Diagnostics.Trace is not supported
  27633. on the Compact Framework.
  27634. </para>
  27635. <para>
  27636. If the AppDomain is not configured with a config file then
  27637. the call to System.Diagnostics.Trace may fail. This is only
  27638. an issue if you are programmatically creating your own AppDomains.
  27639. </para>
  27640. </remarks>
  27641. </member>
  27642. <member name="F:log4net.Util.LogLog.s_debugEnabled">
  27643. <summary>
  27644. Default debug level
  27645. </summary>
  27646. </member>
  27647. <member name="F:log4net.Util.LogLog.s_quietMode">
  27648. <summary>
  27649. In quietMode not even errors generate any output.
  27650. </summary>
  27651. </member>
  27652. <member name="E:log4net.Util.LogLog.LogReceived">
  27653. <summary>
  27654. The event raised when an internal message has been received.
  27655. </summary>
  27656. </member>
  27657. <member name="P:log4net.Util.LogLog.Source">
  27658. <summary>
  27659. The Type that generated the internal message.
  27660. </summary>
  27661. </member>
  27662. <member name="P:log4net.Util.LogLog.TimeStamp">
  27663. <summary>
  27664. The DateTime stamp of when the internal message was received.
  27665. </summary>
  27666. </member>
  27667. <member name="P:log4net.Util.LogLog.TimeStampUtc">
  27668. <summary>
  27669. The UTC DateTime stamp of when the internal message was received.
  27670. </summary>
  27671. </member>
  27672. <member name="P:log4net.Util.LogLog.Prefix">
  27673. <summary>
  27674. A string indicating the severity of the internal message.
  27675. </summary>
  27676. <remarks>
  27677. "log4net: ",
  27678. "log4net:ERROR ",
  27679. "log4net:WARN "
  27680. </remarks>
  27681. </member>
  27682. <member name="P:log4net.Util.LogLog.Message">
  27683. <summary>
  27684. The internal log message.
  27685. </summary>
  27686. </member>
  27687. <member name="P:log4net.Util.LogLog.Exception">
  27688. <summary>
  27689. The Exception related to the message.
  27690. </summary>
  27691. <remarks>
  27692. Optional. Will be null if no Exception was passed.
  27693. </remarks>
  27694. </member>
  27695. <member name="P:log4net.Util.LogLog.InternalDebugging">
  27696. <summary>
  27697. Gets or sets a value indicating whether log4net internal logging
  27698. is enabled or disabled.
  27699. </summary>
  27700. <value>
  27701. <c>true</c> if log4net internal logging is enabled, otherwise
  27702. <c>false</c>.
  27703. </value>
  27704. <remarks>
  27705. <para>
  27706. When set to <c>true</c>, internal debug level logging will be
  27707. displayed.
  27708. </para>
  27709. <para>
  27710. This value can be set by setting the application setting
  27711. <c>log4net.Internal.Debug</c> in the application configuration
  27712. file.
  27713. </para>
  27714. <para>
  27715. The default value is <c>false</c>, i.e. debugging is
  27716. disabled.
  27717. </para>
  27718. </remarks>
  27719. <example>
  27720. <para>
  27721. The following example enables internal debugging using the
  27722. application configuration file :
  27723. </para>
  27724. <code lang="XML" escaped="true">
  27725. <configuration>
  27726. <appSettings>
  27727. <add key="log4net.Internal.Debug" value="true" />
  27728. </appSettings>
  27729. </configuration>
  27730. </code>
  27731. </example>
  27732. </member>
  27733. <member name="P:log4net.Util.LogLog.QuietMode">
  27734. <summary>
  27735. Gets or sets a value indicating whether log4net should generate no output
  27736. from internal logging, not even for errors.
  27737. </summary>
  27738. <value>
  27739. <c>true</c> if log4net should generate no output at all from internal
  27740. logging, otherwise <c>false</c>.
  27741. </value>
  27742. <remarks>
  27743. <para>
  27744. When set to <c>true</c> will cause internal logging at all levels to be
  27745. suppressed. This means that no warning or error reports will be logged.
  27746. This option overrides the <see cref="P:log4net.Util.LogLog.InternalDebugging"/> setting and
  27747. disables all debug also.
  27748. </para>
  27749. <para>This value can be set by setting the application setting
  27750. <c>log4net.Internal.Quiet</c> in the application configuration file.
  27751. </para>
  27752. <para>
  27753. The default value is <c>false</c>, i.e. internal logging is not
  27754. disabled.
  27755. </para>
  27756. </remarks>
  27757. <example>
  27758. The following example disables internal logging using the
  27759. application configuration file :
  27760. <code lang="XML" escaped="true">
  27761. <configuration>
  27762. <appSettings>
  27763. <add key="log4net.Internal.Quiet" value="true"/>
  27764. </appSettings>
  27765. </configuration>
  27766. </code>
  27767. </example>
  27768. </member>
  27769. <member name="P:log4net.Util.LogLog.EmitInternalMessages">
  27770. <summary>
  27771. </summary>
  27772. </member>
  27773. <member name="P:log4net.Util.LogLog.IsDebugEnabled">
  27774. <summary>
  27775. Test if LogLog.Debug is enabled for output.
  27776. </summary>
  27777. <value>
  27778. <c>true</c> if Debug is enabled
  27779. </value>
  27780. <remarks>
  27781. <para>
  27782. Test if LogLog.Debug is enabled for output.
  27783. </para>
  27784. </remarks>
  27785. </member>
  27786. <member name="P:log4net.Util.LogLog.IsWarnEnabled">
  27787. <summary>
  27788. Test if LogLog.Warn is enabled for output.
  27789. </summary>
  27790. <value>
  27791. <c>true</c> if Warn is enabled
  27792. </value>
  27793. <remarks>
  27794. <para>
  27795. Test if LogLog.Warn is enabled for output.
  27796. </para>
  27797. </remarks>
  27798. </member>
  27799. <member name="P:log4net.Util.LogLog.IsErrorEnabled">
  27800. <summary>
  27801. Test if LogLog.Error is enabled for output.
  27802. </summary>
  27803. <value>
  27804. <c>true</c> if Error is enabled
  27805. </value>
  27806. <remarks>
  27807. <para>
  27808. Test if LogLog.Error is enabled for output.
  27809. </para>
  27810. </remarks>
  27811. </member>
  27812. <member name="T:log4net.Util.LogLog.LogReceivedAdapter">
  27813. <summary>
  27814. Subscribes to the LogLog.LogReceived event and stores messages
  27815. to the supplied IList instance.
  27816. </summary>
  27817. </member>
  27818. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.#ctor(System.Collections.IList)">
  27819. <summary>
  27820. </summary>
  27821. <param name="items"></param>
  27822. </member>
  27823. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.Dispose">
  27824. <summary>
  27825. </summary>
  27826. </member>
  27827. <member name="P:log4net.Util.LogLog.LogReceivedAdapter.Items">
  27828. <summary>
  27829. </summary>
  27830. </member>
  27831. <member name="T:log4net.Util.LogReceivedEventArgs">
  27832. <summary>
  27833. </summary>
  27834. </member>
  27835. <member name="M:log4net.Util.LogReceivedEventArgs.#ctor(log4net.Util.LogLog)">
  27836. <summary>
  27837. </summary>
  27838. <param name="loglog"></param>
  27839. </member>
  27840. <member name="P:log4net.Util.LogReceivedEventArgs.LogLog">
  27841. <summary>
  27842. </summary>
  27843. </member>
  27844. <member name="T:log4net.Util.NativeError">
  27845. <summary>
  27846. Represents a native error code and message.
  27847. </summary>
  27848. <remarks>
  27849. <para>
  27850. Represents a Win32 platform native error.
  27851. </para>
  27852. </remarks>
  27853. <author>Nicko Cadell</author>
  27854. <author>Gert Driesen</author>
  27855. </member>
  27856. <member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)">
  27857. <summary>
  27858. Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
  27859. error number and message.
  27860. </summary>
  27861. <param name="number">The number of the native error.</param>
  27862. <param name="message">The message of the native error.</param>
  27863. <remarks>
  27864. <para>
  27865. Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
  27866. error number and message.
  27867. </para>
  27868. </remarks>
  27869. </member>
  27870. <member name="M:log4net.Util.NativeError.GetLastError">
  27871. <summary>
  27872. Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class for the last Windows error.
  27873. </summary>
  27874. <returns>
  27875. An instance of the <see cref="T:log4net.Util.NativeError"/> class for the last windows error.
  27876. </returns>
  27877. <remarks>
  27878. <para>
  27879. The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the
  27880. native Win32 <c>FormatMessage</c> function.
  27881. </para>
  27882. </remarks>
  27883. </member>
  27884. <member name="M:log4net.Util.NativeError.GetError(System.Int32)">
  27885. <summary>
  27886. Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class.
  27887. </summary>
  27888. <param name="number">the error number for the native error</param>
  27889. <returns>
  27890. An instance of the <see cref="T:log4net.Util.NativeError"/> class for the specified
  27891. error number.
  27892. </returns>
  27893. <remarks>
  27894. <para>
  27895. The message for the specified error number is lookup up using the
  27896. native Win32 <c>FormatMessage</c> function.
  27897. </para>
  27898. </remarks>
  27899. </member>
  27900. <member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)">
  27901. <summary>
  27902. Retrieves the message corresponding with a Win32 message identifier.
  27903. </summary>
  27904. <param name="messageId">Message identifier for the requested message.</param>
  27905. <returns>
  27906. The message corresponding with the specified message identifier.
  27907. </returns>
  27908. <remarks>
  27909. <para>
  27910. The message will be searched for in system message-table resource(s)
  27911. using the native <c>FormatMessage</c> function.
  27912. </para>
  27913. </remarks>
  27914. </member>
  27915. <member name="M:log4net.Util.NativeError.ToString">
  27916. <summary>
  27917. Return error information string
  27918. </summary>
  27919. <returns>error information string</returns>
  27920. <remarks>
  27921. <para>
  27922. Return error information string
  27923. </para>
  27924. </remarks>
  27925. </member>
  27926. <member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)">
  27927. <summary>
  27928. Formats a message string.
  27929. </summary>
  27930. <param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource" /> parameter.</param>
  27931. <param name="lpSource">Location of the message definition.</param>
  27932. <param name="dwMessageId">Message identifier for the requested message.</param>
  27933. <param name="dwLanguageId">Language identifier for the requested message.</param>
  27934. <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>
  27935. <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>
  27936. <param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param>
  27937. <remarks>
  27938. <para>
  27939. The function requires a message definition as input. The message definition can come from a
  27940. buffer passed into the function. It can come from a message table resource in an
  27941. already-loaded module. Or the caller can ask the function to search the system's message
  27942. table resource(s) for the message definition. The function finds the message definition
  27943. in a message table resource based on a message identifier and a language identifier.
  27944. The function copies the formatted message text to an output buffer, processing any embedded
  27945. insert sequences if requested.
  27946. </para>
  27947. <para>
  27948. To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message.
  27949. </para>
  27950. </remarks>
  27951. <returns>
  27952. <para>
  27953. If the function succeeds, the return value is the number of TCHARs stored in the output
  27954. buffer, excluding the terminating null character.
  27955. </para>
  27956. <para>
  27957. If the function fails, the return value is zero. To get extended error information,
  27958. call <see cref="M:Marshal.GetLastWin32Error()" />.
  27959. </para>
  27960. </returns>
  27961. </member>
  27962. <member name="P:log4net.Util.NativeError.Number">
  27963. <summary>
  27964. Gets the number of the native error.
  27965. </summary>
  27966. <value>
  27967. The number of the native error.
  27968. </value>
  27969. <remarks>
  27970. <para>
  27971. Gets the number of the native error.
  27972. </para>
  27973. </remarks>
  27974. </member>
  27975. <member name="P:log4net.Util.NativeError.Message">
  27976. <summary>
  27977. Gets the message of the native error.
  27978. </summary>
  27979. <value>
  27980. The message of the native error.
  27981. </value>
  27982. <remarks>
  27983. <para>
  27984. </para>
  27985. Gets the message of the native error.
  27986. </remarks>
  27987. </member>
  27988. <member name="T:log4net.Util.NullDictionaryEnumerator">
  27989. <summary>
  27990. An always empty <see cref="T:System.Collections.IDictionaryEnumerator"/>.
  27991. </summary>
  27992. <remarks>
  27993. <para>
  27994. A singleton implementation of the <see cref="T:System.Collections.IDictionaryEnumerator"/> over a collection
  27995. that is empty and not modifiable.
  27996. </para>
  27997. </remarks>
  27998. <author>Nicko Cadell</author>
  27999. <author>Gert Driesen</author>
  28000. </member>
  28001. <member name="M:log4net.Util.NullDictionaryEnumerator.#ctor">
  28002. <summary>
  28003. Initializes a new instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> class.
  28004. </summary>
  28005. <remarks>
  28006. <para>
  28007. Uses a private access modifier to enforce the singleton pattern.
  28008. </para>
  28009. </remarks>
  28010. </member>
  28011. <member name="M:log4net.Util.NullDictionaryEnumerator.MoveNext">
  28012. <summary>
  28013. Test if the enumerator can advance, if so advance.
  28014. </summary>
  28015. <returns><c>false</c> as the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> cannot advance.</returns>
  28016. <remarks>
  28017. <para>
  28018. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28019. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullDictionaryEnumerator.MoveNext"/>
  28020. will always return <c>false</c>.
  28021. </para>
  28022. </remarks>
  28023. </member>
  28024. <member name="M:log4net.Util.NullDictionaryEnumerator.Reset">
  28025. <summary>
  28026. Resets the enumerator back to the start.
  28027. </summary>
  28028. <remarks>
  28029. <para>
  28030. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullDictionaryEnumerator.Reset"/> does nothing.
  28031. </para>
  28032. </remarks>
  28033. </member>
  28034. <member name="F:log4net.Util.NullDictionaryEnumerator.s_instance">
  28035. <summary>
  28036. The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
  28037. </summary>
  28038. </member>
  28039. <member name="P:log4net.Util.NullDictionaryEnumerator.Instance">
  28040. <summary>
  28041. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
  28042. </summary>
  28043. <returns>The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.</returns>
  28044. <remarks>
  28045. <para>
  28046. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
  28047. </para>
  28048. </remarks>
  28049. </member>
  28050. <member name="P:log4net.Util.NullDictionaryEnumerator.Current">
  28051. <summary>
  28052. Gets the current object from the enumerator.
  28053. </summary>
  28054. <remarks>
  28055. Throws an <see cref="T:System.InvalidOperationException"/> because the
  28056. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
  28057. </remarks>
  28058. <remarks>
  28059. <para>
  28060. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28061. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28062. will throw an <see cref="T:System.InvalidOperationException"/>.
  28063. </para>
  28064. </remarks>
  28065. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28066. cannot be positioned over a valid location.</exception>
  28067. </member>
  28068. <member name="P:log4net.Util.NullDictionaryEnumerator.Key">
  28069. <summary>
  28070. Gets the current key from the enumerator.
  28071. </summary>
  28072. <remarks>
  28073. Throws an exception because the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>
  28074. never has a current value.
  28075. </remarks>
  28076. <remarks>
  28077. <para>
  28078. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28079. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Key"/>
  28080. will throw an <see cref="T:System.InvalidOperationException"/>.
  28081. </para>
  28082. </remarks>
  28083. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28084. cannot be positioned over a valid location.</exception>
  28085. </member>
  28086. <member name="P:log4net.Util.NullDictionaryEnumerator.Value">
  28087. <summary>
  28088. Gets the current value from the enumerator.
  28089. </summary>
  28090. <value>The current value from the enumerator.</value>
  28091. <remarks>
  28092. Throws an <see cref="T:System.InvalidOperationException"/> because the
  28093. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
  28094. </remarks>
  28095. <remarks>
  28096. <para>
  28097. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28098. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Value"/>
  28099. will throw an <see cref="T:System.InvalidOperationException"/>.
  28100. </para>
  28101. </remarks>
  28102. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28103. cannot be positioned over a valid location.</exception>
  28104. </member>
  28105. <member name="P:log4net.Util.NullDictionaryEnumerator.Entry">
  28106. <summary>
  28107. Gets the current entry from the enumerator.
  28108. </summary>
  28109. <remarks>
  28110. Throws an <see cref="T:System.InvalidOperationException"/> because the
  28111. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current entry.
  28112. </remarks>
  28113. <remarks>
  28114. <para>
  28115. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28116. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Entry"/>
  28117. will throw an <see cref="T:System.InvalidOperationException"/>.
  28118. </para>
  28119. </remarks>
  28120. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  28121. cannot be positioned over a valid location.</exception>
  28122. </member>
  28123. <member name="T:log4net.Util.NullEnumerator">
  28124. <summary>
  28125. An always empty <see cref="T:System.Collections.IEnumerator"/>.
  28126. </summary>
  28127. <remarks>
  28128. <para>
  28129. A singleton implementation of the <see cref="T:System.Collections.IEnumerator"/> over a collection
  28130. that is empty and not modifiable.
  28131. </para>
  28132. </remarks>
  28133. <author>Nicko Cadell</author>
  28134. <author>Gert Driesen</author>
  28135. </member>
  28136. <member name="M:log4net.Util.NullEnumerator.#ctor">
  28137. <summary>
  28138. Initializes a new instance of the <see cref="T:log4net.Util.NullEnumerator"/> class.
  28139. </summary>
  28140. <remarks>
  28141. <para>
  28142. Uses a private access modifier to enforce the singleton pattern.
  28143. </para>
  28144. </remarks>
  28145. </member>
  28146. <member name="M:log4net.Util.NullEnumerator.MoveNext">
  28147. <summary>
  28148. Test if the enumerator can advance, if so advance
  28149. </summary>
  28150. <returns><c>false</c> as the <see cref="T:log4net.Util.NullEnumerator"/> cannot advance.</returns>
  28151. <remarks>
  28152. <para>
  28153. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  28154. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullEnumerator.MoveNext"/>
  28155. will always return <c>false</c>.
  28156. </para>
  28157. </remarks>
  28158. </member>
  28159. <member name="M:log4net.Util.NullEnumerator.Reset">
  28160. <summary>
  28161. Resets the enumerator back to the start.
  28162. </summary>
  28163. <remarks>
  28164. <para>
  28165. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullEnumerator.Reset"/> does nothing.
  28166. </para>
  28167. </remarks>
  28168. </member>
  28169. <member name="F:log4net.Util.NullEnumerator.s_instance">
  28170. <summary>
  28171. The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
  28172. </summary>
  28173. </member>
  28174. <member name="P:log4net.Util.NullEnumerator.Instance">
  28175. <summary>
  28176. Get the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
  28177. </summary>
  28178. <returns>The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.</returns>
  28179. <remarks>
  28180. <para>
  28181. Gets the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
  28182. </para>
  28183. </remarks>
  28184. </member>
  28185. <member name="P:log4net.Util.NullEnumerator.Current">
  28186. <summary>
  28187. Gets the current object from the enumerator.
  28188. </summary>
  28189. <remarks>
  28190. Throws an <see cref="T:System.InvalidOperationException"/> because the
  28191. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
  28192. </remarks>
  28193. <remarks>
  28194. <para>
  28195. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  28196. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullEnumerator.Current"/>
  28197. will throw an <see cref="T:System.InvalidOperationException"/>.
  28198. </para>
  28199. </remarks>
  28200. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullEnumerator.Current"/>
  28201. cannot be positioned over a valid location.</exception>
  28202. </member>
  28203. <member name="T:log4net.Util.NullSecurityContext">
  28204. <summary>
  28205. A SecurityContext used when a SecurityContext is not required
  28206. </summary>
  28207. <remarks>
  28208. <para>
  28209. The <see cref="T:log4net.Util.NullSecurityContext"/> is a no-op implementation of the
  28210. <see cref="T:log4net.Core.SecurityContext"/> base class. It is used where a <see cref="T:log4net.Core.SecurityContext"/>
  28211. is required but one has not been provided.
  28212. </para>
  28213. </remarks>
  28214. <author>Nicko Cadell</author>
  28215. </member>
  28216. <member name="F:log4net.Util.NullSecurityContext.Instance">
  28217. <summary>
  28218. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  28219. </summary>
  28220. <remarks>
  28221. <para>
  28222. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  28223. </para>
  28224. </remarks>
  28225. </member>
  28226. <member name="M:log4net.Util.NullSecurityContext.#ctor">
  28227. <summary>
  28228. Private constructor
  28229. </summary>
  28230. <remarks>
  28231. <para>
  28232. Private constructor for singleton pattern.
  28233. </para>
  28234. </remarks>
  28235. </member>
  28236. <member name="M:log4net.Util.NullSecurityContext.Impersonate(System.Object)">
  28237. <summary>
  28238. Impersonate this SecurityContext
  28239. </summary>
  28240. <param name="state">State supplied by the caller</param>
  28241. <returns><c>null</c></returns>
  28242. <remarks>
  28243. <para>
  28244. No impersonation is done and <c>null</c> is always returned.
  28245. </para>
  28246. </remarks>
  28247. </member>
  28248. <member name="T:log4net.Util.OnlyOnceErrorHandler">
  28249. <summary>
  28250. Implements log4net's default error handling policy which consists
  28251. of emitting a message for the first error in an appender and
  28252. ignoring all subsequent errors.
  28253. </summary>
  28254. <remarks>
  28255. <para>
  28256. The error message is processed using the LogLog sub-system by default.
  28257. </para>
  28258. <para>
  28259. This policy aims at protecting an otherwise working application
  28260. from being flooded with error messages when logging fails.
  28261. </para>
  28262. </remarks>
  28263. <author>Nicko Cadell</author>
  28264. <author>Gert Driesen</author>
  28265. <author>Ron Grabowski</author>
  28266. </member>
  28267. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor">
  28268. <summary>
  28269. Default Constructor
  28270. </summary>
  28271. <remarks>
  28272. <para>
  28273. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class.
  28274. </para>
  28275. </remarks>
  28276. </member>
  28277. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor(System.String)">
  28278. <summary>
  28279. Constructor
  28280. </summary>
  28281. <param name="prefix">The prefix to use for each message.</param>
  28282. <remarks>
  28283. <para>
  28284. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class
  28285. with the specified prefix.
  28286. </para>
  28287. </remarks>
  28288. </member>
  28289. <member name="M:log4net.Util.OnlyOnceErrorHandler.Reset">
  28290. <summary>
  28291. Reset the error handler back to its initial disabled state.
  28292. </summary>
  28293. </member>
  28294. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  28295. <summary>
  28296. Log an Error
  28297. </summary>
  28298. <param name="message">The error message.</param>
  28299. <param name="e">The exception.</param>
  28300. <param name="errorCode">The internal error code.</param>
  28301. <remarks>
  28302. <para>
  28303. 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.
  28304. </para>
  28305. </remarks>
  28306. </member>
  28307. <member name="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)">
  28308. <summary>
  28309. Log the very first error
  28310. </summary>
  28311. <param name="message">The error message.</param>
  28312. <param name="e">The exception.</param>
  28313. <param name="errorCode">The internal error code.</param>
  28314. <remarks>
  28315. <para>
  28316. Sends the error information to <see cref="T:log4net.Util.LogLog"/>'s Error method.
  28317. </para>
  28318. </remarks>
  28319. </member>
  28320. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception)">
  28321. <summary>
  28322. Log an Error
  28323. </summary>
  28324. <param name="message">The error message.</param>
  28325. <param name="e">The exception.</param>
  28326. <remarks>
  28327. <para>
  28328. 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.
  28329. </para>
  28330. </remarks>
  28331. </member>
  28332. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String)">
  28333. <summary>
  28334. Log an error
  28335. </summary>
  28336. <param name="message">The error message.</param>
  28337. <remarks>
  28338. <para>
  28339. 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.
  28340. </para>
  28341. </remarks>
  28342. </member>
  28343. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_enabledDateUtc">
  28344. <summary>
  28345. The UTC date the error was recorded.
  28346. </summary>
  28347. </member>
  28348. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_firstTime">
  28349. <summary>
  28350. Flag to indicate if it is the first error
  28351. </summary>
  28352. </member>
  28353. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_message">
  28354. <summary>
  28355. The message recorded during the first error.
  28356. </summary>
  28357. </member>
  28358. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_exception">
  28359. <summary>
  28360. The exception recorded during the first error.
  28361. </summary>
  28362. </member>
  28363. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_errorCode">
  28364. <summary>
  28365. The error code recorded during the first error.
  28366. </summary>
  28367. </member>
  28368. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_prefix">
  28369. <summary>
  28370. String to prefix each message with
  28371. </summary>
  28372. </member>
  28373. <member name="F:log4net.Util.OnlyOnceErrorHandler.declaringType">
  28374. <summary>
  28375. The fully qualified type of the OnlyOnceErrorHandler class.
  28376. </summary>
  28377. <remarks>
  28378. Used by the internal logger to record the Type of the
  28379. log message.
  28380. </remarks>
  28381. </member>
  28382. <member name="P:log4net.Util.OnlyOnceErrorHandler.IsEnabled">
  28383. <summary>
  28384. Is error logging enabled
  28385. </summary>
  28386. <remarks>
  28387. <para>
  28388. Is error logging enabled. Logging is only enabled for the
  28389. first error delivered to the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/>.
  28390. </para>
  28391. </remarks>
  28392. </member>
  28393. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDate">
  28394. <summary>
  28395. The date the first error that trigged this error handler occurred, or <see cref="F:System.DateTime.MinValue"/> if it has not been triggered.
  28396. </summary>
  28397. </member>
  28398. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDateUtc">
  28399. <summary>
  28400. 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.
  28401. </summary>
  28402. </member>
  28403. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorMessage">
  28404. <summary>
  28405. The message from the first error that trigged this error handler.
  28406. </summary>
  28407. </member>
  28408. <member name="P:log4net.Util.OnlyOnceErrorHandler.Exception">
  28409. <summary>
  28410. The exception from the first error that trigged this error handler.
  28411. </summary>
  28412. <remarks>
  28413. May be <see langword="null" />.
  28414. </remarks>
  28415. </member>
  28416. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorCode">
  28417. <summary>
  28418. The error code from the first error that trigged this error handler.
  28419. </summary>
  28420. <remarks>
  28421. Defaults to <see cref="F:log4net.Core.ErrorCode.GenericFailure"/>
  28422. </remarks>
  28423. </member>
  28424. <member name="T:log4net.Util.OptionConverter">
  28425. <summary>
  28426. A convenience class to convert property values to specific types.
  28427. </summary>
  28428. <remarks>
  28429. <para>
  28430. Utility functions for converting types and parsing values.
  28431. </para>
  28432. </remarks>
  28433. <author>Nicko Cadell</author>
  28434. <author>Gert Driesen</author>
  28435. </member>
  28436. <member name="M:log4net.Util.OptionConverter.#ctor">
  28437. <summary>
  28438. Initializes a new instance of the <see cref="T:log4net.Util.OptionConverter"/> class.
  28439. </summary>
  28440. <remarks>
  28441. <para>
  28442. Uses a private access modifier to prevent instantiation of this class.
  28443. </para>
  28444. </remarks>
  28445. </member>
  28446. <member name="M:log4net.Util.OptionConverter.ToBoolean(System.String,System.Boolean)">
  28447. <summary>
  28448. Converts a string to a <see cref="T:System.Boolean"/> value.
  28449. </summary>
  28450. <param name="argValue">String to convert.</param>
  28451. <param name="defaultValue">The default value.</param>
  28452. <returns>The <see cref="T:System.Boolean"/> value of <paramref name="argValue"/>.</returns>
  28453. <remarks>
  28454. <para>
  28455. If <paramref name="argValue"/> is "true", then <c>true</c> is returned.
  28456. If <paramref name="argValue"/> is "false", then <c>false</c> is returned.
  28457. Otherwise, <paramref name="defaultValue"/> is returned.
  28458. </para>
  28459. </remarks>
  28460. </member>
  28461. <member name="M:log4net.Util.OptionConverter.ToFileSize(System.String,System.Int64)">
  28462. <summary>
  28463. Parses a file size into a number.
  28464. </summary>
  28465. <param name="argValue">String to parse.</param>
  28466. <param name="defaultValue">The default value.</param>
  28467. <returns>The <see cref="T:System.Int64"/> value of <paramref name="argValue"/>.</returns>
  28468. <remarks>
  28469. <para>
  28470. Parses a file size of the form: number[KB|MB|GB] into a
  28471. long value. It is scaled with the appropriate multiplier.
  28472. </para>
  28473. <para>
  28474. <paramref name="defaultValue"/> is returned when <paramref name="argValue"/>
  28475. cannot be converted to a <see cref="T:System.Int64"/> value.
  28476. </para>
  28477. </remarks>
  28478. </member>
  28479. <member name="M:log4net.Util.OptionConverter.ConvertStringTo(System.Type,System.String)">
  28480. <summary>
  28481. Converts a string to an object.
  28482. </summary>
  28483. <param name="target">The target type to convert to.</param>
  28484. <param name="txt">The string to convert to an object.</param>
  28485. <returns>
  28486. The object converted from a string or <c>null</c> when the
  28487. conversion failed.
  28488. </returns>
  28489. <remarks>
  28490. <para>
  28491. Converts a string to an object. Uses the converter registry to try
  28492. to convert the string value into the specified target type.
  28493. </para>
  28494. </remarks>
  28495. </member>
  28496. <member name="M:log4net.Util.OptionConverter.CanConvertTypeTo(System.Type,System.Type)">
  28497. <summary>
  28498. Checks if there is an appropriate type conversion from the source type to the target type.
  28499. </summary>
  28500. <param name="sourceType">The type to convert from.</param>
  28501. <param name="targetType">The type to convert to.</param>
  28502. <returns><c>true</c> if there is a conversion from the source type to the target type.</returns>
  28503. <remarks>
  28504. Checks if there is an appropriate type conversion from the source type to the target type.
  28505. <para>
  28506. </para>
  28507. </remarks>
  28508. </member>
  28509. <member name="M:log4net.Util.OptionConverter.ConvertTypeTo(System.Object,System.Type)">
  28510. <summary>
  28511. Converts an object to the target type.
  28512. </summary>
  28513. <param name="sourceInstance">The object to convert to the target type.</param>
  28514. <param name="targetType">The type to convert to.</param>
  28515. <returns>The converted object.</returns>
  28516. <remarks>
  28517. <para>
  28518. Converts an object to the target type.
  28519. </para>
  28520. </remarks>
  28521. </member>
  28522. <member name="M:log4net.Util.OptionConverter.InstantiateByClassName(System.String,System.Type,System.Object)">
  28523. <summary>
  28524. Instantiates an object given a class name.
  28525. </summary>
  28526. <param name="className">The fully qualified class name of the object to instantiate.</param>
  28527. <param name="superClass">The class to which the new object should belong.</param>
  28528. <param name="defaultValue">The object to return in case of non-fulfillment.</param>
  28529. <returns>
  28530. An instance of the <paramref name="className"/> or <paramref name="defaultValue"/>
  28531. if the object could not be instantiated.
  28532. </returns>
  28533. <remarks>
  28534. <para>
  28535. Checks that the <paramref name="className"/> is a subclass of
  28536. <paramref name="superClass"/>. If that test fails or the object could
  28537. not be instantiated, then <paramref name="defaultValue"/> is returned.
  28538. </para>
  28539. </remarks>
  28540. </member>
  28541. <member name="M:log4net.Util.OptionConverter.SubstituteVariables(System.String,System.Collections.IDictionary)">
  28542. <summary>
  28543. Performs variable substitution in string <paramref name="value"/> from the
  28544. values of keys found in <paramref name="props"/>.
  28545. </summary>
  28546. <param name="value">The string on which variable substitution is performed.</param>
  28547. <param name="props">The dictionary to use to lookup variables.</param>
  28548. <returns>The result of the substitutions.</returns>
  28549. <remarks>
  28550. <para>
  28551. The variable substitution delimiters are <b>${</b> and <b>}</b>.
  28552. </para>
  28553. <para>
  28554. For example, if props contains <c>key=value</c>, then the call
  28555. </para>
  28556. <para>
  28557. <code lang="C#">
  28558. string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
  28559. </code>
  28560. </para>
  28561. <para>
  28562. will set the variable <c>s</c> to "Value of key is value.".
  28563. </para>
  28564. <para>
  28565. If no value could be found for the specified key, then substitution
  28566. defaults to an empty string.
  28567. </para>
  28568. <para>
  28569. For example, if system properties contains no value for the key
  28570. "nonExistentKey", then the call
  28571. </para>
  28572. <para>
  28573. <code lang="C#">
  28574. string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
  28575. </code>
  28576. </para>
  28577. <para>
  28578. will set <s>s</s> to "Value of nonExistentKey is []".
  28579. </para>
  28580. <para>
  28581. An Exception is thrown if <paramref name="value"/> contains a start
  28582. delimiter "${" which is not balanced by a stop delimiter "}".
  28583. </para>
  28584. </remarks>
  28585. </member>
  28586. <member name="M:log4net.Util.OptionConverter.ParseEnum(System.Type,System.String,System.Boolean)">
  28587. <summary>
  28588. Converts the string representation of the name or numeric value of one or
  28589. more enumerated constants to an equivalent enumerated object.
  28590. </summary>
  28591. <param name="enumType">The type to convert to.</param>
  28592. <param name="value">The enum string value.</param>
  28593. <param name="ignoreCase">If <c>true</c>, ignore case; otherwise, regard case.</param>
  28594. <returns>An object of type <paramref name="enumType" /> whose value is represented by <paramref name="value" />.</returns>
  28595. </member>
  28596. <member name="F:log4net.Util.OptionConverter.declaringType">
  28597. <summary>
  28598. The fully qualified type of the OptionConverter class.
  28599. </summary>
  28600. <remarks>
  28601. Used by the internal logger to record the Type of the
  28602. log message.
  28603. </remarks>
  28604. </member>
  28605. <member name="T:log4net.Util.PatternParser">
  28606. <summary>
  28607. Most of the work of the <see cref="T:log4net.Layout.PatternLayout"/> class
  28608. is delegated to the PatternParser class.
  28609. </summary>
  28610. <remarks>
  28611. <para>
  28612. The <c>PatternParser</c> processes a pattern string and
  28613. returns a chain of <see cref="T:log4net.Util.PatternConverter"/> objects.
  28614. </para>
  28615. </remarks>
  28616. <author>Nicko Cadell</author>
  28617. <author>Gert Driesen</author>
  28618. </member>
  28619. <member name="M:log4net.Util.PatternParser.#ctor(System.String)">
  28620. <summary>
  28621. Constructor
  28622. </summary>
  28623. <param name="pattern">The pattern to parse.</param>
  28624. <remarks>
  28625. <para>
  28626. Initializes a new instance of the <see cref="T:log4net.Util.PatternParser"/> class
  28627. with the specified pattern string.
  28628. </para>
  28629. </remarks>
  28630. </member>
  28631. <member name="M:log4net.Util.PatternParser.Parse">
  28632. <summary>
  28633. Parses the pattern into a chain of pattern converters.
  28634. </summary>
  28635. <returns>The head of a chain of pattern converters.</returns>
  28636. <remarks>
  28637. <para>
  28638. Parses the pattern into a chain of pattern converters.
  28639. </para>
  28640. </remarks>
  28641. </member>
  28642. <member name="M:log4net.Util.PatternParser.BuildCache">
  28643. <summary>
  28644. Build the unified cache of converters from the static and instance maps
  28645. </summary>
  28646. <returns>the list of all the converter names</returns>
  28647. <remarks>
  28648. <para>
  28649. Build the unified cache of converters from the static and instance maps
  28650. </para>
  28651. </remarks>
  28652. </member>
  28653. <member name="M:log4net.Util.PatternParser.ParseInternal(System.String,System.String[])">
  28654. <summary>
  28655. Internal method to parse the specified pattern to find specified matches
  28656. </summary>
  28657. <param name="pattern">the pattern to parse</param>
  28658. <param name="matches">the converter names to match in the pattern</param>
  28659. <remarks>
  28660. <para>
  28661. The matches param must be sorted such that longer strings come before shorter ones.
  28662. </para>
  28663. </remarks>
  28664. </member>
  28665. <member name="M:log4net.Util.PatternParser.ProcessLiteral(System.String)">
  28666. <summary>
  28667. Process a parsed literal
  28668. </summary>
  28669. <param name="text">the literal text</param>
  28670. </member>
  28671. <member name="M:log4net.Util.PatternParser.ProcessConverter(System.String,System.String,log4net.Util.FormattingInfo)">
  28672. <summary>
  28673. Process a parsed converter pattern
  28674. </summary>
  28675. <param name="converterName">the name of the converter</param>
  28676. <param name="option">the optional option for the converter</param>
  28677. <param name="formattingInfo">the formatting info for the converter</param>
  28678. </member>
  28679. <member name="M:log4net.Util.PatternParser.AddConverter(log4net.Util.PatternConverter)">
  28680. <summary>
  28681. Resets the internal state of the parser and adds the specified pattern converter
  28682. to the chain.
  28683. </summary>
  28684. <param name="pc">The pattern converter to add.</param>
  28685. </member>
  28686. <member name="F:log4net.Util.PatternParser.m_head">
  28687. <summary>
  28688. The first pattern converter in the chain
  28689. </summary>
  28690. </member>
  28691. <member name="F:log4net.Util.PatternParser.m_tail">
  28692. <summary>
  28693. the last pattern converter in the chain
  28694. </summary>
  28695. </member>
  28696. <member name="F:log4net.Util.PatternParser.m_pattern">
  28697. <summary>
  28698. The pattern
  28699. </summary>
  28700. </member>
  28701. <member name="F:log4net.Util.PatternParser.m_patternConverters">
  28702. <summary>
  28703. Internal map of converter identifiers to converter types
  28704. </summary>
  28705. <remarks>
  28706. <para>
  28707. This map overrides the static s_globalRulesRegistry map.
  28708. </para>
  28709. </remarks>
  28710. </member>
  28711. <member name="F:log4net.Util.PatternParser.declaringType">
  28712. <summary>
  28713. The fully qualified type of the PatternParser class.
  28714. </summary>
  28715. <remarks>
  28716. Used by the internal logger to record the Type of the
  28717. log message.
  28718. </remarks>
  28719. </member>
  28720. <member name="P:log4net.Util.PatternParser.PatternConverters">
  28721. <summary>
  28722. Get the converter registry used by this parser
  28723. </summary>
  28724. <value>
  28725. The converter registry used by this parser
  28726. </value>
  28727. <remarks>
  28728. <para>
  28729. Get the converter registry used by this parser
  28730. </para>
  28731. </remarks>
  28732. </member>
  28733. <member name="T:log4net.Util.PatternParser.StringLengthComparer">
  28734. <summary>
  28735. Sort strings by length
  28736. </summary>
  28737. <remarks>
  28738. <para>
  28739. <see cref="T:System.Collections.IComparer"/> that orders strings by string length.
  28740. The longest strings are placed first
  28741. </para>
  28742. </remarks>
  28743. </member>
  28744. <member name="T:log4net.Util.PatternString">
  28745. <summary>
  28746. This class implements a patterned string.
  28747. </summary>
  28748. <remarks>
  28749. <para>
  28750. This string has embedded patterns that are resolved and expanded
  28751. when the string is formatted.
  28752. </para>
  28753. <para>
  28754. This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/>
  28755. in that it accepts a pattern and renders it to a string. Unlike the
  28756. <see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c>
  28757. does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
  28758. of the process in general.
  28759. </para>
  28760. <para>
  28761. The recognized conversion pattern names are:
  28762. </para>
  28763. <list type="table">
  28764. <listheader>
  28765. <term>Conversion Pattern Name</term>
  28766. <description>Effect</description>
  28767. </listheader>
  28768. <item>
  28769. <term>appdomain</term>
  28770. <description>
  28771. <para>
  28772. Used to output the friendly name of the current AppDomain.
  28773. </para>
  28774. </description>
  28775. </item>
  28776. <item>
  28777. <term>appsetting</term>
  28778. <description>
  28779. <para>
  28780. Used to output the value of a specific appSetting key in the application
  28781. configuration file.
  28782. </para>
  28783. </description>
  28784. </item>
  28785. <item>
  28786. <term>date</term>
  28787. <description>
  28788. <para>
  28789. Used to output the current date and time in the local time zone.
  28790. To output the date in universal time use the <c>%utcdate</c> pattern.
  28791. The date conversion
  28792. specifier may be followed by a <i>date format specifier</i> enclosed
  28793. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  28794. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  28795. given then ISO8601 format is
  28796. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  28797. </para>
  28798. <para>
  28799. The date format specifier admits the same syntax as the
  28800. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  28801. </para>
  28802. <para>
  28803. For better results it is recommended to use the log4net date
  28804. formatters. These can be specified using one of the strings
  28805. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  28806. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  28807. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  28808. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  28809. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  28810. </para>
  28811. <para>
  28812. These dedicated date formatters perform significantly
  28813. better than <see cref="M:DateTime.ToString(string)"/>.
  28814. </para>
  28815. </description>
  28816. </item>
  28817. <item>
  28818. <term>env</term>
  28819. <description>
  28820. <para>
  28821. Used to output the a specific environment variable. The key to
  28822. lookup must be specified within braces and directly following the
  28823. pattern specifier, e.g. <b>%env{COMPUTERNAME}</b> would include the value
  28824. of the <c>COMPUTERNAME</c> environment variable.
  28825. </para>
  28826. <para>
  28827. The <c>env</c> pattern is not supported on the .NET Compact Framework.
  28828. </para>
  28829. </description>
  28830. </item>
  28831. <item>
  28832. <term>identity</term>
  28833. <description>
  28834. <para>
  28835. Used to output the user name for the currently active user
  28836. (Principal.Identity.Name).
  28837. </para>
  28838. </description>
  28839. </item>
  28840. <item>
  28841. <term>newline</term>
  28842. <description>
  28843. <para>
  28844. Outputs the platform dependent line separator character or
  28845. characters.
  28846. </para>
  28847. <para>
  28848. This conversion pattern name offers the same performance as using
  28849. non-portable line separator strings such as "\n", or "\r\n".
  28850. Thus, it is the preferred way of specifying a line separator.
  28851. </para>
  28852. </description>
  28853. </item>
  28854. <item>
  28855. <term>processid</term>
  28856. <description>
  28857. <para>
  28858. Used to output the system process ID for the current process.
  28859. </para>
  28860. </description>
  28861. </item>
  28862. <item>
  28863. <term>property</term>
  28864. <description>
  28865. <para>
  28866. Used to output a specific context property. The key to
  28867. lookup must be specified within braces and directly following the
  28868. pattern specifier, e.g. <b>%property{user}</b> would include the value
  28869. from the property that is keyed by the string 'user'. Each property value
  28870. that is to be included in the log must be specified separately.
  28871. Properties are stored in logging contexts. By default
  28872. the <c>log4net:HostName</c> property is set to the name of machine on
  28873. which the event was originally logged.
  28874. </para>
  28875. <para>
  28876. If no key is specified, e.g. <b>%property</b> then all the keys and their
  28877. values are printed in a comma separated list.
  28878. </para>
  28879. <para>
  28880. The properties of an event are combined from a number of different
  28881. contexts. These are listed below in the order in which they are searched.
  28882. </para>
  28883. <list type="definition">
  28884. <item>
  28885. <term>the thread properties</term>
  28886. <description>
  28887. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  28888. thread. These properties are shared by all events logged on this thread.
  28889. </description>
  28890. </item>
  28891. <item>
  28892. <term>the global properties</term>
  28893. <description>
  28894. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  28895. properties are shared by all the threads in the AppDomain.
  28896. </description>
  28897. </item>
  28898. </list>
  28899. </description>
  28900. </item>
  28901. <item>
  28902. <term>random</term>
  28903. <description>
  28904. <para>
  28905. Used to output a random string of characters. The string is made up of
  28906. uppercase letters and numbers. By default the string is 4 characters long.
  28907. The length of the string can be specified within braces directly following the
  28908. pattern specifier, e.g. <b>%random{8}</b> would output an 8 character string.
  28909. </para>
  28910. </description>
  28911. </item>
  28912. <item>
  28913. <term>username</term>
  28914. <description>
  28915. <para>
  28916. Used to output the WindowsIdentity for the currently
  28917. active user.
  28918. </para>
  28919. </description>
  28920. </item>
  28921. <item>
  28922. <term>utcdate</term>
  28923. <description>
  28924. <para>
  28925. Used to output the date of the logging event in universal time.
  28926. The date conversion
  28927. specifier may be followed by a <i>date format specifier</i> enclosed
  28928. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  28929. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  28930. given then ISO8601 format is
  28931. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  28932. </para>
  28933. <para>
  28934. The date format specifier admits the same syntax as the
  28935. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  28936. </para>
  28937. <para>
  28938. For better results it is recommended to use the log4net date
  28939. formatters. These can be specified using one of the strings
  28940. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  28941. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  28942. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  28943. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  28944. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  28945. </para>
  28946. <para>
  28947. These dedicated date formatters perform significantly
  28948. better than <see cref="M:DateTime.ToString(string)"/>.
  28949. </para>
  28950. </description>
  28951. </item>
  28952. <item>
  28953. <term>%</term>
  28954. <description>
  28955. <para>
  28956. The sequence %% outputs a single percent sign.
  28957. </para>
  28958. </description>
  28959. </item>
  28960. </list>
  28961. <para>
  28962. Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/>
  28963. instance using <see cref="M:AddConverter(ConverterInfo)"/> or
  28964. <see cref="M:AddConverter(string, Type)"/>.
  28965. </para>
  28966. <para>
  28967. See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the
  28968. <i>format modifiers</i> supported by the patterns.
  28969. </para>
  28970. </remarks>
  28971. <author>Nicko Cadell</author>
  28972. </member>
  28973. <member name="F:log4net.Util.PatternString.s_globalRulesRegistry">
  28974. <summary>
  28975. Internal map of converter identifiers to converter types.
  28976. </summary>
  28977. </member>
  28978. <member name="F:log4net.Util.PatternString.m_pattern">
  28979. <summary>
  28980. the pattern
  28981. </summary>
  28982. </member>
  28983. <member name="F:log4net.Util.PatternString.m_head">
  28984. <summary>
  28985. the head of the pattern converter chain
  28986. </summary>
  28987. </member>
  28988. <member name="F:log4net.Util.PatternString.m_instanceRulesRegistry">
  28989. <summary>
  28990. patterns defined on this PatternString only
  28991. </summary>
  28992. </member>
  28993. <member name="M:log4net.Util.PatternString.#cctor">
  28994. <summary>
  28995. Initialize the global registry
  28996. </summary>
  28997. </member>
  28998. <member name="M:log4net.Util.PatternString.#ctor">
  28999. <summary>
  29000. Default constructor
  29001. </summary>
  29002. <remarks>
  29003. <para>
  29004. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/>
  29005. </para>
  29006. </remarks>
  29007. </member>
  29008. <member name="M:log4net.Util.PatternString.#ctor(System.String)">
  29009. <summary>
  29010. Constructs a PatternString
  29011. </summary>
  29012. <param name="pattern">The pattern to use with this PatternString</param>
  29013. <remarks>
  29014. <para>
  29015. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> with the pattern specified.
  29016. </para>
  29017. </remarks>
  29018. </member>
  29019. <member name="M:log4net.Util.PatternString.ActivateOptions">
  29020. <summary>
  29021. Initialize object options
  29022. </summary>
  29023. <remarks>
  29024. <para>
  29025. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  29026. activation scheme. The <see cref="M:log4net.Util.PatternString.ActivateOptions"/> method must
  29027. be called on this object after the configuration properties have
  29028. been set. Until <see cref="M:log4net.Util.PatternString.ActivateOptions"/> is called this
  29029. object is in an undefined state and must not be used.
  29030. </para>
  29031. <para>
  29032. If any of the configuration properties are modified then
  29033. <see cref="M:log4net.Util.PatternString.ActivateOptions"/> must be called again.
  29034. </para>
  29035. </remarks>
  29036. </member>
  29037. <member name="M:log4net.Util.PatternString.CreatePatternParser(System.String)">
  29038. <summary>
  29039. Create the <see cref="T:log4net.Util.PatternParser"/> used to parse the pattern
  29040. </summary>
  29041. <param name="pattern">the pattern to parse</param>
  29042. <returns>The <see cref="T:log4net.Util.PatternParser"/></returns>
  29043. <remarks>
  29044. <para>
  29045. Returns PatternParser used to parse the conversion string. Subclasses
  29046. may override this to return a subclass of PatternParser which recognize
  29047. custom conversion pattern name.
  29048. </para>
  29049. </remarks>
  29050. </member>
  29051. <member name="M:log4net.Util.PatternString.Format(System.IO.TextWriter)">
  29052. <summary>
  29053. Produces a formatted string as specified by the conversion pattern.
  29054. </summary>
  29055. <param name="writer">The TextWriter to write the formatted event to</param>
  29056. <remarks>
  29057. <para>
  29058. Format the pattern to the <paramref name="writer"/>.
  29059. </para>
  29060. </remarks>
  29061. </member>
  29062. <member name="M:log4net.Util.PatternString.Format">
  29063. <summary>
  29064. Format the pattern as a string
  29065. </summary>
  29066. <returns>the pattern formatted as a string</returns>
  29067. <remarks>
  29068. <para>
  29069. Format the pattern to a string.
  29070. </para>
  29071. </remarks>
  29072. </member>
  29073. <member name="M:log4net.Util.PatternString.AddConverter(log4net.Util.ConverterInfo)">
  29074. <summary>
  29075. Add a converter to this PatternString
  29076. </summary>
  29077. <param name="converterInfo">the converter info</param>
  29078. <remarks>
  29079. <para>
  29080. This version of the method is used by the configurator.
  29081. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  29082. </para>
  29083. </remarks>
  29084. </member>
  29085. <member name="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)">
  29086. <summary>
  29087. Add a converter to this PatternString
  29088. </summary>
  29089. <param name="name">the name of the conversion pattern for this converter</param>
  29090. <param name="type">the type of the converter</param>
  29091. <remarks>
  29092. <para>
  29093. Add a converter to this PatternString
  29094. </para>
  29095. </remarks>
  29096. </member>
  29097. <member name="P:log4net.Util.PatternString.ConversionPattern">
  29098. <summary>
  29099. Gets or sets the pattern formatting string
  29100. </summary>
  29101. <value>
  29102. The pattern formatting string
  29103. </value>
  29104. <remarks>
  29105. <para>
  29106. The <b>ConversionPattern</b> option. This is the string which
  29107. controls formatting and consists of a mix of literal content and
  29108. conversion specifiers.
  29109. </para>
  29110. </remarks>
  29111. </member>
  29112. <member name="T:log4net.Util.PropertiesDictionary">
  29113. <summary>
  29114. String keyed object map.
  29115. </summary>
  29116. <remarks>
  29117. <para>
  29118. While this collection is serializable only member
  29119. objects that are serializable will
  29120. be serialized along with this collection.
  29121. </para>
  29122. </remarks>
  29123. <author>Nicko Cadell</author>
  29124. <author>Gert Driesen</author>
  29125. </member>
  29126. <member name="T:log4net.Util.ReadOnlyPropertiesDictionary">
  29127. <summary>
  29128. String keyed object map that is read only.
  29129. </summary>
  29130. <remarks>
  29131. <para>
  29132. This collection is readonly and cannot be modified.
  29133. </para>
  29134. <para>
  29135. While this collection is serializable only member
  29136. objects that are serializable will
  29137. be serialized along with this collection.
  29138. </para>
  29139. </remarks>
  29140. <author>Nicko Cadell</author>
  29141. <author>Gert Driesen</author>
  29142. </member>
  29143. <member name="F:log4net.Util.ReadOnlyPropertiesDictionary.m_hashtable">
  29144. <summary>
  29145. The Hashtable used to store the properties data
  29146. </summary>
  29147. </member>
  29148. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor">
  29149. <summary>
  29150. Constructor
  29151. </summary>
  29152. <remarks>
  29153. <para>
  29154. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class.
  29155. </para>
  29156. </remarks>
  29157. </member>
  29158. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  29159. <summary>
  29160. Copy Constructor
  29161. </summary>
  29162. <param name="propertiesDictionary">properties to copy</param>
  29163. <remarks>
  29164. <para>
  29165. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class.
  29166. </para>
  29167. </remarks>
  29168. </member>
  29169. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29170. <summary>
  29171. Deserialization constructor
  29172. </summary>
  29173. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
  29174. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  29175. <remarks>
  29176. <para>
  29177. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class
  29178. with serialized data.
  29179. </para>
  29180. </remarks>
  29181. </member>
  29182. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetKeys">
  29183. <summary>
  29184. Gets the key names.
  29185. </summary>
  29186. <returns>An array of all the keys.</returns>
  29187. <remarks>
  29188. <para>
  29189. Gets the key names.
  29190. </para>
  29191. </remarks>
  29192. </member>
  29193. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Contains(System.String)">
  29194. <summary>
  29195. Test if the dictionary contains a specified key
  29196. </summary>
  29197. <param name="key">the key to look for</param>
  29198. <returns>true if the dictionary contains the specified key</returns>
  29199. <remarks>
  29200. <para>
  29201. Test if the dictionary contains a specified key
  29202. </para>
  29203. </remarks>
  29204. </member>
  29205. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29206. <summary>
  29207. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
  29208. </summary>
  29209. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
  29210. <param name="context">The destination for this serialization.</param>
  29211. <remarks>
  29212. <para>
  29213. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
  29214. </para>
  29215. </remarks>
  29216. </member>
  29217. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  29218. <summary>
  29219. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  29220. </summary>
  29221. </member>
  29222. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  29223. <summary>
  29224. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  29225. </summary>
  29226. <param name="key"></param>
  29227. </member>
  29228. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  29229. <summary>
  29230. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  29231. </summary>
  29232. <param name="key"></param>
  29233. <returns></returns>
  29234. </member>
  29235. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Clear">
  29236. <summary>
  29237. Remove all properties from the properties collection
  29238. </summary>
  29239. </member>
  29240. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  29241. <summary>
  29242. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  29243. </summary>
  29244. <param name="key"></param>
  29245. <param name="value"></param>
  29246. </member>
  29247. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  29248. <summary>
  29249. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  29250. </summary>
  29251. <param name="array"></param>
  29252. <param name="index"></param>
  29253. </member>
  29254. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  29255. <summary>
  29256. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  29257. </summary>
  29258. </member>
  29259. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Item(System.String)">
  29260. <summary>
  29261. Gets or sets the value of the property with the specified key.
  29262. </summary>
  29263. <value>
  29264. The value of the property with the specified key.
  29265. </value>
  29266. <param name="key">The key of the property to get or set.</param>
  29267. <remarks>
  29268. <para>
  29269. The property value will only be serialized if it is serializable.
  29270. If it cannot be serialized it will be silently ignored if
  29271. a serialization operation is performed.
  29272. </para>
  29273. </remarks>
  29274. </member>
  29275. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.InnerHashtable">
  29276. <summary>
  29277. The hashtable used to store the properties
  29278. </summary>
  29279. <value>
  29280. The internal collection used to store the properties
  29281. </value>
  29282. <remarks>
  29283. <para>
  29284. The hashtable used to store the properties
  29285. </para>
  29286. </remarks>
  29287. </member>
  29288. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  29289. <summary>
  29290. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  29291. </summary>
  29292. </member>
  29293. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  29294. <summary>
  29295. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  29296. </summary>
  29297. </member>
  29298. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Values">
  29299. <summary>
  29300. See <see cref="P:System.Collections.IDictionary.Values"/>
  29301. </summary>
  29302. </member>
  29303. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Keys">
  29304. <summary>
  29305. See <see cref="P:System.Collections.IDictionary.Keys"/>
  29306. </summary>
  29307. </member>
  29308. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  29309. <summary>
  29310. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  29311. </summary>
  29312. </member>
  29313. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  29314. <summary>
  29315. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  29316. </summary>
  29317. </member>
  29318. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Count">
  29319. <summary>
  29320. The number of properties in this collection
  29321. </summary>
  29322. </member>
  29323. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#SyncRoot">
  29324. <summary>
  29325. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  29326. </summary>
  29327. </member>
  29328. <member name="M:log4net.Util.PropertiesDictionary.#ctor">
  29329. <summary>
  29330. Constructor
  29331. </summary>
  29332. <remarks>
  29333. <para>
  29334. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class.
  29335. </para>
  29336. </remarks>
  29337. </member>
  29338. <member name="M:log4net.Util.PropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  29339. <summary>
  29340. Constructor
  29341. </summary>
  29342. <param name="propertiesDictionary">properties to copy</param>
  29343. <remarks>
  29344. <para>
  29345. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class.
  29346. </para>
  29347. </remarks>
  29348. </member>
  29349. <member name="M:log4net.Util.PropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29350. <summary>
  29351. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class
  29352. with serialized data.
  29353. </summary>
  29354. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
  29355. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  29356. <remarks>
  29357. <para>
  29358. Because this class is sealed the serialization constructor is private.
  29359. </para>
  29360. </remarks>
  29361. </member>
  29362. <member name="M:log4net.Util.PropertiesDictionary.Remove(System.String)">
  29363. <summary>
  29364. Remove the entry with the specified key from this dictionary
  29365. </summary>
  29366. <param name="key">the key for the entry to remove</param>
  29367. <remarks>
  29368. <para>
  29369. Remove the entry with the specified key from this dictionary
  29370. </para>
  29371. </remarks>
  29372. </member>
  29373. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  29374. <summary>
  29375. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  29376. </summary>
  29377. <returns>an enumerator</returns>
  29378. <remarks>
  29379. <para>
  29380. Returns a <see cref="T:System.Collections.IDictionaryEnumerator"/> over the contest of this collection.
  29381. </para>
  29382. </remarks>
  29383. </member>
  29384. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  29385. <summary>
  29386. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  29387. </summary>
  29388. <param name="key">the key to remove</param>
  29389. <remarks>
  29390. <para>
  29391. Remove the entry with the specified key from this dictionary
  29392. </para>
  29393. </remarks>
  29394. </member>
  29395. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  29396. <summary>
  29397. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  29398. </summary>
  29399. <param name="key">the key to lookup in the collection</param>
  29400. <returns><c>true</c> if the collection contains the specified key</returns>
  29401. <remarks>
  29402. <para>
  29403. Test if this collection contains a specified key.
  29404. </para>
  29405. </remarks>
  29406. </member>
  29407. <member name="M:log4net.Util.PropertiesDictionary.Clear">
  29408. <summary>
  29409. Remove all properties from the properties collection
  29410. </summary>
  29411. <remarks>
  29412. <para>
  29413. Remove all properties from the properties collection
  29414. </para>
  29415. </remarks>
  29416. </member>
  29417. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  29418. <summary>
  29419. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  29420. </summary>
  29421. <param name="key">the key</param>
  29422. <param name="value">the value to store for the key</param>
  29423. <remarks>
  29424. <para>
  29425. Store a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  29426. </para>
  29427. </remarks>
  29428. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  29429. </member>
  29430. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  29431. <summary>
  29432. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  29433. </summary>
  29434. <param name="array"></param>
  29435. <param name="index"></param>
  29436. </member>
  29437. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  29438. <summary>
  29439. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  29440. </summary>
  29441. </member>
  29442. <member name="P:log4net.Util.PropertiesDictionary.Item(System.String)">
  29443. <summary>
  29444. Gets or sets the value of the property with the specified key.
  29445. </summary>
  29446. <value>
  29447. The value of the property with the specified key.
  29448. </value>
  29449. <param name="key">The key of the property to get or set.</param>
  29450. <remarks>
  29451. <para>
  29452. The property value will only be serialized if it is serializable.
  29453. If it cannot be serialized it will be silently ignored if
  29454. a serialization operation is performed.
  29455. </para>
  29456. </remarks>
  29457. </member>
  29458. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  29459. <summary>
  29460. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  29461. </summary>
  29462. <value>
  29463. <c>false</c>
  29464. </value>
  29465. <remarks>
  29466. <para>
  29467. This collection is modifiable. This property always
  29468. returns <c>false</c>.
  29469. </para>
  29470. </remarks>
  29471. </member>
  29472. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  29473. <summary>
  29474. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  29475. </summary>
  29476. <value>
  29477. The value for the key specified.
  29478. </value>
  29479. <remarks>
  29480. <para>
  29481. Get or set a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  29482. </para>
  29483. </remarks>
  29484. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  29485. </member>
  29486. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Values">
  29487. <summary>
  29488. See <see cref="P:System.Collections.IDictionary.Values"/>
  29489. </summary>
  29490. </member>
  29491. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Keys">
  29492. <summary>
  29493. See <see cref="P:System.Collections.IDictionary.Keys"/>
  29494. </summary>
  29495. </member>
  29496. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  29497. <summary>
  29498. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  29499. </summary>
  29500. </member>
  29501. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  29502. <summary>
  29503. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  29504. </summary>
  29505. </member>
  29506. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#SyncRoot">
  29507. <summary>
  29508. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  29509. </summary>
  29510. </member>
  29511. <member name="T:log4net.Util.PropertyEntry">
  29512. <summary>
  29513. A class to hold the key and data for a property set in the config file
  29514. </summary>
  29515. <remarks>
  29516. <para>
  29517. A class to hold the key and data for a property set in the config file
  29518. </para>
  29519. </remarks>
  29520. </member>
  29521. <member name="M:log4net.Util.PropertyEntry.ToString">
  29522. <summary>
  29523. Override <c>Object.ToString</c> to return sensible debug info
  29524. </summary>
  29525. <returns>string info about this object</returns>
  29526. </member>
  29527. <member name="P:log4net.Util.PropertyEntry.Key">
  29528. <summary>
  29529. Property Key
  29530. </summary>
  29531. <value>
  29532. Property Key
  29533. </value>
  29534. <remarks>
  29535. <para>
  29536. Property Key.
  29537. </para>
  29538. </remarks>
  29539. </member>
  29540. <member name="P:log4net.Util.PropertyEntry.Value">
  29541. <summary>
  29542. Property Value
  29543. </summary>
  29544. <value>
  29545. Property Value
  29546. </value>
  29547. <remarks>
  29548. <para>
  29549. Property Value.
  29550. </para>
  29551. </remarks>
  29552. </member>
  29553. <member name="T:log4net.Util.ProtectCloseTextWriter">
  29554. <summary>
  29555. A <see cref="T:System.IO.TextWriter"/> that ignores the <see cref="M:log4net.Util.ProtectCloseTextWriter.Close"/> message
  29556. </summary>
  29557. <remarks>
  29558. <para>
  29559. This writer is used in special cases where it is necessary
  29560. to protect a writer from being closed by a client.
  29561. </para>
  29562. </remarks>
  29563. <author>Nicko Cadell</author>
  29564. </member>
  29565. <member name="M:log4net.Util.ProtectCloseTextWriter.#ctor(System.IO.TextWriter)">
  29566. <summary>
  29567. Constructor
  29568. </summary>
  29569. <param name="writer">the writer to actually write to</param>
  29570. <remarks>
  29571. <para>
  29572. Create a new ProtectCloseTextWriter using a writer
  29573. </para>
  29574. </remarks>
  29575. </member>
  29576. <member name="M:log4net.Util.ProtectCloseTextWriter.Attach(System.IO.TextWriter)">
  29577. <summary>
  29578. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  29579. </summary>
  29580. <param name="writer">the writer to attach to</param>
  29581. <remarks>
  29582. <para>
  29583. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  29584. </para>
  29585. </remarks>
  29586. </member>
  29587. <member name="M:log4net.Util.ProtectCloseTextWriter.Close">
  29588. <summary>
  29589. Does not close the underlying output writer.
  29590. </summary>
  29591. <remarks>
  29592. <para>
  29593. Does not close the underlying output writer.
  29594. This method does nothing.
  29595. </para>
  29596. </remarks>
  29597. </member>
  29598. <member name="T:log4net.Util.ReaderWriterLock">
  29599. <summary>
  29600. Defines a lock that supports single writers and multiple readers
  29601. </summary>
  29602. <remarks>
  29603. <para>
  29604. <c>ReaderWriterLock</c> is used to synchronize access to a resource.
  29605. At any given time, it allows either concurrent read access for
  29606. multiple threads, or write access for a single thread. In a
  29607. situation where a resource is changed infrequently, a
  29608. <c>ReaderWriterLock</c> provides better throughput than a simple
  29609. one-at-a-time lock, such as <see cref="T:System.Threading.Monitor"/>.
  29610. </para>
  29611. <para>
  29612. If a platform does not support a <c>System.Threading.ReaderWriterLock</c>
  29613. implementation then all readers and writers are serialized. Therefore
  29614. the caller must not rely on multiple simultaneous readers.
  29615. </para>
  29616. </remarks>
  29617. <author>Nicko Cadell</author>
  29618. </member>
  29619. <member name="M:log4net.Util.ReaderWriterLock.#ctor">
  29620. <summary>
  29621. Constructor
  29622. </summary>
  29623. <remarks>
  29624. <para>
  29625. Initializes a new instance of the <see cref="T:log4net.Util.ReaderWriterLock"/> class.
  29626. </para>
  29627. </remarks>
  29628. </member>
  29629. <member name="M:log4net.Util.ReaderWriterLock.AcquireReaderLock">
  29630. <summary>
  29631. Acquires a reader lock
  29632. </summary>
  29633. <remarks>
  29634. <para>
  29635. <see cref="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"/> blocks if a different thread has the writer
  29636. lock, or if at least one thread is waiting for the writer lock.
  29637. </para>
  29638. </remarks>
  29639. </member>
  29640. <member name="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock">
  29641. <summary>
  29642. Decrements the lock count
  29643. </summary>
  29644. <remarks>
  29645. <para>
  29646. <see cref="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"/> decrements the lock count. When the count
  29647. reaches zero, the lock is released.
  29648. </para>
  29649. </remarks>
  29650. </member>
  29651. <member name="M:log4net.Util.ReaderWriterLock.AcquireWriterLock">
  29652. <summary>
  29653. Acquires the writer lock
  29654. </summary>
  29655. <remarks>
  29656. <para>
  29657. This method blocks if another thread has a reader lock or writer lock.
  29658. </para>
  29659. </remarks>
  29660. </member>
  29661. <member name="M:log4net.Util.ReaderWriterLock.ReleaseWriterLock">
  29662. <summary>
  29663. Decrements the lock count on the writer lock
  29664. </summary>
  29665. <remarks>
  29666. <para>
  29667. ReleaseWriterLock decrements the writer lock count.
  29668. When the count reaches zero, the writer lock is released.
  29669. </para>
  29670. </remarks>
  29671. </member>
  29672. <member name="T:log4net.Util.ReusableStringWriter">
  29673. <summary>
  29674. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused
  29675. </summary>
  29676. <remarks>
  29677. <para>
  29678. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused.
  29679. This uses a single buffer for string operations.
  29680. </para>
  29681. </remarks>
  29682. <author>Nicko Cadell</author>
  29683. </member>
  29684. <member name="M:log4net.Util.ReusableStringWriter.#ctor(System.IFormatProvider)">
  29685. <summary>
  29686. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  29687. </summary>
  29688. <param name="formatProvider">the format provider to use</param>
  29689. <remarks>
  29690. <para>
  29691. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  29692. </para>
  29693. </remarks>
  29694. </member>
  29695. <member name="M:log4net.Util.ReusableStringWriter.Dispose(System.Boolean)">
  29696. <summary>
  29697. Override Dispose to prevent closing of writer
  29698. </summary>
  29699. <param name="disposing">flag</param>
  29700. <remarks>
  29701. <para>
  29702. Override Dispose to prevent closing of writer
  29703. </para>
  29704. </remarks>
  29705. </member>
  29706. <member name="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)">
  29707. <summary>
  29708. Reset this string writer so that it can be reused.
  29709. </summary>
  29710. <param name="maxCapacity">the maximum buffer capacity before it is trimmed</param>
  29711. <param name="defaultSize">the default size to make the buffer</param>
  29712. <remarks>
  29713. <para>
  29714. Reset this string writer so that it can be reused.
  29715. The internal buffers are cleared and reset.
  29716. </para>
  29717. </remarks>
  29718. </member>
  29719. <member name="T:log4net.Util.SystemInfo">
  29720. <summary>
  29721. Utility class for system specific information.
  29722. </summary>
  29723. <remarks>
  29724. <para>
  29725. Utility class of static methods for system specific information.
  29726. </para>
  29727. </remarks>
  29728. <author>Nicko Cadell</author>
  29729. <author>Gert Driesen</author>
  29730. <author>Alexey Solofnenko</author>
  29731. </member>
  29732. <member name="M:log4net.Util.SystemInfo.#ctor">
  29733. <summary>
  29734. Private constructor to prevent instances.
  29735. </summary>
  29736. <remarks>
  29737. <para>
  29738. Only static methods are exposed from this type.
  29739. </para>
  29740. </remarks>
  29741. </member>
  29742. <member name="M:log4net.Util.SystemInfo.#cctor">
  29743. <summary>
  29744. Initialize default values for private static fields.
  29745. </summary>
  29746. <remarks>
  29747. <para>
  29748. Only static methods are exposed from this type.
  29749. </para>
  29750. </remarks>
  29751. </member>
  29752. <member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)">
  29753. <summary>
  29754. Gets the assembly location path for the specified assembly.
  29755. </summary>
  29756. <param name="myAssembly">The assembly to get the location for.</param>
  29757. <returns>The location of the assembly.</returns>
  29758. <remarks>
  29759. <para>
  29760. This method does not guarantee to return the correct path
  29761. to the assembly. If only tries to give an indication as to
  29762. where the assembly was loaded from.
  29763. </para>
  29764. </remarks>
  29765. </member>
  29766. <member name="M:log4net.Util.SystemInfo.AssemblyQualifiedName(System.Type)">
  29767. <summary>
  29768. Gets the fully qualified name of the <see cref="T:System.Type"/>, including
  29769. the name of the assembly from which the <see cref="T:System.Type"/> was
  29770. loaded.
  29771. </summary>
  29772. <param name="type">The <see cref="T:System.Type"/> to get the fully qualified name for.</param>
  29773. <returns>The fully qualified name for the <see cref="T:System.Type"/>.</returns>
  29774. <remarks>
  29775. <para>
  29776. This is equivalent to the <c>Type.AssemblyQualifiedName</c> property,
  29777. but this method works on the .NET Compact Framework 1.0 as well as
  29778. the full .NET runtime.
  29779. </para>
  29780. </remarks>
  29781. </member>
  29782. <member name="M:log4net.Util.SystemInfo.AssemblyShortName(System.Reflection.Assembly)">
  29783. <summary>
  29784. Gets the short name of the <see cref="T:System.Reflection.Assembly"/>.
  29785. </summary>
  29786. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the name for.</param>
  29787. <returns>The short name of the <see cref="T:System.Reflection.Assembly"/>.</returns>
  29788. <remarks>
  29789. <para>
  29790. The short name of the assembly is the <see cref="P:System.Reflection.Assembly.FullName"/>
  29791. without the version, culture, or public key. i.e. it is just the
  29792. assembly's file name without the extension.
  29793. </para>
  29794. <para>
  29795. Use this rather than <c>Assembly.GetName().Name</c> because that
  29796. is not available on the Compact Framework.
  29797. </para>
  29798. <para>
  29799. Because of a FileIOPermission security demand we cannot do
  29800. the obvious Assembly.GetName().Name. We are allowed to get
  29801. the <see cref="P:System.Reflection.Assembly.FullName"/> of the assembly so we
  29802. start from there and strip out just the assembly name.
  29803. </para>
  29804. </remarks>
  29805. </member>
  29806. <member name="M:log4net.Util.SystemInfo.AssemblyFileName(System.Reflection.Assembly)">
  29807. <summary>
  29808. Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension.
  29809. </summary>
  29810. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the file name for.</param>
  29811. <returns>The file name of the assembly.</returns>
  29812. <remarks>
  29813. <para>
  29814. Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension.
  29815. </para>
  29816. </remarks>
  29817. </member>
  29818. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Type,System.String,System.Boolean,System.Boolean)">
  29819. <summary>
  29820. Loads the type specified in the type string.
  29821. </summary>
  29822. <param name="relativeType">A sibling type to use to load the type.</param>
  29823. <param name="typeName">The name of the type to load.</param>
  29824. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  29825. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  29826. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  29827. <remarks>
  29828. <para>
  29829. If the type name is fully qualified, i.e. if contains an assembly name in
  29830. the type name, the type will be loaded from the system using
  29831. <see cref="M:Type.GetType(string,bool)"/>.
  29832. </para>
  29833. <para>
  29834. If the type name is not fully qualified, it will be loaded from the assembly
  29835. containing the specified relative type. If the type is not found in the assembly
  29836. then all the loaded assemblies will be searched for the type.
  29837. </para>
  29838. </remarks>
  29839. </member>
  29840. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.String,System.Boolean,System.Boolean)">
  29841. <summary>
  29842. Loads the type specified in the type string.
  29843. </summary>
  29844. <param name="typeName">The name of the type to load.</param>
  29845. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  29846. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  29847. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  29848. <remarks>
  29849. <para>
  29850. If the type name is fully qualified, i.e. if contains an assembly name in
  29851. the type name, the type will be loaded from the system using
  29852. <see cref="M:Type.GetType(string,bool)"/>.
  29853. </para>
  29854. <para>
  29855. If the type name is not fully qualified it will be loaded from the
  29856. assembly that is directly calling this method. If the type is not found
  29857. in the assembly then all the loaded assemblies will be searched for the type.
  29858. </para>
  29859. </remarks>
  29860. </member>
  29861. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Reflection.Assembly,System.String,System.Boolean,System.Boolean)">
  29862. <summary>
  29863. Loads the type specified in the type string.
  29864. </summary>
  29865. <param name="relativeAssembly">An assembly to load the type from.</param>
  29866. <param name="typeName">The name of the type to load.</param>
  29867. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  29868. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  29869. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  29870. <remarks>
  29871. <para>
  29872. If the type name is fully qualified, i.e. if contains an assembly name in
  29873. the type name, the type will be loaded from the system using
  29874. <see cref="M:Type.GetType(string,bool)"/>.
  29875. </para>
  29876. <para>
  29877. If the type name is not fully qualified it will be loaded from the specified
  29878. assembly. If the type is not found in the assembly then all the loaded assemblies
  29879. will be searched for the type.
  29880. </para>
  29881. </remarks>
  29882. </member>
  29883. <member name="M:log4net.Util.SystemInfo.NewGuid">
  29884. <summary>
  29885. Generate a new guid
  29886. </summary>
  29887. <returns>A new Guid</returns>
  29888. <remarks>
  29889. <para>
  29890. Generate a new guid
  29891. </para>
  29892. </remarks>
  29893. </member>
  29894. <member name="M:log4net.Util.SystemInfo.CreateArgumentOutOfRangeException(System.String,System.Object,System.String)">
  29895. <summary>
  29896. Create an <see cref="T:System.ArgumentOutOfRangeException"/>
  29897. </summary>
  29898. <param name="parameterName">The name of the parameter that caused the exception</param>
  29899. <param name="actualValue">The value of the argument that causes this exception</param>
  29900. <param name="message">The message that describes the error</param>
  29901. <returns>the ArgumentOutOfRangeException object</returns>
  29902. <remarks>
  29903. <para>
  29904. Create a new instance of the <see cref="T:System.ArgumentOutOfRangeException"/> class
  29905. with a specified error message, the parameter name, and the value
  29906. of the argument.
  29907. </para>
  29908. <para>
  29909. The Compact Framework does not support the 3 parameter constructor for the
  29910. <see cref="T:System.ArgumentOutOfRangeException"/> type. This method provides an
  29911. implementation that works for all platforms.
  29912. </para>
  29913. </remarks>
  29914. </member>
  29915. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int32@)">
  29916. <summary>
  29917. Parse a string into an <see cref="T:System.Int32"/> value
  29918. </summary>
  29919. <param name="s">the string to parse</param>
  29920. <param name="val">out param where the parsed value is placed</param>
  29921. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  29922. <remarks>
  29923. <para>
  29924. Attempts to parse the string into an integer. If the string cannot
  29925. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  29926. </para>
  29927. </remarks>
  29928. </member>
  29929. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int64@)">
  29930. <summary>
  29931. Parse a string into an <see cref="T:System.Int64"/> value
  29932. </summary>
  29933. <param name="s">the string to parse</param>
  29934. <param name="val">out param where the parsed value is placed</param>
  29935. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  29936. <remarks>
  29937. <para>
  29938. Attempts to parse the string into an integer. If the string cannot
  29939. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  29940. </para>
  29941. </remarks>
  29942. </member>
  29943. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int16@)">
  29944. <summary>
  29945. Parse a string into an <see cref="T:System.Int16"/> value
  29946. </summary>
  29947. <param name="s">the string to parse</param>
  29948. <param name="val">out param where the parsed value is placed</param>
  29949. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  29950. <remarks>
  29951. <para>
  29952. Attempts to parse the string into an integer. If the string cannot
  29953. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  29954. </para>
  29955. </remarks>
  29956. </member>
  29957. <member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)">
  29958. <summary>
  29959. Lookup an application setting
  29960. </summary>
  29961. <param name="key">the application settings key to lookup</param>
  29962. <returns>the value for the key, or <c>null</c></returns>
  29963. <remarks>
  29964. <para>
  29965. Configuration APIs are not supported under the Compact Framework
  29966. </para>
  29967. </remarks>
  29968. </member>
  29969. <member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)">
  29970. <summary>
  29971. Convert a path into a fully qualified local file path.
  29972. </summary>
  29973. <param name="path">The path to convert.</param>
  29974. <returns>The fully qualified path.</returns>
  29975. <remarks>
  29976. <para>
  29977. Converts the path specified to a fully
  29978. qualified path. If the path is relative it is
  29979. taken as relative from the application base
  29980. directory.
  29981. </para>
  29982. <para>
  29983. The path specified must be a local file path, a URI is not supported.
  29984. </para>
  29985. </remarks>
  29986. </member>
  29987. <member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable">
  29988. <summary>
  29989. Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity.
  29990. </summary>
  29991. <returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns>
  29992. <remarks>
  29993. <para>
  29994. The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer.
  29995. </para>
  29996. </remarks>
  29997. </member>
  29998. <member name="M:log4net.Util.SystemInfo.EqualsIgnoringCase(System.String,System.String)">
  29999. <summary>
  30000. Tests two strings for equality, the ignoring case.
  30001. </summary>
  30002. <remarks>
  30003. If the platform permits, culture information is ignored completely (ordinal comparison).
  30004. The aim of this method is to provide a fast comparison that deals with <c>null</c> and ignores different casing.
  30005. It is not supposed to deal with various, culture-specific habits.
  30006. Use it to compare against pure ASCII constants, like keywords etc.
  30007. </remarks>
  30008. <param name="a">The one string.</param>
  30009. <param name="b">The other string.</param>
  30010. <returns><c>true</c> if the strings are equal, <c>false</c> otherwise.</returns>
  30011. </member>
  30012. <member name="F:log4net.Util.SystemInfo.EmptyTypes">
  30013. <summary>
  30014. Gets an empty array of types.
  30015. </summary>
  30016. <remarks>
  30017. <para>
  30018. The <c>Type.EmptyTypes</c> field is not available on
  30019. the .NET Compact Framework 1.0.
  30020. </para>
  30021. </remarks>
  30022. </member>
  30023. <member name="F:log4net.Util.SystemInfo.declaringType">
  30024. <summary>
  30025. The fully qualified type of the SystemInfo class.
  30026. </summary>
  30027. <remarks>
  30028. Used by the internal logger to record the Type of the
  30029. log message.
  30030. </remarks>
  30031. </member>
  30032. <member name="F:log4net.Util.SystemInfo.s_hostName">
  30033. <summary>
  30034. Cache the host name for the current machine
  30035. </summary>
  30036. </member>
  30037. <member name="F:log4net.Util.SystemInfo.s_appFriendlyName">
  30038. <summary>
  30039. Cache the application friendly name
  30040. </summary>
  30041. </member>
  30042. <member name="F:log4net.Util.SystemInfo.s_nullText">
  30043. <summary>
  30044. Text to output when a <c>null</c> is encountered.
  30045. </summary>
  30046. </member>
  30047. <member name="F:log4net.Util.SystemInfo.s_notAvailableText">
  30048. <summary>
  30049. Text to output when an unsupported feature is requested.
  30050. </summary>
  30051. </member>
  30052. <member name="F:log4net.Util.SystemInfo.s_processStartTimeUtc">
  30053. <summary>
  30054. Start time for the current process.
  30055. </summary>
  30056. </member>
  30057. <member name="P:log4net.Util.SystemInfo.NewLine">
  30058. <summary>
  30059. Gets the system dependent line terminator.
  30060. </summary>
  30061. <value>
  30062. The system dependent line terminator.
  30063. </value>
  30064. <remarks>
  30065. <para>
  30066. Gets the system dependent line terminator.
  30067. </para>
  30068. </remarks>
  30069. </member>
  30070. <member name="P:log4net.Util.SystemInfo.ApplicationBaseDirectory">
  30071. <summary>
  30072. Gets the base directory for this <see cref="T:System.AppDomain"/>.
  30073. </summary>
  30074. <value>The base directory path for the current <see cref="T:System.AppDomain"/>.</value>
  30075. <remarks>
  30076. <para>
  30077. Gets the base directory for this <see cref="T:System.AppDomain"/>.
  30078. </para>
  30079. <para>
  30080. The value returned may be either a local file path or a URI.
  30081. </para>
  30082. </remarks>
  30083. </member>
  30084. <member name="P:log4net.Util.SystemInfo.ConfigurationFileLocation">
  30085. <summary>
  30086. Gets the path to the configuration file for the current <see cref="T:System.AppDomain"/>.
  30087. </summary>
  30088. <value>The path to the configuration file for the current <see cref="T:System.AppDomain"/>.</value>
  30089. <remarks>
  30090. <para>
  30091. The .NET Compact Framework 1.0 does not have a concept of a configuration
  30092. file. For this runtime, we use the entry assembly location as the root for
  30093. the configuration file name.
  30094. </para>
  30095. <para>
  30096. The value returned may be either a local file path or a URI.
  30097. </para>
  30098. </remarks>
  30099. </member>
  30100. <member name="P:log4net.Util.SystemInfo.EntryAssemblyLocation">
  30101. <summary>
  30102. Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
  30103. </summary>
  30104. <value>The path to the entry assembly.</value>
  30105. <remarks>
  30106. <para>
  30107. Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
  30108. </para>
  30109. </remarks>
  30110. </member>
  30111. <member name="P:log4net.Util.SystemInfo.CurrentThreadId">
  30112. <summary>
  30113. Gets the ID of the current thread.
  30114. </summary>
  30115. <value>The ID of the current thread.</value>
  30116. <remarks>
  30117. <para>
  30118. On the .NET framework, the <c>AppDomain.GetCurrentThreadId</c> method
  30119. is used to obtain the thread ID for the current thread. This is the
  30120. operating system ID for the thread.
  30121. </para>
  30122. <para>
  30123. On the .NET Compact Framework 1.0 it is not possible to get the
  30124. operating system thread ID for the current thread. The native method
  30125. <c>GetCurrentThreadId</c> is implemented inline in a header file
  30126. and cannot be called.
  30127. </para>
  30128. <para>
  30129. On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this
  30130. gives a stable id unrelated to the operating system thread ID which may
  30131. change if the runtime is using fibers.
  30132. </para>
  30133. </remarks>
  30134. </member>
  30135. <member name="P:log4net.Util.SystemInfo.HostName">
  30136. <summary>
  30137. Get the host name or machine name for the current machine
  30138. </summary>
  30139. <value>
  30140. The hostname or machine name
  30141. </value>
  30142. <remarks>
  30143. <para>
  30144. Get the host name or machine name for the current machine
  30145. </para>
  30146. <para>
  30147. The host name (<see cref="M:System.Net.Dns.GetHostName"/>) or
  30148. the machine name (<c>Environment.MachineName</c>) for
  30149. the current machine, or if neither of these are available
  30150. then <c>NOT AVAILABLE</c> is returned.
  30151. </para>
  30152. </remarks>
  30153. </member>
  30154. <member name="P:log4net.Util.SystemInfo.ApplicationFriendlyName">
  30155. <summary>
  30156. Get this application's friendly name
  30157. </summary>
  30158. <value>
  30159. The friendly name of this application as a string
  30160. </value>
  30161. <remarks>
  30162. <para>
  30163. If available the name of the application is retrieved from
  30164. the <c>AppDomain</c> using <c>AppDomain.CurrentDomain.FriendlyName</c>.
  30165. </para>
  30166. <para>
  30167. Otherwise the file name of the entry assembly is used.
  30168. </para>
  30169. </remarks>
  30170. </member>
  30171. <member name="P:log4net.Util.SystemInfo.ProcessStartTime">
  30172. <summary>
  30173. Get the start time for the current process.
  30174. </summary>
  30175. <remarks>
  30176. <para>
  30177. This is the time at which the log4net library was loaded into the
  30178. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  30179. this is not the start time for the current process.
  30180. </para>
  30181. <para>
  30182. The log4net library should be loaded by an application early during its
  30183. startup, therefore this start time should be a good approximation for
  30184. the actual start time.
  30185. </para>
  30186. <para>
  30187. Note that AppDomains may be loaded and unloaded within the
  30188. same process without the process terminating, however this start time
  30189. will be set per AppDomain.
  30190. </para>
  30191. </remarks>
  30192. </member>
  30193. <member name="P:log4net.Util.SystemInfo.ProcessStartTimeUtc">
  30194. <summary>
  30195. Get the UTC start time for the current process.
  30196. </summary>
  30197. <remarks>
  30198. <para>
  30199. This is the UTC time at which the log4net library was loaded into the
  30200. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  30201. this is not the start time for the current process.
  30202. </para>
  30203. <para>
  30204. The log4net library should be loaded by an application early during its
  30205. startup, therefore this start time should be a good approximation for
  30206. the actual start time.
  30207. </para>
  30208. <para>
  30209. Note that AppDomains may be loaded and unloaded within the
  30210. same process without the process terminating, however this start time
  30211. will be set per AppDomain.
  30212. </para>
  30213. </remarks>
  30214. </member>
  30215. <member name="P:log4net.Util.SystemInfo.NullText">
  30216. <summary>
  30217. Text to output when a <c>null</c> is encountered.
  30218. </summary>
  30219. <remarks>
  30220. <para>
  30221. Use this value to indicate a <c>null</c> has been encountered while
  30222. outputting a string representation of an item.
  30223. </para>
  30224. <para>
  30225. The default value is <c>(null)</c>. This value can be overridden by specifying
  30226. a value for the <c>log4net.NullText</c> appSetting in the application's
  30227. .config file.
  30228. </para>
  30229. </remarks>
  30230. </member>
  30231. <member name="P:log4net.Util.SystemInfo.NotAvailableText">
  30232. <summary>
  30233. Text to output when an unsupported feature is requested.
  30234. </summary>
  30235. <remarks>
  30236. <para>
  30237. Use this value when an unsupported feature is requested.
  30238. </para>
  30239. <para>
  30240. The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying
  30241. a value for the <c>log4net.NotAvailableText</c> appSetting in the application's
  30242. .config file.
  30243. </para>
  30244. </remarks>
  30245. </member>
  30246. <member name="T:log4net.Util.SystemStringFormat">
  30247. <summary>
  30248. Utility class that represents a format string.
  30249. </summary>
  30250. <remarks>
  30251. <para>
  30252. Utility class that represents a format string.
  30253. </para>
  30254. </remarks>
  30255. <author>Nicko Cadell</author>
  30256. </member>
  30257. <member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])">
  30258. <summary>
  30259. Initialise the <see cref="T:log4net.Util.SystemStringFormat"/>
  30260. </summary>
  30261. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  30262. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  30263. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  30264. </member>
  30265. <member name="M:log4net.Util.SystemStringFormat.ToString">
  30266. <summary>
  30267. Format the string and arguments
  30268. </summary>
  30269. <returns>the formatted string</returns>
  30270. </member>
  30271. <member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])">
  30272. <summary>
  30273. Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent
  30274. of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array.
  30275. A specified parameter supplies culture-specific formatting information.
  30276. </summary>
  30277. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  30278. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  30279. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  30280. <returns>
  30281. A copy of format in which the format items have been replaced by the <see cref="T:System.String"/>
  30282. equivalent of the corresponding instances of <see cref="T:System.Object"/> in args.
  30283. </returns>
  30284. <remarks>
  30285. <para>
  30286. This method does not throw exceptions. If an exception thrown while formatting the result the
  30287. exception and arguments are returned in the result string.
  30288. </para>
  30289. </remarks>
  30290. </member>
  30291. <member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])">
  30292. <summary>
  30293. Process an error during StringFormat
  30294. </summary>
  30295. </member>
  30296. <member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)">
  30297. <summary>
  30298. Dump the contents of an array into a string builder
  30299. </summary>
  30300. </member>
  30301. <member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)">
  30302. <summary>
  30303. Dump an object to a string
  30304. </summary>
  30305. </member>
  30306. <member name="F:log4net.Util.SystemStringFormat.declaringType">
  30307. <summary>
  30308. The fully qualified type of the SystemStringFormat class.
  30309. </summary>
  30310. <remarks>
  30311. Used by the internal logger to record the Type of the
  30312. log message.
  30313. </remarks>
  30314. </member>
  30315. <member name="T:log4net.Util.ThreadContextProperties">
  30316. <summary>
  30317. Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/>
  30318. </summary>
  30319. <remarks>
  30320. <para>
  30321. Class implements a collection of properties that is specific to each thread.
  30322. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  30323. </para>
  30324. </remarks>
  30325. <author>Nicko Cadell</author>
  30326. </member>
  30327. <member name="F:log4net.Util.ThreadContextProperties._dictionary">
  30328. <summary>
  30329. Each thread will automatically have its instance.
  30330. </summary>
  30331. </member>
  30332. <member name="M:log4net.Util.ThreadContextProperties.#ctor">
  30333. <summary>
  30334. Internal constructor
  30335. </summary>
  30336. <remarks>
  30337. <para>
  30338. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextProperties"/> class.
  30339. </para>
  30340. </remarks>
  30341. </member>
  30342. <member name="M:log4net.Util.ThreadContextProperties.Remove(System.String)">
  30343. <summary>
  30344. Remove a property
  30345. </summary>
  30346. <param name="key">the key for the entry to remove</param>
  30347. <remarks>
  30348. <para>
  30349. Remove a property
  30350. </para>
  30351. </remarks>
  30352. </member>
  30353. <member name="M:log4net.Util.ThreadContextProperties.GetKeys">
  30354. <summary>
  30355. Get the keys stored in the properties.
  30356. </summary>
  30357. <para>
  30358. Gets the keys stored in the properties.
  30359. </para>
  30360. <returns>a set of the defined keys</returns>
  30361. </member>
  30362. <member name="M:log4net.Util.ThreadContextProperties.Clear">
  30363. <summary>
  30364. Clear all properties
  30365. </summary>
  30366. <remarks>
  30367. <para>
  30368. Clear all properties
  30369. </para>
  30370. </remarks>
  30371. </member>
  30372. <member name="M:log4net.Util.ThreadContextProperties.GetProperties(System.Boolean)">
  30373. <summary>
  30374. Get the <c>PropertiesDictionary</c> for this thread.
  30375. </summary>
  30376. <param name="create">create the dictionary if it does not exist, otherwise return null if does not exist</param>
  30377. <returns>the properties for this thread</returns>
  30378. <remarks>
  30379. <para>
  30380. The collection returned is only to be used on the calling thread. If the
  30381. caller needs to share the collection between different threads then the
  30382. caller must clone the collection before doing so.
  30383. </para>
  30384. </remarks>
  30385. </member>
  30386. <member name="P:log4net.Util.ThreadContextProperties.Item(System.String)">
  30387. <summary>
  30388. Gets or sets the value of a property
  30389. </summary>
  30390. <value>
  30391. The value for the property with the specified key
  30392. </value>
  30393. <remarks>
  30394. <para>
  30395. Gets or sets the value of a property
  30396. </para>
  30397. </remarks>
  30398. </member>
  30399. <member name="T:log4net.Util.ThreadContextStack">
  30400. <summary>
  30401. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  30402. </summary>
  30403. <remarks>
  30404. <para>
  30405. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  30406. </para>
  30407. </remarks>
  30408. <author>Nicko Cadell</author>
  30409. </member>
  30410. <member name="F:log4net.Util.ThreadContextStack.m_stack">
  30411. <summary>
  30412. The stack store.
  30413. </summary>
  30414. </member>
  30415. <member name="M:log4net.Util.ThreadContextStack.#ctor">
  30416. <summary>
  30417. Internal constructor
  30418. </summary>
  30419. <remarks>
  30420. <para>
  30421. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack"/> class.
  30422. </para>
  30423. </remarks>
  30424. </member>
  30425. <member name="M:log4net.Util.ThreadContextStack.Clear">
  30426. <summary>
  30427. Clears all the contextual information held in this stack.
  30428. </summary>
  30429. <remarks>
  30430. <para>
  30431. Clears all the contextual information held in this stack.
  30432. Only call this if you think that this tread is being reused after
  30433. a previous call execution which may not have completed correctly.
  30434. You do not need to use this method if you always guarantee to call
  30435. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  30436. returned from <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  30437. for example by using the <c>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  30438. syntax.
  30439. </para>
  30440. </remarks>
  30441. </member>
  30442. <member name="M:log4net.Util.ThreadContextStack.Pop">
  30443. <summary>
  30444. Removes the top context from this stack.
  30445. </summary>
  30446. <returns>The message in the context that was removed from the top of this stack.</returns>
  30447. <remarks>
  30448. <para>
  30449. Remove the top context from this stack, and return
  30450. it to the caller. If this stack is empty then an
  30451. empty string (not <see langword="null"/>) is returned.
  30452. </para>
  30453. </remarks>
  30454. </member>
  30455. <member name="M:log4net.Util.ThreadContextStack.Push(System.String)">
  30456. <summary>
  30457. Pushes a new context message into this stack.
  30458. </summary>
  30459. <param name="message">The new context message.</param>
  30460. <returns>
  30461. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  30462. </returns>
  30463. <remarks>
  30464. <para>
  30465. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  30466. is returned that can be used to clean up this stack. This
  30467. can be easily combined with the <c>using</c> keyword to scope the
  30468. context.
  30469. </para>
  30470. </remarks>
  30471. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  30472. <code lang="C#">
  30473. using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
  30474. {
  30475. log.Warn("This should have an ThreadContext Stack message");
  30476. }
  30477. </code>
  30478. </example>
  30479. </member>
  30480. <member name="M:log4net.Util.ThreadContextStack.GetFullMessage">
  30481. <summary>
  30482. Gets the current context information for this stack.
  30483. </summary>
  30484. <returns>The current context information.</returns>
  30485. </member>
  30486. <member name="M:log4net.Util.ThreadContextStack.ToString">
  30487. <summary>
  30488. Gets the current context information for this stack.
  30489. </summary>
  30490. <returns>Gets the current context information</returns>
  30491. <remarks>
  30492. <para>
  30493. Gets the current context information for this stack.
  30494. </para>
  30495. </remarks>
  30496. </member>
  30497. <member name="M:log4net.Util.ThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  30498. <summary>
  30499. Get a portable version of this object
  30500. </summary>
  30501. <returns>the portable instance of this object</returns>
  30502. <remarks>
  30503. <para>
  30504. Get a cross thread portable version of this object
  30505. </para>
  30506. </remarks>
  30507. </member>
  30508. <member name="P:log4net.Util.ThreadContextStack.Count">
  30509. <summary>
  30510. The number of messages in the stack
  30511. </summary>
  30512. <value>
  30513. The current number of messages in the stack
  30514. </value>
  30515. <remarks>
  30516. <para>
  30517. The current number of messages in the stack. That is
  30518. the number of times <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> has been called
  30519. minus the number of times <see cref="M:log4net.Util.ThreadContextStack.Pop"/> has been called.
  30520. </para>
  30521. </remarks>
  30522. </member>
  30523. <member name="P:log4net.Util.ThreadContextStack.InternalStack">
  30524. <summary>
  30525. Gets and sets the internal stack used by this <see cref="T:log4net.Util.ThreadContextStack"/>
  30526. </summary>
  30527. <value>The internal storage stack</value>
  30528. <remarks>
  30529. <para>
  30530. This property is provided only to support backward compatability
  30531. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  30532. be modified.
  30533. </para>
  30534. </remarks>
  30535. </member>
  30536. <member name="T:log4net.Util.ThreadContextStack.StackFrame">
  30537. <summary>
  30538. Inner class used to represent a single context frame in the stack.
  30539. </summary>
  30540. <remarks>
  30541. <para>
  30542. Inner class used to represent a single context frame in the stack.
  30543. </para>
  30544. </remarks>
  30545. </member>
  30546. <member name="M:log4net.Util.ThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.ThreadContextStack.StackFrame)">
  30547. <summary>
  30548. Constructor
  30549. </summary>
  30550. <param name="message">The message for this context.</param>
  30551. <param name="parent">The parent context in the chain.</param>
  30552. <remarks>
  30553. <para>
  30554. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.StackFrame"/> class
  30555. with the specified message and parent context.
  30556. </para>
  30557. </remarks>
  30558. </member>
  30559. <member name="P:log4net.Util.ThreadContextStack.StackFrame.Message">
  30560. <summary>
  30561. Get the message.
  30562. </summary>
  30563. <value>The message.</value>
  30564. <remarks>
  30565. <para>
  30566. Get the message.
  30567. </para>
  30568. </remarks>
  30569. </member>
  30570. <member name="P:log4net.Util.ThreadContextStack.StackFrame.FullMessage">
  30571. <summary>
  30572. Gets the full text of the context down to the root level.
  30573. </summary>
  30574. <value>
  30575. The full text of the context down to the root level.
  30576. </value>
  30577. <remarks>
  30578. <para>
  30579. Gets the full text of the context down to the root level.
  30580. </para>
  30581. </remarks>
  30582. </member>
  30583. <member name="T:log4net.Util.ThreadContextStack.AutoPopStackFrame">
  30584. <summary>
  30585. Struct returned from the <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> method.
  30586. </summary>
  30587. <remarks>
  30588. <para>
  30589. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  30590. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  30591. </para>
  30592. </remarks>
  30593. </member>
  30594. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameStack">
  30595. <summary>
  30596. The ThreadContextStack internal stack
  30597. </summary>
  30598. </member>
  30599. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameDepth">
  30600. <summary>
  30601. The depth to trim the stack to when this instance is disposed
  30602. </summary>
  30603. </member>
  30604. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.#ctor(System.Collections.Stack,System.Int32)">
  30605. <summary>
  30606. Constructor
  30607. </summary>
  30608. <param name="frameStack">The internal stack used by the ThreadContextStack.</param>
  30609. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  30610. <remarks>
  30611. <para>
  30612. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.AutoPopStackFrame"/> class with
  30613. the specified stack and return depth.
  30614. </para>
  30615. </remarks>
  30616. </member>
  30617. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.Dispose">
  30618. <summary>
  30619. Returns the stack to the correct depth.
  30620. </summary>
  30621. <remarks>
  30622. <para>
  30623. Returns the stack to the correct depth.
  30624. </para>
  30625. </remarks>
  30626. </member>
  30627. <member name="T:log4net.Util.ThreadContextStacks">
  30628. <summary>
  30629. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  30630. </summary>
  30631. <remarks>
  30632. <para>
  30633. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  30634. </para>
  30635. </remarks>
  30636. <author>Nicko Cadell</author>
  30637. </member>
  30638. <member name="M:log4net.Util.ThreadContextStacks.#ctor(log4net.Util.ContextPropertiesBase)">
  30639. <summary>
  30640. Internal constructor
  30641. </summary>
  30642. <remarks>
  30643. <para>
  30644. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks"/> class.
  30645. </para>
  30646. </remarks>
  30647. </member>
  30648. <member name="F:log4net.Util.ThreadContextStacks.declaringType">
  30649. <summary>
  30650. The fully qualified type of the ThreadContextStacks class.
  30651. </summary>
  30652. <remarks>
  30653. Used by the internal logger to record the Type of the
  30654. log message.
  30655. </remarks>
  30656. </member>
  30657. <member name="P:log4net.Util.ThreadContextStacks.Item(System.String)">
  30658. <summary>
  30659. Gets the named thread context stack
  30660. </summary>
  30661. <value>
  30662. The named stack
  30663. </value>
  30664. <remarks>
  30665. <para>
  30666. Gets the named thread context stack
  30667. </para>
  30668. </remarks>
  30669. </member>
  30670. <member name="T:log4net.Util.Transform">
  30671. <summary>
  30672. Utility class for transforming strings.
  30673. </summary>
  30674. <remarks>
  30675. <para>
  30676. Utility class for transforming strings.
  30677. </para>
  30678. </remarks>
  30679. <author>Nicko Cadell</author>
  30680. <author>Gert Driesen</author>
  30681. </member>
  30682. <member name="M:log4net.Util.Transform.#ctor">
  30683. <summary>
  30684. Initializes a new instance of the <see cref="T:log4net.Util.Transform"/> class.
  30685. </summary>
  30686. <remarks>
  30687. <para>
  30688. Uses a private access modifier to prevent instantiation of this class.
  30689. </para>
  30690. </remarks>
  30691. </member>
  30692. <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)">
  30693. <summary>
  30694. Write a string to an <see cref="T:System.Xml.XmlWriter"/>
  30695. </summary>
  30696. <param name="writer">the writer to write to</param>
  30697. <param name="textData">the string to write</param>
  30698. <param name="invalidCharReplacement">The string to replace non XML compliant chars with</param>
  30699. <remarks>
  30700. <para>
  30701. The test is escaped either using XML escape entities
  30702. or using CDATA sections.
  30703. </para>
  30704. </remarks>
  30705. </member>
  30706. <member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)">
  30707. <summary>
  30708. Replace invalid XML characters in text string
  30709. </summary>
  30710. <param name="textData">the XML text input string</param>
  30711. <param name="mask">the string to use in place of invalid characters</param>
  30712. <returns>A string that does not contain invalid XML characters.</returns>
  30713. <remarks>
  30714. <para>
  30715. Certain Unicode code points are not allowed in the XML InfoSet, for
  30716. details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>.
  30717. </para>
  30718. <para>
  30719. This method replaces any illegal characters in the input string
  30720. with the mask string specified.
  30721. </para>
  30722. </remarks>
  30723. </member>
  30724. <member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)">
  30725. <summary>
  30726. Count the number of times that the substring occurs in the text
  30727. </summary>
  30728. <param name="text">the text to search</param>
  30729. <param name="substring">the substring to find</param>
  30730. <returns>the number of times the substring occurs in the text</returns>
  30731. <remarks>
  30732. <para>
  30733. The substring is assumed to be non repeating within itself.
  30734. </para>
  30735. </remarks>
  30736. </member>
  30737. <member name="F:log4net.Util.Transform.INVALIDCHARS">
  30738. <summary>
  30739. Characters illegal in XML 1.0
  30740. </summary>
  30741. </member>
  30742. <member name="T:log4net.Util.WindowsSecurityContext">
  30743. <summary>
  30744. Impersonate a Windows Account
  30745. </summary>
  30746. <remarks>
  30747. <para>
  30748. This <see cref="T:log4net.Core.SecurityContext"/> impersonates a Windows account.
  30749. </para>
  30750. <para>
  30751. How the impersonation is done depends on the value of <see cref="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)"/>.
  30752. This allows the context to either impersonate a set of user credentials specified
  30753. using username, domain name and password or to revert to the process credentials.
  30754. </para>
  30755. </remarks>
  30756. </member>
  30757. <member name="M:log4net.Util.WindowsSecurityContext.#ctor">
  30758. <summary>
  30759. Default constructor
  30760. </summary>
  30761. <remarks>
  30762. <para>
  30763. Default constructor
  30764. </para>
  30765. </remarks>
  30766. </member>
  30767. <member name="M:log4net.Util.WindowsSecurityContext.ActivateOptions">
  30768. <summary>
  30769. Initialize the SecurityContext based on the options set.
  30770. </summary>
  30771. <remarks>
  30772. <para>
  30773. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  30774. activation scheme. The <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> method must
  30775. be called on this object after the configuration properties have
  30776. been set. Until <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> is called this
  30777. object is in an undefined state and must not be used.
  30778. </para>
  30779. <para>
  30780. If any of the configuration properties are modified then
  30781. <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> must be called again.
  30782. </para>
  30783. <para>
  30784. The security context will try to Logon the specified user account and
  30785. capture a primary token for impersonation.
  30786. </para>
  30787. </remarks>
  30788. <exception cref="T:System.ArgumentNullException">The required <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>,
  30789. <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> or <see cref="P:log4net.Util.WindowsSecurityContext.Password"/> properties were not specified.</exception>
  30790. </member>
  30791. <member name="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)">
  30792. <summary>
  30793. Impersonate the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
  30794. </summary>
  30795. <param name="state">caller provided state</param>
  30796. <returns>
  30797. An <see cref="T:System.IDisposable"/> instance that will revoke the impersonation of this SecurityContext
  30798. </returns>
  30799. <remarks>
  30800. <para>
  30801. Depending on the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property either
  30802. impersonate a user using credentials supplied or revert
  30803. to the process credentials.
  30804. </para>
  30805. </remarks>
  30806. </member>
  30807. <member name="M:log4net.Util.WindowsSecurityContext.LogonUser(System.String,System.String,System.String)">
  30808. <summary>
  30809. Create a <see cref="T:System.Security.Principal.WindowsIdentity"/> given the userName, domainName and password.
  30810. </summary>
  30811. <param name="userName">the user name</param>
  30812. <param name="domainName">the domain name</param>
  30813. <param name="password">the password</param>
  30814. <returns>the <see cref="T:System.Security.Principal.WindowsIdentity"/> for the account specified</returns>
  30815. <remarks>
  30816. <para>
  30817. Uses the Windows API call LogonUser to get a principal token for the account. This
  30818. token is used to initialize the WindowsIdentity.
  30819. </para>
  30820. </remarks>
  30821. </member>
  30822. <member name="P:log4net.Util.WindowsSecurityContext.Credentials">
  30823. <summary>
  30824. Gets or sets the impersonation mode for this security context
  30825. </summary>
  30826. <value>
  30827. The impersonation mode for this security context
  30828. </value>
  30829. <remarks>
  30830. <para>
  30831. Impersonate either a user with user credentials or
  30832. revert this thread to the credentials of the process.
  30833. The value is one of the <see cref="T:log4net.Util.WindowsSecurityContext.ImpersonationMode"/>
  30834. enum.
  30835. </para>
  30836. <para>
  30837. The default value is <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
  30838. </para>
  30839. <para>
  30840. When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
  30841. the user's credentials are established using the
  30842. <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>, <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.Password"/>
  30843. values.
  30844. </para>
  30845. <para>
  30846. When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process"/>
  30847. no other properties need to be set. If the calling thread is
  30848. impersonating then it will be reverted back to the process credentials.
  30849. </para>
  30850. </remarks>
  30851. </member>
  30852. <member name="P:log4net.Util.WindowsSecurityContext.UserName">
  30853. <summary>
  30854. Gets or sets the Windows username for this security context
  30855. </summary>
  30856. <value>
  30857. The Windows username for this security context
  30858. </value>
  30859. <remarks>
  30860. <para>
  30861. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  30862. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  30863. </para>
  30864. </remarks>
  30865. </member>
  30866. <member name="P:log4net.Util.WindowsSecurityContext.DomainName">
  30867. <summary>
  30868. Gets or sets the Windows domain name for this security context
  30869. </summary>
  30870. <value>
  30871. The Windows domain name for this security context
  30872. </value>
  30873. <remarks>
  30874. <para>
  30875. The default value for <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> is the local machine name
  30876. taken from the <see cref="P:System.Environment.MachineName"/> property.
  30877. </para>
  30878. <para>
  30879. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  30880. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  30881. </para>
  30882. </remarks>
  30883. </member>
  30884. <member name="P:log4net.Util.WindowsSecurityContext.Password">
  30885. <summary>
  30886. Sets the password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
  30887. </summary>
  30888. <value>
  30889. The password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
  30890. </value>
  30891. <remarks>
  30892. <para>
  30893. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  30894. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  30895. </para>
  30896. </remarks>
  30897. </member>
  30898. <member name="T:log4net.Util.WindowsSecurityContext.ImpersonationMode">
  30899. <summary>
  30900. The impersonation modes for the <see cref="T:log4net.Util.WindowsSecurityContext"/>
  30901. </summary>
  30902. <remarks>
  30903. <para>
  30904. See the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property for
  30905. details.
  30906. </para>
  30907. </remarks>
  30908. </member>
  30909. <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User">
  30910. <summary>
  30911. Impersonate a user using the credentials supplied
  30912. </summary>
  30913. </member>
  30914. <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process">
  30915. <summary>
  30916. Revert this the thread to the credentials of the process
  30917. </summary>
  30918. </member>
  30919. <member name="T:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext">
  30920. <summary>
  30921. Adds <see cref="T:System.IDisposable"/> to <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
  30922. </summary>
  30923. <remarks>
  30924. <para>
  30925. Helper class to expose the <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
  30926. through the <see cref="T:System.IDisposable"/> interface.
  30927. </para>
  30928. </remarks>
  30929. </member>
  30930. <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.#ctor(System.Security.Principal.WindowsImpersonationContext)">
  30931. <summary>
  30932. Constructor
  30933. </summary>
  30934. <param name="impersonationContext">the impersonation context being wrapped</param>
  30935. <remarks>
  30936. <para>
  30937. Constructor
  30938. </para>
  30939. </remarks>
  30940. </member>
  30941. <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.Dispose">
  30942. <summary>
  30943. Revert the impersonation
  30944. </summary>
  30945. <remarks>
  30946. <para>
  30947. Revert the impersonation
  30948. </para>
  30949. </remarks>
  30950. </member>
  30951. <member name="T:log4net.GlobalContext">
  30952. <summary>
  30953. The log4net Global Context.
  30954. </summary>
  30955. <remarks>
  30956. <para>
  30957. The <c>GlobalContext</c> provides a location for global debugging
  30958. information to be stored.
  30959. </para>
  30960. <para>
  30961. The global context has a properties map and these properties can
  30962. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  30963. supports selecting and outputing these properties.
  30964. </para>
  30965. <para>
  30966. By default the <c>log4net:HostName</c> property is set to the name of
  30967. the current machine.
  30968. </para>
  30969. </remarks>
  30970. <example>
  30971. <code lang="C#">
  30972. GlobalContext.Properties["hostname"] = Environment.MachineName;
  30973. </code>
  30974. </example>
  30975. <threadsafety static="true" instance="true"/>
  30976. <author>Nicko Cadell</author>
  30977. </member>
  30978. <member name="M:log4net.GlobalContext.#ctor">
  30979. <summary>
  30980. Private Constructor.
  30981. </summary>
  30982. <remarks>
  30983. Uses a private access modifier to prevent instantiation of this class.
  30984. </remarks>
  30985. </member>
  30986. <member name="F:log4net.GlobalContext.s_properties">
  30987. <summary>
  30988. The global context properties instance
  30989. </summary>
  30990. </member>
  30991. <member name="P:log4net.GlobalContext.Properties">
  30992. <summary>
  30993. The global properties map.
  30994. </summary>
  30995. <value>
  30996. The global properties map.
  30997. </value>
  30998. <remarks>
  30999. <para>
  31000. The global properties map.
  31001. </para>
  31002. </remarks>
  31003. </member>
  31004. <member name="T:log4net.AssemblyInfo">
  31005. <summary>
  31006. Provides information about the environment the assembly has
  31007. been built for.
  31008. </summary>
  31009. </member>
  31010. <member name="F:log4net.AssemblyInfo.Version">
  31011. <summary>Version of the assembly</summary>
  31012. </member>
  31013. <member name="F:log4net.AssemblyInfo.TargetFrameworkVersion">
  31014. <summary>Version of the framework targeted</summary>
  31015. </member>
  31016. <member name="F:log4net.AssemblyInfo.TargetFramework">
  31017. <summary>Type of framework targeted</summary>
  31018. </member>
  31019. <member name="F:log4net.AssemblyInfo.ClientProfile">
  31020. <summary>Does it target a client profile?</summary>
  31021. </member>
  31022. <member name="P:log4net.AssemblyInfo.Info">
  31023. <summary>
  31024. Identifies the version and target for this assembly.
  31025. </summary>
  31026. </member>
  31027. <member name="T:log4net.LogicalThreadContext">
  31028. <summary>
  31029. The log4net Logical Thread Context.
  31030. </summary>
  31031. <remarks>
  31032. <para>
  31033. The <c>LogicalThreadContext</c> provides a location for <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> specific debugging
  31034. information to be stored.
  31035. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> or <see cref="T:log4net.GlobalContext"/>
  31036. properties with the same name.
  31037. </para>
  31038. <para>
  31039. For .NET Standard 1.3 this class uses
  31040. System.Threading.AsyncLocal rather than <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>.
  31041. </para>
  31042. <para>
  31043. The Logical Thread Context has a properties map and a stack.
  31044. The properties and stack can
  31045. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  31046. supports selecting and outputting these properties.
  31047. </para>
  31048. <para>
  31049. The Logical Thread Context provides a diagnostic context for the current call context.
  31050. This is an instrument for distinguishing interleaved log
  31051. output from different sources. Log output is typically interleaved
  31052. when a server handles multiple clients near-simultaneously.
  31053. </para>
  31054. <para>
  31055. The Logical Thread Context is managed on a per <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> basis.
  31056. </para>
  31057. <para>
  31058. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  31059. <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
  31060. <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  31061. If the calling code does not have this permission then this context will be disabled.
  31062. It will not store any property values set on it.
  31063. </para>
  31064. </remarks>
  31065. <example>Example of using the thread context properties to store a username.
  31066. <code lang="C#">
  31067. LogicalThreadContext.Properties["user"] = userName;
  31068. log.Info("This log message has a LogicalThreadContext Property called 'user'");
  31069. </code>
  31070. </example>
  31071. <example>Example of how to push a message into the context stack
  31072. <code lang="C#">
  31073. using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
  31074. {
  31075. log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
  31076. } // at the end of the using block the message is automatically popped
  31077. </code>
  31078. </example>
  31079. <threadsafety static="true" instance="true"/>
  31080. <author>Nicko Cadell</author>
  31081. </member>
  31082. <member name="M:log4net.LogicalThreadContext.#ctor">
  31083. <summary>
  31084. Private Constructor.
  31085. </summary>
  31086. <remarks>
  31087. <para>
  31088. Uses a private access modifier to prevent instantiation of this class.
  31089. </para>
  31090. </remarks>
  31091. </member>
  31092. <member name="F:log4net.LogicalThreadContext.s_properties">
  31093. <summary>
  31094. The thread context properties instance
  31095. </summary>
  31096. </member>
  31097. <member name="F:log4net.LogicalThreadContext.s_stacks">
  31098. <summary>
  31099. The thread context stacks instance
  31100. </summary>
  31101. </member>
  31102. <member name="P:log4net.LogicalThreadContext.Properties">
  31103. <summary>
  31104. The thread properties map
  31105. </summary>
  31106. <value>
  31107. The thread properties map
  31108. </value>
  31109. <remarks>
  31110. <para>
  31111. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/>
  31112. or <see cref="T:log4net.GlobalContext"/> properties with the same name.
  31113. </para>
  31114. </remarks>
  31115. </member>
  31116. <member name="P:log4net.LogicalThreadContext.Stacks">
  31117. <summary>
  31118. The thread stacks
  31119. </summary>
  31120. <value>
  31121. stack map
  31122. </value>
  31123. <remarks>
  31124. <para>
  31125. The logical thread stacks.
  31126. </para>
  31127. </remarks>
  31128. </member>
  31129. <member name="T:log4net.LogManager">
  31130. <summary>
  31131. This class is used by client applications to request logger instances.
  31132. </summary>
  31133. <remarks>
  31134. <para>
  31135. This class has static methods that are used by a client to request
  31136. a logger instance. The <see cref="M:GetLogger(string)"/> method is
  31137. used to retrieve a logger.
  31138. </para>
  31139. <para>
  31140. See the <see cref="T:log4net.ILog"/> interface for more details.
  31141. </para>
  31142. </remarks>
  31143. <example>Simple example of logging messages
  31144. <code lang="C#">
  31145. ILog log = LogManager.GetLogger("application-log");
  31146. log.Info("Application Start");
  31147. log.Debug("This is a debug message");
  31148. if (log.IsDebugEnabled)
  31149. {
  31150. log.Debug("This is another debug message");
  31151. }
  31152. </code>
  31153. </example>
  31154. <threadsafety static="true" instance="true"/>
  31155. <seealso cref="T:log4net.ILog"/>
  31156. <author>Nicko Cadell</author>
  31157. <author>Gert Driesen</author>
  31158. </member>
  31159. <member name="M:log4net.LogManager.#ctor">
  31160. <summary>
  31161. Initializes a new instance of the <see cref="T:log4net.LogManager"/> class.
  31162. </summary>
  31163. <remarks>
  31164. Uses a private access modifier to prevent instantiation of this class.
  31165. </remarks>
  31166. </member>
  31167. <member name="M:log4net.LogManager.Exists(System.String)">
  31168. <overloads>Returns the named logger if it exists.</overloads>
  31169. <summary>
  31170. Returns the named logger if it exists.
  31171. </summary>
  31172. <remarks>
  31173. <para>
  31174. If the named logger exists (in the default repository) then it
  31175. returns a reference to the logger, otherwise it returns <c>null</c>.
  31176. </para>
  31177. </remarks>
  31178. <param name="name">The fully qualified logger name to look for.</param>
  31179. <returns>The logger found, or <c>null</c> if no logger could be found.</returns>
  31180. </member>
  31181. <member name="M:log4net.LogManager.GetCurrentLoggers">
  31182. <overloads>Get the currently defined loggers.</overloads>
  31183. <summary>
  31184. Returns all the currently defined loggers in the default repository.
  31185. </summary>
  31186. <remarks>
  31187. <para>The root logger is <b>not</b> included in the returned array.</para>
  31188. </remarks>
  31189. <returns>All the defined loggers.</returns>
  31190. </member>
  31191. <member name="M:log4net.LogManager.GetLogger(System.String)">
  31192. <overloads>Get or create a logger.</overloads>
  31193. <summary>
  31194. Retrieves or creates a named logger.
  31195. </summary>
  31196. <remarks>
  31197. <para>
  31198. Retrieves a logger named as the <paramref name="name"/>
  31199. parameter. If the named logger already exists, then the
  31200. existing instance will be returned. Otherwise, a new instance is
  31201. created.
  31202. </para>
  31203. <para>By default, loggers do not have a set level but inherit
  31204. it from the hierarchy. This is one of the central features of
  31205. log4net.
  31206. </para>
  31207. </remarks>
  31208. <param name="name">The name of the logger to retrieve.</param>
  31209. <returns>The logger with the name specified.</returns>
  31210. </member>
  31211. <member name="M:log4net.LogManager.Exists(System.String,System.String)">
  31212. <summary>
  31213. Returns the named logger if it exists.
  31214. </summary>
  31215. <remarks>
  31216. <para>
  31217. If the named logger exists (in the specified repository) then it
  31218. returns a reference to the logger, otherwise it returns
  31219. <c>null</c>.
  31220. </para>
  31221. </remarks>
  31222. <param name="repository">The repository to lookup in.</param>
  31223. <param name="name">The fully qualified logger name to look for.</param>
  31224. <returns>
  31225. The logger found, or <c>null</c> if the logger doesn't exist in the specified
  31226. repository.
  31227. </returns>
  31228. </member>
  31229. <member name="M:log4net.LogManager.Exists(System.Reflection.Assembly,System.String)">
  31230. <summary>
  31231. Returns the named logger if it exists.
  31232. </summary>
  31233. <remarks>
  31234. <para>
  31235. If the named logger exists (in the repository for the specified assembly) then it
  31236. returns a reference to the logger, otherwise it returns
  31237. <c>null</c>.
  31238. </para>
  31239. </remarks>
  31240. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31241. <param name="name">The fully qualified logger name to look for.</param>
  31242. <returns>
  31243. The logger, or <c>null</c> if the logger doesn't exist in the specified
  31244. assembly's repository.
  31245. </returns>
  31246. </member>
  31247. <member name="M:log4net.LogManager.GetCurrentLoggers(System.String)">
  31248. <summary>
  31249. Returns all the currently defined loggers in the specified repository.
  31250. </summary>
  31251. <param name="repository">The repository to lookup in.</param>
  31252. <remarks>
  31253. The root logger is <b>not</b> included in the returned array.
  31254. </remarks>
  31255. <returns>All the defined loggers.</returns>
  31256. </member>
  31257. <member name="M:log4net.LogManager.GetCurrentLoggers(System.Reflection.Assembly)">
  31258. <summary>
  31259. Returns all the currently defined loggers in the specified assembly's repository.
  31260. </summary>
  31261. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31262. <remarks>
  31263. The root logger is <b>not</b> included in the returned array.
  31264. </remarks>
  31265. <returns>All the defined loggers.</returns>
  31266. </member>
  31267. <member name="M:log4net.LogManager.GetLogger(System.String,System.String)">
  31268. <summary>
  31269. Retrieves or creates a named logger.
  31270. </summary>
  31271. <remarks>
  31272. <para>
  31273. Retrieve a logger named as the <paramref name="name"/>
  31274. parameter. If the named logger already exists, then the
  31275. existing instance will be returned. Otherwise, a new instance is
  31276. created.
  31277. </para>
  31278. <para>
  31279. By default, loggers do not have a set level but inherit
  31280. it from the hierarchy. This is one of the central features of
  31281. log4net.
  31282. </para>
  31283. </remarks>
  31284. <param name="repository">The repository to lookup in.</param>
  31285. <param name="name">The name of the logger to retrieve.</param>
  31286. <returns>The logger with the name specified.</returns>
  31287. </member>
  31288. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.String)">
  31289. <summary>
  31290. Retrieves or creates a named logger.
  31291. </summary>
  31292. <remarks>
  31293. <para>
  31294. Retrieve a logger named as the <paramref name="name"/>
  31295. parameter. If the named logger already exists, then the
  31296. existing instance will be returned. Otherwise, a new instance is
  31297. created.
  31298. </para>
  31299. <para>
  31300. By default, loggers do not have a set level but inherit
  31301. it from the hierarchy. This is one of the central features of
  31302. log4net.
  31303. </para>
  31304. </remarks>
  31305. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31306. <param name="name">The name of the logger to retrieve.</param>
  31307. <returns>The logger with the name specified.</returns>
  31308. </member>
  31309. <member name="M:log4net.LogManager.GetLogger(System.Type)">
  31310. <summary>
  31311. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  31312. </summary>
  31313. <remarks>
  31314. Get the logger for the fully qualified name of the type specified.
  31315. </remarks>
  31316. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  31317. <returns>The logger with the name specified.</returns>
  31318. </member>
  31319. <member name="M:log4net.LogManager.GetLogger(System.String,System.Type)">
  31320. <summary>
  31321. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  31322. </summary>
  31323. <remarks>
  31324. Gets the logger for the fully qualified name of the type specified.
  31325. </remarks>
  31326. <param name="repository">The repository to lookup in.</param>
  31327. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  31328. <returns>The logger with the name specified.</returns>
  31329. </member>
  31330. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)">
  31331. <summary>
  31332. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  31333. </summary>
  31334. <remarks>
  31335. Gets the logger for the fully qualified name of the type specified.
  31336. </remarks>
  31337. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31338. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  31339. <returns>The logger with the name specified.</returns>
  31340. </member>
  31341. <member name="M:log4net.LogManager.Shutdown">
  31342. <summary>
  31343. Shuts down the log4net system.
  31344. </summary>
  31345. <remarks>
  31346. <para>
  31347. Calling this method will <b>safely</b> close and remove all
  31348. appenders in all the loggers including root contained in all the
  31349. default repositories.
  31350. </para>
  31351. <para>
  31352. Some appenders need to be closed before the application exists.
  31353. Otherwise, pending logging events might be lost.
  31354. </para>
  31355. <para>The <c>shutdown</c> method is careful to close nested
  31356. appenders before closing regular appenders. This is allows
  31357. configurations where a regular appender is attached to a logger
  31358. and again to a nested appender.
  31359. </para>
  31360. </remarks>
  31361. </member>
  31362. <member name="M:log4net.LogManager.ShutdownRepository">
  31363. <overloads>Shutdown a logger repository.</overloads>
  31364. <summary>
  31365. Shuts down the default repository.
  31366. </summary>
  31367. <remarks>
  31368. <para>
  31369. Calling this method will <b>safely</b> close and remove all
  31370. appenders in all the loggers including root contained in the
  31371. default repository.
  31372. </para>
  31373. <para>Some appenders need to be closed before the application exists.
  31374. Otherwise, pending logging events might be lost.
  31375. </para>
  31376. <para>The <c>shutdown</c> method is careful to close nested
  31377. appenders before closing regular appenders. This is allows
  31378. configurations where a regular appender is attached to a logger
  31379. and again to a nested appender.
  31380. </para>
  31381. </remarks>
  31382. </member>
  31383. <member name="M:log4net.LogManager.ShutdownRepository(System.String)">
  31384. <summary>
  31385. Shuts down the repository for the repository specified.
  31386. </summary>
  31387. <remarks>
  31388. <para>
  31389. Calling this method will <b>safely</b> close and remove all
  31390. appenders in all the loggers including root contained in the
  31391. <paramref name="repository"/> specified.
  31392. </para>
  31393. <para>
  31394. Some appenders need to be closed before the application exists.
  31395. Otherwise, pending logging events might be lost.
  31396. </para>
  31397. <para>The <c>shutdown</c> method is careful to close nested
  31398. appenders before closing regular appenders. This is allows
  31399. configurations where a regular appender is attached to a logger
  31400. and again to a nested appender.
  31401. </para>
  31402. </remarks>
  31403. <param name="repository">The repository to shutdown.</param>
  31404. </member>
  31405. <member name="M:log4net.LogManager.ShutdownRepository(System.Reflection.Assembly)">
  31406. <summary>
  31407. Shuts down the repository specified.
  31408. </summary>
  31409. <remarks>
  31410. <para>
  31411. Calling this method will <b>safely</b> close and remove all
  31412. appenders in all the loggers including root contained in the
  31413. repository. The repository is looked up using
  31414. the <paramref name="repositoryAssembly"/> specified.
  31415. </para>
  31416. <para>
  31417. Some appenders need to be closed before the application exists.
  31418. Otherwise, pending logging events might be lost.
  31419. </para>
  31420. <para>
  31421. The <c>shutdown</c> method is careful to close nested
  31422. appenders before closing regular appenders. This is allows
  31423. configurations where a regular appender is attached to a logger
  31424. and again to a nested appender.
  31425. </para>
  31426. </remarks>
  31427. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31428. </member>
  31429. <member name="M:log4net.LogManager.ResetConfiguration">
  31430. <overloads>Reset the configuration of a repository</overloads>
  31431. <summary>
  31432. Resets all values contained in this repository instance to their defaults.
  31433. </summary>
  31434. <remarks>
  31435. <para>
  31436. Resets all values contained in the repository instance to their
  31437. defaults. This removes all appenders from all loggers, sets
  31438. the level of all non-root loggers to <c>null</c>,
  31439. sets their additivity flag to <c>true</c> and sets the level
  31440. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  31441. message disabling is set to its default "off" value.
  31442. </para>
  31443. </remarks>
  31444. </member>
  31445. <member name="M:log4net.LogManager.ResetConfiguration(System.String)">
  31446. <summary>
  31447. Resets all values contained in this repository instance to their defaults.
  31448. </summary>
  31449. <remarks>
  31450. <para>
  31451. Reset all values contained in the repository instance to their
  31452. defaults. This removes all appenders from all loggers, sets
  31453. the level of all non-root loggers to <c>null</c>,
  31454. sets their additivity flag to <c>true</c> and sets the level
  31455. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  31456. message disabling is set to its default "off" value.
  31457. </para>
  31458. </remarks>
  31459. <param name="repository">The repository to reset.</param>
  31460. </member>
  31461. <member name="M:log4net.LogManager.ResetConfiguration(System.Reflection.Assembly)">
  31462. <summary>
  31463. Resets all values contained in this repository instance to their defaults.
  31464. </summary>
  31465. <remarks>
  31466. <para>
  31467. Reset all values contained in the repository instance to their
  31468. defaults. This removes all appenders from all loggers, sets
  31469. the level of all non-root loggers to <c>null</c>,
  31470. sets their additivity flag to <c>true</c> and sets the level
  31471. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  31472. message disabling is set to its default "off" value.
  31473. </para>
  31474. </remarks>
  31475. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  31476. </member>
  31477. <member name="M:log4net.LogManager.GetLoggerRepository">
  31478. <overloads>Get the logger repository.</overloads>
  31479. <summary>
  31480. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31481. </summary>
  31482. <remarks>
  31483. <para>
  31484. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31485. by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
  31486. </para>
  31487. </remarks>
  31488. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
  31489. </member>
  31490. <member name="M:log4net.LogManager.GetLoggerRepository(System.String)">
  31491. <summary>
  31492. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31493. </summary>
  31494. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  31495. <remarks>
  31496. <para>
  31497. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31498. by the <paramref name="repository"/> argument.
  31499. </para>
  31500. </remarks>
  31501. <param name="repository">The repository to lookup in.</param>
  31502. </member>
  31503. <member name="M:log4net.LogManager.GetLoggerRepository(System.Reflection.Assembly)">
  31504. <summary>
  31505. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31506. </summary>
  31507. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  31508. <remarks>
  31509. <para>
  31510. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31511. by the <paramref name="repositoryAssembly"/> argument.
  31512. </para>
  31513. </remarks>
  31514. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31515. </member>
  31516. <member name="M:log4net.LogManager.GetRepository">
  31517. <overloads>Get a logger repository.</overloads>
  31518. <summary>
  31519. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31520. </summary>
  31521. <remarks>
  31522. <para>
  31523. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31524. by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
  31525. </para>
  31526. </remarks>
  31527. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
  31528. </member>
  31529. <member name="M:log4net.LogManager.GetRepository(System.String)">
  31530. <summary>
  31531. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31532. </summary>
  31533. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  31534. <remarks>
  31535. <para>
  31536. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31537. by the <paramref name="repository"/> argument.
  31538. </para>
  31539. </remarks>
  31540. <param name="repository">The repository to lookup in.</param>
  31541. </member>
  31542. <member name="M:log4net.LogManager.GetRepository(System.Reflection.Assembly)">
  31543. <summary>
  31544. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  31545. </summary>
  31546. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  31547. <remarks>
  31548. <para>
  31549. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  31550. by the <paramref name="repositoryAssembly"/> argument.
  31551. </para>
  31552. </remarks>
  31553. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  31554. </member>
  31555. <member name="M:log4net.LogManager.CreateDomain(System.Type)">
  31556. <overloads>Create a domain</overloads>
  31557. <summary>
  31558. Creates a repository with the specified repository type.
  31559. </summary>
  31560. <remarks>
  31561. <para>
  31562. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  31563. </para>
  31564. <para>
  31565. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  31566. specified such that a call to <see cref="M:GetRepository()"/> will return
  31567. the same repository instance.
  31568. </para>
  31569. </remarks>
  31570. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31571. and has a no arg constructor. An instance of this type will be created to act
  31572. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31573. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31574. </member>
  31575. <member name="M:log4net.LogManager.CreateRepository(System.Type)">
  31576. <overloads>Create a logger repository.</overloads>
  31577. <summary>
  31578. Creates a repository with the specified repository type.
  31579. </summary>
  31580. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31581. and has a no arg constructor. An instance of this type will be created to act
  31582. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31583. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31584. <remarks>
  31585. <para>
  31586. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  31587. specified such that a call to <see cref="M:GetRepository()"/> will return
  31588. the same repository instance.
  31589. </para>
  31590. </remarks>
  31591. </member>
  31592. <member name="M:log4net.LogManager.CreateDomain(System.String)">
  31593. <summary>
  31594. Creates a repository with the specified name.
  31595. </summary>
  31596. <remarks>
  31597. <para>
  31598. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  31599. </para>
  31600. <para>
  31601. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  31602. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  31603. </para>
  31604. <para>
  31605. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  31606. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  31607. </para>
  31608. </remarks>
  31609. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  31610. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31611. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  31612. </member>
  31613. <member name="M:log4net.LogManager.CreateRepository(System.String)">
  31614. <summary>
  31615. Creates a repository with the specified name.
  31616. </summary>
  31617. <remarks>
  31618. <para>
  31619. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  31620. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  31621. </para>
  31622. <para>
  31623. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  31624. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  31625. </para>
  31626. </remarks>
  31627. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  31628. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31629. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  31630. </member>
  31631. <member name="M:log4net.LogManager.CreateDomain(System.String,System.Type)">
  31632. <summary>
  31633. Creates a repository with the specified name and repository type.
  31634. </summary>
  31635. <remarks>
  31636. <para>
  31637. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  31638. </para>
  31639. <para>
  31640. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  31641. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  31642. </para>
  31643. </remarks>
  31644. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  31645. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31646. and has a no arg constructor. An instance of this type will be created to act
  31647. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31648. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31649. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  31650. </member>
  31651. <member name="M:log4net.LogManager.CreateRepository(System.String,System.Type)">
  31652. <summary>
  31653. Creates a repository with the specified name and repository type.
  31654. </summary>
  31655. <remarks>
  31656. <para>
  31657. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  31658. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  31659. </para>
  31660. </remarks>
  31661. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  31662. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31663. and has a no arg constructor. An instance of this type will be created to act
  31664. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31665. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31666. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  31667. </member>
  31668. <member name="M:log4net.LogManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  31669. <summary>
  31670. Creates a repository for the specified assembly and repository type.
  31671. </summary>
  31672. <remarks>
  31673. <para>
  31674. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  31675. </para>
  31676. <para>
  31677. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  31678. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  31679. same assembly specified will return the same repository instance.
  31680. </para>
  31681. </remarks>
  31682. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  31683. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31684. and has a no arg constructor. An instance of this type will be created to act
  31685. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31686. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31687. </member>
  31688. <member name="M:log4net.LogManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  31689. <summary>
  31690. Creates a repository for the specified assembly and repository type.
  31691. </summary>
  31692. <remarks>
  31693. <para>
  31694. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  31695. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  31696. same assembly specified will return the same repository instance.
  31697. </para>
  31698. </remarks>
  31699. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  31700. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  31701. and has a no arg constructor. An instance of this type will be created to act
  31702. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  31703. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  31704. </member>
  31705. <member name="M:log4net.LogManager.GetAllRepositories">
  31706. <summary>
  31707. Gets the list of currently defined repositories.
  31708. </summary>
  31709. <remarks>
  31710. <para>
  31711. Get an array of all the <see cref="T:log4net.Repository.ILoggerRepository"/> objects that have been created.
  31712. </para>
  31713. </remarks>
  31714. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  31715. </member>
  31716. <member name="M:log4net.LogManager.Flush(System.Int32)">
  31717. <summary>
  31718. Flushes logging events buffered in all configured appenders in the default repository.
  31719. </summary>
  31720. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed.</param>
  31721. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  31722. </member>
  31723. <member name="M:log4net.LogManager.WrapLogger(log4net.Core.ILogger)">
  31724. <summary>
  31725. Looks up the wrapper object for the logger specified.
  31726. </summary>
  31727. <param name="logger">The logger to get the wrapper for.</param>
  31728. <returns>The wrapper for the logger specified.</returns>
  31729. </member>
  31730. <member name="M:log4net.LogManager.WrapLoggers(log4net.Core.ILogger[])">
  31731. <summary>
  31732. Looks up the wrapper objects for the loggers specified.
  31733. </summary>
  31734. <param name="loggers">The loggers to get the wrappers for.</param>
  31735. <returns>The wrapper objects for the loggers specified.</returns>
  31736. </member>
  31737. <member name="M:log4net.LogManager.WrapperCreationHandler(log4net.Core.ILogger)">
  31738. <summary>
  31739. Create the <see cref="T:log4net.Core.ILoggerWrapper"/> objects used by
  31740. this manager.
  31741. </summary>
  31742. <param name="logger">The logger to wrap.</param>
  31743. <returns>The wrapper for the logger specified.</returns>
  31744. </member>
  31745. <member name="F:log4net.LogManager.s_wrapperMap">
  31746. <summary>
  31747. The wrapper map to use to hold the <see cref="T:log4net.Core.LogImpl"/> objects.
  31748. </summary>
  31749. </member>
  31750. <member name="T:log4net.MDC">
  31751. <summary>
  31752. Implementation of Mapped Diagnostic Contexts.
  31753. </summary>
  31754. <remarks>
  31755. <note>
  31756. <para>
  31757. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  31758. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  31759. </para>
  31760. </note>
  31761. <para>
  31762. The MDC class is similar to the <see cref="T:log4net.NDC"/> class except that it is
  31763. based on a map instead of a stack. It provides <i>mapped
  31764. diagnostic contexts</i>. A <i>Mapped Diagnostic Context</i>, or
  31765. MDC in short, is an instrument for distinguishing interleaved log
  31766. output from different sources. Log output is typically interleaved
  31767. when a server handles multiple clients near-simultaneously.
  31768. </para>
  31769. <para>
  31770. The MDC is managed on a per thread basis.
  31771. </para>
  31772. </remarks>
  31773. <threadsafety static="true" instance="true"/>
  31774. <author>Nicko Cadell</author>
  31775. <author>Gert Driesen</author>
  31776. </member>
  31777. <member name="M:log4net.MDC.#ctor">
  31778. <summary>
  31779. Initializes a new instance of the <see cref="T:log4net.MDC"/> class.
  31780. </summary>
  31781. <remarks>
  31782. Uses a private access modifier to prevent instantiation of this class.
  31783. </remarks>
  31784. </member>
  31785. <member name="M:log4net.MDC.Get(System.String)">
  31786. <summary>
  31787. Gets the context value identified by the <paramref name="key"/> parameter.
  31788. </summary>
  31789. <param name="key">The key to lookup in the MDC.</param>
  31790. <returns>The string value held for the key, or a <c>null</c> reference if no corresponding value is found.</returns>
  31791. <remarks>
  31792. <note>
  31793. <para>
  31794. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  31795. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  31796. </para>
  31797. </note>
  31798. <para>
  31799. If the <paramref name="key"/> parameter does not look up to a
  31800. previously defined context then <c>null</c> will be returned.
  31801. </para>
  31802. </remarks>
  31803. </member>
  31804. <member name="M:log4net.MDC.Set(System.String,System.String)">
  31805. <summary>
  31806. Add an entry to the MDC
  31807. </summary>
  31808. <param name="key">The key to store the value under.</param>
  31809. <param name="value">The value to store.</param>
  31810. <remarks>
  31811. <note>
  31812. <para>
  31813. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  31814. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  31815. </para>
  31816. </note>
  31817. <para>
  31818. Puts a context value (the <paramref name="value"/> parameter) as identified
  31819. with the <paramref name="key"/> parameter into the current thread's
  31820. context map.
  31821. </para>
  31822. <para>
  31823. If a value is already defined for the <paramref name="key"/>
  31824. specified then the value will be replaced. If the <paramref name="value"/>
  31825. is specified as <c>null</c> then the key value mapping will be removed.
  31826. </para>
  31827. </remarks>
  31828. </member>
  31829. <member name="M:log4net.MDC.Remove(System.String)">
  31830. <summary>
  31831. Removes the key value mapping for the key specified.
  31832. </summary>
  31833. <param name="key">The key to remove.</param>
  31834. <remarks>
  31835. <note>
  31836. <para>
  31837. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  31838. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  31839. </para>
  31840. </note>
  31841. <para>
  31842. Remove the specified entry from this thread's MDC
  31843. </para>
  31844. </remarks>
  31845. </member>
  31846. <member name="M:log4net.MDC.Clear">
  31847. <summary>
  31848. Clear all entries in the MDC
  31849. </summary>
  31850. <remarks>
  31851. <note>
  31852. <para>
  31853. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  31854. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  31855. </para>
  31856. </note>
  31857. <para>
  31858. Remove all the entries from this thread's MDC
  31859. </para>
  31860. </remarks>
  31861. </member>
  31862. <member name="T:log4net.NDC">
  31863. <summary>
  31864. Implementation of Nested Diagnostic Contexts.
  31865. </summary>
  31866. <remarks>
  31867. <note>
  31868. <para>
  31869. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  31870. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  31871. </para>
  31872. </note>
  31873. <para>
  31874. A Nested Diagnostic Context, or NDC in short, is an instrument
  31875. to distinguish interleaved log output from different sources. Log
  31876. output is typically interleaved when a server handles multiple
  31877. clients near-simultaneously.
  31878. </para>
  31879. <para>
  31880. Interleaved log output can still be meaningful if each log entry
  31881. from different contexts had a distinctive stamp. This is where NDCs
  31882. come into play.
  31883. </para>
  31884. <para>
  31885. Note that NDCs are managed on a per thread basis. The NDC class
  31886. is made up of static methods that operate on the context of the
  31887. calling thread.
  31888. </para>
  31889. </remarks>
  31890. <example>How to push a message into the context
  31891. <code lang="C#">
  31892. using(NDC.Push("my context message"))
  31893. {
  31894. ... all log calls will have 'my context message' included ...
  31895. } // at the end of the using block the message is automatically removed
  31896. </code>
  31897. </example>
  31898. <threadsafety static="true" instance="true"/>
  31899. <author>Nicko Cadell</author>
  31900. <author>Gert Driesen</author>
  31901. </member>
  31902. <member name="M:log4net.NDC.#ctor">
  31903. <summary>
  31904. Initializes a new instance of the <see cref="T:log4net.NDC"/> class.
  31905. </summary>
  31906. <remarks>
  31907. Uses a private access modifier to prevent instantiation of this class.
  31908. </remarks>
  31909. </member>
  31910. <member name="M:log4net.NDC.Clear">
  31911. <summary>
  31912. Clears all the contextual information held on the current thread.
  31913. </summary>
  31914. <remarks>
  31915. <note>
  31916. <para>
  31917. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  31918. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  31919. </para>
  31920. </note>
  31921. <para>
  31922. Clears the stack of NDC data held on the current thread.
  31923. </para>
  31924. </remarks>
  31925. </member>
  31926. <member name="M:log4net.NDC.CloneStack">
  31927. <summary>
  31928. Creates a clone of the stack of context information.
  31929. </summary>
  31930. <returns>A clone of the context info for this thread.</returns>
  31931. <remarks>
  31932. <note>
  31933. <para>
  31934. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  31935. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  31936. </para>
  31937. </note>
  31938. <para>
  31939. The results of this method can be passed to the <see cref="M:log4net.NDC.Inherit(System.Collections.Stack)"/>
  31940. method to allow child threads to inherit the context of their
  31941. parent thread.
  31942. </para>
  31943. </remarks>
  31944. </member>
  31945. <member name="M:log4net.NDC.Inherit(System.Collections.Stack)">
  31946. <summary>
  31947. Inherits the contextual information from another thread.
  31948. </summary>
  31949. <param name="stack">The context stack to inherit.</param>
  31950. <remarks>
  31951. <note>
  31952. <para>
  31953. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  31954. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  31955. </para>
  31956. </note>
  31957. <para>
  31958. This thread will use the context information from the stack
  31959. supplied. This can be used to initialize child threads with
  31960. the same contextual information as their parent threads. These
  31961. contexts will <b>NOT</b> be shared. Any further contexts that
  31962. are pushed onto the stack will not be visible to the other.
  31963. Call <see cref="M:log4net.NDC.CloneStack"/> to obtain a stack to pass to
  31964. this method.
  31965. </para>
  31966. </remarks>
  31967. </member>
  31968. <member name="M:log4net.NDC.Pop">
  31969. <summary>
  31970. Removes the top context from the stack.
  31971. </summary>
  31972. <returns>
  31973. The message in the context that was removed from the top
  31974. of the stack.
  31975. </returns>
  31976. <remarks>
  31977. <note>
  31978. <para>
  31979. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  31980. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  31981. </para>
  31982. </note>
  31983. <para>
  31984. Remove the top context from the stack, and return
  31985. it to the caller. If the stack is empty then an
  31986. empty string (not <c>null</c>) is returned.
  31987. </para>
  31988. </remarks>
  31989. </member>
  31990. <member name="M:log4net.NDC.Push(System.String)">
  31991. <summary>
  31992. Pushes a new context message.
  31993. </summary>
  31994. <param name="message">The new context message.</param>
  31995. <returns>
  31996. An <see cref="T:System.IDisposable"/> that can be used to clean up
  31997. the context stack.
  31998. </returns>
  31999. <remarks>
  32000. <note>
  32001. <para>
  32002. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32003. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32004. </para>
  32005. </note>
  32006. <para>
  32007. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  32008. is returned that can be used to clean up the context stack. This
  32009. can be easily combined with the <c>using</c> keyword to scope the
  32010. context.
  32011. </para>
  32012. </remarks>
  32013. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  32014. <code lang="C#">
  32015. using(log4net.NDC.Push("NDC_Message"))
  32016. {
  32017. log.Warn("This should have an NDC message");
  32018. }
  32019. </code>
  32020. </example>
  32021. </member>
  32022. <member name="M:log4net.NDC.PushFormat(System.String,System.Object[])">
  32023. <summary>
  32024. Pushes a new context message.
  32025. </summary>
  32026. <param name="messageFormat">The new context message string format.</param>
  32027. <param name="args">Arguments to be passed into messageFormat.</param>
  32028. <returns>
  32029. An <see cref="T:System.IDisposable"/> that can be used to clean up
  32030. the context stack.
  32031. </returns>
  32032. <remarks>
  32033. <note>
  32034. <para>
  32035. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32036. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32037. </para>
  32038. </note>
  32039. <para>
  32040. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  32041. is returned that can be used to clean up the context stack. This
  32042. can be easily combined with the <c>using</c> keyword to scope the
  32043. context.
  32044. </para>
  32045. </remarks>
  32046. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  32047. <code lang="C#">
  32048. var someValue = "ExampleContext"
  32049. using(log4net.NDC.PushFormat("NDC_Message {0}", someValue))
  32050. {
  32051. log.Warn("This should have an NDC message");
  32052. }
  32053. </code>
  32054. </example>
  32055. </member>
  32056. <member name="M:log4net.NDC.Remove">
  32057. <summary>
  32058. Removes the context information for this thread. It is
  32059. not required to call this method.
  32060. </summary>
  32061. <remarks>
  32062. <note>
  32063. <para>
  32064. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32065. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32066. </para>
  32067. </note>
  32068. <para>
  32069. This method is not implemented.
  32070. </para>
  32071. </remarks>
  32072. </member>
  32073. <member name="M:log4net.NDC.SetMaxDepth(System.Int32)">
  32074. <summary>
  32075. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  32076. </summary>
  32077. <param name="maxDepth">The maximum depth of the stack</param>
  32078. <remarks>
  32079. <note>
  32080. <para>
  32081. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32082. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32083. </para>
  32084. </note>
  32085. <para>
  32086. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  32087. This may truncate the head of the stack. This only affects the
  32088. stack in the current thread. Also it does not prevent it from
  32089. growing, it only sets the maximum depth at the time of the
  32090. call. This can be used to return to a known context depth.
  32091. </para>
  32092. </remarks>
  32093. </member>
  32094. <member name="P:log4net.NDC.Depth">
  32095. <summary>
  32096. Gets the current context depth.
  32097. </summary>
  32098. <value>The current context depth.</value>
  32099. <remarks>
  32100. <note>
  32101. <para>
  32102. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  32103. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  32104. </para>
  32105. </note>
  32106. <para>
  32107. The number of context values pushed onto the context stack.
  32108. </para>
  32109. <para>
  32110. Used to record the current depth of the context. This can then
  32111. be restored using the <see cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> method.
  32112. </para>
  32113. </remarks>
  32114. <seealso cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/>
  32115. </member>
  32116. <member name="T:log4net.ThreadContext">
  32117. <summary>
  32118. The log4net Thread Context.
  32119. </summary>
  32120. <remarks>
  32121. <para>
  32122. The <c>ThreadContext</c> provides a location for thread specific debugging
  32123. information to be stored.
  32124. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  32125. properties with the same name.
  32126. </para>
  32127. <para>
  32128. The thread context has a properties map and a stack.
  32129. The properties and stack can
  32130. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  32131. supports selecting and outputting these properties.
  32132. </para>
  32133. <para>
  32134. The Thread Context provides a diagnostic context for the current thread.
  32135. This is an instrument for distinguishing interleaved log
  32136. output from different sources. Log output is typically interleaved
  32137. when a server handles multiple clients near-simultaneously.
  32138. </para>
  32139. <para>
  32140. The Thread Context is managed on a per thread basis.
  32141. </para>
  32142. </remarks>
  32143. <example>Example of using the thread context properties to store a username.
  32144. <code lang="C#">
  32145. ThreadContext.Properties["user"] = userName;
  32146. log.Info("This log message has a ThreadContext Property called 'user'");
  32147. </code>
  32148. </example>
  32149. <example>Example of how to push a message into the context stack
  32150. <code lang="C#">
  32151. using(ThreadContext.Stacks["NDC"].Push("my context message"))
  32152. {
  32153. log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
  32154. } // at the end of the using block the message is automatically popped
  32155. </code>
  32156. </example>
  32157. <threadsafety static="true" instance="true"/>
  32158. <author>Nicko Cadell</author>
  32159. </member>
  32160. <member name="M:log4net.ThreadContext.#ctor">
  32161. <summary>
  32162. Private Constructor.
  32163. </summary>
  32164. <remarks>
  32165. <para>
  32166. Uses a private access modifier to prevent instantiation of this class.
  32167. </para>
  32168. </remarks>
  32169. </member>
  32170. <member name="F:log4net.ThreadContext.s_properties">
  32171. <summary>
  32172. The thread context properties instance
  32173. </summary>
  32174. </member>
  32175. <member name="F:log4net.ThreadContext.s_stacks">
  32176. <summary>
  32177. The thread context stacks instance
  32178. </summary>
  32179. </member>
  32180. <member name="P:log4net.ThreadContext.Properties">
  32181. <summary>
  32182. The thread properties map
  32183. </summary>
  32184. <value>
  32185. The thread properties map
  32186. </value>
  32187. <remarks>
  32188. <para>
  32189. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  32190. properties with the same name.
  32191. </para>
  32192. </remarks>
  32193. </member>
  32194. <member name="P:log4net.ThreadContext.Stacks">
  32195. <summary>
  32196. The thread stacks
  32197. </summary>
  32198. <value>
  32199. stack map
  32200. </value>
  32201. <remarks>
  32202. <para>
  32203. The thread local stacks.
  32204. </para>
  32205. </remarks>
  32206. </member>
  32207. </members>
  32208. </doc>