log4net.xml 1.4 MB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058250592506025061250622506325064250652506625067250682506925070250712507225073250742507525076250772507825079250802508125082250832508425085250862508725088250892509025091250922509325094250952509625097250982509925100251012510225103251042510525106251072510825109251102511125112251132511425115251162511725118251192512025121251222512325124251252512625127251282512925130251312513225133251342513525136251372513825139251402514125142251432514425145251462514725148251492515025151251522515325154251552515625157251582515925160251612516225163251642516525166251672516825169251702517125172251732517425175251762517725178251792518025181251822518325184251852518625187251882518925190251912519225193251942519525196251972519825199252002520125202252032520425205252062520725208252092521025211252122521325214252152521625217252182521925220252212522225223252242522525226252272522825229252302523125232252332523425235252362523725238252392524025241252422524325244252452524625247252482524925250252512525225253252542525525256252572525825259252602526125262252632526425265252662526725268252692527025271252722527325274252752527625277252782527925280252812528225283252842528525286252872528825289252902529125292252932529425295252962529725298252992530025301253022530325304253052530625307253082530925310253112531225313253142531525316253172531825319253202532125322253232532425325253262532725328253292533025331253322533325334253352533625337253382533925340253412534225343253442534525346253472534825349253502535125352253532535425355253562535725358253592536025361253622536325364253652536625367253682536925370253712537225373253742537525376253772537825379253802538125382253832538425385253862538725388253892539025391253922539325394253952539625397253982539925400254012540225403254042540525406254072540825409254102541125412254132541425415254162541725418254192542025421254222542325424254252542625427254282542925430254312543225433254342543525436254372543825439254402544125442254432544425445254462544725448254492545025451254522545325454254552545625457254582545925460254612546225463254642546525466254672546825469254702547125472254732547425475254762547725478254792548025481254822548325484254852548625487254882548925490254912549225493254942549525496254972549825499255002550125502255032550425505255062550725508255092551025511255122551325514255152551625517255182551925520255212552225523255242552525526255272552825529255302553125532255332553425535255362553725538255392554025541255422554325544255452554625547255482554925550255512555225553255542555525556255572555825559255602556125562255632556425565255662556725568255692557025571255722557325574255752557625577255782557925580255812558225583255842558525586255872558825589255902559125592255932559425595255962559725598255992560025601256022560325604256052560625607256082560925610256112561225613256142561525616256172561825619256202562125622256232562425625256262562725628256292563025631256322563325634256352563625637256382563925640256412564225643256442564525646256472564825649256502565125652256532565425655256562565725658256592566025661256622566325664256652566625667256682566925670256712567225673256742567525676256772567825679256802568125682256832568425685256862568725688256892569025691256922569325694256952569625697256982569925700257012570225703257042570525706257072570825709257102571125712257132571425715257162571725718257192572025721257222572325724257252572625727257282572925730257312573225733257342573525736257372573825739257402574125742257432574425745257462574725748257492575025751257522575325754257552575625757257582575925760257612576225763257642576525766257672576825769257702577125772257732577425775257762577725778257792578025781257822578325784257852578625787257882578925790257912579225793257942579525796257972579825799258002580125802258032580425805258062580725808258092581025811258122581325814258152581625817258182581925820258212582225823258242582525826258272582825829258302583125832258332583425835258362583725838258392584025841258422584325844258452584625847258482584925850258512585225853258542585525856258572585825859258602586125862258632586425865258662586725868258692587025871258722587325874258752587625877258782587925880258812588225883258842588525886258872588825889258902589125892258932589425895258962589725898258992590025901259022590325904259052590625907259082590925910259112591225913259142591525916259172591825919259202592125922259232592425925259262592725928259292593025931259322593325934259352593625937259382593925940259412594225943259442594525946259472594825949259502595125952259532595425955259562595725958259592596025961259622596325964259652596625967259682596925970259712597225973259742597525976259772597825979259802598125982259832598425985259862598725988259892599025991259922599325994259952599625997259982599926000260012600226003260042600526006260072600826009260102601126012260132601426015260162601726018260192602026021260222602326024260252602626027260282602926030260312603226033260342603526036260372603826039260402604126042260432604426045260462604726048260492605026051260522605326054260552605626057260582605926060260612606226063260642606526066260672606826069260702607126072260732607426075260762607726078260792608026081260822608326084260852608626087260882608926090260912609226093260942609526096260972609826099261002610126102261032610426105261062610726108261092611026111261122611326114261152611626117261182611926120261212612226123261242612526126261272612826129261302613126132261332613426135261362613726138261392614026141261422614326144261452614626147261482614926150261512615226153261542615526156261572615826159261602616126162261632616426165261662616726168261692617026171261722617326174261752617626177261782617926180261812618226183261842618526186261872618826189261902619126192261932619426195261962619726198261992620026201262022620326204262052620626207262082620926210262112621226213262142621526216262172621826219262202622126222262232622426225262262622726228262292623026231262322623326234262352623626237262382623926240262412624226243262442624526246262472624826249262502625126252262532625426255262562625726258262592626026261262622626326264262652626626267262682626926270262712627226273262742627526276262772627826279262802628126282262832628426285262862628726288262892629026291262922629326294262952629626297262982629926300263012630226303263042630526306263072630826309263102631126312263132631426315263162631726318263192632026321263222632326324263252632626327263282632926330263312633226333263342633526336263372633826339263402634126342263432634426345263462634726348263492635026351263522635326354263552635626357263582635926360263612636226363263642636526366263672636826369263702637126372263732637426375263762637726378263792638026381263822638326384263852638626387263882638926390263912639226393263942639526396263972639826399264002640126402264032640426405264062640726408264092641026411264122641326414264152641626417264182641926420264212642226423264242642526426264272642826429264302643126432264332643426435264362643726438264392644026441264422644326444264452644626447264482644926450264512645226453264542645526456264572645826459264602646126462264632646426465264662646726468264692647026471264722647326474264752647626477264782647926480264812648226483264842648526486264872648826489264902649126492264932649426495264962649726498264992650026501265022650326504265052650626507265082650926510265112651226513265142651526516265172651826519265202652126522265232652426525265262652726528265292653026531265322653326534265352653626537265382653926540265412654226543265442654526546265472654826549265502655126552265532655426555265562655726558265592656026561265622656326564265652656626567265682656926570265712657226573265742657526576265772657826579265802658126582265832658426585265862658726588265892659026591265922659326594265952659626597265982659926600266012660226603266042660526606266072660826609266102661126612266132661426615266162661726618266192662026621266222662326624266252662626627266282662926630266312663226633266342663526636266372663826639266402664126642266432664426645266462664726648266492665026651266522665326654266552665626657266582665926660266612666226663266642666526666266672666826669266702667126672266732667426675266762667726678266792668026681266822668326684266852668626687266882668926690266912669226693266942669526696266972669826699267002670126702267032670426705267062670726708267092671026711267122671326714267152671626717267182671926720267212672226723267242672526726267272672826729267302673126732267332673426735267362673726738267392674026741267422674326744267452674626747267482674926750267512675226753267542675526756267572675826759267602676126762267632676426765267662676726768267692677026771267722677326774267752677626777267782677926780267812678226783267842678526786267872678826789267902679126792267932679426795267962679726798267992680026801268022680326804268052680626807268082680926810268112681226813268142681526816268172681826819268202682126822268232682426825268262682726828268292683026831268322683326834268352683626837268382683926840268412684226843268442684526846268472684826849268502685126852268532685426855268562685726858268592686026861268622686326864268652686626867268682686926870268712687226873268742687526876268772687826879268802688126882268832688426885268862688726888268892689026891268922689326894268952689626897268982689926900269012690226903269042690526906269072690826909269102691126912269132691426915269162691726918269192692026921269222692326924269252692626927269282692926930269312693226933269342693526936269372693826939269402694126942269432694426945269462694726948269492695026951269522695326954269552695626957269582695926960269612696226963269642696526966269672696826969269702697126972269732697426975269762697726978269792698026981269822698326984269852698626987269882698926990269912699226993269942699526996269972699826999270002700127002270032700427005270062700727008270092701027011270122701327014270152701627017270182701927020270212702227023270242702527026270272702827029270302703127032270332703427035270362703727038270392704027041270422704327044270452704627047270482704927050270512705227053270542705527056270572705827059270602706127062270632706427065270662706727068270692707027071270722707327074270752707627077270782707927080270812708227083270842708527086270872708827089270902709127092270932709427095270962709727098270992710027101271022710327104271052710627107271082710927110271112711227113271142711527116271172711827119271202712127122271232712427125271262712727128271292713027131271322713327134271352713627137271382713927140271412714227143271442714527146271472714827149271502715127152271532715427155271562715727158271592716027161271622716327164271652716627167271682716927170271712717227173271742717527176271772717827179271802718127182271832718427185271862718727188271892719027191271922719327194271952719627197271982719927200272012720227203272042720527206272072720827209272102721127212272132721427215272162721727218272192722027221272222722327224272252722627227272282722927230272312723227233272342723527236272372723827239272402724127242272432724427245272462724727248272492725027251272522725327254272552725627257272582725927260272612726227263272642726527266272672726827269272702727127272272732727427275272762727727278272792728027281272822728327284272852728627287272882728927290272912729227293272942729527296272972729827299273002730127302273032730427305273062730727308273092731027311273122731327314273152731627317273182731927320273212732227323273242732527326273272732827329273302733127332273332733427335273362733727338273392734027341273422734327344273452734627347273482734927350273512735227353273542735527356273572735827359273602736127362273632736427365273662736727368273692737027371273722737327374273752737627377273782737927380273812738227383273842738527386273872738827389273902739127392273932739427395273962739727398273992740027401274022740327404274052740627407274082740927410274112741227413274142741527416274172741827419274202742127422274232742427425274262742727428274292743027431274322743327434274352743627437274382743927440274412744227443274442744527446274472744827449274502745127452274532745427455274562745727458274592746027461274622746327464274652746627467274682746927470274712747227473274742747527476274772747827479274802748127482274832748427485274862748727488274892749027491274922749327494274952749627497274982749927500275012750227503275042750527506275072750827509275102751127512275132751427515275162751727518275192752027521275222752327524275252752627527275282752927530275312753227533275342753527536275372753827539275402754127542275432754427545275462754727548275492755027551275522755327554275552755627557275582755927560275612756227563275642756527566275672756827569275702757127572275732757427575275762757727578275792758027581275822758327584275852758627587275882758927590275912759227593275942759527596275972759827599276002760127602276032760427605276062760727608276092761027611276122761327614276152761627617276182761927620276212762227623276242762527626276272762827629276302763127632276332763427635276362763727638276392764027641276422764327644276452764627647276482764927650276512765227653276542765527656276572765827659276602766127662276632766427665276662766727668276692767027671276722767327674276752767627677276782767927680276812768227683276842768527686276872768827689276902769127692276932769427695276962769727698276992770027701277022770327704277052770627707277082770927710277112771227713277142771527716277172771827719277202772127722277232772427725277262772727728277292773027731277322773327734277352773627737277382773927740277412774227743277442774527746277472774827749277502775127752277532775427755277562775727758277592776027761277622776327764277652776627767277682776927770277712777227773277742777527776277772777827779277802778127782277832778427785277862778727788277892779027791277922779327794277952779627797277982779927800278012780227803278042780527806278072780827809278102781127812278132781427815278162781727818278192782027821278222782327824278252782627827278282782927830278312783227833278342783527836278372783827839278402784127842278432784427845278462784727848278492785027851278522785327854278552785627857278582785927860278612786227863278642786527866278672786827869278702787127872278732787427875278762787727878278792788027881278822788327884278852788627887278882788927890278912789227893278942789527896278972789827899279002790127902279032790427905279062790727908279092791027911279122791327914279152791627917279182791927920279212792227923279242792527926279272792827929279302793127932279332793427935279362793727938279392794027941279422794327944279452794627947279482794927950279512795227953279542795527956279572795827959279602796127962279632796427965279662796727968279692797027971279722797327974279752797627977279782797927980279812798227983279842798527986279872798827989279902799127992279932799427995279962799727998279992800028001280022800328004280052800628007280082800928010280112801228013280142801528016280172801828019280202802128022280232802428025280262802728028280292803028031280322803328034280352803628037280382803928040280412804228043280442804528046280472804828049280502805128052280532805428055280562805728058280592806028061280622806328064280652806628067280682806928070280712807228073280742807528076280772807828079280802808128082280832808428085280862808728088280892809028091280922809328094280952809628097280982809928100281012810228103281042810528106281072810828109281102811128112281132811428115281162811728118281192812028121281222812328124281252812628127281282812928130281312813228133281342813528136281372813828139281402814128142281432814428145281462814728148281492815028151281522815328154281552815628157281582815928160281612816228163281642816528166281672816828169281702817128172281732817428175281762817728178281792818028181281822818328184281852818628187281882818928190281912819228193281942819528196281972819828199282002820128202282032820428205282062820728208282092821028211282122821328214282152821628217282182821928220282212822228223282242822528226282272822828229282302823128232282332823428235282362823728238282392824028241282422824328244282452824628247282482824928250282512825228253282542825528256282572825828259282602826128262282632826428265282662826728268282692827028271282722827328274282752827628277282782827928280282812828228283282842828528286282872828828289282902829128292282932829428295282962829728298282992830028301283022830328304283052830628307283082830928310283112831228313283142831528316283172831828319283202832128322283232832428325283262832728328283292833028331283322833328334283352833628337283382833928340283412834228343283442834528346283472834828349283502835128352283532835428355283562835728358283592836028361283622836328364283652836628367283682836928370283712837228373283742837528376283772837828379283802838128382283832838428385283862838728388283892839028391283922839328394283952839628397283982839928400284012840228403284042840528406284072840828409284102841128412284132841428415284162841728418284192842028421284222842328424284252842628427284282842928430284312843228433284342843528436284372843828439284402844128442284432844428445284462844728448284492845028451284522845328454284552845628457284582845928460284612846228463284642846528466284672846828469284702847128472284732847428475284762847728478284792848028481284822848328484284852848628487284882848928490284912849228493284942849528496284972849828499285002850128502285032850428505285062850728508285092851028511285122851328514285152851628517285182851928520285212852228523285242852528526285272852828529285302853128532285332853428535285362853728538285392854028541285422854328544285452854628547285482854928550285512855228553285542855528556285572855828559285602856128562285632856428565285662856728568285692857028571285722857328574285752857628577285782857928580285812858228583285842858528586285872858828589285902859128592285932859428595285962859728598285992860028601286022860328604286052860628607286082860928610286112861228613286142861528616286172861828619286202862128622286232862428625286262862728628286292863028631286322863328634286352863628637286382863928640286412864228643286442864528646286472864828649286502865128652286532865428655286562865728658286592866028661286622866328664286652866628667286682866928670286712867228673286742867528676286772867828679286802868128682286832868428685286862868728688286892869028691286922869328694286952869628697286982869928700287012870228703287042870528706287072870828709287102871128712287132871428715287162871728718287192872028721287222872328724287252872628727287282872928730287312873228733287342873528736287372873828739287402874128742287432874428745287462874728748287492875028751287522875328754287552875628757287582875928760287612876228763287642876528766287672876828769287702877128772287732877428775287762877728778287792878028781287822878328784287852878628787287882878928790287912879228793287942879528796287972879828799288002880128802288032880428805288062880728808288092881028811288122881328814288152881628817288182881928820288212882228823288242882528826288272882828829288302883128832288332883428835288362883728838288392884028841288422884328844288452884628847288482884928850288512885228853288542885528856288572885828859288602886128862288632886428865288662886728868288692887028871288722887328874288752887628877288782887928880288812888228883288842888528886288872888828889288902889128892288932889428895288962889728898288992890028901289022890328904289052890628907289082890928910289112891228913289142891528916289172891828919289202892128922289232892428925289262892728928289292893028931289322893328934289352893628937289382893928940289412894228943289442894528946289472894828949289502895128952289532895428955289562895728958289592896028961289622896328964289652896628967289682896928970289712897228973289742897528976289772897828979289802898128982289832898428985289862898728988289892899028991289922899328994289952899628997289982899929000290012900229003290042900529006290072900829009290102901129012290132901429015290162901729018290192902029021290222902329024290252902629027290282902929030290312903229033290342903529036290372903829039290402904129042290432904429045290462904729048290492905029051290522905329054290552905629057290582905929060290612906229063290642906529066290672906829069290702907129072290732907429075290762907729078290792908029081290822908329084290852908629087290882908929090290912909229093290942909529096290972909829099291002910129102291032910429105291062910729108291092911029111291122911329114291152911629117291182911929120291212912229123291242912529126291272912829129291302913129132291332913429135291362913729138291392914029141291422914329144291452914629147291482914929150291512915229153291542915529156291572915829159291602916129162291632916429165291662916729168291692917029171291722917329174291752917629177291782917929180291812918229183291842918529186291872918829189291902919129192291932919429195291962919729198291992920029201292022920329204292052920629207292082920929210292112921229213292142921529216292172921829219292202922129222292232922429225292262922729228292292923029231292322923329234292352923629237292382923929240292412924229243292442924529246292472924829249292502925129252292532925429255292562925729258292592926029261292622926329264292652926629267292682926929270292712927229273292742927529276292772927829279292802928129282292832928429285292862928729288292892929029291292922929329294292952929629297292982929929300293012930229303293042930529306293072930829309293102931129312293132931429315293162931729318293192932029321293222932329324293252932629327293282932929330293312933229333293342933529336293372933829339293402934129342293432934429345293462934729348293492935029351293522935329354293552935629357293582935929360293612936229363293642936529366293672936829369293702937129372293732937429375293762937729378293792938029381293822938329384293852938629387293882938929390293912939229393293942939529396293972939829399294002940129402294032940429405294062940729408294092941029411294122941329414294152941629417294182941929420294212942229423294242942529426294272942829429294302943129432294332943429435294362943729438294392944029441294422944329444294452944629447294482944929450294512945229453294542945529456294572945829459294602946129462294632946429465294662946729468294692947029471294722947329474294752947629477294782947929480294812948229483294842948529486294872948829489294902949129492294932949429495294962949729498294992950029501295022950329504295052950629507295082950929510295112951229513295142951529516295172951829519295202952129522295232952429525295262952729528295292953029531295322953329534295352953629537295382953929540295412954229543295442954529546295472954829549295502955129552295532955429555295562955729558295592956029561295622956329564295652956629567295682956929570295712957229573295742957529576295772957829579295802958129582295832958429585295862958729588295892959029591295922959329594295952959629597295982959929600296012960229603296042960529606296072960829609296102961129612296132961429615296162961729618296192962029621296222962329624296252962629627296282962929630296312963229633296342963529636296372963829639296402964129642296432964429645296462964729648296492965029651296522965329654296552965629657296582965929660296612966229663296642966529666296672966829669296702967129672296732967429675296762967729678296792968029681296822968329684296852968629687296882968929690296912969229693296942969529696296972969829699297002970129702297032970429705297062970729708297092971029711297122971329714297152971629717297182971929720297212972229723297242972529726297272972829729297302973129732297332973429735297362973729738297392974029741297422974329744297452974629747297482974929750297512975229753297542975529756297572975829759297602976129762297632976429765297662976729768297692977029771297722977329774297752977629777297782977929780297812978229783297842978529786297872978829789297902979129792297932979429795297962979729798297992980029801298022980329804298052980629807298082980929810298112981229813298142981529816298172981829819298202982129822298232982429825298262982729828298292983029831298322983329834298352983629837298382983929840298412984229843298442984529846298472984829849298502985129852298532985429855298562985729858298592986029861298622986329864298652986629867298682986929870298712987229873298742987529876298772987829879298802988129882298832988429885298862988729888298892989029891298922989329894298952989629897298982989929900299012990229903299042990529906299072990829909299102991129912299132991429915299162991729918299192992029921299222992329924299252992629927299282992929930299312993229933299342993529936299372993829939299402994129942299432994429945299462994729948299492995029951299522995329954299552995629957299582995929960299612996229963299642996529966299672996829969299702997129972299732997429975299762997729978299792998029981299822998329984299852998629987299882998929990299912999229993299942999529996299972999829999300003000130002300033000430005300063000730008300093001030011300123001330014300153001630017300183001930020300213002230023300243002530026300273002830029300303003130032300333003430035300363003730038300393004030041300423004330044300453004630047300483004930050300513005230053300543005530056300573005830059300603006130062300633006430065300663006730068300693007030071300723007330074300753007630077300783007930080300813008230083300843008530086300873008830089300903009130092300933009430095300963009730098300993010030101301023010330104301053010630107301083010930110301113011230113301143011530116301173011830119301203012130122301233012430125301263012730128301293013030131301323013330134301353013630137301383013930140301413014230143301443014530146301473014830149301503015130152301533015430155301563015730158301593016030161301623016330164301653016630167301683016930170301713017230173301743017530176301773017830179301803018130182301833018430185301863018730188301893019030191301923019330194301953019630197301983019930200302013020230203302043020530206302073020830209302103021130212302133021430215302163021730218302193022030221302223022330224302253022630227302283022930230302313023230233302343023530236302373023830239302403024130242302433024430245302463024730248302493025030251302523025330254302553025630257302583025930260302613026230263302643026530266302673026830269302703027130272302733027430275302763027730278302793028030281302823028330284302853028630287302883028930290302913029230293302943029530296302973029830299303003030130302303033030430305303063030730308303093031030311303123031330314303153031630317303183031930320303213032230323303243032530326303273032830329303303033130332303333033430335303363033730338303393034030341303423034330344303453034630347303483034930350303513035230353303543035530356303573035830359303603036130362303633036430365303663036730368303693037030371303723037330374303753037630377303783037930380303813038230383303843038530386303873038830389303903039130392303933039430395303963039730398303993040030401304023040330404304053040630407304083040930410304113041230413304143041530416304173041830419304203042130422304233042430425304263042730428304293043030431304323043330434304353043630437304383043930440304413044230443304443044530446304473044830449304503045130452304533045430455304563045730458304593046030461304623046330464304653046630467304683046930470304713047230473304743047530476304773047830479304803048130482304833048430485304863048730488304893049030491304923049330494304953049630497304983049930500305013050230503305043050530506305073050830509305103051130512305133051430515305163051730518305193052030521305223052330524305253052630527305283052930530305313053230533305343053530536305373053830539305403054130542305433054430545305463054730548305493055030551305523055330554305553055630557305583055930560305613056230563305643056530566305673056830569305703057130572305733057430575305763057730578305793058030581305823058330584305853058630587305883058930590305913059230593305943059530596305973059830599306003060130602306033060430605306063060730608306093061030611306123061330614306153061630617306183061930620306213062230623306243062530626306273062830629306303063130632306333063430635306363063730638306393064030641306423064330644306453064630647306483064930650306513065230653306543065530656306573065830659306603066130662306633066430665306663066730668306693067030671306723067330674306753067630677306783067930680306813068230683306843068530686306873068830689306903069130692306933069430695306963069730698306993070030701307023070330704307053070630707307083070930710307113071230713307143071530716307173071830719307203072130722307233072430725307263072730728307293073030731307323073330734307353073630737307383073930740307413074230743307443074530746307473074830749307503075130752307533075430755307563075730758307593076030761307623076330764307653076630767307683076930770307713077230773307743077530776307773077830779307803078130782307833078430785307863078730788307893079030791307923079330794307953079630797307983079930800308013080230803308043080530806308073080830809308103081130812308133081430815308163081730818308193082030821308223082330824308253082630827308283082930830308313083230833308343083530836308373083830839308403084130842308433084430845308463084730848308493085030851308523085330854308553085630857308583085930860308613086230863308643086530866308673086830869308703087130872308733087430875308763087730878308793088030881308823088330884308853088630887308883088930890308913089230893308943089530896308973089830899309003090130902309033090430905309063090730908309093091030911309123091330914309153091630917309183091930920309213092230923309243092530926309273092830929309303093130932309333093430935309363093730938309393094030941309423094330944309453094630947309483094930950309513095230953309543095530956309573095830959309603096130962309633096430965309663096730968309693097030971309723097330974309753097630977309783097930980309813098230983309843098530986309873098830989309903099130992309933099430995309963099730998309993100031001310023100331004310053100631007310083100931010310113101231013310143101531016310173101831019310203102131022310233102431025310263102731028310293103031031310323103331034310353103631037310383103931040310413104231043310443104531046310473104831049310503105131052310533105431055310563105731058310593106031061310623106331064310653106631067310683106931070310713107231073310743107531076310773107831079310803108131082310833108431085310863108731088310893109031091310923109331094310953109631097310983109931100311013110231103311043110531106311073110831109311103111131112311133111431115311163111731118311193112031121311223112331124311253112631127311283112931130311313113231133311343113531136311373113831139311403114131142311433114431145311463114731148311493115031151311523115331154311553115631157311583115931160311613116231163311643116531166311673116831169311703117131172311733117431175311763117731178311793118031181311823118331184311853118631187311883118931190311913119231193311943119531196311973119831199312003120131202312033120431205312063120731208312093121031211312123121331214312153121631217312183121931220312213122231223312243122531226312273122831229312303123131232312333123431235312363123731238312393124031241312423124331244312453124631247312483124931250312513125231253312543125531256312573125831259312603126131262312633126431265312663126731268312693127031271312723127331274312753127631277312783127931280312813128231283312843128531286312873128831289312903129131292312933129431295312963129731298312993130031301313023130331304313053130631307313083130931310313113131231313313143131531316313173131831319313203132131322313233132431325313263132731328313293133031331313323133331334313353133631337313383133931340313413134231343313443134531346313473134831349313503135131352313533135431355313563135731358313593136031361313623136331364313653136631367313683136931370313713137231373313743137531376313773137831379313803138131382313833138431385313863138731388313893139031391313923139331394313953139631397313983139931400314013140231403314043140531406314073140831409314103141131412314133141431415314163141731418314193142031421314223142331424314253142631427314283142931430314313143231433314343143531436314373143831439314403144131442314433144431445314463144731448314493145031451314523145331454314553145631457314583145931460314613146231463314643146531466314673146831469314703147131472314733147431475314763147731478314793148031481314823148331484314853148631487314883148931490314913149231493314943149531496314973149831499315003150131502315033150431505315063150731508315093151031511315123151331514315153151631517315183151931520315213152231523315243152531526315273152831529315303153131532315333153431535315363153731538315393154031541315423154331544315453154631547315483154931550315513155231553315543155531556315573155831559315603156131562315633156431565315663156731568315693157031571315723157331574315753157631577315783157931580315813158231583315843158531586315873158831589315903159131592315933159431595315963159731598315993160031601316023160331604316053160631607316083160931610316113161231613316143161531616316173161831619316203162131622316233162431625316263162731628316293163031631316323163331634316353163631637316383163931640316413164231643316443164531646316473164831649316503165131652316533165431655316563165731658316593166031661316623166331664316653166631667316683166931670316713167231673316743167531676316773167831679316803168131682316833168431685316863168731688316893169031691316923169331694316953169631697316983169931700317013170231703317043170531706317073170831709317103171131712317133171431715317163171731718317193172031721317223172331724317253172631727317283172931730317313173231733317343173531736317373173831739317403174131742317433174431745317463174731748317493175031751317523175331754317553175631757317583175931760317613176231763317643176531766317673176831769317703177131772317733177431775317763177731778317793178031781317823178331784317853178631787317883178931790317913179231793317943179531796317973179831799318003180131802318033180431805318063180731808318093181031811318123181331814318153181631817318183181931820318213182231823318243182531826318273182831829318303183131832318333183431835318363183731838318393184031841318423184331844318453184631847318483184931850318513185231853318543185531856318573185831859318603186131862318633186431865318663186731868318693187031871318723187331874318753187631877318783187931880318813188231883318843188531886318873188831889318903189131892318933189431895318963189731898318993190031901319023190331904319053190631907319083190931910319113191231913319143191531916319173191831919319203192131922319233192431925319263192731928319293193031931319323193331934319353193631937319383193931940319413194231943319443194531946319473194831949319503195131952319533195431955319563195731958319593196031961319623196331964319653196631967319683196931970319713197231973319743197531976319773197831979319803198131982319833198431985319863198731988319893199031991319923199331994319953199631997319983199932000320013200232003320043200532006320073200832009320103201132012320133201432015320163201732018320193202032021320223202332024320253202632027320283202932030320313203232033320343203532036320373203832039320403204132042320433204432045320463204732048320493205032051320523205332054320553205632057320583205932060320613206232063320643206532066320673206832069320703207132072320733207432075320763207732078320793208032081320823208332084320853208632087320883208932090320913209232093320943209532096320973209832099321003210132102321033210432105321063210732108321093211032111321123211332114321153211632117321183211932120321213212232123321243212532126321273212832129321303213132132321333213432135321363213732138321393214032141321423214332144321453214632147321483214932150321513215232153321543215532156321573215832159321603216132162321633216432165321663216732168321693217032171321723217332174321753217632177321783217932180321813218232183321843218532186321873218832189321903219132192321933219432195321963219732198321993220032201322023220332204322053220632207322083220932210322113221232213322143221532216322173221832219322203222132222322233222432225322263222732228322293223032231322323223332234322353223632237322383223932240
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>log4net</name>
  5. </assembly>
  6. <members>
  7. <member name="T:log4net.Appender.AdoNetAppender">
  8. <summary>
  9. Appender that logs to a database.
  10. </summary>
  11. <remarks>
  12. <para>
  13. <see cref="T:log4net.Appender.AdoNetAppender"/> appends logging events to a table within a
  14. database. The appender can be configured to specify the connection
  15. string by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionString"/> property.
  16. The connection type (provider) can be specified by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/>
  17. property. For more information on database connection strings for
  18. your specific database see <a href="http://www.connectionstrings.com/">http://www.connectionstrings.com/</a>.
  19. </para>
  20. <para>
  21. Records are written into the database either using a prepared
  22. statement or a stored procedure. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property
  23. is set to <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify a prepared statement
  24. or to <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify a stored
  25. procedure.
  26. </para>
  27. <para>
  28. The prepared statement text or the name of the stored procedure
  29. must be set in the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property.
  30. </para>
  31. <para>
  32. The prepared statement or stored procedure can take a number
  33. of parameters. Parameters are added using the <see cref="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"/>
  34. method. This adds a single <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> to the
  35. ordered list of parameters. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/>
  36. type may be subclassed if required to provide database specific
  37. functionality. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> specifies
  38. the parameter name, database type, size, and how the value should
  39. be generated using a <see cref="T:log4net.Layout.ILayout"/>.
  40. </para>
  41. </remarks>
  42. <example>
  43. An example of a SQL Server table that could be logged to:
  44. <code lang="SQL">
  45. CREATE TABLE [dbo].[Log] (
  46. [ID] [int] IDENTITY (1, 1) NOT NULL ,
  47. [Date] [datetime] NOT NULL ,
  48. [Thread] [varchar] (255) NOT NULL ,
  49. [Level] [varchar] (20) NOT NULL ,
  50. [Logger] [varchar] (255) NOT NULL ,
  51. [Message] [varchar] (4000) NOT NULL
  52. ) ON [PRIMARY]
  53. </code>
  54. </example>
  55. <example>
  56. An example configuration to log to the above table:
  57. <code lang="XML" escaped="true">
  58. <appender name="AdoNetAppender_SqlServer" type="log4net.Appender.AdoNetAppender" >
  59. <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
  60. <connectionString value="data source=SQLSVR;initial catalog=test_log4net;integrated security=false;persist security info=True;User ID=sa;Password=sa" />
  61. <commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)" />
  62. <parameter>
  63. <parameterName value="@log_date" />
  64. <dbType value="DateTime" />
  65. <layout type="log4net.Layout.PatternLayout" value="%date{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}" />
  66. </parameter>
  67. <parameter>
  68. <parameterName value="@thread" />
  69. <dbType value="String" />
  70. <size value="255" />
  71. <layout type="log4net.Layout.PatternLayout" value="%thread" />
  72. </parameter>
  73. <parameter>
  74. <parameterName value="@log_level" />
  75. <dbType value="String" />
  76. <size value="50" />
  77. <layout type="log4net.Layout.PatternLayout" value="%level" />
  78. </parameter>
  79. <parameter>
  80. <parameterName value="@logger" />
  81. <dbType value="String" />
  82. <size value="255" />
  83. <layout type="log4net.Layout.PatternLayout" value="%logger" />
  84. </parameter>
  85. <parameter>
  86. <parameterName value="@message" />
  87. <dbType value="String" />
  88. <size value="4000" />
  89. <layout type="log4net.Layout.PatternLayout" value="%message" />
  90. </parameter>
  91. </appender>
  92. </code>
  93. </example>
  94. <author>Julian Biddle</author>
  95. <author>Nicko Cadell</author>
  96. <author>Gert Driesen</author>
  97. <author>Lance Nehring</author>
  98. </member>
  99. <member name="M:log4net.Appender.AdoNetAppender.#ctor">
  100. <summary>
  101. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender" /> class.
  102. </summary>
  103. <remarks>
  104. Public default constructor to initialize a new instance of this class.
  105. </remarks>
  106. </member>
  107. <member name="P:log4net.Appender.AdoNetAppender.ConnectionString">
  108. <summary>
  109. Gets or sets the database connection string that is used to connect to
  110. the database.
  111. </summary>
  112. <value>
  113. The database connection string used to connect to the database.
  114. </value>
  115. <remarks>
  116. <para>
  117. The connections string is specific to the connection type.
  118. See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information.
  119. </para>
  120. </remarks>
  121. <example>Connection string for MS Access via ODBC:
  122. <code>"DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"</code>
  123. </example>
  124. <example>Another connection string for MS Access via ODBC:
  125. <code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code>
  126. </example>
  127. <example>Connection string for MS Access via OLE DB:
  128. <code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code>
  129. </example>
  130. </member>
  131. <member name="P:log4net.Appender.AdoNetAppender.AppSettingsKey">
  132. <summary>
  133. The appSettings key from App.Config that contains the connection string.
  134. </summary>
  135. </member>
  136. <member name="P:log4net.Appender.AdoNetAppender.ConnectionStringName">
  137. <summary>
  138. The connectionStrings key from App.Config that contains the connection string.
  139. </summary>
  140. <remarks>
  141. This property requires at least .NET 2.0.
  142. </remarks>
  143. </member>
  144. <member name="P:log4net.Appender.AdoNetAppender.ConnectionType">
  145. <summary>
  146. Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection
  147. that should be created.
  148. </summary>
  149. <value>
  150. The type name of the <see cref="T:System.Data.IDbConnection"/> connection.
  151. </value>
  152. <remarks>
  153. <para>
  154. The type name of the ADO.NET provider to use.
  155. </para>
  156. <para>
  157. The default is to use the OLE DB provider.
  158. </para>
  159. </remarks>
  160. <example>Use the OLE DB Provider. This is the default value.
  161. <code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  162. </example>
  163. <example>Use the MS SQL Server Provider.
  164. <code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  165. </example>
  166. <example>Use the ODBC Provider.
  167. <code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code>
  168. This is an optional package that you can download from
  169. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  170. search for <b>ODBC .NET Data Provider</b>.
  171. </example>
  172. <example>Use the Oracle Provider.
  173. <code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  174. This is an optional package that you can download from
  175. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  176. search for <b>.NET Managed Provider for Oracle</b>.
  177. </example>
  178. </member>
  179. <member name="P:log4net.Appender.AdoNetAppender.CommandText">
  180. <summary>
  181. Gets or sets the command text that is used to insert logging events
  182. into the database.
  183. </summary>
  184. <value>
  185. The command text used to insert logging events into the database.
  186. </value>
  187. <remarks>
  188. <para>
  189. Either the text of the prepared statement or the
  190. name of the stored procedure to execute to write into
  191. the database.
  192. </para>
  193. <para>
  194. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if
  195. this text is a prepared statement or a stored procedure.
  196. </para>
  197. <para>
  198. If this property is not set, the command text is retrieved by invoking
  199. <see cref="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)"/>.
  200. </para>
  201. </remarks>
  202. </member>
  203. <member name="P:log4net.Appender.AdoNetAppender.CommandType">
  204. <summary>
  205. Gets or sets the command type to execute.
  206. </summary>
  207. <value>
  208. The command type to execute.
  209. </value>
  210. <remarks>
  211. <para>
  212. This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify
  213. that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute,
  214. or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the
  215. <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure
  216. to execute.
  217. </para>
  218. <para>
  219. The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>).
  220. </para>
  221. </remarks>
  222. </member>
  223. <member name="P:log4net.Appender.AdoNetAppender.UseTransactions">
  224. <summary>
  225. Should transactions be used to insert logging events in the database.
  226. </summary>
  227. <value>
  228. <c>true</c> if transactions should be used to insert logging events in
  229. the database, otherwise <c>false</c>. The default value is <c>true</c>.
  230. </value>
  231. <remarks>
  232. <para>
  233. Gets or sets a value that indicates whether transactions should be used
  234. to insert logging events in the database.
  235. </para>
  236. <para>
  237. When set a single transaction will be used to insert the buffered events
  238. into the database. Otherwise each event will be inserted without using
  239. an explicit transaction.
  240. </para>
  241. </remarks>
  242. </member>
  243. <member name="P:log4net.Appender.AdoNetAppender.SecurityContext">
  244. <summary>
  245. Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  246. </summary>
  247. <value>
  248. The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  249. </value>
  250. <remarks>
  251. <para>
  252. Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender
  253. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  254. security context to use. The default behavior is to use the security context
  255. of the current thread.
  256. </para>
  257. </remarks>
  258. </member>
  259. <member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError">
  260. <summary>
  261. Should this appender try to reconnect to the database on error.
  262. </summary>
  263. <value>
  264. <c>true</c> if the appender should try to reconnect to the database after an
  265. error has occurred, otherwise <c>false</c>. The default value is <c>false</c>,
  266. i.e. not to try to reconnect.
  267. </value>
  268. <remarks>
  269. <para>
  270. The default behaviour is for the appender not to try to reconnect to the
  271. database if an error occurs. Subsequent logging events are discarded.
  272. </para>
  273. <para>
  274. To force the appender to attempt to reconnect to the database set this
  275. property to <c>true</c>.
  276. </para>
  277. <note>
  278. When the appender attempts to connect to the database there may be a
  279. delay of up to the connection timeout specified in the connection string.
  280. This delay will block the calling application's thread.
  281. Until the connection can be reestablished this potential delay may occur multiple times.
  282. </note>
  283. </remarks>
  284. </member>
  285. <member name="P:log4net.Appender.AdoNetAppender.Connection">
  286. <summary>
  287. Gets or sets the underlying <see cref="T:System.Data.IDbConnection" />.
  288. </summary>
  289. <value>
  290. The underlying <see cref="T:System.Data.IDbConnection" />.
  291. </value>
  292. <remarks>
  293. <see cref="T:log4net.Appender.AdoNetAppender" /> creates a <see cref="T:System.Data.IDbConnection" /> to insert
  294. logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender" />
  295. can use this property to get or set this <see cref="T:System.Data.IDbConnection" />. Use the
  296. underlying <see cref="T:System.Data.IDbConnection" /> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection" /> if
  297. you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender" /> provides.
  298. </remarks>
  299. </member>
  300. <member name="M:log4net.Appender.AdoNetAppender.ActivateOptions">
  301. <summary>
  302. Initialize the appender based on the options set
  303. </summary>
  304. <remarks>
  305. <para>
  306. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  307. activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must
  308. be called on this object after the configuration properties have
  309. been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this
  310. object is in an undefined state and must not be used.
  311. </para>
  312. <para>
  313. If any of the configuration properties are modified then
  314. <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again.
  315. </para>
  316. </remarks>
  317. </member>
  318. <member name="M:log4net.Appender.AdoNetAppender.OnClose">
  319. <summary>
  320. Override the parent method to close the database
  321. </summary>
  322. <remarks>
  323. <para>
  324. Closes the database command and database connection.
  325. </para>
  326. </remarks>
  327. </member>
  328. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  329. <summary>
  330. Inserts the events into the database.
  331. </summary>
  332. <param name="events">The events to insert into the database.</param>
  333. <remarks>
  334. <para>
  335. Insert all the events specified in the <paramref name="events"/>
  336. array into the database.
  337. </para>
  338. </remarks>
  339. </member>
  340. <member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)">
  341. <summary>
  342. Adds a parameter to the command.
  343. </summary>
  344. <param name="parameter">The parameter to add to the command.</param>
  345. <remarks>
  346. <para>
  347. Adds a parameter to the ordered list of command parameters.
  348. </para>
  349. </remarks>
  350. </member>
  351. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])">
  352. <summary>
  353. Writes the events to the database using the transaction specified.
  354. </summary>
  355. <param name="dbTran">The transaction that the events will be executed under.</param>
  356. <param name="events">The array of events to insert into the database.</param>
  357. <remarks>
  358. <para>
  359. The transaction argument can be <c>null</c> if the appender has been
  360. configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/>
  361. property for more information.
  362. </para>
  363. </remarks>
  364. </member>
  365. <member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)">
  366. <summary>
  367. Formats the log message into database statement text.
  368. </summary>
  369. <param name="logEvent">The event being logged.</param>
  370. <remarks>
  371. This method can be overridden by subclasses to provide
  372. more control over the format of the database statement.
  373. </remarks>
  374. <returns>
  375. Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
  376. </returns>
  377. </member>
  378. <member name="M:log4net.Appender.AdoNetAppender.CreateConnection(System.Type,System.String)">
  379. <summary>
  380. Creates an <see cref="T:System.Data.IDbConnection"/> instance used to connect to the database.
  381. </summary>
  382. <remarks>
  383. This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary).
  384. </remarks>
  385. <param name="connectionType">The <see cref="T:System.Type"/> of the <see cref="T:System.Data.IDbConnection"/> object.</param>
  386. <param name="connectionString">The connectionString output from the ResolveConnectionString method.</param>
  387. <returns>An <see cref="T:System.Data.IDbConnection"/> instance with a valid connection string.</returns>
  388. </member>
  389. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionString(System.String@)">
  390. <summary>
  391. Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey
  392. property.
  393. </summary>
  394. <remarks>
  395. ConnectiongStringName is only supported on .NET 2.0 and higher.
  396. </remarks>
  397. <param name="connectionStringContext">Additional information describing the connection string.</param>
  398. <returns>A connection string used to connect to the database.</returns>
  399. </member>
  400. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType">
  401. <summary>
  402. Retrieves the class type of the ADO.NET provider.
  403. </summary>
  404. <remarks>
  405. <para>
  406. Gets the Type of the ADO.NET provider to use to connect to the
  407. database. This method resolves the type specified in the
  408. <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property.
  409. </para>
  410. <para>
  411. Subclasses can override this method to return a different type
  412. if necessary.
  413. </para>
  414. </remarks>
  415. <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns>
  416. </member>
  417. <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection">
  418. <summary>
  419. Connects to the database.
  420. </summary>
  421. </member>
  422. <member name="M:log4net.Appender.AdoNetAppender.DiposeConnection">
  423. <summary>
  424. Cleanup the existing connection.
  425. </summary>
  426. <remarks>
  427. Calls the IDbConnection's <see cref="M:System.Data.IDbConnection.Close"/> method.
  428. </remarks>
  429. </member>
  430. <member name="F:log4net.Appender.AdoNetAppender.m_parameters">
  431. <summary>
  432. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  433. </summary>
  434. <remarks>
  435. <para>
  436. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  437. </para>
  438. </remarks>
  439. </member>
  440. <member name="F:log4net.Appender.AdoNetAppender.m_securityContext">
  441. <summary>
  442. The security context to use for privileged calls
  443. </summary>
  444. </member>
  445. <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection">
  446. <summary>
  447. The <see cref="T:System.Data.IDbConnection" /> that will be used
  448. to insert logging events into a database.
  449. </summary>
  450. </member>
  451. <member name="F:log4net.Appender.AdoNetAppender.m_connectionString">
  452. <summary>
  453. Database connection string.
  454. </summary>
  455. </member>
  456. <member name="F:log4net.Appender.AdoNetAppender.m_appSettingsKey">
  457. <summary>
  458. The appSettings key from App.Config that contains the connection string.
  459. </summary>
  460. </member>
  461. <member name="F:log4net.Appender.AdoNetAppender.m_connectionStringName">
  462. <summary>
  463. The connectionStrings key from App.Config that contains the connection string.
  464. </summary>
  465. </member>
  466. <member name="F:log4net.Appender.AdoNetAppender.m_connectionType">
  467. <summary>
  468. String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
  469. </summary>
  470. </member>
  471. <member name="F:log4net.Appender.AdoNetAppender.m_commandText">
  472. <summary>
  473. The text of the command.
  474. </summary>
  475. </member>
  476. <member name="F:log4net.Appender.AdoNetAppender.m_commandType">
  477. <summary>
  478. The command type.
  479. </summary>
  480. </member>
  481. <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions">
  482. <summary>
  483. Indicates whether to use transactions when writing to the database.
  484. </summary>
  485. </member>
  486. <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError">
  487. <summary>
  488. Indicates whether to reconnect when a connection is lost.
  489. </summary>
  490. </member>
  491. <member name="F:log4net.Appender.AdoNetAppender.declaringType">
  492. <summary>
  493. The fully qualified type of the AdoNetAppender class.
  494. </summary>
  495. <remarks>
  496. Used by the internal logger to record the Type of the
  497. log message.
  498. </remarks>
  499. </member>
  500. <member name="T:log4net.Appender.AdoNetAppenderParameter">
  501. <summary>
  502. Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>.
  503. </summary>
  504. <remarks>
  505. <para>
  506. This class provides the basic database parameter properties
  507. as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface.
  508. </para>
  509. <para>This type can be subclassed to provide database specific
  510. functionality. The two methods that are called externally are
  511. <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>.
  512. </para>
  513. </remarks>
  514. </member>
  515. <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor">
  516. <summary>
  517. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter" /> class.
  518. </summary>
  519. <remarks>
  520. Default constructor for the AdoNetAppenderParameter class.
  521. </remarks>
  522. </member>
  523. <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName">
  524. <summary>
  525. Gets or sets the name of this parameter.
  526. </summary>
  527. <value>
  528. The name of this parameter.
  529. </value>
  530. <remarks>
  531. <para>
  532. The name of this parameter. The parameter name
  533. must match up to a named parameter to the SQL stored procedure
  534. or prepared statement.
  535. </para>
  536. </remarks>
  537. </member>
  538. <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType">
  539. <summary>
  540. Gets or sets the database type for this parameter.
  541. </summary>
  542. <value>
  543. The database type for this parameter.
  544. </value>
  545. <remarks>
  546. <para>
  547. The database type for this parameter. This property should
  548. be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/>
  549. enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>.
  550. </para>
  551. <para>
  552. This property is optional. If not specified the ADO.NET provider
  553. will attempt to infer the type from the value.
  554. </para>
  555. </remarks>
  556. <seealso cref="P:System.Data.IDataParameter.DbType" />
  557. </member>
  558. <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision">
  559. <summary>
  560. Gets or sets the precision for this parameter.
  561. </summary>
  562. <value>
  563. The precision for this parameter.
  564. </value>
  565. <remarks>
  566. <para>
  567. The maximum number of digits used to represent the Value.
  568. </para>
  569. <para>
  570. This property is optional. If not specified the ADO.NET provider
  571. will attempt to infer the precision from the value.
  572. </para>
  573. </remarks>
  574. <seealso cref="P:System.Data.IDbDataParameter.Precision" />
  575. </member>
  576. <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale">
  577. <summary>
  578. Gets or sets the scale for this parameter.
  579. </summary>
  580. <value>
  581. The scale for this parameter.
  582. </value>
  583. <remarks>
  584. <para>
  585. The number of decimal places to which Value is resolved.
  586. </para>
  587. <para>
  588. This property is optional. If not specified the ADO.NET provider
  589. will attempt to infer the scale from the value.
  590. </para>
  591. </remarks>
  592. <seealso cref="P:System.Data.IDbDataParameter.Scale" />
  593. </member>
  594. <member name="P:log4net.Appender.AdoNetAppenderParameter.Size">
  595. <summary>
  596. Gets or sets the size for this parameter.
  597. </summary>
  598. <value>
  599. The size for this parameter.
  600. </value>
  601. <remarks>
  602. <para>
  603. The maximum size, in bytes, of the data within the column.
  604. </para>
  605. <para>
  606. This property is optional. If not specified the ADO.NET provider
  607. will attempt to infer the size from the value.
  608. </para>
  609. <para>
  610. For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case.
  611. </para>
  612. </remarks>
  613. <seealso cref="P:System.Data.IDbDataParameter.Size" />
  614. </member>
  615. <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout">
  616. <summary>
  617. Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to
  618. render the logging event into an object for this
  619. parameter.
  620. </summary>
  621. <value>
  622. The <see cref="T:log4net.Layout.IRawLayout"/> used to render the
  623. logging event into an object for this parameter.
  624. </value>
  625. <remarks>
  626. <para>
  627. The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this
  628. parameter.
  629. </para>
  630. <para>
  631. The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt
  632. any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/>
  633. for use in the property.
  634. </para>
  635. </remarks>
  636. </member>
  637. <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)">
  638. <summary>
  639. Prepare the specified database command object.
  640. </summary>
  641. <param name="command">The command to prepare.</param>
  642. <remarks>
  643. <para>
  644. Prepares the database command object by adding
  645. this parameter to its collection of parameters.
  646. </para>
  647. </remarks>
  648. </member>
  649. <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)">
  650. <summary>
  651. Renders the logging event and set the parameter value in the command.
  652. </summary>
  653. <param name="command">The command containing the parameter.</param>
  654. <param name="loggingEvent">The event to be rendered.</param>
  655. <remarks>
  656. <para>
  657. Renders the logging event using this parameters layout
  658. object. Sets the value of the parameter on the command object.
  659. </para>
  660. </remarks>
  661. </member>
  662. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName">
  663. <summary>
  664. The name of this parameter.
  665. </summary>
  666. </member>
  667. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType">
  668. <summary>
  669. The database type for this parameter.
  670. </summary>
  671. </member>
  672. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType">
  673. <summary>
  674. Flag to infer type rather than use the DbType
  675. </summary>
  676. </member>
  677. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision">
  678. <summary>
  679. The precision for this parameter.
  680. </summary>
  681. </member>
  682. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale">
  683. <summary>
  684. The scale for this parameter.
  685. </summary>
  686. </member>
  687. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size">
  688. <summary>
  689. The size for this parameter.
  690. </summary>
  691. </member>
  692. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout">
  693. <summary>
  694. The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the
  695. logging event into an object for this parameter.
  696. </summary>
  697. </member>
  698. <member name="T:log4net.Appender.AnsiColorTerminalAppender">
  699. <summary>
  700. Appends logging events to the terminal using ANSI color escape sequences.
  701. </summary>
  702. <remarks>
  703. <para>
  704. AnsiColorTerminalAppender appends log events to the standard output stream
  705. or the error output stream using a layout specified by the
  706. user. It also allows the color of a specific level of message to be set.
  707. </para>
  708. <note>
  709. This appender expects the terminal to understand the VT100 control set
  710. in order to interpret the color codes. If the terminal or console does not
  711. understand the control codes the behavior is not defined.
  712. </note>
  713. <para>
  714. By default, all output is written to the console's standard output stream.
  715. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the
  716. error stream.
  717. </para>
  718. <para>
  719. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  720. <c>System.Console.Error</c> that is set at the time the event is appended.
  721. Therefore it is possible to programmatically redirect the output of this appender
  722. (for example NUnit does this to capture program output). While this is the desired
  723. behavior of this appender it may have security implications in your application.
  724. </para>
  725. <para>
  726. When configuring the ANSI colored terminal appender, a mapping should be
  727. specified to map a logging level to a color. For example:
  728. </para>
  729. <code lang="XML" escaped="true">
  730. <mapping>
  731. <level value="ERROR" />
  732. <foreColor value="White" />
  733. <backColor value="Red" />
  734. <attributes value="Bright,Underscore" />
  735. </mapping>
  736. <mapping>
  737. <level value="DEBUG" />
  738. <backColor value="Green" />
  739. </mapping>
  740. </code>
  741. <para>
  742. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  743. of the following values:
  744. <list type="bullet">
  745. <item><term>Blue</term><description></description></item>
  746. <item><term>Green</term><description></description></item>
  747. <item><term>Red</term><description></description></item>
  748. <item><term>White</term><description></description></item>
  749. <item><term>Yellow</term><description></description></item>
  750. <item><term>Purple</term><description></description></item>
  751. <item><term>Cyan</term><description></description></item>
  752. </list>
  753. These color values cannot be combined together to make new colors.
  754. </para>
  755. <para>
  756. The attributes can be any combination of the following:
  757. <list type="bullet">
  758. <item><term>Bright</term><description>foreground is brighter</description></item>
  759. <item><term>Dim</term><description>foreground is dimmer</description></item>
  760. <item><term>Underscore</term><description>message is underlined</description></item>
  761. <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item>
  762. <item><term>Reverse</term><description>foreground and background are reversed</description></item>
  763. <item><term>Hidden</term><description>output is hidden</description></item>
  764. <item><term>Strikethrough</term><description>message has a line through it</description></item>
  765. </list>
  766. While any of these attributes may be combined together not all combinations
  767. work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes
  768. no sense.
  769. </para>
  770. </remarks>
  771. <author>Patrick Wagstrom</author>
  772. <author>Nicko Cadell</author>
  773. </member>
  774. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes">
  775. <summary>
  776. The enum of possible display attributes
  777. </summary>
  778. <remarks>
  779. <para>
  780. The following flags can be combined together to
  781. form the ANSI color attributes.
  782. </para>
  783. </remarks>
  784. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender" />
  785. </member>
  786. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright">
  787. <summary>
  788. text is bright
  789. </summary>
  790. </member>
  791. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim">
  792. <summary>
  793. text is dim
  794. </summary>
  795. </member>
  796. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore">
  797. <summary>
  798. text is underlined
  799. </summary>
  800. </member>
  801. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink">
  802. <summary>
  803. text is blinking
  804. </summary>
  805. <remarks>
  806. Not all terminals support this attribute
  807. </remarks>
  808. </member>
  809. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse">
  810. <summary>
  811. text and background colors are reversed
  812. </summary>
  813. </member>
  814. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden">
  815. <summary>
  816. text is hidden
  817. </summary>
  818. </member>
  819. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough">
  820. <summary>
  821. text is displayed with a strikethrough
  822. </summary>
  823. </member>
  824. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Light">
  825. <summary>
  826. text color is light
  827. </summary>
  828. </member>
  829. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor">
  830. <summary>
  831. The enum of possible foreground or background color values for
  832. use with the color mapping method
  833. </summary>
  834. <remarks>
  835. <para>
  836. The output can be in one for the following ANSI colors.
  837. </para>
  838. </remarks>
  839. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender" />
  840. </member>
  841. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black">
  842. <summary>
  843. color is black
  844. </summary>
  845. </member>
  846. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red">
  847. <summary>
  848. color is red
  849. </summary>
  850. </member>
  851. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green">
  852. <summary>
  853. color is green
  854. </summary>
  855. </member>
  856. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow">
  857. <summary>
  858. color is yellow
  859. </summary>
  860. </member>
  861. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue">
  862. <summary>
  863. color is blue
  864. </summary>
  865. </member>
  866. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta">
  867. <summary>
  868. color is magenta
  869. </summary>
  870. </member>
  871. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan">
  872. <summary>
  873. color is cyan
  874. </summary>
  875. </member>
  876. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White">
  877. <summary>
  878. color is white
  879. </summary>
  880. </member>
  881. <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor">
  882. <summary>
  883. Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender" /> class.
  884. </summary>
  885. <remarks>
  886. The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender" /> class is set up to write
  887. to the standard output stream.
  888. </remarks>
  889. </member>
  890. <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target">
  891. <summary>
  892. Target is the value of the console output stream.
  893. </summary>
  894. <value>
  895. Target is the value of the console output stream.
  896. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  897. </value>
  898. <remarks>
  899. <para>
  900. Target is the value of the console output stream.
  901. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  902. </para>
  903. </remarks>
  904. </member>
  905. <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)">
  906. <summary>
  907. Add a mapping of level to color
  908. </summary>
  909. <param name="mapping">The mapping to add</param>
  910. <remarks>
  911. <para>
  912. Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender.
  913. Each mapping defines the foreground and background colours
  914. for a level.
  915. </para>
  916. </remarks>
  917. </member>
  918. <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)">
  919. <summary>
  920. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  921. </summary>
  922. <param name="loggingEvent">The event to log.</param>
  923. <remarks>
  924. <para>
  925. Writes the event to the console.
  926. </para>
  927. <para>
  928. The format of the output will depend on the appender's layout.
  929. </para>
  930. </remarks>
  931. </member>
  932. <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout">
  933. <summary>
  934. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  935. </summary>
  936. <value><c>true</c></value>
  937. <remarks>
  938. <para>
  939. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  940. </para>
  941. </remarks>
  942. </member>
  943. <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions">
  944. <summary>
  945. Initialize the options for this appender
  946. </summary>
  947. <remarks>
  948. <para>
  949. Initialize the level to color mappings set on this appender.
  950. </para>
  951. </remarks>
  952. </member>
  953. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut">
  954. <summary>
  955. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  956. standard output stream.
  957. </summary>
  958. <remarks>
  959. <para>
  960. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  961. standard output stream.
  962. </para>
  963. </remarks>
  964. </member>
  965. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError">
  966. <summary>
  967. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  968. standard error output stream.
  969. </summary>
  970. <remarks>
  971. <para>
  972. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  973. standard error output stream.
  974. </para>
  975. </remarks>
  976. </member>
  977. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream">
  978. <summary>
  979. Flag to write output to the error stream rather than the standard output stream
  980. </summary>
  981. </member>
  982. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping">
  983. <summary>
  984. Mapping from level object to color value
  985. </summary>
  986. </member>
  987. <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes">
  988. <summary>
  989. Ansi code to reset terminal
  990. </summary>
  991. </member>
  992. <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors">
  993. <summary>
  994. A class to act as a mapping between the level that a logging call is made at and
  995. the color it should be displayed as.
  996. </summary>
  997. <remarks>
  998. <para>
  999. Defines the mapping between a level and the color it should be displayed in.
  1000. </para>
  1001. </remarks>
  1002. </member>
  1003. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor">
  1004. <summary>
  1005. The mapped foreground color for the specified level
  1006. </summary>
  1007. <remarks>
  1008. <para>
  1009. Required property.
  1010. The mapped foreground color for the specified level
  1011. </para>
  1012. </remarks>
  1013. </member>
  1014. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor">
  1015. <summary>
  1016. The mapped background color for the specified level
  1017. </summary>
  1018. <remarks>
  1019. <para>
  1020. Required property.
  1021. The mapped background color for the specified level
  1022. </para>
  1023. </remarks>
  1024. </member>
  1025. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes">
  1026. <summary>
  1027. The color attributes for the specified level
  1028. </summary>
  1029. <remarks>
  1030. <para>
  1031. Required property.
  1032. The color attributes for the specified level
  1033. </para>
  1034. </remarks>
  1035. </member>
  1036. <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions">
  1037. <summary>
  1038. Initialize the options for the object
  1039. </summary>
  1040. <remarks>
  1041. <para>
  1042. Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together
  1043. and append the attributes.
  1044. </para>
  1045. </remarks>
  1046. </member>
  1047. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor">
  1048. <summary>
  1049. The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and
  1050. <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color.
  1051. </summary>
  1052. </member>
  1053. <member name="T:log4net.Appender.AppenderCollection">
  1054. <summary>
  1055. A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects.
  1056. </summary>
  1057. <author>Nicko Cadell</author>
  1058. </member>
  1059. <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator">
  1060. <summary>
  1061. Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  1062. </summary>
  1063. <exclude/>
  1064. </member>
  1065. <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current">
  1066. <summary>
  1067. Gets the current element in the collection.
  1068. </summary>
  1069. </member>
  1070. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext">
  1071. <summary>
  1072. Advances the enumerator to the next element in the collection.
  1073. </summary>
  1074. <returns>
  1075. <c>true</c> if the enumerator was successfully advanced to the next element;
  1076. <c>false</c> if the enumerator has passed the end of the collection.
  1077. </returns>
  1078. <exception cref="T:System.InvalidOperationException">
  1079. The collection was modified after the enumerator was created.
  1080. </exception>
  1081. </member>
  1082. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset">
  1083. <summary>
  1084. Sets the enumerator to its initial position, before the first element in the collection.
  1085. </summary>
  1086. </member>
  1087. <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)">
  1088. <summary>
  1089. Creates a read-only wrapper for a <c>AppenderCollection</c> instance.
  1090. </summary>
  1091. <param name="list">list to create a readonly wrapper arround</param>
  1092. <returns>
  1093. An <c>AppenderCollection</c> wrapper that is read-only.
  1094. </returns>
  1095. </member>
  1096. <member name="F:log4net.Appender.AppenderCollection.EmptyCollection">
  1097. <summary>
  1098. An empty readonly static AppenderCollection
  1099. </summary>
  1100. </member>
  1101. <member name="M:log4net.Appender.AppenderCollection.#ctor">
  1102. <summary>
  1103. Initializes a new instance of the <c>AppenderCollection</c> class
  1104. that is empty and has the default initial capacity.
  1105. </summary>
  1106. </member>
  1107. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)">
  1108. <summary>
  1109. Initializes a new instance of the <c>AppenderCollection</c> class
  1110. that has the specified initial capacity.
  1111. </summary>
  1112. <param name="capacity">
  1113. The number of elements that the new <c>AppenderCollection</c> is initially capable of storing.
  1114. </param>
  1115. </member>
  1116. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)">
  1117. <summary>
  1118. Initializes a new instance of the <c>AppenderCollection</c> class
  1119. that contains elements copied from the specified <c>AppenderCollection</c>.
  1120. </summary>
  1121. <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param>
  1122. </member>
  1123. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])">
  1124. <summary>
  1125. Initializes a new instance of the <c>AppenderCollection</c> class
  1126. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array.
  1127. </summary>
  1128. <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param>
  1129. </member>
  1130. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)">
  1131. <summary>
  1132. Initializes a new instance of the <c>AppenderCollection</c> class
  1133. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection.
  1134. </summary>
  1135. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param>
  1136. </member>
  1137. <member name="T:log4net.Appender.AppenderCollection.Tag">
  1138. <summary>
  1139. Type visible only to our subclasses
  1140. Used to access protected constructor
  1141. </summary>
  1142. <exclude/>
  1143. </member>
  1144. <member name="F:log4net.Appender.AppenderCollection.Tag.Default">
  1145. <summary>
  1146. A value
  1147. </summary>
  1148. </member>
  1149. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)">
  1150. <summary>
  1151. Allow subclasses to avoid our default constructors
  1152. </summary>
  1153. <param name="tag"></param>
  1154. <exclude/>
  1155. </member>
  1156. <member name="P:log4net.Appender.AppenderCollection.Count">
  1157. <summary>
  1158. Gets the number of elements actually contained in the <c>AppenderCollection</c>.
  1159. </summary>
  1160. </member>
  1161. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])">
  1162. <summary>
  1163. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  1164. <see cref="T:log4net.Appender.IAppender"/> array.
  1165. </summary>
  1166. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  1167. </member>
  1168. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)">
  1169. <summary>
  1170. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  1171. <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array.
  1172. </summary>
  1173. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  1174. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  1175. </member>
  1176. <member name="P:log4net.Appender.AppenderCollection.IsSynchronized">
  1177. <summary>
  1178. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  1179. </summary>
  1180. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  1181. </member>
  1182. <member name="P:log4net.Appender.AppenderCollection.SyncRoot">
  1183. <summary>
  1184. Gets an object that can be used to synchronize access to the collection.
  1185. </summary>
  1186. </member>
  1187. <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)">
  1188. <summary>
  1189. Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index.
  1190. </summary>
  1191. <param name="index">The zero-based index of the element to get or set.</param>
  1192. <exception cref="T:System.ArgumentOutOfRangeException">
  1193. <para><paramref name="index"/> is less than zero</para>
  1194. <para>-or-</para>
  1195. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1196. </exception>
  1197. </member>
  1198. <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)">
  1199. <summary>
  1200. Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>.
  1201. </summary>
  1202. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param>
  1203. <returns>The index at which the value has been added.</returns>
  1204. </member>
  1205. <member name="M:log4net.Appender.AppenderCollection.Clear">
  1206. <summary>
  1207. Removes all elements from the <c>AppenderCollection</c>.
  1208. </summary>
  1209. </member>
  1210. <member name="M:log4net.Appender.AppenderCollection.Clone">
  1211. <summary>
  1212. Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>.
  1213. </summary>
  1214. <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns>
  1215. </member>
  1216. <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)">
  1217. <summary>
  1218. Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>.
  1219. </summary>
  1220. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param>
  1221. <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns>
  1222. </member>
  1223. <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)">
  1224. <summary>
  1225. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/>
  1226. in the <c>AppenderCollection</c>.
  1227. </summary>
  1228. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param>
  1229. <returns>
  1230. The zero-based index of the first occurrence of <paramref name="item"/>
  1231. in the entire <c>AppenderCollection</c>, if found; otherwise, -1.
  1232. </returns>
  1233. </member>
  1234. <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)">
  1235. <summary>
  1236. Inserts an element into the <c>AppenderCollection</c> at the specified index.
  1237. </summary>
  1238. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  1239. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param>
  1240. <exception cref="T:System.ArgumentOutOfRangeException">
  1241. <para><paramref name="index"/> is less than zero</para>
  1242. <para>-or-</para>
  1243. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1244. </exception>
  1245. </member>
  1246. <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)">
  1247. <summary>
  1248. Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>.
  1249. </summary>
  1250. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param>
  1251. <exception cref="T:System.ArgumentException">
  1252. The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>.
  1253. </exception>
  1254. </member>
  1255. <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)">
  1256. <summary>
  1257. Removes the element at the specified index of the <c>AppenderCollection</c>.
  1258. </summary>
  1259. <param name="index">The zero-based index of the element to remove.</param>
  1260. <exception cref="T:System.ArgumentOutOfRangeException">
  1261. <para><paramref name="index"/> is less than zero</para>
  1262. <para>-or-</para>
  1263. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1264. </exception>
  1265. </member>
  1266. <member name="P:log4net.Appender.AppenderCollection.IsFixedSize">
  1267. <summary>
  1268. Gets a value indicating whether the collection has a fixed size.
  1269. </summary>
  1270. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  1271. </member>
  1272. <member name="P:log4net.Appender.AppenderCollection.IsReadOnly">
  1273. <summary>
  1274. Gets a value indicating whether the IList is read-only.
  1275. </summary>
  1276. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  1277. </member>
  1278. <member name="M:log4net.Appender.AppenderCollection.GetEnumerator">
  1279. <summary>
  1280. Returns an enumerator that can iterate through the <c>AppenderCollection</c>.
  1281. </summary>
  1282. <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns>
  1283. </member>
  1284. <member name="P:log4net.Appender.AppenderCollection.Capacity">
  1285. <summary>
  1286. Gets or sets the number of elements the <c>AppenderCollection</c> can contain.
  1287. </summary>
  1288. </member>
  1289. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)">
  1290. <summary>
  1291. Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>.
  1292. </summary>
  1293. <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param>
  1294. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1295. </member>
  1296. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])">
  1297. <summary>
  1298. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>.
  1299. </summary>
  1300. <param name="x">The <see cref="T:log4net.Appender.IAppender"/> array whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
  1301. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1302. </member>
  1303. <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)">
  1304. <summary>
  1305. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>.
  1306. </summary>
  1307. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
  1308. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1309. </member>
  1310. <member name="M:log4net.Appender.AppenderCollection.TrimToSize">
  1311. <summary>
  1312. Sets the capacity to the actual number of elements.
  1313. </summary>
  1314. </member>
  1315. <member name="M:log4net.Appender.AppenderCollection.ToArray">
  1316. <summary>
  1317. Return the collection elements as an array
  1318. </summary>
  1319. <returns>the array</returns>
  1320. </member>
  1321. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)">
  1322. <exception cref="T:System.ArgumentOutOfRangeException">
  1323. <para><paramref name="i"/> is less than zero</para>
  1324. <para>-or-</para>
  1325. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1326. </exception>
  1327. </member>
  1328. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)">
  1329. <exception cref="T:System.ArgumentOutOfRangeException">
  1330. <para><paramref name="i"/> is less than zero</para>
  1331. <para>-or-</para>
  1332. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1333. </exception>
  1334. </member>
  1335. <member name="T:log4net.Appender.AppenderCollection.Enumerator">
  1336. <summary>
  1337. Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  1338. </summary>
  1339. <exclude/>
  1340. </member>
  1341. <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)">
  1342. <summary>
  1343. Initializes a new instance of the <c>Enumerator</c> class.
  1344. </summary>
  1345. <param name="tc"></param>
  1346. </member>
  1347. <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current">
  1348. <summary>
  1349. Gets the current element in the collection.
  1350. </summary>
  1351. </member>
  1352. <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext">
  1353. <summary>
  1354. Advances the enumerator to the next element in the collection.
  1355. </summary>
  1356. <returns>
  1357. <c>true</c> if the enumerator was successfully advanced to the next element;
  1358. <c>false</c> if the enumerator has passed the end of the collection.
  1359. </returns>
  1360. <exception cref="T:System.InvalidOperationException">
  1361. The collection was modified after the enumerator was created.
  1362. </exception>
  1363. </member>
  1364. <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset">
  1365. <summary>
  1366. Sets the enumerator to its initial position, before the first element in the collection.
  1367. </summary>
  1368. </member>
  1369. <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection">
  1370. <exclude/>
  1371. </member>
  1372. <member name="T:log4net.Appender.AppenderSkeleton">
  1373. <summary>
  1374. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>.
  1375. </summary>
  1376. <remarks>
  1377. <para>
  1378. This class provides the code for common functionality, such
  1379. as support for threshold filtering and support for general filters.
  1380. </para>
  1381. <para>
  1382. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  1383. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  1384. be called after the appenders properties have been configured.
  1385. </para>
  1386. </remarks>
  1387. <author>Nicko Cadell</author>
  1388. <author>Gert Driesen</author>
  1389. </member>
  1390. <member name="M:log4net.Appender.AppenderSkeleton.#ctor">
  1391. <summary>
  1392. Default constructor
  1393. </summary>
  1394. <remarks>
  1395. <para>Empty default constructor</para>
  1396. </remarks>
  1397. </member>
  1398. <member name="M:log4net.Appender.AppenderSkeleton.Finalize">
  1399. <summary>
  1400. Finalizes this appender by calling the implementation's
  1401. <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
  1402. </summary>
  1403. <remarks>
  1404. <para>
  1405. If this appender has not been closed then the <c>Finalize</c> method
  1406. will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>.
  1407. </para>
  1408. </remarks>
  1409. </member>
  1410. <member name="P:log4net.Appender.AppenderSkeleton.Threshold">
  1411. <summary>
  1412. Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender.
  1413. </summary>
  1414. <value>
  1415. The threshold <see cref="T:log4net.Core.Level"/> of the appender.
  1416. </value>
  1417. <remarks>
  1418. <para>
  1419. All log events with lower level than the threshold level are ignored
  1420. by the appender.
  1421. </para>
  1422. <para>
  1423. In configuration files this option is specified by setting the
  1424. value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
  1425. string, such as "DEBUG", "INFO" and so on.
  1426. </para>
  1427. </remarks>
  1428. </member>
  1429. <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
  1430. <summary>
  1431. Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  1432. </summary>
  1433. <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value>
  1434. <remarks>
  1435. <para>
  1436. The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
  1437. implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
  1438. </para>
  1439. </remarks>
  1440. </member>
  1441. <member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
  1442. <summary>
  1443. The filter chain.
  1444. </summary>
  1445. <value>The head of the filter chain filter chain.</value>
  1446. <remarks>
  1447. <para>
  1448. Returns the head Filter. The Filters are organized in a linked list
  1449. and so all Filters on this Appender are available through the result.
  1450. </para>
  1451. </remarks>
  1452. </member>
  1453. <member name="P:log4net.Appender.AppenderSkeleton.Layout">
  1454. <summary>
  1455. Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
  1456. </summary>
  1457. <value>The layout of the appender.</value>
  1458. <remarks>
  1459. <para>
  1460. See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
  1461. </para>
  1462. </remarks>
  1463. <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
  1464. </member>
  1465. <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
  1466. <summary>
  1467. Initialize the appender based on the options set
  1468. </summary>
  1469. <remarks>
  1470. <para>
  1471. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  1472. activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must
  1473. be called on this object after the configuration properties have
  1474. been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this
  1475. object is in an undefined state and must not be used.
  1476. </para>
  1477. <para>
  1478. If any of the configuration properties are modified then
  1479. <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again.
  1480. </para>
  1481. </remarks>
  1482. </member>
  1483. <member name="P:log4net.Appender.AppenderSkeleton.Name">
  1484. <summary>
  1485. Gets or sets the name of this appender.
  1486. </summary>
  1487. <value>The name of the appender.</value>
  1488. <remarks>
  1489. <para>
  1490. The name uniquely identifies the appender.
  1491. </para>
  1492. </remarks>
  1493. </member>
  1494. <member name="M:log4net.Appender.AppenderSkeleton.Close">
  1495. <summary>
  1496. Closes the appender and release resources.
  1497. </summary>
  1498. <remarks>
  1499. <para>
  1500. Release any resources allocated within the appender such as file handles,
  1501. network connections, etc.
  1502. </para>
  1503. <para>
  1504. It is a programming error to append to a closed appender.
  1505. </para>
  1506. <para>
  1507. This method cannot be overridden by subclasses. This method
  1508. delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
  1509. method which must be overridden in the subclass.
  1510. </para>
  1511. </remarks>
  1512. </member>
  1513. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)">
  1514. <summary>
  1515. Performs threshold checks and invokes filters before
  1516. delegating actual logging to the subclasses specific
  1517. <see cref="M:Append(LoggingEvent)"/> method.
  1518. </summary>
  1519. <param name="loggingEvent">The event to log.</param>
  1520. <remarks>
  1521. <para>
  1522. This method cannot be overridden by derived classes. A
  1523. derived class should override the <see cref="M:Append(LoggingEvent)"/> method
  1524. which is called by this method.
  1525. </para>
  1526. <para>
  1527. The implementation of this method is as follows:
  1528. </para>
  1529. <para>
  1530. <list type="bullet">
  1531. <item>
  1532. <description>
  1533. Checks that the severity of the <paramref name="loggingEvent"/>
  1534. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1535. appender.</description>
  1536. </item>
  1537. <item>
  1538. <description>
  1539. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1540. <paramref name="loggingEvent"/>.
  1541. </description>
  1542. </item>
  1543. <item>
  1544. <description>
  1545. Calls <see cref="M:PreAppendCheck()"/> and checks that
  1546. it returns <c>true</c>.</description>
  1547. </item>
  1548. </list>
  1549. </para>
  1550. <para>
  1551. If all of the above steps succeed then the <paramref name="loggingEvent"/>
  1552. will be passed to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  1553. </para>
  1554. </remarks>
  1555. </member>
  1556. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
  1557. <summary>
  1558. Performs threshold checks and invokes filters before
  1559. delegating actual logging to the subclasses specific
  1560. <see cref="M:Append(LoggingEvent[])"/> method.
  1561. </summary>
  1562. <param name="loggingEvents">The array of events to log.</param>
  1563. <remarks>
  1564. <para>
  1565. This method cannot be overridden by derived classes. A
  1566. derived class should override the <see cref="M:Append(LoggingEvent[])"/> method
  1567. which is called by this method.
  1568. </para>
  1569. <para>
  1570. The implementation of this method is as follows:
  1571. </para>
  1572. <para>
  1573. <list type="bullet">
  1574. <item>
  1575. <description>
  1576. Checks that the severity of the <paramref name="loggingEvents"/>
  1577. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1578. appender.</description>
  1579. </item>
  1580. <item>
  1581. <description>
  1582. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1583. <paramref name="loggingEvents"/>.
  1584. </description>
  1585. </item>
  1586. <item>
  1587. <description>
  1588. Calls <see cref="M:PreAppendCheck()"/> and checks that
  1589. it returns <c>true</c>.</description>
  1590. </item>
  1591. </list>
  1592. </para>
  1593. <para>
  1594. If all of the above steps succeed then the <paramref name="loggingEvents"/>
  1595. will be passed to the <see cref="M:Append(LoggingEvent[])"/> method.
  1596. </para>
  1597. </remarks>
  1598. </member>
  1599. <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
  1600. <summary>
  1601. Test if the logging event should we output by this appender
  1602. </summary>
  1603. <param name="loggingEvent">the event to test</param>
  1604. <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
  1605. <remarks>
  1606. <para>
  1607. This method checks the logging event against the threshold level set
  1608. on this appender and also against the filters specified on this
  1609. appender.
  1610. </para>
  1611. <para>
  1612. The implementation of this method is as follows:
  1613. </para>
  1614. <para>
  1615. <list type="bullet">
  1616. <item>
  1617. <description>
  1618. Checks that the severity of the <paramref name="loggingEvent"/>
  1619. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1620. appender.</description>
  1621. </item>
  1622. <item>
  1623. <description>
  1624. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1625. <paramref name="loggingEvent"/>.
  1626. </description>
  1627. </item>
  1628. </list>
  1629. </para>
  1630. </remarks>
  1631. </member>
  1632. <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
  1633. <summary>
  1634. Adds a filter to the end of the filter chain.
  1635. </summary>
  1636. <param name="filter">the filter to add to this appender</param>
  1637. <remarks>
  1638. <para>
  1639. The Filters are organized in a linked list.
  1640. </para>
  1641. <para>
  1642. Setting this property causes the new filter to be pushed onto the
  1643. back of the filter chain.
  1644. </para>
  1645. </remarks>
  1646. </member>
  1647. <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
  1648. <summary>
  1649. Clears the filter list for this appender.
  1650. </summary>
  1651. <remarks>
  1652. <para>
  1653. Clears the filter list for this appender.
  1654. </para>
  1655. </remarks>
  1656. </member>
  1657. <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)">
  1658. <summary>
  1659. Checks if the message level is below this appender's threshold.
  1660. </summary>
  1661. <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param>
  1662. <remarks>
  1663. <para>
  1664. If there is no threshold set, then the return value is always <c>true</c>.
  1665. </para>
  1666. </remarks>
  1667. <returns>
  1668. <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
  1669. requirements of this appender.
  1670. </returns>
  1671. </member>
  1672. <member name="M:log4net.Appender.AppenderSkeleton.OnClose">
  1673. <summary>
  1674. Is called when the appender is closed. Derived classes should override
  1675. this method if resources need to be released.
  1676. </summary>
  1677. <remarks>
  1678. <para>
  1679. Releases any resources allocated within the appender such as file handles,
  1680. network connections, etc.
  1681. </para>
  1682. <para>
  1683. It is a programming error to append to a closed appender.
  1684. </para>
  1685. </remarks>
  1686. </member>
  1687. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  1688. <summary>
  1689. Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
  1690. to perform actual logging.
  1691. </summary>
  1692. <param name="loggingEvent">The event to append.</param>
  1693. <remarks>
  1694. <para>
  1695. A subclass must implement this method to perform
  1696. logging of the <paramref name="loggingEvent"/>.
  1697. </para>
  1698. <para>This method will be called by <see cref="M:DoAppend(LoggingEvent)"/>
  1699. if all the conditions listed for that method are met.
  1700. </para>
  1701. <para>
  1702. To restrict the logging of events in the appender
  1703. override the <see cref="M:PreAppendCheck()"/> method.
  1704. </para>
  1705. </remarks>
  1706. </member>
  1707. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
  1708. <summary>
  1709. Append a bulk array of logging events.
  1710. </summary>
  1711. <param name="loggingEvents">the array of logging events</param>
  1712. <remarks>
  1713. <para>
  1714. This base class implementation calls the <see cref="M:Append(LoggingEvent)"/>
  1715. method for each element in the bulk array.
  1716. </para>
  1717. <para>
  1718. A sub class that can better process a bulk array of events should
  1719. override this method in addition to <see cref="M:Append(LoggingEvent)"/>.
  1720. </para>
  1721. </remarks>
  1722. </member>
  1723. <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
  1724. <summary>
  1725. Called before <see cref="M:Append(LoggingEvent)"/> as a precondition.
  1726. </summary>
  1727. <remarks>
  1728. <para>
  1729. This method is called by <see cref="M:DoAppend(LoggingEvent)"/>
  1730. before the call to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  1731. </para>
  1732. <para>
  1733. This method can be overridden in a subclass to extend the checks
  1734. made before the event is passed to the <see cref="M:Append(LoggingEvent)"/> method.
  1735. </para>
  1736. <para>
  1737. A subclass should ensure that they delegate this call to
  1738. this base class if it is overridden.
  1739. </para>
  1740. </remarks>
  1741. <returns><c>true</c> if the call to <see cref="M:Append(LoggingEvent)"/> should proceed.</returns>
  1742. </member>
  1743. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)">
  1744. <summary>
  1745. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  1746. </summary>
  1747. <param name="loggingEvent">The event to render.</param>
  1748. <returns>The event rendered as a string.</returns>
  1749. <remarks>
  1750. <para>
  1751. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  1752. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  1753. set to render the <paramref name="loggingEvent"/> to
  1754. a string.
  1755. </para>
  1756. <para>If there is exception data in the logging event and
  1757. the layout does not process the exception, this method
  1758. will append the exception text to the rendered string.
  1759. </para>
  1760. <para>
  1761. Where possible use the alternative version of this method
  1762. <see cref="M:RenderLoggingEvent(TextWriter,LoggingEvent)"/>.
  1763. That method streams the rendering onto an existing Writer
  1764. which can give better performance if the caller already has
  1765. a <see cref="T:System.IO.TextWriter"/> open and ready for writing.
  1766. </para>
  1767. </remarks>
  1768. </member>
  1769. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  1770. <summary>
  1771. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  1772. </summary>
  1773. <param name="loggingEvent">The event to render.</param>
  1774. <param name="writer">The TextWriter to write the formatted event to</param>
  1775. <remarks>
  1776. <para>
  1777. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  1778. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  1779. set to render the <paramref name="loggingEvent"/> to
  1780. a string.
  1781. </para>
  1782. <para>If there is exception data in the logging event and
  1783. the layout does not process the exception, this method
  1784. will append the exception text to the rendered string.
  1785. </para>
  1786. <para>
  1787. Use this method in preference to <see cref="M:RenderLoggingEvent(LoggingEvent)"/>
  1788. where possible. If, however, the caller needs to render the event
  1789. to a string then <see cref="M:RenderLoggingEvent(LoggingEvent)"/> does
  1790. provide an efficient mechanism for doing so.
  1791. </para>
  1792. </remarks>
  1793. </member>
  1794. <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
  1795. <summary>
  1796. Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  1797. </summary>
  1798. <remarks>
  1799. <para>
  1800. In the rather exceptional case, where the appender
  1801. implementation admits a layout but can also work without it,
  1802. then the appender should return <c>true</c>.
  1803. </para>
  1804. <para>
  1805. This default implementation always returns <c>false</c>.
  1806. </para>
  1807. </remarks>
  1808. <returns>
  1809. <c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
  1810. </returns>
  1811. </member>
  1812. <member name="M:log4net.Appender.AppenderSkeleton.Flush(System.Int32)">
  1813. <summary>
  1814. Flushes any buffered log data.
  1815. </summary>
  1816. <remarks>
  1817. This implementation doesn't flush anything and always returns true
  1818. </remarks>
  1819. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  1820. </member>
  1821. <member name="F:log4net.Appender.AppenderSkeleton.m_layout">
  1822. <summary>
  1823. The layout of this appender.
  1824. </summary>
  1825. <remarks>
  1826. See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
  1827. </remarks>
  1828. </member>
  1829. <member name="F:log4net.Appender.AppenderSkeleton.m_name">
  1830. <summary>
  1831. The name of this appender.
  1832. </summary>
  1833. <remarks>
  1834. See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
  1835. </remarks>
  1836. </member>
  1837. <member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
  1838. <summary>
  1839. The level threshold of this appender.
  1840. </summary>
  1841. <remarks>
  1842. <para>
  1843. There is no level threshold filtering by default.
  1844. </para>
  1845. <para>
  1846. See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
  1847. </para>
  1848. </remarks>
  1849. </member>
  1850. <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
  1851. <summary>
  1852. It is assumed and enforced that errorHandler is never null.
  1853. </summary>
  1854. <remarks>
  1855. <para>
  1856. It is assumed and enforced that errorHandler is never null.
  1857. </para>
  1858. <para>
  1859. See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
  1860. </para>
  1861. </remarks>
  1862. </member>
  1863. <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
  1864. <summary>
  1865. The first filter in the filter chain.
  1866. </summary>
  1867. <remarks>
  1868. <para>
  1869. Set to <c>null</c> initially.
  1870. </para>
  1871. <para>
  1872. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  1873. </para>
  1874. </remarks>
  1875. </member>
  1876. <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
  1877. <summary>
  1878. The last filter in the filter chain.
  1879. </summary>
  1880. <remarks>
  1881. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  1882. </remarks>
  1883. </member>
  1884. <member name="F:log4net.Appender.AppenderSkeleton.m_closed">
  1885. <summary>
  1886. Flag indicating if this appender is closed.
  1887. </summary>
  1888. <remarks>
  1889. See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
  1890. </remarks>
  1891. </member>
  1892. <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
  1893. <summary>
  1894. The guard prevents an appender from repeatedly calling its own DoAppend method
  1895. </summary>
  1896. </member>
  1897. <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter">
  1898. <summary>
  1899. StringWriter used to render events
  1900. </summary>
  1901. </member>
  1902. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize">
  1903. <summary>
  1904. Initial buffer size
  1905. </summary>
  1906. </member>
  1907. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity">
  1908. <summary>
  1909. Maximum buffer size before it is recycled
  1910. </summary>
  1911. </member>
  1912. <member name="F:log4net.Appender.AppenderSkeleton.declaringType">
  1913. <summary>
  1914. The fully qualified type of the AppenderSkeleton class.
  1915. </summary>
  1916. <remarks>
  1917. Used by the internal logger to record the Type of the
  1918. log message.
  1919. </remarks>
  1920. </member>
  1921. <member name="T:log4net.Appender.BufferingAppenderSkeleton">
  1922. <summary>
  1923. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that
  1924. buffers events in a fixed size buffer.
  1925. </summary>
  1926. <remarks>
  1927. <para>
  1928. This base class should be used by appenders that need to buffer a
  1929. number of events before logging them.
  1930. For example the <see cref="T:log4net.Appender.AdoNetAppender"/>
  1931. buffers events and then submits the entire contents of the buffer to
  1932. the underlying database in one go.
  1933. </para>
  1934. <para>
  1935. Subclasses should override the <see cref="M:SendBuffer(LoggingEvent[])"/>
  1936. method to deliver the buffered events.
  1937. </para>
  1938. <para>The BufferingAppenderSkeleton maintains a fixed size cyclic
  1939. buffer of events. The size of the buffer is set using
  1940. the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property.
  1941. </para>
  1942. <para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect
  1943. each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  1944. triggers, then the current buffer is sent immediately
  1945. (see <see cref="M:SendBuffer(LoggingEvent[])"/>). Otherwise the event
  1946. is stored in the buffer. For example, an evaluator can be used to
  1947. deliver the events immediately when an ERROR event arrives.
  1948. </para>
  1949. <para>
  1950. The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode.
  1951. By default the appender is NOT lossy. When the buffer is full all
  1952. the buffered events are sent with <see cref="M:SendBuffer(LoggingEvent[])"/>.
  1953. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the
  1954. buffer will not be sent when it is full, and new events arriving
  1955. in the appender will overwrite the oldest event in the buffer.
  1956. In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  1957. triggers. This can be useful behavior when you need to know about
  1958. ERROR events but not about events with a lower level, configure an
  1959. evaluator that will trigger when an ERROR event arrives, the whole
  1960. buffer will be sent which gives a history of events leading up to
  1961. the ERROR event.
  1962. </para>
  1963. </remarks>
  1964. <author>Nicko Cadell</author>
  1965. <author>Gert Driesen</author>
  1966. </member>
  1967. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
  1968. <summary>
  1969. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton" /> class.
  1970. </summary>
  1971. <remarks>
  1972. <para>
  1973. Protected default constructor to allow subclassing.
  1974. </para>
  1975. </remarks>
  1976. </member>
  1977. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
  1978. <summary>
  1979. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton" /> class.
  1980. </summary>
  1981. <param name="eventMustBeFixed">the events passed through this appender must be
  1982. fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param>
  1983. <remarks>
  1984. <para>
  1985. Protected constructor to allow subclassing.
  1986. </para>
  1987. <para>
  1988. The <paramref name="eventMustBeFixed"/> should be set if the subclass
  1989. expects the events delivered to be fixed even if the
  1990. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs.
  1991. </para>
  1992. </remarks>
  1993. </member>
  1994. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
  1995. <summary>
  1996. Gets or sets a value that indicates whether the appender is lossy.
  1997. </summary>
  1998. <value>
  1999. <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
  2000. </value>
  2001. <remarks>
  2002. <para>
  2003. This appender uses a buffer to store logging events before
  2004. delivering them. A triggering event causes the whole buffer
  2005. to be send to the remote sink. If the buffer overruns before
  2006. a triggering event then logging events could be lost. Set
  2007. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
  2008. from being lost.
  2009. </para>
  2010. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  2011. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  2012. </remarks>
  2013. </member>
  2014. <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
  2015. <summary>
  2016. Gets or sets the size of the cyclic buffer used to hold the
  2017. logging events.
  2018. </summary>
  2019. <value>
  2020. The size of the cyclic buffer used to hold the logging events.
  2021. </value>
  2022. <remarks>
  2023. <para>
  2024. The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
  2025. representing the maximum number of logging events to collect in
  2026. a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
  2027. oldest events are deleted as new events are added to the
  2028. buffer. By default the size of the cyclic buffer is 512 events.
  2029. </para>
  2030. <para>
  2031. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than
  2032. or equal to 1 then no buffering will occur. The logging event
  2033. will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>
  2034. and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will
  2035. be buffered.
  2036. </para>
  2037. </remarks>
  2038. </member>
  2039. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
  2040. <summary>
  2041. Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the
  2042. buffer to be sent immediately.
  2043. </summary>
  2044. <value>
  2045. The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be
  2046. sent immediately.
  2047. </value>
  2048. <remarks>
  2049. <para>
  2050. The evaluator will be called for each event that is appended to this
  2051. appender. If the evaluator triggers then the current buffer will
  2052. immediately be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  2053. </para>
  2054. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  2055. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  2056. </remarks>
  2057. </member>
  2058. <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
  2059. <summary>
  2060. Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  2061. </summary>
  2062. <value>
  2063. The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  2064. </value>
  2065. <remarks>
  2066. <para>
  2067. The evaluator will be called for each event that is discarded from this
  2068. appender. If the evaluator triggers then the current buffer will immediately
  2069. be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  2070. </para>
  2071. </remarks>
  2072. </member>
  2073. <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
  2074. <summary>
  2075. Gets or sets a value indicating if only part of the logging event data
  2076. should be fixed.
  2077. </summary>
  2078. <value>
  2079. <c>true</c> if the appender should only fix part of the logging event
  2080. data, otherwise <c>false</c>. The default is <c>false</c>.
  2081. </value>
  2082. <remarks>
  2083. <para>
  2084. Setting this property to <c>true</c> will cause only part of the
  2085. event data to be fixed and serialized. This will improve performance.
  2086. </para>
  2087. <para>
  2088. See <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/> for more information.
  2089. </para>
  2090. </remarks>
  2091. </member>
  2092. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
  2093. <summary>
  2094. Gets or sets a the fields that will be fixed in the event
  2095. </summary>
  2096. <value>
  2097. The event fields that will be fixed before the event is buffered
  2098. </value>
  2099. <remarks>
  2100. <para>
  2101. The logging event needs to have certain thread specific values
  2102. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  2103. for details.
  2104. </para>
  2105. </remarks>
  2106. <seealso cref="P:log4net.Core.LoggingEvent.Fix"/>
  2107. </member>
  2108. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Int32)">
  2109. <summary>
  2110. Flushes any buffered log data.
  2111. </summary>
  2112. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  2113. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  2114. </member>
  2115. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
  2116. <summary>
  2117. Flush the currently buffered events
  2118. </summary>
  2119. <remarks>
  2120. <para>
  2121. Flushes any events that have been buffered.
  2122. </para>
  2123. <para>
  2124. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  2125. of the buffer will NOT be flushed to the appender.
  2126. </para>
  2127. </remarks>
  2128. </member>
  2129. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
  2130. <summary>
  2131. Flush the currently buffered events
  2132. </summary>
  2133. <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
  2134. <remarks>
  2135. <para>
  2136. Flushes events that have been buffered. If <paramref name="flushLossyBuffer" /> is
  2137. <c>false</c> then events will only be flushed if this buffer is non-lossy mode.
  2138. </para>
  2139. <para>
  2140. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  2141. of the buffer will only be flushed if <paramref name="flushLossyBuffer" /> is <c>true</c>.
  2142. In this case the contents of the buffer will be tested against the
  2143. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
  2144. events will be discarded.
  2145. </para>
  2146. <para>
  2147. If <paramref name="flushLossyBuffer" /> is <c>true</c> then the buffer will always
  2148. be emptied by calling this method.
  2149. </para>
  2150. </remarks>
  2151. </member>
  2152. <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
  2153. <summary>
  2154. Initialize the appender based on the options set
  2155. </summary>
  2156. <remarks>
  2157. <para>
  2158. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  2159. activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must
  2160. be called on this object after the configuration properties have
  2161. been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this
  2162. object is in an undefined state and must not be used.
  2163. </para>
  2164. <para>
  2165. If any of the configuration properties are modified then
  2166. <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again.
  2167. </para>
  2168. </remarks>
  2169. </member>
  2170. <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
  2171. <summary>
  2172. Close this appender instance.
  2173. </summary>
  2174. <remarks>
  2175. <para>
  2176. Close this appender instance. If this appender is marked
  2177. as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
  2178. the buffer must be sent when the appender is closed.
  2179. </para>
  2180. </remarks>
  2181. </member>
  2182. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  2183. <summary>
  2184. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  2185. </summary>
  2186. <param name="loggingEvent">the event to log</param>
  2187. <remarks>
  2188. <para>
  2189. Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
  2190. </para>
  2191. <para>
  2192. The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
  2193. method) if one of the following conditions is met:
  2194. </para>
  2195. <list type="bullet">
  2196. <item>
  2197. <description>The cyclic buffer is full and this appender is
  2198. marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
  2199. </item>
  2200. <item>
  2201. <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
  2202. it is triggered for the <paramref name="loggingEvent"/>
  2203. specified.</description>
  2204. </item>
  2205. </list>
  2206. <para>
  2207. Before the event is stored in the buffer it is fixed
  2208. (see <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/>) to ensure that
  2209. any data referenced by the event will be valid when the buffer
  2210. is processed.
  2211. </para>
  2212. </remarks>
  2213. </member>
  2214. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
  2215. <summary>
  2216. Sends the contents of the buffer.
  2217. </summary>
  2218. <param name="firstLoggingEvent">The first logging event.</param>
  2219. <param name="buffer">The buffer containing the events that need to be send.</param>
  2220. <remarks>
  2221. <para>
  2222. The subclass must override <see cref="M:SendBuffer(LoggingEvent[])"/>.
  2223. </para>
  2224. </remarks>
  2225. </member>
  2226. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
  2227. <summary>
  2228. Sends the events.
  2229. </summary>
  2230. <param name="events">The events that need to be send.</param>
  2231. <remarks>
  2232. <para>
  2233. The subclass must override this method to process the buffered events.
  2234. </para>
  2235. </remarks>
  2236. </member>
  2237. <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
  2238. <summary>
  2239. The default buffer size.
  2240. </summary>
  2241. <remarks>
  2242. The default size of the cyclic buffer used to store events.
  2243. This is set to 512 by default.
  2244. </remarks>
  2245. </member>
  2246. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
  2247. <summary>
  2248. The size of the cyclic buffer used to hold the logging events.
  2249. </summary>
  2250. <remarks>
  2251. Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
  2252. </remarks>
  2253. </member>
  2254. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
  2255. <summary>
  2256. The cyclic buffer used to store the logging events.
  2257. </summary>
  2258. </member>
  2259. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
  2260. <summary>
  2261. The triggering event evaluator that causes the buffer to be sent immediately.
  2262. </summary>
  2263. <remarks>
  2264. The object that is used to determine if an event causes the entire
  2265. buffer to be sent immediately. This field can be <c>null</c>, which
  2266. indicates that event triggering is not to be done. The evaluator
  2267. can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
  2268. has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
  2269. <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
  2270. </remarks>
  2271. </member>
  2272. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
  2273. <summary>
  2274. Indicates if the appender should overwrite events in the cyclic buffer
  2275. when it becomes full, or if the buffer should be flushed when the
  2276. buffer is full.
  2277. </summary>
  2278. <remarks>
  2279. If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
  2280. be set.
  2281. </remarks>
  2282. </member>
  2283. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
  2284. <summary>
  2285. The triggering event evaluator filters discarded events.
  2286. </summary>
  2287. <remarks>
  2288. The object that is used to determine if an event that is discarded should
  2289. really be discarded or if it should be sent to the appenders.
  2290. This field can be <c>null</c>, which indicates that all discarded events will
  2291. be discarded.
  2292. </remarks>
  2293. </member>
  2294. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
  2295. <summary>
  2296. Value indicating which fields in the event should be fixed
  2297. </summary>
  2298. <remarks>
  2299. By default all fields are fixed
  2300. </remarks>
  2301. </member>
  2302. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
  2303. <summary>
  2304. The events delivered to the subclass must be fixed.
  2305. </summary>
  2306. </member>
  2307. <member name="T:log4net.Appender.BufferingForwardingAppender">
  2308. <summary>
  2309. Buffers events and then forwards them to attached appenders.
  2310. </summary>
  2311. <remarks>
  2312. <para>
  2313. The events are buffered in this appender until conditions are
  2314. met to allow the appender to deliver the events to the attached
  2315. appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the
  2316. conditions that cause the buffer to be sent.
  2317. </para>
  2318. <para>The forwarding appender can be used to specify different
  2319. thresholds and filters for the same appender at different locations
  2320. within the hierarchy.
  2321. </para>
  2322. </remarks>
  2323. <author>Nicko Cadell</author>
  2324. <author>Gert Driesen</author>
  2325. </member>
  2326. <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor">
  2327. <summary>
  2328. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender" /> class.
  2329. </summary>
  2330. <remarks>
  2331. <para>
  2332. Default constructor.
  2333. </para>
  2334. </remarks>
  2335. </member>
  2336. <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose">
  2337. <summary>
  2338. Closes the appender and releases resources.
  2339. </summary>
  2340. <remarks>
  2341. <para>
  2342. Releases any resources allocated within the appender such as file handles,
  2343. network connections, etc.
  2344. </para>
  2345. <para>
  2346. It is a programming error to append to a closed appender.
  2347. </para>
  2348. </remarks>
  2349. </member>
  2350. <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  2351. <summary>
  2352. Send the events.
  2353. </summary>
  2354. <param name="events">The events that need to be send.</param>
  2355. <remarks>
  2356. <para>
  2357. Forwards the events to the attached appenders.
  2358. </para>
  2359. </remarks>
  2360. </member>
  2361. <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  2362. <summary>
  2363. Adds an <see cref="T:log4net.Appender.IAppender" /> to the list of appenders of this
  2364. instance.
  2365. </summary>
  2366. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender" /> to add to this appender.</param>
  2367. <remarks>
  2368. <para>
  2369. If the specified <see cref="T:log4net.Appender.IAppender" /> is already in the list of
  2370. appenders, then it won't be added again.
  2371. </para>
  2372. </remarks>
  2373. </member>
  2374. <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders">
  2375. <summary>
  2376. Gets the appenders contained in this appender as an
  2377. <see cref="T:System.Collections.ICollection"/>.
  2378. </summary>
  2379. <remarks>
  2380. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  2381. is returned.
  2382. </remarks>
  2383. <returns>
  2384. A collection of the appenders in this appender.
  2385. </returns>
  2386. </member>
  2387. <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)">
  2388. <summary>
  2389. Looks for the appender with the specified name.
  2390. </summary>
  2391. <param name="name">The name of the appender to lookup.</param>
  2392. <returns>
  2393. The appender with the specified name, or <c>null</c>.
  2394. </returns>
  2395. <remarks>
  2396. <para>
  2397. Get the named appender attached to this buffering appender.
  2398. </para>
  2399. </remarks>
  2400. </member>
  2401. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders">
  2402. <summary>
  2403. Removes all previously added appenders from this appender.
  2404. </summary>
  2405. <remarks>
  2406. <para>
  2407. This is useful when re-reading configuration information.
  2408. </para>
  2409. </remarks>
  2410. </member>
  2411. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  2412. <summary>
  2413. Removes the specified appender from the list of appenders.
  2414. </summary>
  2415. <param name="appender">The appender to remove.</param>
  2416. <returns>The appender removed from the list</returns>
  2417. <remarks>
  2418. The appender removed is not closed.
  2419. If you are discarding the appender you must call
  2420. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2421. </remarks>
  2422. </member>
  2423. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)">
  2424. <summary>
  2425. Removes the appender with the specified name from the list of appenders.
  2426. </summary>
  2427. <param name="name">The name of the appender to remove.</param>
  2428. <returns>The appender removed from the list</returns>
  2429. <remarks>
  2430. The appender removed is not closed.
  2431. If you are discarding the appender you must call
  2432. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2433. </remarks>
  2434. </member>
  2435. <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl">
  2436. <summary>
  2437. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  2438. </summary>
  2439. </member>
  2440. <member name="T:log4net.Appender.ColoredConsoleAppender">
  2441. <summary>
  2442. Appends logging events to the console.
  2443. </summary>
  2444. <remarks>
  2445. <para>
  2446. ColoredConsoleAppender appends log events to the standard output stream
  2447. or the error output stream using a layout specified by the
  2448. user. It also allows the color of a specific type of message to be set.
  2449. </para>
  2450. <para>
  2451. By default, all output is written to the console's standard output stream.
  2452. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> property can be set to direct the output to the
  2453. error stream.
  2454. </para>
  2455. <para>
  2456. NOTE: This appender writes directly to the application's attached console
  2457. not to the <c>System.Console.Out</c> or <c>System.Console.Error</c> <c>TextWriter</c>.
  2458. The <c>System.Console.Out</c> and <c>System.Console.Error</c> streams can be
  2459. programmatically redirected (for example NUnit does this to capture program output).
  2460. This appender will ignore these redirections because it needs to use Win32
  2461. API calls to colorize the output. To respect these redirections the <see cref="T:log4net.Appender.ConsoleAppender"/>
  2462. must be used.
  2463. </para>
  2464. <para>
  2465. When configuring the colored console appender, mapping should be
  2466. specified to map a logging level to a color. For example:
  2467. </para>
  2468. <code lang="XML" escaped="true">
  2469. <mapping>
  2470. <level value="ERROR" />
  2471. <foreColor value="White" />
  2472. <backColor value="Red, HighIntensity" />
  2473. </mapping>
  2474. <mapping>
  2475. <level value="DEBUG" />
  2476. <backColor value="Green" />
  2477. </mapping>
  2478. </code>
  2479. <para>
  2480. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  2481. combination of the following values:
  2482. <list type="bullet">
  2483. <item><term>Blue</term><description></description></item>
  2484. <item><term>Green</term><description></description></item>
  2485. <item><term>Red</term><description></description></item>
  2486. <item><term>White</term><description></description></item>
  2487. <item><term>Yellow</term><description></description></item>
  2488. <item><term>Purple</term><description></description></item>
  2489. <item><term>Cyan</term><description></description></item>
  2490. <item><term>HighIntensity</term><description></description></item>
  2491. </list>
  2492. </para>
  2493. </remarks>
  2494. <author>Rick Hobbs</author>
  2495. <author>Nicko Cadell</author>
  2496. </member>
  2497. <member name="T:log4net.Appender.ColoredConsoleAppender.Colors">
  2498. <summary>
  2499. The enum of possible color values for use with the color mapping method
  2500. </summary>
  2501. <remarks>
  2502. <para>
  2503. The following flags can be combined together to
  2504. form the colors.
  2505. </para>
  2506. </remarks>
  2507. <seealso cref="T:log4net.Appender.ColoredConsoleAppender" />
  2508. </member>
  2509. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Blue">
  2510. <summary>
  2511. color is blue
  2512. </summary>
  2513. </member>
  2514. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Green">
  2515. <summary>
  2516. color is green
  2517. </summary>
  2518. </member>
  2519. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Red">
  2520. <summary>
  2521. color is red
  2522. </summary>
  2523. </member>
  2524. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.White">
  2525. <summary>
  2526. color is white
  2527. </summary>
  2528. </member>
  2529. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Yellow">
  2530. <summary>
  2531. color is yellow
  2532. </summary>
  2533. </member>
  2534. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Purple">
  2535. <summary>
  2536. color is purple
  2537. </summary>
  2538. </member>
  2539. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Cyan">
  2540. <summary>
  2541. color is cyan
  2542. </summary>
  2543. </member>
  2544. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.HighIntensity">
  2545. <summary>
  2546. color is intensified
  2547. </summary>
  2548. </member>
  2549. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor">
  2550. <summary>
  2551. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender" /> class.
  2552. </summary>
  2553. <remarks>
  2554. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender" /> class is set up to write
  2555. to the standard output stream.
  2556. </remarks>
  2557. </member>
  2558. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout)">
  2559. <summary>
  2560. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender" /> class
  2561. with the specified layout.
  2562. </summary>
  2563. <param name="layout">the layout to use for this appender</param>
  2564. <remarks>
  2565. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender" /> class is set up to write
  2566. to the standard output stream.
  2567. </remarks>
  2568. </member>
  2569. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  2570. <summary>
  2571. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender" /> class
  2572. with the specified layout.
  2573. </summary>
  2574. <param name="layout">the layout to use for this appender</param>
  2575. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  2576. <remarks>
  2577. When <paramref name="writeToErrorStream" /> is set to <c>true</c>, output is written to
  2578. the standard error output stream. Otherwise, output is written to the standard
  2579. output stream.
  2580. </remarks>
  2581. </member>
  2582. <member name="P:log4net.Appender.ColoredConsoleAppender.Target">
  2583. <summary>
  2584. Target is the value of the console output stream.
  2585. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2586. </summary>
  2587. <value>
  2588. Target is the value of the console output stream.
  2589. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2590. </value>
  2591. <remarks>
  2592. <para>
  2593. Target is the value of the console output stream.
  2594. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2595. </para>
  2596. </remarks>
  2597. </member>
  2598. <member name="M:log4net.Appender.ColoredConsoleAppender.AddMapping(log4net.Appender.ColoredConsoleAppender.LevelColors)">
  2599. <summary>
  2600. Add a mapping of level to color - done by the config file
  2601. </summary>
  2602. <param name="mapping">The mapping to add</param>
  2603. <remarks>
  2604. <para>
  2605. Add a <see cref="T:log4net.Appender.ColoredConsoleAppender.LevelColors"/> mapping to this appender.
  2606. Each mapping defines the foreground and background colors
  2607. for a level.
  2608. </para>
  2609. </remarks>
  2610. </member>
  2611. <member name="M:log4net.Appender.ColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  2612. <summary>
  2613. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  2614. </summary>
  2615. <param name="loggingEvent">The event to log.</param>
  2616. <remarks>
  2617. <para>
  2618. Writes the event to the console.
  2619. </para>
  2620. <para>
  2621. The format of the output will depend on the appender's layout.
  2622. </para>
  2623. </remarks>
  2624. </member>
  2625. <member name="P:log4net.Appender.ColoredConsoleAppender.RequiresLayout">
  2626. <summary>
  2627. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2628. </summary>
  2629. <value><c>true</c></value>
  2630. <remarks>
  2631. <para>
  2632. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2633. </para>
  2634. </remarks>
  2635. </member>
  2636. <member name="M:log4net.Appender.ColoredConsoleAppender.ActivateOptions">
  2637. <summary>
  2638. Initialize the options for this appender
  2639. </summary>
  2640. <remarks>
  2641. <para>
  2642. Initialize the level to color mappings set on this appender.
  2643. </para>
  2644. </remarks>
  2645. </member>
  2646. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleOut">
  2647. <summary>
  2648. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2649. standard output stream.
  2650. </summary>
  2651. <remarks>
  2652. <para>
  2653. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2654. standard output stream.
  2655. </para>
  2656. </remarks>
  2657. </member>
  2658. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleError">
  2659. <summary>
  2660. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2661. standard error output stream.
  2662. </summary>
  2663. <remarks>
  2664. <para>
  2665. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2666. standard error output stream.
  2667. </para>
  2668. </remarks>
  2669. </member>
  2670. <member name="F:log4net.Appender.ColoredConsoleAppender.m_writeToErrorStream">
  2671. <summary>
  2672. Flag to write output to the error stream rather than the standard output stream
  2673. </summary>
  2674. </member>
  2675. <member name="F:log4net.Appender.ColoredConsoleAppender.m_levelMapping">
  2676. <summary>
  2677. Mapping from level object to color value
  2678. </summary>
  2679. </member>
  2680. <member name="F:log4net.Appender.ColoredConsoleAppender.m_consoleOutputWriter">
  2681. <summary>
  2682. The console output stream writer to write to
  2683. </summary>
  2684. <remarks>
  2685. <para>
  2686. This writer is not thread safe.
  2687. </para>
  2688. </remarks>
  2689. </member>
  2690. <member name="T:log4net.Appender.ColoredConsoleAppender.LevelColors">
  2691. <summary>
  2692. A class to act as a mapping between the level that a logging call is made at and
  2693. the color it should be displayed as.
  2694. </summary>
  2695. <remarks>
  2696. <para>
  2697. Defines the mapping between a level and the color it should be displayed in.
  2698. </para>
  2699. </remarks>
  2700. </member>
  2701. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor">
  2702. <summary>
  2703. The mapped foreground color for the specified level
  2704. </summary>
  2705. <remarks>
  2706. <para>
  2707. Required property.
  2708. The mapped foreground color for the specified level.
  2709. </para>
  2710. </remarks>
  2711. </member>
  2712. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor">
  2713. <summary>
  2714. The mapped background color for the specified level
  2715. </summary>
  2716. <remarks>
  2717. <para>
  2718. Required property.
  2719. The mapped background color for the specified level.
  2720. </para>
  2721. </remarks>
  2722. </member>
  2723. <member name="M:log4net.Appender.ColoredConsoleAppender.LevelColors.ActivateOptions">
  2724. <summary>
  2725. Initialize the options for the object
  2726. </summary>
  2727. <remarks>
  2728. <para>
  2729. Combine the <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> together.
  2730. </para>
  2731. </remarks>
  2732. </member>
  2733. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.CombinedColor">
  2734. <summary>
  2735. The combined <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> suitable for
  2736. setting the console color.
  2737. </summary>
  2738. </member>
  2739. <member name="T:log4net.Appender.ConsoleAppender">
  2740. <summary>
  2741. Appends logging events to the console.
  2742. </summary>
  2743. <remarks>
  2744. <para>
  2745. ConsoleAppender appends log events to the standard output stream
  2746. or the error output stream using a layout specified by the
  2747. user.
  2748. </para>
  2749. <para>
  2750. By default, all output is written to the console's standard output stream.
  2751. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
  2752. error stream.
  2753. </para>
  2754. <para>
  2755. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  2756. <c>System.Console.Error</c> that is set at the time the event is appended.
  2757. Therefore it is possible to programmatically redirect the output of this appender
  2758. (for example NUnit does this to capture program output). While this is the desired
  2759. behavior of this appender it may have security implications in your application.
  2760. </para>
  2761. </remarks>
  2762. <author>Nicko Cadell</author>
  2763. <author>Gert Driesen</author>
  2764. </member>
  2765. <member name="M:log4net.Appender.ConsoleAppender.#ctor">
  2766. <summary>
  2767. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class.
  2768. </summary>
  2769. <remarks>
  2770. The instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class is set up to write
  2771. to the standard output stream.
  2772. </remarks>
  2773. </member>
  2774. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
  2775. <summary>
  2776. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class
  2777. with the specified layout.
  2778. </summary>
  2779. <param name="layout">the layout to use for this appender</param>
  2780. <remarks>
  2781. The instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class is set up to write
  2782. to the standard output stream.
  2783. </remarks>
  2784. </member>
  2785. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  2786. <summary>
  2787. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class
  2788. with the specified layout.
  2789. </summary>
  2790. <param name="layout">the layout to use for this appender</param>
  2791. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  2792. <remarks>
  2793. When <paramref name="writeToErrorStream" /> is set to <c>true</c>, output is written to
  2794. the standard error output stream. Otherwise, output is written to the standard
  2795. output stream.
  2796. </remarks>
  2797. </member>
  2798. <member name="P:log4net.Appender.ConsoleAppender.Target">
  2799. <summary>
  2800. Target is the value of the console output stream.
  2801. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2802. </summary>
  2803. <value>
  2804. Target is the value of the console output stream.
  2805. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2806. </value>
  2807. <remarks>
  2808. <para>
  2809. Target is the value of the console output stream.
  2810. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2811. </para>
  2812. </remarks>
  2813. </member>
  2814. <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
  2815. <summary>
  2816. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  2817. </summary>
  2818. <param name="loggingEvent">The event to log.</param>
  2819. <remarks>
  2820. <para>
  2821. Writes the event to the console.
  2822. </para>
  2823. <para>
  2824. The format of the output will depend on the appender's layout.
  2825. </para>
  2826. </remarks>
  2827. </member>
  2828. <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
  2829. <summary>
  2830. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2831. </summary>
  2832. <value><c>true</c></value>
  2833. <remarks>
  2834. <para>
  2835. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2836. </para>
  2837. </remarks>
  2838. </member>
  2839. <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
  2840. <summary>
  2841. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2842. standard output stream.
  2843. </summary>
  2844. <remarks>
  2845. <para>
  2846. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2847. standard output stream.
  2848. </para>
  2849. </remarks>
  2850. </member>
  2851. <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
  2852. <summary>
  2853. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2854. standard error output stream.
  2855. </summary>
  2856. <remarks>
  2857. <para>
  2858. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2859. standard error output stream.
  2860. </para>
  2861. </remarks>
  2862. </member>
  2863. <member name="T:log4net.Appender.DebugAppender">
  2864. <summary>
  2865. Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
  2866. </summary>
  2867. <remarks>
  2868. <para>
  2869. The application configuration file can be used to control what listeners
  2870. are actually used. See the MSDN documentation for the
  2871. <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
  2872. debug system.
  2873. </para>
  2874. <para>
  2875. Events are written using the <see cref="M:System.Diagnostics.Debug.Write(string,string)"/>
  2876. method. The event's logger name is passed as the value for the category name to the Write method.
  2877. </para>
  2878. </remarks>
  2879. <author>Nicko Cadell</author>
  2880. </member>
  2881. <member name="M:log4net.Appender.DebugAppender.#ctor">
  2882. <summary>
  2883. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender" />.
  2884. </summary>
  2885. <remarks>
  2886. <para>
  2887. Default constructor.
  2888. </para>
  2889. </remarks>
  2890. </member>
  2891. <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
  2892. <summary>
  2893. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender" />
  2894. with a specified layout.
  2895. </summary>
  2896. <param name="layout">The layout to use with this appender.</param>
  2897. <remarks>
  2898. <para>
  2899. Obsolete constructor.
  2900. </para>
  2901. </remarks>
  2902. </member>
  2903. <member name="P:log4net.Appender.DebugAppender.ImmediateFlush">
  2904. <summary>
  2905. Gets or sets a value that indicates whether the appender will
  2906. flush at the end of each write.
  2907. </summary>
  2908. <remarks>
  2909. <para>The default behavior is to flush at the end of each
  2910. write. If the option is set to<c>false</c>, then the underlying
  2911. stream can defer writing to physical medium to a later time.
  2912. </para>
  2913. <para>
  2914. Avoiding the flush operation at the end of each append results
  2915. in a performance gain of 10 to 20 percent. However, there is safety
  2916. trade-off involved in skipping flushing. Indeed, when flushing is
  2917. skipped, then it is likely that the last few log events will not
  2918. be recorded on disk when the application exits. This is a high
  2919. price to pay even for a 20% performance gain.
  2920. </para>
  2921. </remarks>
  2922. </member>
  2923. <member name="P:log4net.Appender.DebugAppender.Category">
  2924. <summary>
  2925. Formats the category parameter sent to the Debug method.
  2926. </summary>
  2927. <remarks>
  2928. <para>
  2929. Defaults to a <see cref="T:log4net.Layout.PatternLayout"/> with %logger as the pattern which will use the logger name of the current
  2930. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  2931. </para>
  2932. <para>
  2933. </para>
  2934. </remarks>
  2935. </member>
  2936. <member name="M:log4net.Appender.DebugAppender.Flush(System.Int32)">
  2937. <summary>
  2938. Flushes any buffered log data.
  2939. </summary>
  2940. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  2941. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  2942. </member>
  2943. <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
  2944. <summary>
  2945. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  2946. </summary>
  2947. <param name="loggingEvent">The event to log.</param>
  2948. <remarks>
  2949. <para>
  2950. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  2951. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/>
  2952. is called.
  2953. </para>
  2954. </remarks>
  2955. </member>
  2956. <member name="P:log4net.Appender.DebugAppender.RequiresLayout">
  2957. <summary>
  2958. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2959. </summary>
  2960. <value><c>true</c></value>
  2961. <remarks>
  2962. <para>
  2963. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2964. </para>
  2965. </remarks>
  2966. </member>
  2967. <member name="F:log4net.Appender.DebugAppender.m_immediateFlush">
  2968. <summary>
  2969. Immediate flush means that the underlying writer or output stream
  2970. will be flushed at the end of each append operation.
  2971. </summary>
  2972. <remarks>
  2973. <para>
  2974. Immediate flush is slower but ensures that each append request is
  2975. actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to
  2976. <c>false</c>, then there is a good chance that the last few
  2977. logs events are not actually written to persistent media if and
  2978. when the application crashes.
  2979. </para>
  2980. <para>
  2981. The default value is <c>true</c>.</para>
  2982. </remarks>
  2983. </member>
  2984. <member name="F:log4net.Appender.DebugAppender.m_category">
  2985. <summary>
  2986. Defaults to a <see cref="T:log4net.Layout.PatternLayout"/> with %logger as the pattern.
  2987. </summary>
  2988. </member>
  2989. <member name="T:log4net.Appender.EventLogAppender">
  2990. <summary>
  2991. Writes events to the system event log.
  2992. </summary>
  2993. <remarks>
  2994. <para>
  2995. 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.
  2996. See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog
  2997. </para>
  2998. <para>
  2999. The <c>EventID</c> of the event log entry can be
  3000. set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3001. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3002. </para>
  3003. <para>
  3004. The <c>Category</c> of the event log entry can be
  3005. set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3006. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3007. </para>
  3008. <para>
  3009. There is a limit of 32K characters for an event log message
  3010. </para>
  3011. <para>
  3012. When configuring the EventLogAppender a mapping can be
  3013. specified to map a logging level to an event log entry type. For example:
  3014. </para>
  3015. <code lang="XML">
  3016. &lt;mapping&gt;
  3017. &lt;level value="ERROR" /&gt;
  3018. &lt;eventLogEntryType value="Error" /&gt;
  3019. &lt;/mapping&gt;
  3020. &lt;mapping&gt;
  3021. &lt;level value="DEBUG" /&gt;
  3022. &lt;eventLogEntryType value="Information" /&gt;
  3023. &lt;/mapping&gt;
  3024. </code>
  3025. <para>
  3026. The Level is the standard log4net logging level and eventLogEntryType can be any value
  3027. from the <see cref="T:System.Diagnostics.EventLogEntryType"/> enum, i.e.:
  3028. <list type="bullet">
  3029. <item><term>Error</term><description>an error event</description></item>
  3030. <item><term>Warning</term><description>a warning event</description></item>
  3031. <item><term>Information</term><description>an informational event</description></item>
  3032. </list>
  3033. </para>
  3034. </remarks>
  3035. <author>Aspi Havewala</author>
  3036. <author>Douglas de la Torre</author>
  3037. <author>Nicko Cadell</author>
  3038. <author>Gert Driesen</author>
  3039. <author>Thomas Voss</author>
  3040. </member>
  3041. <member name="M:log4net.Appender.EventLogAppender.#ctor">
  3042. <summary>
  3043. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender" /> class.
  3044. </summary>
  3045. <remarks>
  3046. <para>
  3047. Default constructor.
  3048. </para>
  3049. </remarks>
  3050. </member>
  3051. <member name="M:log4net.Appender.EventLogAppender.#ctor(log4net.Layout.ILayout)">
  3052. <summary>
  3053. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender" /> class
  3054. with the specified <see cref="T:log4net.Layout.ILayout" />.
  3055. </summary>
  3056. <param name="layout">The <see cref="T:log4net.Layout.ILayout" /> to use with this appender.</param>
  3057. <remarks>
  3058. <para>
  3059. Obsolete constructor.
  3060. </para>
  3061. </remarks>
  3062. </member>
  3063. <member name="P:log4net.Appender.EventLogAppender.LogName">
  3064. <summary>
  3065. The name of the log where messages will be stored.
  3066. </summary>
  3067. <value>
  3068. The string name of the log where messages will be stored.
  3069. </value>
  3070. <remarks>
  3071. <para>This is the name of the log as it appears in the Event Viewer
  3072. tree. The default value is to log into the <c>Application</c>
  3073. log, this is where most applications write their events. However
  3074. if you need a separate log for your application (or applications)
  3075. then you should set the <see cref="P:log4net.Appender.EventLogAppender.LogName"/> appropriately.</para>
  3076. <para>This should not be used to distinguish your event log messages
  3077. from those of other applications, the <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>
  3078. property should be used to distinguish events. This property should be
  3079. used to group together events into a single log.
  3080. </para>
  3081. </remarks>
  3082. </member>
  3083. <member name="P:log4net.Appender.EventLogAppender.ApplicationName">
  3084. <summary>
  3085. Property used to set the Application name. This appears in the
  3086. event logs when logging.
  3087. </summary>
  3088. <value>
  3089. The string used to distinguish events from different sources.
  3090. </value>
  3091. <remarks>
  3092. Sets the event log source property.
  3093. </remarks>
  3094. </member>
  3095. <member name="P:log4net.Appender.EventLogAppender.MachineName">
  3096. <summary>
  3097. This property is used to return the name of the computer to use
  3098. when accessing the event logs. Currently, this is the current
  3099. computer, denoted by a dot "."
  3100. </summary>
  3101. <value>
  3102. The string name of the machine holding the event log that
  3103. will be logged into.
  3104. </value>
  3105. <remarks>
  3106. This property cannot be changed. It is currently set to '.'
  3107. i.e. the local machine. This may be changed in future.
  3108. </remarks>
  3109. </member>
  3110. <member name="M:log4net.Appender.EventLogAppender.AddMapping(log4net.Appender.EventLogAppender.Level2EventLogEntryType)">
  3111. <summary>
  3112. Add a mapping of level to <see cref="T:System.Diagnostics.EventLogEntryType"/> - done by the config file
  3113. </summary>
  3114. <param name="mapping">The mapping to add</param>
  3115. <remarks>
  3116. <para>
  3117. Add a <see cref="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"/> mapping to this appender.
  3118. Each mapping defines the event log entry type for a level.
  3119. </para>
  3120. </remarks>
  3121. </member>
  3122. <member name="P:log4net.Appender.EventLogAppender.SecurityContext">
  3123. <summary>
  3124. Gets or sets the <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3125. </summary>
  3126. <value>
  3127. The <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3128. </value>
  3129. <remarks>
  3130. <para>
  3131. The system security context used to write to the EventLog.
  3132. </para>
  3133. <para>
  3134. Unless a <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> specified here for this appender
  3135. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  3136. security context to use. The default behavior is to use the security context
  3137. of the current thread.
  3138. </para>
  3139. </remarks>
  3140. </member>
  3141. <member name="P:log4net.Appender.EventLogAppender.EventId">
  3142. <summary>
  3143. Gets or sets the <c>EventId</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3144. </summary>
  3145. <remarks>
  3146. <para>
  3147. The <c>EventID</c> of the event log entry will normally be
  3148. set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3149. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3150. This property provides the fallback value which defaults to 0.
  3151. </para>
  3152. </remarks>
  3153. </member>
  3154. <member name="P:log4net.Appender.EventLogAppender.Category">
  3155. <summary>
  3156. Gets or sets the <c>Category</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3157. </summary>
  3158. <remarks>
  3159. <para>
  3160. The <c>Category</c> of the event log entry will normally be
  3161. set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3162. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3163. This property provides the fallback value which defaults to 0.
  3164. </para>
  3165. </remarks>
  3166. </member>
  3167. <member name="M:log4net.Appender.EventLogAppender.ActivateOptions">
  3168. <summary>
  3169. Initialize the appender based on the options set
  3170. </summary>
  3171. <remarks>
  3172. <para>
  3173. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3174. activation scheme. The <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> method must
  3175. be called on this object after the configuration properties have
  3176. been set. Until <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> is called this
  3177. object is in an undefined state and must not be used.
  3178. </para>
  3179. <para>
  3180. If any of the configuration properties are modified then
  3181. <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> must be called again.
  3182. </para>
  3183. </remarks>
  3184. </member>
  3185. <member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)">
  3186. <summary>
  3187. Create an event log source
  3188. </summary>
  3189. <remarks>
  3190. Uses different API calls under NET_2_0
  3191. </remarks>
  3192. </member>
  3193. <member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)">
  3194. <summary>
  3195. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3196. method.
  3197. </summary>
  3198. <param name="loggingEvent">the event to log</param>
  3199. <remarks>
  3200. <para>Writes the event to the system event log using the
  3201. <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>.</para>
  3202. <para>If the event has an <c>EventID</c> property (see <see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3203. set then this integer will be used as the event log event id.</para>
  3204. <para>
  3205. There is a limit of 32K characters for an event log message
  3206. </para>
  3207. </remarks>
  3208. </member>
  3209. <member name="P:log4net.Appender.EventLogAppender.RequiresLayout">
  3210. <summary>
  3211. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3212. </summary>
  3213. <value><c>true</c></value>
  3214. <remarks>
  3215. <para>
  3216. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3217. </para>
  3218. </remarks>
  3219. </member>
  3220. <member name="M:log4net.Appender.EventLogAppender.GetEntryType(log4net.Core.Level)">
  3221. <summary>
  3222. Get the equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/>
  3223. </summary>
  3224. <param name="level">the Level to convert to an EventLogEntryType</param>
  3225. <returns>The equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/></returns>
  3226. <remarks>
  3227. Because there are fewer applicable <see cref="T:System.Diagnostics.EventLogEntryType"/>
  3228. values to use in logging levels than there are in the
  3229. <see cref="T:log4net.Core.Level"/> this is a one way mapping. There is
  3230. a loss of information during the conversion.
  3231. </remarks>
  3232. </member>
  3233. <member name="F:log4net.Appender.EventLogAppender.m_logName">
  3234. <summary>
  3235. The log name is the section in the event logs where the messages
  3236. are stored.
  3237. </summary>
  3238. </member>
  3239. <member name="F:log4net.Appender.EventLogAppender.m_applicationName">
  3240. <summary>
  3241. Name of the application to use when logging. This appears in the
  3242. application column of the event log named by <see cref="F:log4net.Appender.EventLogAppender.m_logName"/>.
  3243. </summary>
  3244. </member>
  3245. <member name="F:log4net.Appender.EventLogAppender.m_machineName">
  3246. <summary>
  3247. The name of the machine which holds the event log. This is
  3248. currently only allowed to be '.' i.e. the current machine.
  3249. </summary>
  3250. </member>
  3251. <member name="F:log4net.Appender.EventLogAppender.m_levelMapping">
  3252. <summary>
  3253. Mapping from level object to EventLogEntryType
  3254. </summary>
  3255. </member>
  3256. <member name="F:log4net.Appender.EventLogAppender.m_securityContext">
  3257. <summary>
  3258. The security context to use for privileged calls
  3259. </summary>
  3260. </member>
  3261. <member name="F:log4net.Appender.EventLogAppender.m_eventId">
  3262. <summary>
  3263. The event ID to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3264. </summary>
  3265. </member>
  3266. <member name="F:log4net.Appender.EventLogAppender.m_category">
  3267. <summary>
  3268. The event category to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3269. </summary>
  3270. </member>
  3271. <member name="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType">
  3272. <summary>
  3273. A class to act as a mapping between the level that a logging call is made at and
  3274. the color it should be displayed as.
  3275. </summary>
  3276. <remarks>
  3277. <para>
  3278. Defines the mapping between a level and its event log entry type.
  3279. </para>
  3280. </remarks>
  3281. </member>
  3282. <member name="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType">
  3283. <summary>
  3284. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3285. </summary>
  3286. <remarks>
  3287. <para>
  3288. Required property.
  3289. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3290. </para>
  3291. </remarks>
  3292. </member>
  3293. <member name="F:log4net.Appender.EventLogAppender.declaringType">
  3294. <summary>
  3295. The fully qualified type of the EventLogAppender class.
  3296. </summary>
  3297. <remarks>
  3298. Used by the internal logger to record the Type of the
  3299. log message.
  3300. </remarks>
  3301. </member>
  3302. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_DEFAULT">
  3303. <summary>
  3304. The maximum size supported by default.
  3305. </summary>
  3306. <remarks>
  3307. http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx
  3308. The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766
  3309. may leave space for a two byte null terminator of #0#0). The 32766 max
  3310. length is what the .NET 4.0 source code checks for, but this is WRONG!
  3311. Strings with a length > 31839 on Windows Vista or higher can CORRUPT
  3312. the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent()
  3313. for the use of the 32766 max size.
  3314. </remarks>
  3315. </member>
  3316. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_VISTA_OR_NEWER">
  3317. <summary>
  3318. The maximum size supported by a windows operating system that is vista
  3319. or newer.
  3320. </summary>
  3321. <remarks>
  3322. See ReportEvent API:
  3323. http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx
  3324. ReportEvent's lpStrings parameter:
  3325. "A pointer to a buffer containing an array of
  3326. null-terminated strings that are merged into the message before Event Viewer
  3327. displays the string to the user. This parameter must be a valid pointer
  3328. (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters."
  3329. Going beyond the size of 31839 will (at some point) corrupt the event log on Windows
  3330. Vista or higher! It may succeed for a while...but you will eventually run into the
  3331. error: "System.ComponentModel.Win32Exception : A device attached to the system is
  3332. not functioning", and the event log will then be corrupt (I was able to corrupt
  3333. an event log using a length of 31877 on Windows 7).
  3334. The max size for Windows Vista or higher is documented here:
  3335. http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx.
  3336. Going over this size may succeed a few times but the buffer will overrun and
  3337. eventually corrupt the log (based on testing).
  3338. The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API.
  3339. The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a
  3340. terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the
  3341. buffer, given enough time).
  3342. </remarks>
  3343. </member>
  3344. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE">
  3345. <summary>
  3346. The maximum size that the operating system supports for
  3347. a event log message.
  3348. </summary>
  3349. <remarks>
  3350. Used to determine the maximum string length that can be written
  3351. to the operating system event log and eventually truncate a string
  3352. that exceeds the limits.
  3353. </remarks>
  3354. </member>
  3355. <member name="M:log4net.Appender.EventLogAppender.GetMaxEventLogMessageSize">
  3356. <summary>
  3357. This method determines the maximum event log message size allowed for
  3358. the current environment.
  3359. </summary>
  3360. <returns></returns>
  3361. </member>
  3362. <member name="T:log4net.Appender.FileAppender">
  3363. <summary>
  3364. Appends logging events to a file.
  3365. </summary>
  3366. <remarks>
  3367. <para>
  3368. Logging events are sent to the file specified by
  3369. the <see cref="P:log4net.Appender.FileAppender.File"/> property.
  3370. </para>
  3371. <para>
  3372. The file can be opened in either append or overwrite mode
  3373. by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property.
  3374. If the file path is relative it is taken as relative from
  3375. the application base directory. The file encoding can be
  3376. specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property.
  3377. </para>
  3378. <para>
  3379. The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  3380. values will be written each time the file is opened and closed
  3381. respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/>
  3382. then the file may contain multiple copies of the header and footer.
  3383. </para>
  3384. <para>
  3385. This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/>
  3386. is called. This will typically be during configuration.
  3387. If the file cannot be opened for writing the appender will attempt
  3388. to open the file again each time a message is logged to the appender.
  3389. If the file cannot be opened for writing when a message is logged then
  3390. the message will be discarded by this appender.
  3391. </para>
  3392. <para>
  3393. The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via
  3394. the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property.
  3395. The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>
  3396. is to obtain an exclusive write lock on the file until this appender is closed.
  3397. The alternative models only hold a
  3398. write lock while the appender is writing a logging event (<see cref="T:log4net.Appender.FileAppender.MinimalLock"/>)
  3399. or synchronize by using a named system wide Mutex (<see cref="T:log4net.Appender.FileAppender.InterProcessLock"/>).
  3400. </para>
  3401. <para>
  3402. All locking strategies have issues and you should seriously consider using a different strategy that
  3403. avoids having multiple processes logging to the same file.
  3404. </para>
  3405. </remarks>
  3406. <author>Nicko Cadell</author>
  3407. <author>Gert Driesen</author>
  3408. <author>Rodrigo B. de Oliveira</author>
  3409. <author>Douglas de la Torre</author>
  3410. <author>Niall Daley</author>
  3411. </member>
  3412. <member name="T:log4net.Appender.FileAppender.LockingStream">
  3413. <summary>
  3414. Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/>
  3415. to manage access to an underlying resource.
  3416. </summary>
  3417. </member>
  3418. <member name="M:log4net.Appender.FileAppender.LockingStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
  3419. <summary>
  3420. True asynchronous writes are not supported, the implementation forces a synchronous write.
  3421. </summary>
  3422. </member>
  3423. <member name="T:log4net.Appender.FileAppender.LockingModelBase">
  3424. <summary>
  3425. Locking model base class
  3426. </summary>
  3427. <remarks>
  3428. <para>
  3429. Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers.
  3430. </para>
  3431. </remarks>
  3432. </member>
  3433. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  3434. <summary>
  3435. Open the output file
  3436. </summary>
  3437. <param name="filename">The filename to use</param>
  3438. <param name="append">Whether to append to the file, or overwrite</param>
  3439. <param name="encoding">The encoding to use</param>
  3440. <remarks>
  3441. <para>
  3442. Open the file specified and prepare for logging.
  3443. No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called.
  3444. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>,
  3445. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>.
  3446. </para>
  3447. </remarks>
  3448. </member>
  3449. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile">
  3450. <summary>
  3451. Close the file
  3452. </summary>
  3453. <remarks>
  3454. <para>
  3455. Close the file. No further writes will be made.
  3456. </para>
  3457. </remarks>
  3458. </member>
  3459. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ActivateOptions">
  3460. <summary>
  3461. Initializes all resources used by this locking model.
  3462. </summary>
  3463. </member>
  3464. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OnClose">
  3465. <summary>
  3466. Disposes all resources that were initialized by this locking model.
  3467. </summary>
  3468. </member>
  3469. <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock">
  3470. <summary>
  3471. Acquire the lock on the file
  3472. </summary>
  3473. <returns>A stream that is ready to be written to.</returns>
  3474. <remarks>
  3475. <para>
  3476. Acquire the lock on the file in preparation for writing to it.
  3477. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/>
  3478. must be called to release the lock on the output file.
  3479. </para>
  3480. </remarks>
  3481. </member>
  3482. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock">
  3483. <summary>
  3484. Release the lock on the file
  3485. </summary>
  3486. <remarks>
  3487. <para>
  3488. Release the lock on the file. No further writes will be made to the
  3489. stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again.
  3490. </para>
  3491. </remarks>
  3492. </member>
  3493. <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender">
  3494. <summary>
  3495. Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  3496. </summary>
  3497. <value>
  3498. The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  3499. </value>
  3500. <remarks>
  3501. <para>
  3502. The file appender this locking model is attached to and working on
  3503. behalf of.
  3504. </para>
  3505. <para>
  3506. The file appender is used to locate the security context and the error handler to use.
  3507. </para>
  3508. <para>
  3509. 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
  3510. called.
  3511. </para>
  3512. </remarks>
  3513. </member>
  3514. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CreateStream(System.String,System.Boolean,System.IO.FileShare)">
  3515. <summary>
  3516. Helper method that creates a FileStream under CurrentAppender's SecurityContext.
  3517. </summary>
  3518. <remarks>
  3519. <para>
  3520. Typically called during OpenFile or AcquireLock.
  3521. </para>
  3522. <para>
  3523. If the directory portion of the <paramref name="filename"/> does not exist, it is created
  3524. via Directory.CreateDirecctory.
  3525. </para>
  3526. </remarks>
  3527. <param name="filename"></param>
  3528. <param name="append"></param>
  3529. <param name="fileShare"></param>
  3530. <returns></returns>
  3531. </member>
  3532. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseStream(System.IO.Stream)">
  3533. <summary>
  3534. Helper method to close <paramref name="stream"/> under CurrentAppender's SecurityContext.
  3535. </summary>
  3536. <remarks>
  3537. Does not set <paramref name="stream"/> to null.
  3538. </remarks>
  3539. <param name="stream"></param>
  3540. </member>
  3541. <member name="T:log4net.Appender.FileAppender.ExclusiveLock">
  3542. <summary>
  3543. Hold an exclusive lock on the output file
  3544. </summary>
  3545. <remarks>
  3546. <para>
  3547. Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called.
  3548. Maintains an exclusive lock on the file during this time.
  3549. </para>
  3550. </remarks>
  3551. </member>
  3552. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  3553. <summary>
  3554. Open the file specified and prepare for logging.
  3555. </summary>
  3556. <param name="filename">The filename to use</param>
  3557. <param name="append">Whether to append to the file, or overwrite</param>
  3558. <param name="encoding">The encoding to use</param>
  3559. <remarks>
  3560. <para>
  3561. Open the file specified and prepare for logging.
  3562. No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called.
  3563. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>,
  3564. <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>.
  3565. </para>
  3566. </remarks>
  3567. </member>
  3568. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile">
  3569. <summary>
  3570. Close the file
  3571. </summary>
  3572. <remarks>
  3573. <para>
  3574. Close the file. No further writes will be made.
  3575. </para>
  3576. </remarks>
  3577. </member>
  3578. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock">
  3579. <summary>
  3580. Acquire the lock on the file
  3581. </summary>
  3582. <returns>A stream that is ready to be written to.</returns>
  3583. <remarks>
  3584. <para>
  3585. Does nothing. The lock is already taken
  3586. </para>
  3587. </remarks>
  3588. </member>
  3589. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock">
  3590. <summary>
  3591. Release the lock on the file
  3592. </summary>
  3593. <remarks>
  3594. <para>
  3595. Does nothing. The lock will be released when the file is closed.
  3596. </para>
  3597. </remarks>
  3598. </member>
  3599. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ActivateOptions">
  3600. <summary>
  3601. Initializes all resources used by this locking model.
  3602. </summary>
  3603. </member>
  3604. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OnClose">
  3605. <summary>
  3606. Disposes all resources that were initialized by this locking model.
  3607. </summary>
  3608. </member>
  3609. <member name="T:log4net.Appender.FileAppender.MinimalLock">
  3610. <summary>
  3611. Acquires the file lock for each write
  3612. </summary>
  3613. <remarks>
  3614. <para>
  3615. Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle,
  3616. thus holding the lock for the minimal amount of time. This method of locking
  3617. is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows
  3618. other processes to move/delete the log file whilst logging continues.
  3619. </para>
  3620. </remarks>
  3621. </member>
  3622. <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  3623. <summary>
  3624. Prepares to open the file when the first message is logged.
  3625. </summary>
  3626. <param name="filename">The filename to use</param>
  3627. <param name="append">Whether to append to the file, or overwrite</param>
  3628. <param name="encoding">The encoding to use</param>
  3629. <remarks>
  3630. <para>
  3631. Open the file specified and prepare for logging.
  3632. No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called.
  3633. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>,
  3634. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>.
  3635. </para>
  3636. </remarks>
  3637. </member>
  3638. <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile">
  3639. <summary>
  3640. Close the file
  3641. </summary>
  3642. <remarks>
  3643. <para>
  3644. Close the file. No further writes will be made.
  3645. </para>
  3646. </remarks>
  3647. </member>
  3648. <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock">
  3649. <summary>
  3650. Acquire the lock on the file
  3651. </summary>
  3652. <returns>A stream that is ready to be written to.</returns>
  3653. <remarks>
  3654. <para>
  3655. Acquire the lock on the file in preparation for writing to it.
  3656. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/>
  3657. must be called to release the lock on the output file.
  3658. </para>
  3659. </remarks>
  3660. </member>
  3661. <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock">
  3662. <summary>
  3663. Release the lock on the file
  3664. </summary>
  3665. <remarks>
  3666. <para>
  3667. Release the lock on the file. No further writes will be made to the
  3668. stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again.
  3669. </para>
  3670. </remarks>
  3671. </member>
  3672. <member name="M:log4net.Appender.FileAppender.MinimalLock.ActivateOptions">
  3673. <summary>
  3674. Initializes all resources used by this locking model.
  3675. </summary>
  3676. </member>
  3677. <member name="M:log4net.Appender.FileAppender.MinimalLock.OnClose">
  3678. <summary>
  3679. Disposes all resources that were initialized by this locking model.
  3680. </summary>
  3681. </member>
  3682. <member name="T:log4net.Appender.FileAppender.InterProcessLock">
  3683. <summary>
  3684. Provides cross-process file locking.
  3685. </summary>
  3686. <author>Ron Grabowski</author>
  3687. <author>Steve Wranovsky</author>
  3688. </member>
  3689. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  3690. <summary>
  3691. Open the file specified and prepare for logging.
  3692. </summary>
  3693. <param name="filename">The filename to use</param>
  3694. <param name="append">Whether to append to the file, or overwrite</param>
  3695. <param name="encoding">The encoding to use</param>
  3696. <remarks>
  3697. <para>
  3698. Open the file specified and prepare for logging.
  3699. No writes will be made until <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/> is called.
  3700. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/>,
  3701. -<see cref="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"/>.
  3702. </para>
  3703. </remarks>
  3704. </member>
  3705. <member name="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile">
  3706. <summary>
  3707. Close the file
  3708. </summary>
  3709. <remarks>
  3710. <para>
  3711. Close the file. No further writes will be made.
  3712. </para>
  3713. </remarks>
  3714. </member>
  3715. <member name="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock">
  3716. <summary>
  3717. Acquire the lock on the file
  3718. </summary>
  3719. <returns>A stream that is ready to be written to.</returns>
  3720. <remarks>
  3721. <para>
  3722. Does nothing. The lock is already taken
  3723. </para>
  3724. </remarks>
  3725. </member>
  3726. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock">
  3727. <summary>
  3728. Releases the lock and allows others to acquire a lock.
  3729. </summary>
  3730. </member>
  3731. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ActivateOptions">
  3732. <summary>
  3733. Initializes all resources used by this locking model.
  3734. </summary>
  3735. </member>
  3736. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OnClose">
  3737. <summary>
  3738. Disposes all resources that were initialized by this locking model.
  3739. </summary>
  3740. </member>
  3741. <member name="M:log4net.Appender.FileAppender.#ctor">
  3742. <summary>
  3743. Default constructor
  3744. </summary>
  3745. <remarks>
  3746. <para>
  3747. Default constructor
  3748. </para>
  3749. </remarks>
  3750. </member>
  3751. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)">
  3752. <summary>
  3753. Construct a new appender using the layout, file and append mode.
  3754. </summary>
  3755. <param name="layout">the layout to use with this appender</param>
  3756. <param name="filename">the full path to the file to write to</param>
  3757. <param name="append">flag to indicate if the file should be appended to</param>
  3758. <remarks>
  3759. <para>
  3760. Obsolete constructor.
  3761. </para>
  3762. </remarks>
  3763. </member>
  3764. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)">
  3765. <summary>
  3766. Construct a new appender using the layout and file specified.
  3767. The file will be appended to.
  3768. </summary>
  3769. <param name="layout">the layout to use with this appender</param>
  3770. <param name="filename">the full path to the file to write to</param>
  3771. <remarks>
  3772. <para>
  3773. Obsolete constructor.
  3774. </para>
  3775. </remarks>
  3776. </member>
  3777. <member name="P:log4net.Appender.FileAppender.File">
  3778. <summary>
  3779. Gets or sets the path to the file that logging will be written to.
  3780. </summary>
  3781. <value>
  3782. The path to the file that logging will be written to.
  3783. </value>
  3784. <remarks>
  3785. <para>
  3786. If the path is relative it is taken as relative from
  3787. the application base directory.
  3788. </para>
  3789. </remarks>
  3790. </member>
  3791. <member name="P:log4net.Appender.FileAppender.AppendToFile">
  3792. <summary>
  3793. Gets or sets a flag that indicates whether the file should be
  3794. appended to or overwritten.
  3795. </summary>
  3796. <value>
  3797. Indicates whether the file should be appended to or overwritten.
  3798. </value>
  3799. <remarks>
  3800. <para>
  3801. If the value is set to false then the file will be overwritten, if
  3802. it is set to true then the file will be appended to.
  3803. </para>
  3804. The default value is true.
  3805. </remarks>
  3806. </member>
  3807. <member name="P:log4net.Appender.FileAppender.Encoding">
  3808. <summary>
  3809. Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  3810. </summary>
  3811. <value>
  3812. The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  3813. </value>
  3814. <remarks>
  3815. <para>
  3816. The default encoding set is <see cref="P:System.Text.Encoding.Default"/>
  3817. which is the encoding for the system's current ANSI code page.
  3818. </para>
  3819. </remarks>
  3820. </member>
  3821. <member name="P:log4net.Appender.FileAppender.SecurityContext">
  3822. <summary>
  3823. Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  3824. </summary>
  3825. <value>
  3826. The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  3827. </value>
  3828. <remarks>
  3829. <para>
  3830. Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender
  3831. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  3832. security context to use. The default behavior is to use the security context
  3833. of the current thread.
  3834. </para>
  3835. </remarks>
  3836. </member>
  3837. <member name="P:log4net.Appender.FileAppender.LockingModel">
  3838. <summary>
  3839. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  3840. </summary>
  3841. <value>
  3842. The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file.
  3843. </value>
  3844. <remarks>
  3845. <para>
  3846. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  3847. </para>
  3848. <para>
  3849. 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"/> .
  3850. The first locks the file from the start of logging to the end, the
  3851. second locks only for the minimal amount of time when logging each message
  3852. and the last synchronizes processes using a named system wide Mutex.
  3853. </para>
  3854. <para>
  3855. The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>.
  3856. </para>
  3857. </remarks>
  3858. </member>
  3859. <member name="M:log4net.Appender.FileAppender.ActivateOptions">
  3860. <summary>
  3861. Activate the options on the file appender.
  3862. </summary>
  3863. <remarks>
  3864. <para>
  3865. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3866. activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must
  3867. be called on this object after the configuration properties have
  3868. been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this
  3869. object is in an undefined state and must not be used.
  3870. </para>
  3871. <para>
  3872. If any of the configuration properties are modified then
  3873. <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again.
  3874. </para>
  3875. <para>
  3876. This will cause the file to be opened.
  3877. </para>
  3878. </remarks>
  3879. </member>
  3880. <member name="M:log4net.Appender.FileAppender.Reset">
  3881. <summary>
  3882. Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>.
  3883. </summary>
  3884. <remarks>
  3885. <para>
  3886. Resets the filename and the file stream.
  3887. </para>
  3888. </remarks>
  3889. </member>
  3890. <member name="M:log4net.Appender.FileAppender.OnClose">
  3891. <summary>
  3892. Close this appender instance. The underlying stream or writer is also closed.
  3893. </summary>
  3894. </member>
  3895. <member name="M:log4net.Appender.FileAppender.PrepareWriter">
  3896. <summary>
  3897. Called to initialize the file writer
  3898. </summary>
  3899. <remarks>
  3900. <para>
  3901. Will be called for each logged message until the file is
  3902. successfully opened.
  3903. </para>
  3904. </remarks>
  3905. </member>
  3906. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)">
  3907. <summary>
  3908. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3909. method.
  3910. </summary>
  3911. <param name="loggingEvent">The event to log.</param>
  3912. <remarks>
  3913. <para>
  3914. Writes a log statement to the output stream if the output stream exists
  3915. and is writable.
  3916. </para>
  3917. <para>
  3918. The format of the output will depend on the appender's layout.
  3919. </para>
  3920. </remarks>
  3921. </member>
  3922. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
  3923. <summary>
  3924. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  3925. method.
  3926. </summary>
  3927. <param name="loggingEvents">The array of events to log.</param>
  3928. <remarks>
  3929. <para>
  3930. Acquires the output file locks once before writing all the events to
  3931. the stream.
  3932. </para>
  3933. </remarks>
  3934. </member>
  3935. <member name="M:log4net.Appender.FileAppender.WriteFooter">
  3936. <summary>
  3937. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3938. </summary>
  3939. <remarks>
  3940. <para>
  3941. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3942. </para>
  3943. </remarks>
  3944. </member>
  3945. <member name="M:log4net.Appender.FileAppender.WriteHeader">
  3946. <summary>
  3947. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3948. </summary>
  3949. <remarks>
  3950. <para>
  3951. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3952. </para>
  3953. </remarks>
  3954. </member>
  3955. <member name="M:log4net.Appender.FileAppender.CloseWriter">
  3956. <summary>
  3957. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3958. </summary>
  3959. <remarks>
  3960. <para>
  3961. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3962. </para>
  3963. </remarks>
  3964. </member>
  3965. <member name="M:log4net.Appender.FileAppender.CloseFile">
  3966. <summary>
  3967. Closes the previously opened file.
  3968. </summary>
  3969. <remarks>
  3970. <para>
  3971. Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then
  3972. closes the file.
  3973. </para>
  3974. </remarks>
  3975. </member>
  3976. <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)">
  3977. <summary>
  3978. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  3979. </summary>
  3980. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  3981. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  3982. <remarks>
  3983. <para>
  3984. Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception.
  3985. Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>.
  3986. </para>
  3987. </remarks>
  3988. </member>
  3989. <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)">
  3990. <summary>
  3991. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  3992. </summary>
  3993. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  3994. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  3995. <remarks>
  3996. <para>
  3997. If there was already an opened file, then the previous file
  3998. is closed first.
  3999. </para>
  4000. <para>
  4001. This method will ensure that the directory structure
  4002. for the <paramref name="fileName"/> specified exists.
  4003. </para>
  4004. </remarks>
  4005. </member>
  4006. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)">
  4007. <summary>
  4008. Sets the quiet writer used for file output
  4009. </summary>
  4010. <param name="fileStream">the file stream that has been opened for writing</param>
  4011. <remarks>
  4012. <para>
  4013. This implementation of <see cref="M:SetQWForFiles(Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/>
  4014. over the <paramref name="fileStream"/> and passes it to the
  4015. <see cref="M:SetQWForFiles(TextWriter)"/> method.
  4016. </para>
  4017. <para>
  4018. This method can be overridden by sub classes that want to wrap the
  4019. <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output
  4020. data using a <c>System.Security.Cryptography.CryptoStream</c>.
  4021. </para>
  4022. </remarks>
  4023. </member>
  4024. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)">
  4025. <summary>
  4026. Sets the quiet writer being used.
  4027. </summary>
  4028. <param name="writer">the writer over the file stream that has been opened for writing</param>
  4029. <remarks>
  4030. <para>
  4031. This method can be overridden by sub classes that want to
  4032. wrap the <see cref="T:System.IO.TextWriter"/> in some way.
  4033. </para>
  4034. </remarks>
  4035. </member>
  4036. <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)">
  4037. <summary>
  4038. Convert a path into a fully qualified path.
  4039. </summary>
  4040. <param name="path">The path to convert.</param>
  4041. <returns>The fully qualified path.</returns>
  4042. <remarks>
  4043. <para>
  4044. Converts the path specified to a fully
  4045. qualified path. If the path is relative it is
  4046. taken as relative from the application base
  4047. directory.
  4048. </para>
  4049. </remarks>
  4050. </member>
  4051. <member name="F:log4net.Appender.FileAppender.m_appendToFile">
  4052. <summary>
  4053. Flag to indicate if we should append to the file
  4054. or overwrite the file. The default is to append.
  4055. </summary>
  4056. </member>
  4057. <member name="F:log4net.Appender.FileAppender.m_fileName">
  4058. <summary>
  4059. The name of the log file.
  4060. </summary>
  4061. </member>
  4062. <member name="F:log4net.Appender.FileAppender.m_encoding">
  4063. <summary>
  4064. The encoding to use for the file stream.
  4065. </summary>
  4066. </member>
  4067. <member name="F:log4net.Appender.FileAppender.m_securityContext">
  4068. <summary>
  4069. The security context to use for privileged calls
  4070. </summary>
  4071. </member>
  4072. <member name="F:log4net.Appender.FileAppender.m_stream">
  4073. <summary>
  4074. The stream to log to. Has added locking semantics
  4075. </summary>
  4076. </member>
  4077. <member name="F:log4net.Appender.FileAppender.m_lockingModel">
  4078. <summary>
  4079. The locking model to use
  4080. </summary>
  4081. </member>
  4082. <member name="F:log4net.Appender.FileAppender.declaringType">
  4083. <summary>
  4084. The fully qualified type of the FileAppender class.
  4085. </summary>
  4086. <remarks>
  4087. Used by the internal logger to record the Type of the
  4088. log message.
  4089. </remarks>
  4090. </member>
  4091. <member name="T:log4net.Appender.ForwardingAppender">
  4092. <summary>
  4093. This appender forwards logging events to attached appenders.
  4094. </summary>
  4095. <remarks>
  4096. <para>
  4097. The forwarding appender can be used to specify different thresholds
  4098. and filters for the same appender at different locations within the hierarchy.
  4099. </para>
  4100. </remarks>
  4101. <author>Nicko Cadell</author>
  4102. <author>Gert Driesen</author>
  4103. </member>
  4104. <member name="M:log4net.Appender.ForwardingAppender.#ctor">
  4105. <summary>
  4106. Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender" /> class.
  4107. </summary>
  4108. <remarks>
  4109. <para>
  4110. Default constructor.
  4111. </para>
  4112. </remarks>
  4113. </member>
  4114. <member name="M:log4net.Appender.ForwardingAppender.OnClose">
  4115. <summary>
  4116. Closes the appender and releases resources.
  4117. </summary>
  4118. <remarks>
  4119. <para>
  4120. Releases any resources allocated within the appender such as file handles,
  4121. network connections, etc.
  4122. </para>
  4123. <para>
  4124. It is a programming error to append to a closed appender.
  4125. </para>
  4126. </remarks>
  4127. </member>
  4128. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
  4129. <summary>
  4130. Forward the logging event to the attached appenders
  4131. </summary>
  4132. <param name="loggingEvent">The event to log.</param>
  4133. <remarks>
  4134. <para>
  4135. Delivers the logging event to all the attached appenders.
  4136. </para>
  4137. </remarks>
  4138. </member>
  4139. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
  4140. <summary>
  4141. Forward the logging events to the attached appenders
  4142. </summary>
  4143. <param name="loggingEvents">The array of events to log.</param>
  4144. <remarks>
  4145. <para>
  4146. Delivers the logging events to all the attached appenders.
  4147. </para>
  4148. </remarks>
  4149. </member>
  4150. <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  4151. <summary>
  4152. Adds an <see cref="T:log4net.Appender.IAppender" /> to the list of appenders of this
  4153. instance.
  4154. </summary>
  4155. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender" /> to add to this appender.</param>
  4156. <remarks>
  4157. <para>
  4158. If the specified <see cref="T:log4net.Appender.IAppender" /> is already in the list of
  4159. appenders, then it won't be added again.
  4160. </para>
  4161. </remarks>
  4162. </member>
  4163. <member name="P:log4net.Appender.ForwardingAppender.Appenders">
  4164. <summary>
  4165. Gets the appenders contained in this appender as an
  4166. <see cref="T:System.Collections.ICollection"/>.
  4167. </summary>
  4168. <remarks>
  4169. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  4170. is returned.
  4171. </remarks>
  4172. <returns>
  4173. A collection of the appenders in this appender.
  4174. </returns>
  4175. </member>
  4176. <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)">
  4177. <summary>
  4178. Looks for the appender with the specified name.
  4179. </summary>
  4180. <param name="name">The name of the appender to lookup.</param>
  4181. <returns>
  4182. The appender with the specified name, or <c>null</c>.
  4183. </returns>
  4184. <remarks>
  4185. <para>
  4186. Get the named appender attached to this appender.
  4187. </para>
  4188. </remarks>
  4189. </member>
  4190. <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders">
  4191. <summary>
  4192. Removes all previously added appenders from this appender.
  4193. </summary>
  4194. <remarks>
  4195. <para>
  4196. This is useful when re-reading configuration information.
  4197. </para>
  4198. </remarks>
  4199. </member>
  4200. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  4201. <summary>
  4202. Removes the specified appender from the list of appenders.
  4203. </summary>
  4204. <param name="appender">The appender to remove.</param>
  4205. <returns>The appender removed from the list</returns>
  4206. <remarks>
  4207. The appender removed is not closed.
  4208. If you are discarding the appender you must call
  4209. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4210. </remarks>
  4211. </member>
  4212. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)">
  4213. <summary>
  4214. Removes the appender with the specified name from the list of appenders.
  4215. </summary>
  4216. <param name="name">The name of the appender to remove.</param>
  4217. <returns>The appender removed from the list</returns>
  4218. <remarks>
  4219. The appender removed is not closed.
  4220. If you are discarding the appender you must call
  4221. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4222. </remarks>
  4223. </member>
  4224. <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl">
  4225. <summary>
  4226. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  4227. </summary>
  4228. </member>
  4229. <member name="T:log4net.Appender.IAppender">
  4230. <summary>
  4231. Implement this interface for your own strategies for printing log statements.
  4232. </summary>
  4233. <remarks>
  4234. <para>
  4235. Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/>
  4236. class which provides a default implementation of this interface.
  4237. </para>
  4238. <para>
  4239. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  4240. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  4241. be called after the appenders properties have been configured.
  4242. </para>
  4243. </remarks>
  4244. <author>Nicko Cadell</author>
  4245. <author>Gert Driesen</author>
  4246. </member>
  4247. <member name="M:log4net.Appender.IAppender.Close">
  4248. <summary>
  4249. Closes the appender and releases resources.
  4250. </summary>
  4251. <remarks>
  4252. <para>
  4253. Releases any resources allocated within the appender such as file handles,
  4254. network connections, etc.
  4255. </para>
  4256. <para>
  4257. It is a programming error to append to a closed appender.
  4258. </para>
  4259. </remarks>
  4260. </member>
  4261. <member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)">
  4262. <summary>
  4263. Log the logging event in Appender specific way.
  4264. </summary>
  4265. <param name="loggingEvent">The event to log</param>
  4266. <remarks>
  4267. <para>
  4268. This method is called to log a message into this appender.
  4269. </para>
  4270. </remarks>
  4271. </member>
  4272. <member name="P:log4net.Appender.IAppender.Name">
  4273. <summary>
  4274. Gets or sets the name of this appender.
  4275. </summary>
  4276. <value>The name of the appender.</value>
  4277. <remarks>
  4278. <para>The name uniquely identifies the appender.</para>
  4279. </remarks>
  4280. </member>
  4281. <member name="T:log4net.Appender.IBulkAppender">
  4282. <summary>
  4283. Interface for appenders that support bulk logging.
  4284. </summary>
  4285. <remarks>
  4286. <para>
  4287. This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to
  4288. support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders
  4289. should only implement this interface if they can bulk log efficiently.
  4290. </para>
  4291. </remarks>
  4292. <author>Nicko Cadell</author>
  4293. </member>
  4294. <member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])">
  4295. <summary>
  4296. Log the array of logging events in Appender specific way.
  4297. </summary>
  4298. <param name="loggingEvents">The events to log</param>
  4299. <remarks>
  4300. <para>
  4301. This method is called to log an array of events into this appender.
  4302. </para>
  4303. </remarks>
  4304. </member>
  4305. <member name="T:log4net.Appender.IFlushable">
  4306. <summary>
  4307. Interface that can be implemented by Appenders that buffer logging data and expose a <see cref="M:log4net.Appender.IFlushable.Flush(System.Int32)"/> method.
  4308. </summary>
  4309. </member>
  4310. <member name="M:log4net.Appender.IFlushable.Flush(System.Int32)">
  4311. <summary>
  4312. Flushes any buffered log data.
  4313. </summary>
  4314. <remarks>
  4315. 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
  4316. the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  4317. <para>
  4318. Typically this is done by locking on the Appender instance, e.g.:
  4319. <code>
  4320. <![CDATA[
  4321. public bool Flush(int millisecondsTimeout)
  4322. {
  4323. lock(this)
  4324. {
  4325. // Flush buffered logging data
  4326. ...
  4327. }
  4328. }
  4329. ]]>
  4330. </code>
  4331. </para>
  4332. <para>
  4333. The <paramref name="millisecondsTimeout"/> parameter is only relevant for appenders that process logging events asynchronously,
  4334. such as <see cref="T:log4net.Appender.RemotingAppender"/>.
  4335. </para>
  4336. </remarks>
  4337. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  4338. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  4339. </member>
  4340. <member name="T:log4net.Appender.LocalSyslogAppender">
  4341. <summary>
  4342. Logs events to a local syslog service.
  4343. </summary>
  4344. <remarks>
  4345. <note>
  4346. This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>.
  4347. If these functions are not available on the local system then this appender will not work!
  4348. </note>
  4349. <para>
  4350. The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and
  4351. POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service.
  4352. </para>
  4353. <para>
  4354. This appender talks to a local syslog service. If you need to log to a remote syslog
  4355. daemon and you cannot configure your local syslog service to do this you may be
  4356. able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP.
  4357. </para>
  4358. <para>
  4359. Syslog messages must have a facility and and a severity. The severity
  4360. is derived from the Level of the logging event.
  4361. The facility must be chosen from the set of defined syslog
  4362. <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  4363. and cannot be extended.
  4364. </para>
  4365. <para>
  4366. An identifier is specified with each log message. This can be specified
  4367. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  4368. as the tag) must not contain white space. The default value for the
  4369. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  4370. </para>
  4371. </remarks>
  4372. <author>Rob Lyon</author>
  4373. <author>Nicko Cadell</author>
  4374. </member>
  4375. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity">
  4376. <summary>
  4377. syslog severities
  4378. </summary>
  4379. <remarks>
  4380. <para>
  4381. The log4net Level maps to a syslog severity using the
  4382. <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/>
  4383. class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>.
  4384. </para>
  4385. </remarks>
  4386. </member>
  4387. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency">
  4388. <summary>
  4389. system is unusable
  4390. </summary>
  4391. </member>
  4392. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert">
  4393. <summary>
  4394. action must be taken immediately
  4395. </summary>
  4396. </member>
  4397. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical">
  4398. <summary>
  4399. critical conditions
  4400. </summary>
  4401. </member>
  4402. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error">
  4403. <summary>
  4404. error conditions
  4405. </summary>
  4406. </member>
  4407. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning">
  4408. <summary>
  4409. warning conditions
  4410. </summary>
  4411. </member>
  4412. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice">
  4413. <summary>
  4414. normal but significant condition
  4415. </summary>
  4416. </member>
  4417. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational">
  4418. <summary>
  4419. informational
  4420. </summary>
  4421. </member>
  4422. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug">
  4423. <summary>
  4424. debug-level messages
  4425. </summary>
  4426. </member>
  4427. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility">
  4428. <summary>
  4429. syslog facilities
  4430. </summary>
  4431. <remarks>
  4432. <para>
  4433. The syslog facility defines which subsystem the logging comes from.
  4434. This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property.
  4435. </para>
  4436. </remarks>
  4437. </member>
  4438. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel">
  4439. <summary>
  4440. kernel messages
  4441. </summary>
  4442. </member>
  4443. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User">
  4444. <summary>
  4445. random user-level messages
  4446. </summary>
  4447. </member>
  4448. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail">
  4449. <summary>
  4450. mail system
  4451. </summary>
  4452. </member>
  4453. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons">
  4454. <summary>
  4455. system daemons
  4456. </summary>
  4457. </member>
  4458. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization">
  4459. <summary>
  4460. security/authorization messages
  4461. </summary>
  4462. </member>
  4463. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog">
  4464. <summary>
  4465. messages generated internally by syslogd
  4466. </summary>
  4467. </member>
  4468. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer">
  4469. <summary>
  4470. line printer subsystem
  4471. </summary>
  4472. </member>
  4473. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News">
  4474. <summary>
  4475. network news subsystem
  4476. </summary>
  4477. </member>
  4478. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp">
  4479. <summary>
  4480. UUCP subsystem
  4481. </summary>
  4482. </member>
  4483. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock">
  4484. <summary>
  4485. clock (cron/at) daemon
  4486. </summary>
  4487. </member>
  4488. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2">
  4489. <summary>
  4490. security/authorization messages (private)
  4491. </summary>
  4492. </member>
  4493. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp">
  4494. <summary>
  4495. ftp daemon
  4496. </summary>
  4497. </member>
  4498. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp">
  4499. <summary>
  4500. NTP subsystem
  4501. </summary>
  4502. </member>
  4503. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit">
  4504. <summary>
  4505. log audit
  4506. </summary>
  4507. </member>
  4508. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert">
  4509. <summary>
  4510. log alert
  4511. </summary>
  4512. </member>
  4513. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2">
  4514. <summary>
  4515. clock daemon
  4516. </summary>
  4517. </member>
  4518. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0">
  4519. <summary>
  4520. reserved for local use
  4521. </summary>
  4522. </member>
  4523. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1">
  4524. <summary>
  4525. reserved for local use
  4526. </summary>
  4527. </member>
  4528. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2">
  4529. <summary>
  4530. reserved for local use
  4531. </summary>
  4532. </member>
  4533. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3">
  4534. <summary>
  4535. reserved for local use
  4536. </summary>
  4537. </member>
  4538. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4">
  4539. <summary>
  4540. reserved for local use
  4541. </summary>
  4542. </member>
  4543. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5">
  4544. <summary>
  4545. reserved for local use
  4546. </summary>
  4547. </member>
  4548. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6">
  4549. <summary>
  4550. reserved for local use
  4551. </summary>
  4552. </member>
  4553. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7">
  4554. <summary>
  4555. reserved for local use
  4556. </summary>
  4557. </member>
  4558. <member name="M:log4net.Appender.LocalSyslogAppender.#ctor">
  4559. <summary>
  4560. Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender" /> class.
  4561. </summary>
  4562. <remarks>
  4563. This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender" /> class is set up to write
  4564. to a local syslog service.
  4565. </remarks>
  4566. </member>
  4567. <member name="P:log4net.Appender.LocalSyslogAppender.Identity">
  4568. <summary>
  4569. Message identity
  4570. </summary>
  4571. <remarks>
  4572. <para>
  4573. An identifier is specified with each log message. This can be specified
  4574. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  4575. as the tag) must not contain white space. The default value for the
  4576. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  4577. </para>
  4578. </remarks>
  4579. </member>
  4580. <member name="P:log4net.Appender.LocalSyslogAppender.Facility">
  4581. <summary>
  4582. Syslog facility
  4583. </summary>
  4584. <remarks>
  4585. Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of
  4586. facilities is predefined and cannot be extended. The default value
  4587. is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  4588. </remarks>
  4589. </member>
  4590. <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)">
  4591. <summary>
  4592. Add a mapping of level to severity
  4593. </summary>
  4594. <param name="mapping">The mapping to add</param>
  4595. <remarks>
  4596. <para>
  4597. Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender.
  4598. </para>
  4599. </remarks>
  4600. </member>
  4601. <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions">
  4602. <summary>
  4603. Initialize the appender based on the options set.
  4604. </summary>
  4605. <remarks>
  4606. <para>
  4607. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4608. activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must
  4609. be called on this object after the configuration properties have
  4610. been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this
  4611. object is in an undefined state and must not be used.
  4612. </para>
  4613. <para>
  4614. If any of the configuration properties are modified then
  4615. <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again.
  4616. </para>
  4617. </remarks>
  4618. </member>
  4619. <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)">
  4620. <summary>
  4621. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  4622. </summary>
  4623. <param name="loggingEvent">The event to log.</param>
  4624. <remarks>
  4625. <para>
  4626. Writes the event to a remote syslog daemon.
  4627. </para>
  4628. <para>
  4629. The format of the output will depend on the appender's layout.
  4630. </para>
  4631. </remarks>
  4632. </member>
  4633. <member name="M:log4net.Appender.LocalSyslogAppender.OnClose">
  4634. <summary>
  4635. Close the syslog when the appender is closed
  4636. </summary>
  4637. <remarks>
  4638. <para>
  4639. Close the syslog when the appender is closed
  4640. </para>
  4641. </remarks>
  4642. </member>
  4643. <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout">
  4644. <summary>
  4645. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  4646. </summary>
  4647. <value><c>true</c></value>
  4648. <remarks>
  4649. <para>
  4650. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  4651. </para>
  4652. </remarks>
  4653. </member>
  4654. <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)">
  4655. <summary>
  4656. Translates a log4net level to a syslog severity.
  4657. </summary>
  4658. <param name="level">A log4net level.</param>
  4659. <returns>A syslog severity.</returns>
  4660. <remarks>
  4661. <para>
  4662. Translates a log4net level to a syslog severity.
  4663. </para>
  4664. </remarks>
  4665. </member>
  4666. <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)">
  4667. <summary>
  4668. Generate a syslog priority.
  4669. </summary>
  4670. <param name="facility">The syslog facility.</param>
  4671. <param name="severity">The syslog severity.</param>
  4672. <returns>A syslog priority.</returns>
  4673. </member>
  4674. <member name="F:log4net.Appender.LocalSyslogAppender.m_facility">
  4675. <summary>
  4676. The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  4677. </summary>
  4678. </member>
  4679. <member name="F:log4net.Appender.LocalSyslogAppender.m_identity">
  4680. <summary>
  4681. The message identity
  4682. </summary>
  4683. </member>
  4684. <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity">
  4685. <summary>
  4686. Marshaled handle to the identity string. We have to hold on to the
  4687. string as the <c>openlog</c> and <c>syslog</c> APIs just hold the
  4688. pointer to the ident and dereference it for each log message.
  4689. </summary>
  4690. </member>
  4691. <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping">
  4692. <summary>
  4693. Mapping from level object to syslog severity
  4694. </summary>
  4695. </member>
  4696. <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)">
  4697. <summary>
  4698. Open connection to system logger.
  4699. </summary>
  4700. </member>
  4701. <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
  4702. <summary>
  4703. Generate a log message.
  4704. </summary>
  4705. <remarks>
  4706. <para>
  4707. The libc syslog method takes a format string and a variable argument list similar
  4708. to the classic printf function. As this type of vararg list is not supported
  4709. by C# we need to specify the arguments explicitly. Here we have specified the
  4710. format string with a single message argument. The caller must set the format
  4711. string to <c>"%s"</c>.
  4712. </para>
  4713. </remarks>
  4714. </member>
  4715. <member name="M:log4net.Appender.LocalSyslogAppender.closelog">
  4716. <summary>
  4717. Close descriptor used to write to system logger.
  4718. </summary>
  4719. </member>
  4720. <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity">
  4721. <summary>
  4722. A class to act as a mapping between the level that a logging call is made at and
  4723. the syslog severity that is should be logged at.
  4724. </summary>
  4725. <remarks>
  4726. <para>
  4727. A class to act as a mapping between the level that a logging call is made at and
  4728. the syslog severity that is should be logged at.
  4729. </para>
  4730. </remarks>
  4731. </member>
  4732. <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity">
  4733. <summary>
  4734. The mapped syslog severity for the specified level
  4735. </summary>
  4736. <remarks>
  4737. <para>
  4738. Required property.
  4739. The mapped syslog severity for the specified level
  4740. </para>
  4741. </remarks>
  4742. </member>
  4743. <member name="T:log4net.Appender.ManagedColoredConsoleAppender">
  4744. <summary>
  4745. Appends colorful logging events to the console, using the .NET 2
  4746. built-in capabilities.
  4747. </summary>
  4748. <remarks>
  4749. <para>
  4750. ManagedColoredConsoleAppender appends log events to the standard output stream
  4751. or the error output stream using a layout specified by the
  4752. user. It also allows the color of a specific type of message to be set.
  4753. </para>
  4754. <para>
  4755. By default, all output is written to the console's standard output stream.
  4756. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> property can be set to direct the output to the
  4757. error stream.
  4758. </para>
  4759. <para>
  4760. When configuring the colored console appender, mappings should be
  4761. specified to map logging levels to colors. For example:
  4762. </para>
  4763. <code lang="XML" escaped="true">
  4764. <mapping>
  4765. <level value="ERROR" />
  4766. <foreColor value="DarkRed" />
  4767. <backColor value="White" />
  4768. </mapping>
  4769. <mapping>
  4770. <level value="WARN" />
  4771. <foreColor value="Yellow" />
  4772. </mapping>
  4773. <mapping>
  4774. <level value="INFO" />
  4775. <foreColor value="White" />
  4776. </mapping>
  4777. <mapping>
  4778. <level value="DEBUG" />
  4779. <foreColor value="Blue" />
  4780. </mapping>
  4781. </code>
  4782. <para>
  4783. The Level is the standard log4net logging level while
  4784. ForeColor and BackColor are the values of <see cref="T:System.ConsoleColor"/>
  4785. enumeration.
  4786. </para>
  4787. <para>
  4788. Based on the ColoredConsoleAppender
  4789. </para>
  4790. </remarks>
  4791. <author>Rick Hobbs</author>
  4792. <author>Nicko Cadell</author>
  4793. <author>Pavlos Touboulidis</author>
  4794. </member>
  4795. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.#ctor">
  4796. <summary>
  4797. Initializes a new instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender" /> class.
  4798. </summary>
  4799. <remarks>
  4800. The instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender" /> class is set up to write
  4801. to the standard output stream.
  4802. </remarks>
  4803. </member>
  4804. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.Target">
  4805. <summary>
  4806. Target is the value of the console output stream.
  4807. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4808. </summary>
  4809. <value>
  4810. Target is the value of the console output stream.
  4811. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4812. </value>
  4813. <remarks>
  4814. <para>
  4815. Target is the value of the console output stream.
  4816. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4817. </para>
  4818. </remarks>
  4819. </member>
  4820. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.AddMapping(log4net.Appender.ManagedColoredConsoleAppender.LevelColors)">
  4821. <summary>
  4822. Add a mapping of level to color - done by the config file
  4823. </summary>
  4824. <param name="mapping">The mapping to add</param>
  4825. <remarks>
  4826. <para>
  4827. Add a <see cref="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors"/> mapping to this appender.
  4828. Each mapping defines the foreground and background colors
  4829. for a level.
  4830. </para>
  4831. </remarks>
  4832. </member>
  4833. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  4834. <summary>
  4835. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  4836. </summary>
  4837. <param name="loggingEvent">The event to log.</param>
  4838. <remarks>
  4839. <para>
  4840. Writes the event to the console.
  4841. </para>
  4842. <para>
  4843. The format of the output will depend on the appender's layout.
  4844. </para>
  4845. </remarks>
  4846. </member>
  4847. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.RequiresLayout">
  4848. <summary>
  4849. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4850. </summary>
  4851. <value><c>true</c></value>
  4852. <remarks>
  4853. <para>
  4854. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4855. </para>
  4856. </remarks>
  4857. </member>
  4858. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.ActivateOptions">
  4859. <summary>
  4860. Initialize the options for this appender
  4861. </summary>
  4862. <remarks>
  4863. <para>
  4864. Initialize the level to color mappings set on this appender.
  4865. </para>
  4866. </remarks>
  4867. </member>
  4868. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleOut">
  4869. <summary>
  4870. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4871. standard output stream.
  4872. </summary>
  4873. <remarks>
  4874. <para>
  4875. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4876. standard output stream.
  4877. </para>
  4878. </remarks>
  4879. </member>
  4880. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleError">
  4881. <summary>
  4882. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4883. standard error output stream.
  4884. </summary>
  4885. <remarks>
  4886. <para>
  4887. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4888. standard error output stream.
  4889. </para>
  4890. </remarks>
  4891. </member>
  4892. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_writeToErrorStream">
  4893. <summary>
  4894. Flag to write output to the error stream rather than the standard output stream
  4895. </summary>
  4896. </member>
  4897. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_levelMapping">
  4898. <summary>
  4899. Mapping from level object to color value
  4900. </summary>
  4901. </member>
  4902. <member name="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors">
  4903. <summary>
  4904. A class to act as a mapping between the level that a logging call is made at and
  4905. the color it should be displayed as.
  4906. </summary>
  4907. <remarks>
  4908. <para>
  4909. Defines the mapping between a level and the color it should be displayed in.
  4910. </para>
  4911. </remarks>
  4912. </member>
  4913. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.ForeColor">
  4914. <summary>
  4915. The mapped foreground color for the specified level
  4916. </summary>
  4917. <remarks>
  4918. <para>
  4919. Required property.
  4920. The mapped foreground color for the specified level.
  4921. </para>
  4922. </remarks>
  4923. </member>
  4924. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.BackColor">
  4925. <summary>
  4926. The mapped background color for the specified level
  4927. </summary>
  4928. <remarks>
  4929. <para>
  4930. Required property.
  4931. The mapped background color for the specified level.
  4932. </para>
  4933. </remarks>
  4934. </member>
  4935. <member name="T:log4net.Appender.MemoryAppender">
  4936. <summary>
  4937. Stores logging events in an array.
  4938. </summary>
  4939. <remarks>
  4940. <para>
  4941. The memory appender stores all the logging events
  4942. that are appended in an in-memory array.
  4943. </para>
  4944. <para>
  4945. Use the <see cref="M:PopAllEvents()"/> method to get
  4946. and clear the current list of events that have been appended.
  4947. </para>
  4948. <para>
  4949. Use the <see cref="M:GetEvents()"/> method to get the current
  4950. list of events that have been appended. Note there is a
  4951. race-condition when calling <see cref="M:GetEvents()"/> and
  4952. <see cref="M:Clear()"/> in pairs, you better use <see
  4953. mref="M:PopAllEvents()"/> in that case.
  4954. </para>
  4955. <para>
  4956. Use the <see cref="M:Clear()"/> method to clear the
  4957. current list of events. Note there is a
  4958. race-condition when calling <see cref="M:GetEvents()"/> and
  4959. <see cref="M:Clear()"/> in pairs, you better use <see
  4960. mref="M:PopAllEvents()"/> in that case.
  4961. </para>
  4962. </remarks>
  4963. <author>Julian Biddle</author>
  4964. <author>Nicko Cadell</author>
  4965. <author>Gert Driesen</author>
  4966. </member>
  4967. <member name="M:log4net.Appender.MemoryAppender.#ctor">
  4968. <summary>
  4969. Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender" /> class.
  4970. </summary>
  4971. <remarks>
  4972. <para>
  4973. Default constructor.
  4974. </para>
  4975. </remarks>
  4976. </member>
  4977. <member name="M:log4net.Appender.MemoryAppender.GetEvents">
  4978. <summary>
  4979. Gets the events that have been logged.
  4980. </summary>
  4981. <returns>The events that have been logged</returns>
  4982. <remarks>
  4983. <para>
  4984. Gets the events that have been logged.
  4985. </para>
  4986. </remarks>
  4987. </member>
  4988. <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
  4989. <summary>
  4990. Gets or sets a value indicating whether only part of the logging event
  4991. data should be fixed.
  4992. </summary>
  4993. <value>
  4994. <c>true</c> if the appender should only fix part of the logging event
  4995. data, otherwise <c>false</c>. The default is <c>false</c>.
  4996. </value>
  4997. <remarks>
  4998. <para>
  4999. Setting this property to <c>true</c> will cause only part of the event
  5000. data to be fixed and stored in the appender, hereby improving performance.
  5001. </para>
  5002. <para>
  5003. See <see cref="M:LoggingEvent.FixVolatileData(bool)"/> for more information.
  5004. </para>
  5005. </remarks>
  5006. </member>
  5007. <member name="P:log4net.Appender.MemoryAppender.Fix">
  5008. <summary>
  5009. Gets or sets the fields that will be fixed in the event
  5010. </summary>
  5011. <remarks>
  5012. <para>
  5013. The logging event needs to have certain thread specific values
  5014. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  5015. for details.
  5016. </para>
  5017. </remarks>
  5018. </member>
  5019. <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)">
  5020. <summary>
  5021. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5022. </summary>
  5023. <param name="loggingEvent">the event to log</param>
  5024. <remarks>
  5025. <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
  5026. </remarks>
  5027. </member>
  5028. <member name="M:log4net.Appender.MemoryAppender.Clear">
  5029. <summary>
  5030. Clear the list of events
  5031. </summary>
  5032. <remarks>
  5033. Clear the list of events
  5034. </remarks>
  5035. </member>
  5036. <member name="M:log4net.Appender.MemoryAppender.PopAllEvents">
  5037. <summary>
  5038. Gets the events that have been logged and clears the list of events.
  5039. </summary>
  5040. <returns>The events that have been logged</returns>
  5041. <remarks>
  5042. <para>
  5043. Gets the events that have been logged and clears the list of events.
  5044. </para>
  5045. </remarks>
  5046. </member>
  5047. <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
  5048. <summary>
  5049. The list of events that have been appended.
  5050. </summary>
  5051. </member>
  5052. <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
  5053. <summary>
  5054. Value indicating which fields in the event should be fixed
  5055. </summary>
  5056. <remarks>
  5057. By default all fields are fixed
  5058. </remarks>
  5059. </member>
  5060. <member name="T:log4net.Appender.NetSendAppender">
  5061. <summary>
  5062. Logs entries by sending network messages using the
  5063. <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)" /> native function.
  5064. </summary>
  5065. <remarks>
  5066. <para>
  5067. You can send messages only to names that are active
  5068. on the network. If you send the message to a user name,
  5069. that user must be logged on and running the Messenger
  5070. service to receive the message.
  5071. </para>
  5072. <para>
  5073. The receiver will get a top most window displaying the
  5074. messages one at a time, therefore this appender should
  5075. not be used to deliver a high volume of messages.
  5076. </para>
  5077. <para>
  5078. The following table lists some possible uses for this appender :
  5079. </para>
  5080. <para>
  5081. <list type="table">
  5082. <listheader>
  5083. <term>Action</term>
  5084. <description>Property Value(s)</description>
  5085. </listheader>
  5086. <item>
  5087. <term>Send a message to a user account on the local machine</term>
  5088. <description>
  5089. <para>
  5090. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine&gt;
  5091. </para>
  5092. <para>
  5093. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5094. </para>
  5095. </description>
  5096. </item>
  5097. <item>
  5098. <term>Send a message to a user account on a remote machine</term>
  5099. <description>
  5100. <para>
  5101. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the remote machine&gt;
  5102. </para>
  5103. <para>
  5104. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5105. </para>
  5106. </description>
  5107. </item>
  5108. <item>
  5109. <term>Send a message to a domain user account</term>
  5110. <description>
  5111. <para>
  5112. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of a domain controller | uninitialized&gt;
  5113. </para>
  5114. <para>
  5115. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5116. </para>
  5117. </description>
  5118. </item>
  5119. <item>
  5120. <term>Send a message to all the names in a workgroup or domain</term>
  5121. <description>
  5122. <para>
  5123. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;workgroup name | domain name&gt;*
  5124. </para>
  5125. </description>
  5126. </item>
  5127. <item>
  5128. <term>Send a message from the local machine to a remote machine</term>
  5129. <description>
  5130. <para>
  5131. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine | uninitialized&gt;
  5132. </para>
  5133. <para>
  5134. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;name of the remote machine&gt;
  5135. </para>
  5136. </description>
  5137. </item>
  5138. </list>
  5139. </para>
  5140. <para>
  5141. <b>Note :</b> security restrictions apply for sending
  5142. network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)" />
  5143. for more information.
  5144. </para>
  5145. </remarks>
  5146. <example>
  5147. <para>
  5148. An example configuration section to log information
  5149. using this appender from the local machine, named
  5150. LOCAL_PC, to machine OPERATOR_PC :
  5151. </para>
  5152. <code lang="XML" escaped="true">
  5153. <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
  5154. <server value="LOCAL_PC" />
  5155. <recipient value="OPERATOR_PC" />
  5156. <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n" />
  5157. </appender>
  5158. </code>
  5159. </example>
  5160. <author>Nicko Cadell</author>
  5161. <author>Gert Driesen</author>
  5162. </member>
  5163. <member name="F:log4net.Appender.NetSendAppender.m_server">
  5164. <summary>
  5165. The DNS or NetBIOS name of the server on which the function is to execute.
  5166. </summary>
  5167. </member>
  5168. <member name="F:log4net.Appender.NetSendAppender.m_sender">
  5169. <summary>
  5170. The sender of the network message.
  5171. </summary>
  5172. </member>
  5173. <member name="F:log4net.Appender.NetSendAppender.m_recipient">
  5174. <summary>
  5175. The message alias to which the message should be sent.
  5176. </summary>
  5177. </member>
  5178. <member name="F:log4net.Appender.NetSendAppender.m_securityContext">
  5179. <summary>
  5180. The security context to use for privileged calls
  5181. </summary>
  5182. </member>
  5183. <member name="M:log4net.Appender.NetSendAppender.#ctor">
  5184. <summary>
  5185. Initializes the appender.
  5186. </summary>
  5187. <remarks>
  5188. The default constructor initializes all fields to their default values.
  5189. </remarks>
  5190. </member>
  5191. <member name="P:log4net.Appender.NetSendAppender.Sender">
  5192. <summary>
  5193. Gets or sets the sender of the message.
  5194. </summary>
  5195. <value>
  5196. The sender of the message.
  5197. </value>
  5198. <remarks>
  5199. If this property is not specified, the message is sent from the local computer.
  5200. </remarks>
  5201. </member>
  5202. <member name="P:log4net.Appender.NetSendAppender.Recipient">
  5203. <summary>
  5204. Gets or sets the message alias to which the message should be sent.
  5205. </summary>
  5206. <value>
  5207. The recipient of the message.
  5208. </value>
  5209. <remarks>
  5210. This property should always be specified in order to send a message.
  5211. </remarks>
  5212. </member>
  5213. <member name="P:log4net.Appender.NetSendAppender.Server">
  5214. <summary>
  5215. Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
  5216. </summary>
  5217. <value>
  5218. DNS or NetBIOS name of the remote server on which the function is to execute.
  5219. </value>
  5220. <remarks>
  5221. <para>
  5222. For Windows NT 4.0 and earlier, the string should begin with \\.
  5223. </para>
  5224. <para>
  5225. If this property is not specified, the local computer is used.
  5226. </para>
  5227. </remarks>
  5228. </member>
  5229. <member name="P:log4net.Appender.NetSendAppender.SecurityContext">
  5230. <summary>
  5231. Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5232. </summary>
  5233. <value>
  5234. The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5235. </value>
  5236. <remarks>
  5237. <para>
  5238. Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
  5239. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  5240. security context to use. The default behavior is to use the security context
  5241. of the current thread.
  5242. </para>
  5243. </remarks>
  5244. </member>
  5245. <member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
  5246. <summary>
  5247. Initialize the appender based on the options set.
  5248. </summary>
  5249. <remarks>
  5250. <para>
  5251. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5252. activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
  5253. be called on this object after the configuration properties have
  5254. been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
  5255. object is in an undefined state and must not be used.
  5256. </para>
  5257. <para>
  5258. If any of the configuration properties are modified then
  5259. <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
  5260. </para>
  5261. <para>
  5262. The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient" /> was specified.
  5263. </para>
  5264. </remarks>
  5265. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient" /> was not specified.</exception>
  5266. </member>
  5267. <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
  5268. <summary>
  5269. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5270. </summary>
  5271. <param name="loggingEvent">The event to log.</param>
  5272. <remarks>
  5273. <para>
  5274. Sends the event using a network message.
  5275. </para>
  5276. </remarks>
  5277. </member>
  5278. <member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
  5279. <summary>
  5280. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5281. </summary>
  5282. <value><c>true</c></value>
  5283. <remarks>
  5284. <para>
  5285. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5286. </para>
  5287. </remarks>
  5288. </member>
  5289. <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
  5290. <summary>
  5291. Sends a buffer of information to a registered message alias.
  5292. </summary>
  5293. <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
  5294. <param name="msgName">The message alias to which the message buffer should be sent</param>
  5295. <param name="fromName">The originator of the message.</param>
  5296. <param name="buffer">The message text.</param>
  5297. <param name="bufferSize">The length, in bytes, of the message text.</param>
  5298. <remarks>
  5299. <para>
  5300. The following restrictions apply for sending network messages:
  5301. </para>
  5302. <para>
  5303. <list type="table">
  5304. <listheader>
  5305. <term>Platform</term>
  5306. <description>Requirements</description>
  5307. </listheader>
  5308. <item>
  5309. <term>Windows NT</term>
  5310. <description>
  5311. <para>
  5312. No special group membership is required to send a network message.
  5313. </para>
  5314. <para>
  5315. Admin, Accounts, Print, or Server Operator group membership is required to
  5316. successfully send a network message on a remote server.
  5317. </para>
  5318. </description>
  5319. </item>
  5320. <item>
  5321. <term>Windows 2000 or later</term>
  5322. <description>
  5323. <para>
  5324. If you send a message on a domain controller that is running Active Directory,
  5325. access is allowed or denied based on the access control list (ACL) for the securable
  5326. object. The default ACL permits only Domain Admins and Account Operators to send a network message.
  5327. </para>
  5328. <para>
  5329. On a member server or workstation, only Administrators and Server Operators can send a network message.
  5330. </para>
  5331. </description>
  5332. </item>
  5333. </list>
  5334. </para>
  5335. <para>
  5336. 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>.
  5337. </para>
  5338. </remarks>
  5339. <returns>
  5340. <para>
  5341. If the function succeeds, the return value is zero.
  5342. </para>
  5343. </returns>
  5344. </member>
  5345. <member name="T:log4net.Appender.OutputDebugStringAppender">
  5346. <summary>
  5347. Appends log events to the OutputDebugString system.
  5348. </summary>
  5349. <remarks>
  5350. <para>
  5351. OutputDebugStringAppender appends log events to the
  5352. OutputDebugString system.
  5353. </para>
  5354. <para>
  5355. The string is passed to the native <c>OutputDebugString</c>
  5356. function.
  5357. </para>
  5358. </remarks>
  5359. <author>Nicko Cadell</author>
  5360. <author>Gert Driesen</author>
  5361. </member>
  5362. <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
  5363. <summary>
  5364. Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender" /> class.
  5365. </summary>
  5366. <remarks>
  5367. <para>
  5368. Default constructor.
  5369. </para>
  5370. </remarks>
  5371. </member>
  5372. <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
  5373. <summary>
  5374. Write the logging event to the output debug string API
  5375. </summary>
  5376. <param name="loggingEvent">the event to log</param>
  5377. <remarks>
  5378. <para>
  5379. Write the logging event to the output debug string API
  5380. </para>
  5381. </remarks>
  5382. </member>
  5383. <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
  5384. <summary>
  5385. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5386. </summary>
  5387. <value><c>true</c></value>
  5388. <remarks>
  5389. <para>
  5390. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5391. </para>
  5392. </remarks>
  5393. </member>
  5394. <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
  5395. <summary>
  5396. Stub for OutputDebugString native method
  5397. </summary>
  5398. <param name="message">the string to output</param>
  5399. <remarks>
  5400. <para>
  5401. Stub for OutputDebugString native method
  5402. </para>
  5403. </remarks>
  5404. </member>
  5405. <member name="T:log4net.Appender.RemoteSyslogAppender">
  5406. <summary>
  5407. Logs events to a remote syslog daemon.
  5408. </summary>
  5409. <remarks>
  5410. <para>
  5411. The BSD syslog protocol is used to remotely log to
  5412. a syslog daemon. The syslogd listens for for messages
  5413. on UDP port 514.
  5414. </para>
  5415. <para>
  5416. The syslog UDP protocol is not authenticated. Most syslog daemons
  5417. do not accept remote log messages because of the security implications.
  5418. You may be able to use the LocalSyslogAppender to talk to a local
  5419. syslog service.
  5420. </para>
  5421. <para>
  5422. There is an RFC 3164 that claims to document the BSD Syslog Protocol.
  5423. This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html.
  5424. This appender generates what the RFC calls an "Original Device Message",
  5425. i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation
  5426. this format of message will be accepted by all current syslog daemon
  5427. implementations. The daemon will attach the current time and the source
  5428. hostname or IP address to any messages received.
  5429. </para>
  5430. <para>
  5431. Syslog messages must have a facility and and a severity. The severity
  5432. is derived from the Level of the logging event.
  5433. The facility must be chosen from the set of defined syslog
  5434. <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  5435. and cannot be extended.
  5436. </para>
  5437. <para>
  5438. An identifier is specified with each log message. This can be specified
  5439. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  5440. as the tag) must not contain white space. The default value for the
  5441. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  5442. </para>
  5443. </remarks>
  5444. <author>Rob Lyon</author>
  5445. <author>Nicko Cadell</author>
  5446. </member>
  5447. <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort">
  5448. <summary>
  5449. Syslog port 514
  5450. </summary>
  5451. </member>
  5452. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity">
  5453. <summary>
  5454. syslog severities
  5455. </summary>
  5456. <remarks>
  5457. <para>
  5458. The syslog severities.
  5459. </para>
  5460. </remarks>
  5461. </member>
  5462. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency">
  5463. <summary>
  5464. system is unusable
  5465. </summary>
  5466. </member>
  5467. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert">
  5468. <summary>
  5469. action must be taken immediately
  5470. </summary>
  5471. </member>
  5472. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical">
  5473. <summary>
  5474. critical conditions
  5475. </summary>
  5476. </member>
  5477. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error">
  5478. <summary>
  5479. error conditions
  5480. </summary>
  5481. </member>
  5482. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning">
  5483. <summary>
  5484. warning conditions
  5485. </summary>
  5486. </member>
  5487. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice">
  5488. <summary>
  5489. normal but significant condition
  5490. </summary>
  5491. </member>
  5492. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational">
  5493. <summary>
  5494. informational
  5495. </summary>
  5496. </member>
  5497. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug">
  5498. <summary>
  5499. debug-level messages
  5500. </summary>
  5501. </member>
  5502. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility">
  5503. <summary>
  5504. syslog facilities
  5505. </summary>
  5506. <remarks>
  5507. <para>
  5508. The syslog facilities
  5509. </para>
  5510. </remarks>
  5511. </member>
  5512. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel">
  5513. <summary>
  5514. kernel messages
  5515. </summary>
  5516. </member>
  5517. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User">
  5518. <summary>
  5519. random user-level messages
  5520. </summary>
  5521. </member>
  5522. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail">
  5523. <summary>
  5524. mail system
  5525. </summary>
  5526. </member>
  5527. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons">
  5528. <summary>
  5529. system daemons
  5530. </summary>
  5531. </member>
  5532. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization">
  5533. <summary>
  5534. security/authorization messages
  5535. </summary>
  5536. </member>
  5537. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog">
  5538. <summary>
  5539. messages generated internally by syslogd
  5540. </summary>
  5541. </member>
  5542. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer">
  5543. <summary>
  5544. line printer subsystem
  5545. </summary>
  5546. </member>
  5547. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News">
  5548. <summary>
  5549. network news subsystem
  5550. </summary>
  5551. </member>
  5552. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp">
  5553. <summary>
  5554. UUCP subsystem
  5555. </summary>
  5556. </member>
  5557. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock">
  5558. <summary>
  5559. clock (cron/at) daemon
  5560. </summary>
  5561. </member>
  5562. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2">
  5563. <summary>
  5564. security/authorization messages (private)
  5565. </summary>
  5566. </member>
  5567. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp">
  5568. <summary>
  5569. ftp daemon
  5570. </summary>
  5571. </member>
  5572. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp">
  5573. <summary>
  5574. NTP subsystem
  5575. </summary>
  5576. </member>
  5577. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit">
  5578. <summary>
  5579. log audit
  5580. </summary>
  5581. </member>
  5582. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert">
  5583. <summary>
  5584. log alert
  5585. </summary>
  5586. </member>
  5587. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2">
  5588. <summary>
  5589. clock daemon
  5590. </summary>
  5591. </member>
  5592. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0">
  5593. <summary>
  5594. reserved for local use
  5595. </summary>
  5596. </member>
  5597. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1">
  5598. <summary>
  5599. reserved for local use
  5600. </summary>
  5601. </member>
  5602. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2">
  5603. <summary>
  5604. reserved for local use
  5605. </summary>
  5606. </member>
  5607. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3">
  5608. <summary>
  5609. reserved for local use
  5610. </summary>
  5611. </member>
  5612. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4">
  5613. <summary>
  5614. reserved for local use
  5615. </summary>
  5616. </member>
  5617. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5">
  5618. <summary>
  5619. reserved for local use
  5620. </summary>
  5621. </member>
  5622. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6">
  5623. <summary>
  5624. reserved for local use
  5625. </summary>
  5626. </member>
  5627. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7">
  5628. <summary>
  5629. reserved for local use
  5630. </summary>
  5631. </member>
  5632. <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor">
  5633. <summary>
  5634. Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender" /> class.
  5635. </summary>
  5636. <remarks>
  5637. This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender" /> class is set up to write
  5638. to a remote syslog daemon.
  5639. </remarks>
  5640. </member>
  5641. <member name="P:log4net.Appender.RemoteSyslogAppender.Identity">
  5642. <summary>
  5643. Message identity
  5644. </summary>
  5645. <remarks>
  5646. <para>
  5647. An identifier is specified with each log message. This can be specified
  5648. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  5649. as the tag) must not contain white space. The default value for the
  5650. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  5651. </para>
  5652. </remarks>
  5653. </member>
  5654. <member name="P:log4net.Appender.RemoteSyslogAppender.Facility">
  5655. <summary>
  5656. Syslog facility
  5657. </summary>
  5658. <remarks>
  5659. Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of
  5660. facilities is predefined and cannot be extended. The default value
  5661. is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  5662. </remarks>
  5663. </member>
  5664. <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)">
  5665. <summary>
  5666. Add a mapping of level to severity
  5667. </summary>
  5668. <param name="mapping">The mapping to add</param>
  5669. <remarks>
  5670. <para>
  5671. Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender.
  5672. </para>
  5673. </remarks>
  5674. </member>
  5675. <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)">
  5676. <summary>
  5677. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5678. </summary>
  5679. <param name="loggingEvent">The event to log.</param>
  5680. <remarks>
  5681. <para>
  5682. Writes the event to a remote syslog daemon.
  5683. </para>
  5684. <para>
  5685. The format of the output will depend on the appender's layout.
  5686. </para>
  5687. </remarks>
  5688. </member>
  5689. <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions">
  5690. <summary>
  5691. Initialize the options for this appender
  5692. </summary>
  5693. <remarks>
  5694. <para>
  5695. Initialize the level to syslog severity mappings set on this appender.
  5696. </para>
  5697. </remarks>
  5698. </member>
  5699. <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)">
  5700. <summary>
  5701. Translates a log4net level to a syslog severity.
  5702. </summary>
  5703. <param name="level">A log4net level.</param>
  5704. <returns>A syslog severity.</returns>
  5705. <remarks>
  5706. <para>
  5707. Translates a log4net level to a syslog severity.
  5708. </para>
  5709. </remarks>
  5710. </member>
  5711. <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)">
  5712. <summary>
  5713. Generate a syslog priority.
  5714. </summary>
  5715. <param name="facility">The syslog facility.</param>
  5716. <param name="severity">The syslog severity.</param>
  5717. <returns>A syslog priority.</returns>
  5718. <remarks>
  5719. <para>
  5720. Generate a syslog priority.
  5721. </para>
  5722. </remarks>
  5723. </member>
  5724. <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility">
  5725. <summary>
  5726. The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  5727. </summary>
  5728. </member>
  5729. <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity">
  5730. <summary>
  5731. The message identity
  5732. </summary>
  5733. </member>
  5734. <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping">
  5735. <summary>
  5736. Mapping from level object to syslog severity
  5737. </summary>
  5738. </member>
  5739. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferSize">
  5740. <summary>
  5741. Initial buffer size
  5742. </summary>
  5743. </member>
  5744. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferMaxCapacity">
  5745. <summary>
  5746. Maximum buffer size before it is recycled
  5747. </summary>
  5748. </member>
  5749. <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity">
  5750. <summary>
  5751. A class to act as a mapping between the level that a logging call is made at and
  5752. the syslog severity that is should be logged at.
  5753. </summary>
  5754. <remarks>
  5755. <para>
  5756. A class to act as a mapping between the level that a logging call is made at and
  5757. the syslog severity that is should be logged at.
  5758. </para>
  5759. </remarks>
  5760. </member>
  5761. <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity">
  5762. <summary>
  5763. The mapped syslog severity for the specified level
  5764. </summary>
  5765. <remarks>
  5766. <para>
  5767. Required property.
  5768. The mapped syslog severity for the specified level
  5769. </para>
  5770. </remarks>
  5771. </member>
  5772. <member name="T:log4net.Appender.RemotingAppender">
  5773. <summary>
  5774. Delivers logging events to a remote logging sink.
  5775. </summary>
  5776. <remarks>
  5777. <para>
  5778. This Appender is designed to deliver events to a remote sink.
  5779. That is any object that implements the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  5780. interface. It delivers the events using .NET remoting. The
  5781. object to deliver events to is specified by setting the
  5782. appenders <see cref="P:log4net.Appender.RemotingAppender.Sink"/> property.</para>
  5783. <para>
  5784. The RemotingAppender buffers events before sending them. This allows it to
  5785. make more efficient use of the remoting infrastructure.</para>
  5786. <para>
  5787. Once the buffer is full the events are still not sent immediately.
  5788. They are scheduled to be sent using a pool thread. The effect is that
  5789. the send occurs asynchronously. This is very important for a
  5790. number of non obvious reasons. The remoting infrastructure will
  5791. flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  5792. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  5793. remoting boundary. If the server is not contactable then
  5794. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  5795. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  5796. having side effects on the calling application the remoting call must be made
  5797. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  5798. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  5799. the events will block in the thread pool manager until a thread is available.</para>
  5800. <para>
  5801. Because the events are sent asynchronously using pool threads it is possible to close
  5802. this appender before all the queued events have been sent.
  5803. When closing the appender attempts to wait until all the queued events have been sent, but
  5804. this will timeout after 30 seconds regardless.</para>
  5805. <para>
  5806. If this appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
  5807. event has fired it may not be possible to send all the queued events. During process
  5808. exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
  5809. event handler is allowed to run for. If the runtime terminates the threads before
  5810. the queued events have been sent then they will be lost. To ensure that all events
  5811. are sent the appender must be closed before the application exits. See
  5812. <see cref="M:log4net.Core.LoggerManager.Shutdown"/> for details on how to shutdown
  5813. log4net programmatically.</para>
  5814. </remarks>
  5815. <seealso cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink" />
  5816. <author>Nicko Cadell</author>
  5817. <author>Gert Driesen</author>
  5818. <author>Daniel Cazzulino</author>
  5819. </member>
  5820. <member name="M:log4net.Appender.RemotingAppender.#ctor">
  5821. <summary>
  5822. Initializes a new instance of the <see cref="T:log4net.Appender.RemotingAppender" /> class.
  5823. </summary>
  5824. <remarks>
  5825. <para>
  5826. Default constructor.
  5827. </para>
  5828. </remarks>
  5829. </member>
  5830. <member name="P:log4net.Appender.RemotingAppender.Sink">
  5831. <summary>
  5832. Gets or sets the URL of the well-known object that will accept
  5833. the logging events.
  5834. </summary>
  5835. <value>
  5836. The well-known URL of the remote sink.
  5837. </value>
  5838. <remarks>
  5839. <para>
  5840. The URL of the remoting sink that will accept logging events.
  5841. The sink must implement the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  5842. interface.
  5843. </para>
  5844. </remarks>
  5845. </member>
  5846. <member name="M:log4net.Appender.RemotingAppender.ActivateOptions">
  5847. <summary>
  5848. Initialize the appender based on the options set
  5849. </summary>
  5850. <remarks>
  5851. <para>
  5852. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5853. activation scheme. The <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> method must
  5854. be called on this object after the configuration properties have
  5855. been set. Until <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> is called this
  5856. object is in an undefined state and must not be used.
  5857. </para>
  5858. <para>
  5859. If any of the configuration properties are modified then
  5860. <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> must be called again.
  5861. </para>
  5862. </remarks>
  5863. </member>
  5864. <member name="M:log4net.Appender.RemotingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  5865. <summary>
  5866. Send the contents of the buffer to the remote sink.
  5867. </summary>
  5868. <remarks>
  5869. The events are not sent immediately. They are scheduled to be sent
  5870. using a pool thread. The effect is that the send occurs asynchronously.
  5871. This is very important for a number of non obvious reasons. The remoting
  5872. infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  5873. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  5874. remoting boundary. If the server is not contactable then
  5875. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  5876. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  5877. having side effects on the calling application the remoting call must be made
  5878. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  5879. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  5880. the events will block in the thread pool manager until a thread is available.
  5881. </remarks>
  5882. <param name="events">The events to send.</param>
  5883. </member>
  5884. <member name="M:log4net.Appender.RemotingAppender.OnClose">
  5885. <summary>
  5886. Override base class close.
  5887. </summary>
  5888. <remarks>
  5889. <para>
  5890. This method waits while there are queued work items. The events are
  5891. sent asynchronously using <see cref="T:System.Threading.ThreadPool"/> work items. These items
  5892. will be sent once a thread pool thread is available to send them, therefore
  5893. it is possible to close the appender before all the queued events have been
  5894. sent.</para>
  5895. <para>
  5896. This method attempts to wait until all the queued events have been sent, but this
  5897. method will timeout after 30 seconds regardless.</para>
  5898. <para>
  5899. If the appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
  5900. event has fired it may not be possible to send all the queued events. During process
  5901. exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
  5902. event handler is allowed to run for.</para>
  5903. </remarks>
  5904. </member>
  5905. <member name="M:log4net.Appender.RemotingAppender.Flush(System.Int32)">
  5906. <summary>
  5907. Flushes any buffered log data.
  5908. </summary>
  5909. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  5910. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  5911. </member>
  5912. <member name="M:log4net.Appender.RemotingAppender.BeginAsyncSend">
  5913. <summary>
  5914. A work item is being queued into the thread pool
  5915. </summary>
  5916. </member>
  5917. <member name="M:log4net.Appender.RemotingAppender.EndAsyncSend">
  5918. <summary>
  5919. A work item from the thread pool has completed
  5920. </summary>
  5921. </member>
  5922. <member name="M:log4net.Appender.RemotingAppender.SendBufferCallback(System.Object)">
  5923. <summary>
  5924. Send the contents of the buffer to the remote sink.
  5925. </summary>
  5926. <remarks>
  5927. This method is designed to be used with the <see cref="T:System.Threading.ThreadPool"/>.
  5928. This method expects to be passed an array of <see cref="T:log4net.Core.LoggingEvent"/>
  5929. objects in the state param.
  5930. </remarks>
  5931. <param name="state">the logging events to send</param>
  5932. </member>
  5933. <member name="F:log4net.Appender.RemotingAppender.m_sinkUrl">
  5934. <summary>
  5935. The URL of the remote sink.
  5936. </summary>
  5937. </member>
  5938. <member name="F:log4net.Appender.RemotingAppender.m_sinkObj">
  5939. <summary>
  5940. The local proxy (.NET remoting) for the remote logging sink.
  5941. </summary>
  5942. </member>
  5943. <member name="F:log4net.Appender.RemotingAppender.m_queuedCallbackCount">
  5944. <summary>
  5945. The number of queued callbacks currently waiting or executing
  5946. </summary>
  5947. </member>
  5948. <member name="F:log4net.Appender.RemotingAppender.m_workQueueEmptyEvent">
  5949. <summary>
  5950. Event used to signal when there are no queued work items
  5951. </summary>
  5952. <remarks>
  5953. This event is set when there are no queued work items. In this
  5954. state it is safe to close the appender.
  5955. </remarks>
  5956. </member>
  5957. <member name="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink">
  5958. <summary>
  5959. Interface used to deliver <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  5960. </summary>
  5961. <remarks>
  5962. This interface must be implemented by a remoting sink
  5963. if the <see cref="T:log4net.Appender.RemotingAppender"/> is to be used
  5964. to deliver logging events to the sink.
  5965. </remarks>
  5966. </member>
  5967. <member name="M:log4net.Appender.RemotingAppender.IRemoteLoggingSink.LogEvents(log4net.Core.LoggingEvent[])">
  5968. <summary>
  5969. Delivers logging events to the remote sink
  5970. </summary>
  5971. <param name="events">Array of events to log.</param>
  5972. <remarks>
  5973. <para>
  5974. Delivers logging events to the remote sink
  5975. </para>
  5976. </remarks>
  5977. </member>
  5978. <member name="T:log4net.Appender.RollingFileAppender">
  5979. <summary>
  5980. Appender that rolls log files based on size or date or both.
  5981. </summary>
  5982. <remarks>
  5983. <para>
  5984. RollingFileAppender can roll log files based on size or date or both
  5985. depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property.
  5986. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled
  5987. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  5988. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled
  5989. once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  5990. is crossed.
  5991. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be
  5992. rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  5993. is crossed, but within a date boundary the file will also be rolled
  5994. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  5995. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when
  5996. the appender is configured. This effectively means that the log file can be
  5997. rolled once per program execution.
  5998. </para>
  5999. <para>
  6000. A of few additional optional features have been added:
  6001. <list type="bullet">
  6002. <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item>
  6003. <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item>
  6004. <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item>
  6005. </list>
  6006. </para>
  6007. <note>
  6008. <para>
  6009. For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/>
  6010. greater than zero is highly recommended, otherwise all the backup files need
  6011. to be renamed each time a new backup is created.
  6012. </para>
  6013. <para>
  6014. When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6015. to <see langword="true"/> will reduce the number of file renamings to few or none.
  6016. </para>
  6017. </note>
  6018. <note type="caution">
  6019. <para>
  6020. Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing
  6021. the log file directory of backup files will cause unexpected and unwanted side effects.
  6022. </para>
  6023. </note>
  6024. <para>
  6025. If Date/Time based rolling is enabled this appender will attempt to roll existing files
  6026. in the directory without a Date/Time tag based on the last write date of the base log file.
  6027. The appender only rolls the log file when a message is logged. If Date/Time based rolling
  6028. is enabled then the appender will not roll the log file at the Date/Time boundary but
  6029. at the point when the next message is logged after the boundary has been crossed.
  6030. </para>
  6031. <para>
  6032. The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and
  6033. has the same behavior when opening the log file.
  6034. The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>
  6035. is called. This will typically be during configuration.
  6036. If the file cannot be opened for writing the appender will attempt
  6037. to open the file again each time a message is logged to the appender.
  6038. If the file cannot be opened for writing when a message is logged then
  6039. the message will be discarded by this appender.
  6040. </para>
  6041. <para>
  6042. When rolling a backup file necessitates deleting an older backup file the
  6043. file to be deleted is moved to a temporary name before being deleted.
  6044. </para>
  6045. <note type="caution">
  6046. <para>
  6047. A maximum number of backup files when rolling on date/time boundaries is not supported.
  6048. </para>
  6049. </note>
  6050. </remarks>
  6051. <author>Nicko Cadell</author>
  6052. <author>Gert Driesen</author>
  6053. <author>Aspi Havewala</author>
  6054. <author>Douglas de la Torre</author>
  6055. <author>Edward Smit</author>
  6056. </member>
  6057. <member name="T:log4net.Appender.RollingFileAppender.RollingMode">
  6058. <summary>
  6059. Style of rolling to use
  6060. </summary>
  6061. <remarks>
  6062. <para>
  6063. Style of rolling to use
  6064. </para>
  6065. </remarks>
  6066. </member>
  6067. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once">
  6068. <summary>
  6069. Roll files once per program execution
  6070. </summary>
  6071. <remarks>
  6072. <para>
  6073. Roll files once per program execution.
  6074. Well really once each time this appender is
  6075. configured.
  6076. </para>
  6077. <para>
  6078. Setting this option also sets <c>AppendToFile</c> to
  6079. <c>false</c> on the <c>RollingFileAppender</c>, otherwise
  6080. this appender would just be a normal file appender.
  6081. </para>
  6082. </remarks>
  6083. </member>
  6084. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size">
  6085. <summary>
  6086. Roll files based only on the size of the file
  6087. </summary>
  6088. </member>
  6089. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date">
  6090. <summary>
  6091. Roll files based only on the date
  6092. </summary>
  6093. </member>
  6094. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite">
  6095. <summary>
  6096. Roll files based on both the size and date of the file
  6097. </summary>
  6098. </member>
  6099. <member name="T:log4net.Appender.RollingFileAppender.RollPoint">
  6100. <summary>
  6101. The code assumes that the following 'time' constants are in a increasing sequence.
  6102. </summary>
  6103. <remarks>
  6104. <para>
  6105. The code assumes that the following 'time' constants are in a increasing sequence.
  6106. </para>
  6107. </remarks>
  6108. </member>
  6109. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint">
  6110. <summary>
  6111. Roll the log not based on the date
  6112. </summary>
  6113. </member>
  6114. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute">
  6115. <summary>
  6116. Roll the log for each minute
  6117. </summary>
  6118. </member>
  6119. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour">
  6120. <summary>
  6121. Roll the log for each hour
  6122. </summary>
  6123. </member>
  6124. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay">
  6125. <summary>
  6126. Roll the log twice a day (midday and midnight)
  6127. </summary>
  6128. </member>
  6129. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay">
  6130. <summary>
  6131. Roll the log each day (midnight)
  6132. </summary>
  6133. </member>
  6134. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek">
  6135. <summary>
  6136. Roll the log each week
  6137. </summary>
  6138. </member>
  6139. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth">
  6140. <summary>
  6141. Roll the log each month
  6142. </summary>
  6143. </member>
  6144. <member name="M:log4net.Appender.RollingFileAppender.#ctor">
  6145. <summary>
  6146. Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender" /> class.
  6147. </summary>
  6148. <remarks>
  6149. <para>
  6150. Default constructor.
  6151. </para>
  6152. </remarks>
  6153. </member>
  6154. <member name="M:log4net.Appender.RollingFileAppender.Finalize">
  6155. <summary>
  6156. Cleans up all resources used by this appender.
  6157. </summary>
  6158. </member>
  6159. <member name="P:log4net.Appender.RollingFileAppender.DateTimeStrategy">
  6160. <summary>
  6161. Gets or sets the strategy for determining the current date and time. The default
  6162. implementation is to use LocalDateTime which internally calls through to DateTime.Now.
  6163. DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying
  6164. <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  6165. </summary>
  6166. <value>
  6167. An implementation of the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> interface which returns the current date and time.
  6168. </value>
  6169. <remarks>
  6170. <para>
  6171. Gets or sets the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> used to return the current date and time.
  6172. </para>
  6173. <para>
  6174. There are two built strategies for determining the current date and time,
  6175. <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>
  6176. and <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  6177. </para>
  6178. <para>
  6179. The default strategy is <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>.
  6180. </para>
  6181. </remarks>
  6182. </member>
  6183. <member name="P:log4net.Appender.RollingFileAppender.DatePattern">
  6184. <summary>
  6185. Gets or sets the date pattern to be used for generating file names
  6186. when rolling over on date.
  6187. </summary>
  6188. <value>
  6189. The date pattern to be used for generating file names when rolling
  6190. over on date.
  6191. </value>
  6192. <remarks>
  6193. <para>
  6194. Takes a string in the same format as expected by
  6195. <see cref="T:log4net.DateFormatter.SimpleDateFormatter" />.
  6196. </para>
  6197. <para>
  6198. This property determines the rollover schedule when rolling over
  6199. on date.
  6200. </para>
  6201. </remarks>
  6202. </member>
  6203. <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups">
  6204. <summary>
  6205. Gets or sets the maximum number of backup files that are kept before
  6206. the oldest is erased.
  6207. </summary>
  6208. <value>
  6209. The maximum number of backup files that are kept before the oldest is
  6210. erased.
  6211. </value>
  6212. <remarks>
  6213. <para>
  6214. If set to zero, then there will be no backup files and the log file
  6215. will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>.
  6216. </para>
  6217. <para>
  6218. If a negative number is supplied then no deletions will be made. Note
  6219. that this could result in very slow performance as a large number of
  6220. files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used.
  6221. </para>
  6222. <para>
  6223. The maximum applies to <b>each</b> time based group of files and
  6224. <b>not</b> the total.
  6225. </para>
  6226. </remarks>
  6227. </member>
  6228. <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize">
  6229. <summary>
  6230. Gets or sets the maximum size that the output file is allowed to reach
  6231. before being rolled over to backup files.
  6232. </summary>
  6233. <value>
  6234. The maximum size in bytes that the output file is allowed to reach before being
  6235. rolled over to backup files.
  6236. </value>
  6237. <remarks>
  6238. <para>
  6239. This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except
  6240. that it is required for differentiating the setter taking a
  6241. <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/>
  6242. argument.
  6243. </para>
  6244. <para>
  6245. The default maximum file size is 10MB (10*1024*1024).
  6246. </para>
  6247. </remarks>
  6248. </member>
  6249. <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize">
  6250. <summary>
  6251. Gets or sets the maximum size that the output file is allowed to reach
  6252. before being rolled over to backup files.
  6253. </summary>
  6254. <value>
  6255. The maximum size that the output file is allowed to reach before being
  6256. rolled over to backup files.
  6257. </value>
  6258. <remarks>
  6259. <para>
  6260. This property allows you to specify the maximum size with the
  6261. suffixes "KB", "MB" or "GB" so that the size is interpreted being
  6262. expressed respectively in kilobytes, megabytes or gigabytes.
  6263. </para>
  6264. <para>
  6265. For example, the value "10KB" will be interpreted as 10240 bytes.
  6266. </para>
  6267. <para>
  6268. The default maximum file size is 10MB.
  6269. </para>
  6270. <para>
  6271. If you have the option to set the maximum file size programmatically
  6272. consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this
  6273. allows you to set the size in bytes as a <see cref="T:System.Int64"/>.
  6274. </para>
  6275. </remarks>
  6276. </member>
  6277. <member name="P:log4net.Appender.RollingFileAppender.CountDirection">
  6278. <summary>
  6279. Gets or sets the rolling file count direction.
  6280. </summary>
  6281. <value>
  6282. The rolling file count direction.
  6283. </value>
  6284. <remarks>
  6285. <para>
  6286. Indicates if the current file is the lowest numbered file or the
  6287. highest numbered file.
  6288. </para>
  6289. <para>
  6290. By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &lt; 0),
  6291. i.e. log.1 is most recent, log.5 is the 5th backup, etc...
  6292. </para>
  6293. <para>
  6294. <see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &gt;= 0 does the opposite i.e.
  6295. log.1 is the first backup made, log.5 is the 5th backup made, etc.
  6296. For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &gt;= 0 to reduce
  6297. rollover costs.
  6298. </para>
  6299. <para>The default file count direction is -1.</para>
  6300. </remarks>
  6301. </member>
  6302. <member name="P:log4net.Appender.RollingFileAppender.RollingStyle">
  6303. <summary>
  6304. Gets or sets the rolling style.
  6305. </summary>
  6306. <value>The rolling style.</value>
  6307. <remarks>
  6308. <para>
  6309. The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite" />.
  6310. </para>
  6311. <para>
  6312. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's
  6313. <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
  6314. the appender would append to a single file rather than rolling
  6315. the file each time it is opened.
  6316. </para>
  6317. </remarks>
  6318. </member>
  6319. <member name="P:log4net.Appender.RollingFileAppender.PreserveLogFileNameExtension">
  6320. <summary>
  6321. Gets or sets a value indicating whether to preserve the file name extension when rolling.
  6322. </summary>
  6323. <value>
  6324. <c>true</c> if the file name extension should be preserved.
  6325. </value>
  6326. <remarks>
  6327. <para>
  6328. By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup.
  6329. However, under Windows the new file name will loose any program associations as the
  6330. extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or
  6331. file.curSizeRollBackup.log to maintain any program associations.
  6332. </para>
  6333. </remarks>
  6334. </member>
  6335. <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName">
  6336. <summary>
  6337. Gets or sets a value indicating whether to always log to
  6338. the same file.
  6339. </summary>
  6340. <value>
  6341. <c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
  6342. </value>
  6343. <remarks>
  6344. <para>
  6345. By default file.log is always the current file. Optionally
  6346. file.log.yyyy-mm-dd for current formatted datePattern can by the currently
  6347. logging file (or file.log.curSizeRollBackup or even
  6348. file.log.yyyy-mm-dd.curSizeRollBackup).
  6349. </para>
  6350. <para>
  6351. This will make time based rollovers with a large number of backups
  6352. much faster as the appender it won't have to rename all the backups!
  6353. </para>
  6354. </remarks>
  6355. </member>
  6356. <member name="F:log4net.Appender.RollingFileAppender.declaringType">
  6357. <summary>
  6358. The fully qualified type of the RollingFileAppender class.
  6359. </summary>
  6360. <remarks>
  6361. Used by the internal logger to record the Type of the
  6362. log message.
  6363. </remarks>
  6364. </member>
  6365. <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)">
  6366. <summary>
  6367. Sets the quiet writer being used.
  6368. </summary>
  6369. <remarks>
  6370. This method can be overridden by sub classes.
  6371. </remarks>
  6372. <param name="writer">the writer to set</param>
  6373. </member>
  6374. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)">
  6375. <summary>
  6376. Write out a logging event.
  6377. </summary>
  6378. <param name="loggingEvent">the event to write to file.</param>
  6379. <remarks>
  6380. <para>
  6381. Handles append time behavior for RollingFileAppender. This checks
  6382. if a roll over either by date (checked first) or time (checked second)
  6383. is need and then appends to the file last.
  6384. </para>
  6385. </remarks>
  6386. </member>
  6387. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
  6388. <summary>
  6389. Write out an array of logging events.
  6390. </summary>
  6391. <param name="loggingEvents">the events to write to file.</param>
  6392. <remarks>
  6393. <para>
  6394. Handles append time behavior for RollingFileAppender. This checks
  6395. if a roll over either by date (checked first) or time (checked second)
  6396. is need and then appends to the file last.
  6397. </para>
  6398. </remarks>
  6399. </member>
  6400. <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
  6401. <summary>
  6402. Performs any required rolling before outputting the next event
  6403. </summary>
  6404. <remarks>
  6405. <para>
  6406. Handles append time behavior for RollingFileAppender. This checks
  6407. if a roll over either by date (checked first) or time (checked second)
  6408. is need and then appends to the file last.
  6409. </para>
  6410. </remarks>
  6411. </member>
  6412. <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)">
  6413. <summary>
  6414. Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6415. is false then the fully qualified name is determined and used.
  6416. </summary>
  6417. <param name="fileName">the name of the file to open</param>
  6418. <param name="append">true to append to existing file</param>
  6419. <remarks>
  6420. <para>This method will ensure that the directory structure
  6421. for the <paramref name="fileName"/> specified exists.</para>
  6422. </remarks>
  6423. </member>
  6424. <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)">
  6425. <summary>
  6426. Get the current output file name
  6427. </summary>
  6428. <param name="fileName">the base file name</param>
  6429. <returns>the output file name</returns>
  6430. <remarks>
  6431. The output file name is based on the base fileName specified.
  6432. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output
  6433. file name is the same as the base file passed in. Otherwise
  6434. the output file depends on the date pattern, on the count
  6435. direction or both.
  6436. </remarks>
  6437. </member>
  6438. <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups">
  6439. <summary>
  6440. Determines curSizeRollBackups (only within the current roll point)
  6441. </summary>
  6442. </member>
  6443. <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)">
  6444. <summary>
  6445. Generates a wildcard pattern that can be used to find all files
  6446. that are similar to the base file name.
  6447. </summary>
  6448. <param name="baseFileName"></param>
  6449. <returns></returns>
  6450. </member>
  6451. <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)">
  6452. <summary>
  6453. Builds a list of filenames for all files matching the base filename plus a file
  6454. pattern.
  6455. </summary>
  6456. <param name="baseFilePath"></param>
  6457. <returns></returns>
  6458. </member>
  6459. <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing">
  6460. <summary>
  6461. Initiates a roll over if needed for crossing a date boundary since the last run.
  6462. </summary>
  6463. </member>
  6464. <member name="M:log4net.Appender.RollingFileAppender.ExistingInit">
  6465. <summary>
  6466. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  6467. </summary>
  6468. <remarks>
  6469. <para>
  6470. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  6471. The following is done
  6472. <list type="bullet">
  6473. <item>determine curSizeRollBackups (only within the current roll point)</item>
  6474. <item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
  6475. </list>
  6476. </para>
  6477. </remarks>
  6478. </member>
  6479. <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)">
  6480. <summary>
  6481. Does the work of bumping the 'current' file counter higher
  6482. to the highest count when an incremental file name is seen.
  6483. The highest count is either the first file (when count direction
  6484. is greater than 0) or the last file (when count direction less than 0).
  6485. In either case, we want to know the highest count that is present.
  6486. </summary>
  6487. <param name="baseFile"></param>
  6488. <param name="curFileName"></param>
  6489. </member>
  6490. <member name="M:log4net.Appender.RollingFileAppender.GetBackUpIndex(System.String)">
  6491. <summary>
  6492. Attempts to extract a number from the end of the file name that indicates
  6493. the number of the times the file has been rolled over.
  6494. </summary>
  6495. <remarks>
  6496. Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes.
  6497. </remarks>
  6498. <param name="curFileName"></param>
  6499. <returns></returns>
  6500. </member>
  6501. <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)">
  6502. <summary>
  6503. Takes a list of files and a base file name, and looks for
  6504. 'incremented' versions of the base file. Bumps the max
  6505. count up to the highest count seen.
  6506. </summary>
  6507. <param name="baseFile"></param>
  6508. <param name="arrayFiles"></param>
  6509. </member>
  6510. <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)">
  6511. <summary>
  6512. Calculates the RollPoint for the datePattern supplied.
  6513. </summary>
  6514. <param name="datePattern">the date pattern to calculate the check period for</param>
  6515. <returns>The RollPoint that is most accurate for the date pattern supplied</returns>
  6516. <remarks>
  6517. Essentially the date pattern is examined to determine what the
  6518. most suitable roll point is. The roll point chosen is the roll point
  6519. with the smallest period that can be detected using the date pattern
  6520. supplied. i.e. if the date pattern only outputs the year, month, day
  6521. and hour then the smallest roll point that can be detected would be
  6522. and hourly roll point as minutes could not be detected.
  6523. </remarks>
  6524. </member>
  6525. <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions">
  6526. <summary>
  6527. Initialize the appender based on the options set
  6528. </summary>
  6529. <remarks>
  6530. <para>
  6531. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6532. activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must
  6533. be called on this object after the configuration properties have
  6534. been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this
  6535. object is in an undefined state and must not be used.
  6536. </para>
  6537. <para>
  6538. If any of the configuration properties are modified then
  6539. <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again.
  6540. </para>
  6541. <para>
  6542. Sets initial conditions including date/time roll over information, first check,
  6543. scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize
  6544. the current number of backups.
  6545. </para>
  6546. </remarks>
  6547. </member>
  6548. <member name="M:log4net.Appender.RollingFileAppender.CombinePath(System.String,System.String)">
  6549. <summary>
  6550. </summary>
  6551. <param name="path1"></param>
  6552. <param name="path2">.1, .2, .3, etc.</param>
  6553. <returns></returns>
  6554. </member>
  6555. <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)">
  6556. <summary>
  6557. Rollover the file(s) to date/time tagged file(s).
  6558. </summary>
  6559. <param name="fileIsOpen">set to true if the file to be rolled is currently open</param>
  6560. <remarks>
  6561. <para>
  6562. Rollover the file(s) to date/time tagged file(s).
  6563. Resets curSizeRollBackups.
  6564. If fileIsOpen is set then the new file is opened (through SafeOpenFile).
  6565. </para>
  6566. </remarks>
  6567. </member>
  6568. <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)">
  6569. <summary>
  6570. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>.
  6571. </summary>
  6572. <param name="fromFile">Name of existing file to roll.</param>
  6573. <param name="toFile">New name for file.</param>
  6574. <remarks>
  6575. <para>
  6576. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It
  6577. also checks for existence of target file and deletes if it does.
  6578. </para>
  6579. </remarks>
  6580. </member>
  6581. <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)">
  6582. <summary>
  6583. Test if a file exists at a specified path
  6584. </summary>
  6585. <param name="path">the path to the file</param>
  6586. <returns>true if the file exists</returns>
  6587. <remarks>
  6588. <para>
  6589. Test if a file exists at a specified path
  6590. </para>
  6591. </remarks>
  6592. </member>
  6593. <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)">
  6594. <summary>
  6595. Deletes the specified file if it exists.
  6596. </summary>
  6597. <param name="fileName">The file to delete.</param>
  6598. <remarks>
  6599. <para>
  6600. Delete a file if is exists.
  6601. The file is first moved to a new filename then deleted.
  6602. This allows the file to be removed even when it cannot
  6603. be deleted, but it still can be moved.
  6604. </para>
  6605. </remarks>
  6606. </member>
  6607. <member name="M:log4net.Appender.RollingFileAppender.RollOverSize">
  6608. <summary>
  6609. Implements file roll base on file size.
  6610. </summary>
  6611. <remarks>
  6612. <para>
  6613. If the maximum number of size based backups is reached
  6614. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  6615. file is deleted -- its index determined by the sign of countDirection.
  6616. If <c>countDirection</c> &lt; 0, then files
  6617. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  6618. are renamed to {<c>File.2</c>, ...,
  6619. <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is
  6620. renamed <c>File.1</c> and closed.
  6621. </para>
  6622. <para>
  6623. A new file is created to receive further log output.
  6624. </para>
  6625. <para>
  6626. If <c>maxSizeRollBackups</c> is equal to zero, then the
  6627. <c>File</c> is truncated with no backup files created.
  6628. </para>
  6629. <para>
  6630. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  6631. renamed if needed and no files are deleted.
  6632. </para>
  6633. </remarks>
  6634. </member>
  6635. <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)">
  6636. <summary>
  6637. Implements file roll.
  6638. </summary>
  6639. <param name="baseFileName">the base name to rename</param>
  6640. <remarks>
  6641. <para>
  6642. If the maximum number of size based backups is reached
  6643. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  6644. file is deleted -- its index determined by the sign of countDirection.
  6645. If <c>countDirection</c> &lt; 0, then files
  6646. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  6647. are renamed to {<c>File.2</c>, ...,
  6648. <c>File.curSizeRollBackups</c>}.
  6649. </para>
  6650. <para>
  6651. If <c>maxSizeRollBackups</c> is equal to zero, then the
  6652. <c>File</c> is truncated with no backup files created.
  6653. </para>
  6654. <para>
  6655. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  6656. renamed if needed and no files are deleted.
  6657. </para>
  6658. <para>
  6659. This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files.
  6660. </para>
  6661. </remarks>
  6662. </member>
  6663. <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
  6664. <summary>
  6665. Get the start time of the next window for the current rollpoint
  6666. </summary>
  6667. <param name="currentDateTime">the current date</param>
  6668. <param name="rollPoint">the type of roll point we are working with</param>
  6669. <returns>the start time for the next roll point an interval after the currentDateTime date</returns>
  6670. <remarks>
  6671. <para>
  6672. Returns the date of the next roll point after the currentDateTime date passed to the method.
  6673. </para>
  6674. <para>
  6675. The basic strategy is to subtract the time parts that are less significant
  6676. than the rollpoint from the current time. This should roll the time back to
  6677. the start of the time window for the current rollpoint. Then we add 1 window
  6678. worth of time and get the start time of the next window for the rollpoint.
  6679. </para>
  6680. </remarks>
  6681. </member>
  6682. <member name="F:log4net.Appender.RollingFileAppender.m_dateTime">
  6683. <summary>
  6684. This object supplies the current date/time. Allows test code to plug in
  6685. a method to control this class when testing date/time based rolling. The default
  6686. implementation uses the underlying value of DateTime.Now.
  6687. </summary>
  6688. </member>
  6689. <member name="F:log4net.Appender.RollingFileAppender.m_datePattern">
  6690. <summary>
  6691. The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c>
  6692. meaning daily rollover.
  6693. </summary>
  6694. </member>
  6695. <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename">
  6696. <summary>
  6697. The actual formatted filename that is currently being written to
  6698. or will be the file transferred to on roll over
  6699. (based on staticLogFileName).
  6700. </summary>
  6701. </member>
  6702. <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck">
  6703. <summary>
  6704. The timestamp when we shall next recompute the filename.
  6705. </summary>
  6706. </member>
  6707. <member name="F:log4net.Appender.RollingFileAppender.m_now">
  6708. <summary>
  6709. Holds date of last roll over
  6710. </summary>
  6711. </member>
  6712. <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint">
  6713. <summary>
  6714. The type of rolling done
  6715. </summary>
  6716. </member>
  6717. <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize">
  6718. <summary>
  6719. The default maximum file size is 10MB
  6720. </summary>
  6721. </member>
  6722. <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups">
  6723. <summary>
  6724. There is zero backup files by default
  6725. </summary>
  6726. </member>
  6727. <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups">
  6728. <summary>
  6729. How many sized based backups have been made so far
  6730. </summary>
  6731. </member>
  6732. <member name="F:log4net.Appender.RollingFileAppender.m_countDirection">
  6733. <summary>
  6734. The rolling file count direction.
  6735. </summary>
  6736. </member>
  6737. <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle">
  6738. <summary>
  6739. The rolling mode used in this appender.
  6740. </summary>
  6741. </member>
  6742. <member name="F:log4net.Appender.RollingFileAppender.m_rollDate">
  6743. <summary>
  6744. Cache flag set if we are rolling by date.
  6745. </summary>
  6746. </member>
  6747. <member name="F:log4net.Appender.RollingFileAppender.m_rollSize">
  6748. <summary>
  6749. Cache flag set if we are rolling by size.
  6750. </summary>
  6751. </member>
  6752. <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName">
  6753. <summary>
  6754. Value indicating whether to always log to the same file.
  6755. </summary>
  6756. </member>
  6757. <member name="F:log4net.Appender.RollingFileAppender.m_preserveLogFileNameExtension">
  6758. <summary>
  6759. Value indicating whether to preserve the file name extension when rolling.
  6760. </summary>
  6761. </member>
  6762. <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName">
  6763. <summary>
  6764. FileName provided in configuration. Used for rolling properly
  6765. </summary>
  6766. </member>
  6767. <member name="F:log4net.Appender.RollingFileAppender.m_mutexForRolling">
  6768. <summary>
  6769. A mutex that is used to lock rolling of files.
  6770. </summary>
  6771. </member>
  6772. <member name="F:log4net.Appender.RollingFileAppender.s_date1970">
  6773. <summary>
  6774. The 1st of January 1970 in UTC
  6775. </summary>
  6776. </member>
  6777. <member name="T:log4net.Appender.RollingFileAppender.IDateTime">
  6778. <summary>
  6779. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  6780. </summary>
  6781. <remarks>
  6782. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  6783. Used primarily to allow test classes to plug themselves in so they can
  6784. supply test date/times.
  6785. </remarks>
  6786. </member>
  6787. <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now">
  6788. <summary>
  6789. Gets the <i>current</i> time.
  6790. </summary>
  6791. <value>The <i>current</i> time.</value>
  6792. <remarks>
  6793. <para>
  6794. Gets the <i>current</i> time.
  6795. </para>
  6796. </remarks>
  6797. </member>
  6798. <member name="T:log4net.Appender.RollingFileAppender.LocalDateTime">
  6799. <summary>
  6800. Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time.
  6801. </summary>
  6802. </member>
  6803. <member name="P:log4net.Appender.RollingFileAppender.LocalDateTime.Now">
  6804. <summary>
  6805. Gets the <b>current</b> time.
  6806. </summary>
  6807. <value>The <b>current</b> time.</value>
  6808. <remarks>
  6809. <para>
  6810. Gets the <b>current</b> time.
  6811. </para>
  6812. </remarks>
  6813. </member>
  6814. <member name="T:log4net.Appender.RollingFileAppender.UniversalDateTime">
  6815. <summary>
  6816. Implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time as the coordinated universal time (UTC).
  6817. </summary>
  6818. </member>
  6819. <member name="P:log4net.Appender.RollingFileAppender.UniversalDateTime.Now">
  6820. <summary>
  6821. Gets the <b>current</b> time.
  6822. </summary>
  6823. <value>The <b>current</b> time.</value>
  6824. <remarks>
  6825. <para>
  6826. Gets the <b>current</b> time.
  6827. </para>
  6828. </remarks>
  6829. </member>
  6830. <member name="T:log4net.Appender.SmtpAppender">
  6831. <summary>
  6832. Send an e-mail when a specific logging event occurs, typically on errors
  6833. or fatal errors.
  6834. </summary>
  6835. <remarks>
  6836. <para>
  6837. The number of logging events delivered in this e-mail depend on
  6838. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  6839. <see cref="T:log4net.Appender.SmtpAppender"/> keeps only the last
  6840. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  6841. cyclic buffer. This keeps memory requirements at a reasonable level while
  6842. still delivering useful application context.
  6843. </para>
  6844. <note type="caution">
  6845. Authentication and setting the server Port are only available on the MS .NET 1.1 runtime.
  6846. For these features to be enabled you need to ensure that you are using a version of
  6847. the log4net assembly that is built against the MS .NET 1.1 framework and that you are
  6848. running the your application on the MS .NET 1.1 runtime. On all other platforms only sending
  6849. unauthenticated messages to a server listening on port 25 (the default) is supported.
  6850. </note>
  6851. <para>
  6852. Authentication is supported by setting the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property to
  6853. either <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> or <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  6854. If using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> authentication then the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  6855. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> properties must also be set.
  6856. </para>
  6857. <para>
  6858. To set the SMTP server port use the <see cref="P:log4net.Appender.SmtpAppender.Port"/> property. The default port is 25.
  6859. </para>
  6860. </remarks>
  6861. <author>Nicko Cadell</author>
  6862. <author>Gert Driesen</author>
  6863. </member>
  6864. <member name="M:log4net.Appender.SmtpAppender.#ctor">
  6865. <summary>
  6866. Default constructor
  6867. </summary>
  6868. <remarks>
  6869. <para>
  6870. Default constructor
  6871. </para>
  6872. </remarks>
  6873. </member>
  6874. <member name="P:log4net.Appender.SmtpAppender.To">
  6875. <summary>
  6876. 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).
  6877. </summary>
  6878. <value>
  6879. <para>
  6880. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  6881. </para>
  6882. <para>
  6883. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  6884. </para>
  6885. </value>
  6886. <remarks>
  6887. <para>
  6888. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  6889. </para>
  6890. <para>
  6891. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  6892. </para>
  6893. </remarks>
  6894. </member>
  6895. <member name="P:log4net.Appender.SmtpAppender.Cc">
  6896. <summary>
  6897. Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses
  6898. that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions).
  6899. </summary>
  6900. <value>
  6901. <para>
  6902. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  6903. </para>
  6904. <para>
  6905. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  6906. </para>
  6907. </value>
  6908. <remarks>
  6909. <para>
  6910. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  6911. </para>
  6912. <para>
  6913. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  6914. </para>
  6915. </remarks>
  6916. </member>
  6917. <member name="P:log4net.Appender.SmtpAppender.Bcc">
  6918. <summary>
  6919. Gets or sets a semicolon-delimited list of recipient e-mail addresses
  6920. that will be blind carbon copied.
  6921. </summary>
  6922. <value>
  6923. A semicolon-delimited list of e-mail addresses.
  6924. </value>
  6925. <remarks>
  6926. <para>
  6927. A semicolon-delimited list of recipient e-mail addresses.
  6928. </para>
  6929. </remarks>
  6930. </member>
  6931. <member name="P:log4net.Appender.SmtpAppender.From">
  6932. <summary>
  6933. Gets or sets the e-mail address of the sender.
  6934. </summary>
  6935. <value>
  6936. The e-mail address of the sender.
  6937. </value>
  6938. <remarks>
  6939. <para>
  6940. The e-mail address of the sender.
  6941. </para>
  6942. </remarks>
  6943. </member>
  6944. <member name="P:log4net.Appender.SmtpAppender.Subject">
  6945. <summary>
  6946. Gets or sets the subject line of the e-mail message.
  6947. </summary>
  6948. <value>
  6949. The subject line of the e-mail message.
  6950. </value>
  6951. <remarks>
  6952. <para>
  6953. The subject line of the e-mail message.
  6954. </para>
  6955. </remarks>
  6956. </member>
  6957. <member name="P:log4net.Appender.SmtpAppender.SmtpHost">
  6958. <summary>
  6959. Gets or sets the name of the SMTP relay mail server to use to send
  6960. the e-mail messages.
  6961. </summary>
  6962. <value>
  6963. The name of the e-mail relay server. If SmtpServer is not set, the
  6964. name of the local SMTP server is used.
  6965. </value>
  6966. <remarks>
  6967. <para>
  6968. The name of the e-mail relay server. If SmtpServer is not set, the
  6969. name of the local SMTP server is used.
  6970. </para>
  6971. </remarks>
  6972. </member>
  6973. <member name="P:log4net.Appender.SmtpAppender.LocationInfo">
  6974. <summary>
  6975. Obsolete
  6976. </summary>
  6977. <remarks>
  6978. Use the BufferingAppenderSkeleton Fix methods instead
  6979. </remarks>
  6980. <remarks>
  6981. <para>
  6982. Obsolete property.
  6983. </para>
  6984. </remarks>
  6985. </member>
  6986. <member name="P:log4net.Appender.SmtpAppender.Authentication">
  6987. <summary>
  6988. The mode to use to authentication with the SMTP server
  6989. </summary>
  6990. <remarks>
  6991. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  6992. <para>
  6993. Valid Authentication mode values are: <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>,
  6994. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, and <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  6995. The default value is <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>. When using
  6996. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> you must specify the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  6997. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> to use to authenticate.
  6998. When using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/> the Windows credentials for the current
  6999. thread, if impersonating, or the process will be used to authenticate.
  7000. </para>
  7001. </remarks>
  7002. </member>
  7003. <member name="P:log4net.Appender.SmtpAppender.Username">
  7004. <summary>
  7005. The username to use to authenticate with the SMTP server
  7006. </summary>
  7007. <remarks>
  7008. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7009. <para>
  7010. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7011. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7012. otherwise the username will be ignored.
  7013. </para>
  7014. </remarks>
  7015. </member>
  7016. <member name="P:log4net.Appender.SmtpAppender.Password">
  7017. <summary>
  7018. The password to use to authenticate with the SMTP server
  7019. </summary>
  7020. <remarks>
  7021. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7022. <para>
  7023. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7024. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7025. otherwise the password will be ignored.
  7026. </para>
  7027. </remarks>
  7028. </member>
  7029. <member name="P:log4net.Appender.SmtpAppender.Port">
  7030. <summary>
  7031. The port on which the SMTP server is listening
  7032. </summary>
  7033. <remarks>
  7034. <note type="caution">Server Port is only available on the MS .NET 1.1 runtime.</note>
  7035. <para>
  7036. The port on which the SMTP server is listening. The default
  7037. port is <c>25</c>. The Port can only be changed when running on
  7038. the MS .NET 1.1 runtime.
  7039. </para>
  7040. </remarks>
  7041. </member>
  7042. <member name="P:log4net.Appender.SmtpAppender.Priority">
  7043. <summary>
  7044. Gets or sets the priority of the e-mail message
  7045. </summary>
  7046. <value>
  7047. One of the <see cref="T:System.Net.Mail.MailPriority"/> values.
  7048. </value>
  7049. <remarks>
  7050. <para>
  7051. Sets the priority of the e-mails generated by this
  7052. appender. The default priority is <see cref="F:System.Net.Mail.MailPriority.Normal"/>.
  7053. </para>
  7054. <para>
  7055. If you are using this appender to report errors then
  7056. you may want to set the priority to <see cref="F:System.Net.Mail.MailPriority.High"/>.
  7057. </para>
  7058. </remarks>
  7059. </member>
  7060. <member name="P:log4net.Appender.SmtpAppender.EnableSsl">
  7061. <summary>
  7062. Enable or disable use of SSL when sending e-mail message
  7063. </summary>
  7064. <remarks>
  7065. This is available on MS .NET 2.0 runtime and higher
  7066. </remarks>
  7067. </member>
  7068. <member name="P:log4net.Appender.SmtpAppender.ReplyTo">
  7069. <summary>
  7070. Gets or sets the reply-to e-mail address.
  7071. </summary>
  7072. <remarks>
  7073. This is available on MS .NET 2.0 runtime and higher
  7074. </remarks>
  7075. </member>
  7076. <member name="P:log4net.Appender.SmtpAppender.SubjectEncoding">
  7077. <summary>
  7078. Gets or sets the subject encoding to be used.
  7079. </summary>
  7080. <remarks>
  7081. The default encoding is the operating system's current ANSI codepage.
  7082. </remarks>
  7083. </member>
  7084. <member name="P:log4net.Appender.SmtpAppender.BodyEncoding">
  7085. <summary>
  7086. Gets or sets the body encoding to be used.
  7087. </summary>
  7088. <remarks>
  7089. The default encoding is the operating system's current ANSI codepage.
  7090. </remarks>
  7091. </member>
  7092. <member name="M:log4net.Appender.SmtpAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  7093. <summary>
  7094. Sends the contents of the cyclic buffer as an e-mail message.
  7095. </summary>
  7096. <param name="events">The logging events to send.</param>
  7097. </member>
  7098. <member name="P:log4net.Appender.SmtpAppender.RequiresLayout">
  7099. <summary>
  7100. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7101. </summary>
  7102. <value><c>true</c></value>
  7103. <remarks>
  7104. <para>
  7105. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7106. </para>
  7107. </remarks>
  7108. </member>
  7109. <member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)">
  7110. <summary>
  7111. Send the email message
  7112. </summary>
  7113. <param name="messageBody">the body text to include in the mail</param>
  7114. </member>
  7115. <member name="T:log4net.Appender.SmtpAppender.SmtpAuthentication">
  7116. <summary>
  7117. Values for the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property.
  7118. </summary>
  7119. <remarks>
  7120. <para>
  7121. SMTP authentication modes.
  7122. </para>
  7123. </remarks>
  7124. </member>
  7125. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None">
  7126. <summary>
  7127. No authentication
  7128. </summary>
  7129. </member>
  7130. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic">
  7131. <summary>
  7132. Basic authentication.
  7133. </summary>
  7134. <remarks>
  7135. Requires a username and password to be supplied
  7136. </remarks>
  7137. </member>
  7138. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm">
  7139. <summary>
  7140. Integrated authentication
  7141. </summary>
  7142. <remarks>
  7143. Uses the Windows credentials from the current thread or process to authenticate.
  7144. </remarks>
  7145. </member>
  7146. <member name="M:log4net.Appender.SmtpAppender.MaybeTrimSeparators(System.String)">
  7147. <summary>
  7148. trims leading and trailing commas or semicolons
  7149. </summary>
  7150. </member>
  7151. <member name="T:log4net.Appender.SmtpPickupDirAppender">
  7152. <summary>
  7153. Send an email when a specific logging event occurs, typically on errors
  7154. or fatal errors. Rather than sending via smtp it writes a file into the
  7155. directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such
  7156. as the IIS SMTP agent to manage sending the messages.
  7157. </summary>
  7158. <remarks>
  7159. <para>
  7160. The configuration for this appender is identical to that of the <c>SMTPAppender</c>,
  7161. except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify
  7162. <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>.
  7163. </para>
  7164. <para>
  7165. The number of logging events delivered in this e-mail depend on
  7166. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  7167. <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last
  7168. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  7169. cyclic buffer. This keeps memory requirements at a reasonable level while
  7170. still delivering useful application context.
  7171. </para>
  7172. </remarks>
  7173. <author>Niall Daley</author>
  7174. <author>Nicko Cadell</author>
  7175. </member>
  7176. <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor">
  7177. <summary>
  7178. Default constructor
  7179. </summary>
  7180. <remarks>
  7181. <para>
  7182. Default constructor
  7183. </para>
  7184. </remarks>
  7185. </member>
  7186. <member name="P:log4net.Appender.SmtpPickupDirAppender.To">
  7187. <summary>
  7188. Gets or sets a semicolon-delimited list of recipient e-mail addresses.
  7189. </summary>
  7190. <value>
  7191. A semicolon-delimited list of e-mail addresses.
  7192. </value>
  7193. <remarks>
  7194. <para>
  7195. A semicolon-delimited list of e-mail addresses.
  7196. </para>
  7197. </remarks>
  7198. </member>
  7199. <member name="P:log4net.Appender.SmtpPickupDirAppender.From">
  7200. <summary>
  7201. Gets or sets the e-mail address of the sender.
  7202. </summary>
  7203. <value>
  7204. The e-mail address of the sender.
  7205. </value>
  7206. <remarks>
  7207. <para>
  7208. The e-mail address of the sender.
  7209. </para>
  7210. </remarks>
  7211. </member>
  7212. <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject">
  7213. <summary>
  7214. Gets or sets the subject line of the e-mail message.
  7215. </summary>
  7216. <value>
  7217. The subject line of the e-mail message.
  7218. </value>
  7219. <remarks>
  7220. <para>
  7221. The subject line of the e-mail message.
  7222. </para>
  7223. </remarks>
  7224. </member>
  7225. <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir">
  7226. <summary>
  7227. Gets or sets the path to write the messages to.
  7228. </summary>
  7229. <remarks>
  7230. <para>
  7231. Gets or sets the path to write the messages to. This should be the same
  7232. as that used by the agent sending the messages.
  7233. </para>
  7234. </remarks>
  7235. </member>
  7236. <member name="P:log4net.Appender.SmtpPickupDirAppender.FileExtension">
  7237. <summary>
  7238. Gets or sets the file extension for the generated files
  7239. </summary>
  7240. <value>
  7241. The file extension for the generated files
  7242. </value>
  7243. <remarks>
  7244. <para>
  7245. The file extension for the generated files
  7246. </para>
  7247. </remarks>
  7248. </member>
  7249. <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext">
  7250. <summary>
  7251. Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  7252. </summary>
  7253. <value>
  7254. The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  7255. </value>
  7256. <remarks>
  7257. <para>
  7258. Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender
  7259. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  7260. security context to use. The default behavior is to use the security context
  7261. of the current thread.
  7262. </para>
  7263. </remarks>
  7264. </member>
  7265. <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  7266. <summary>
  7267. Sends the contents of the cyclic buffer as an e-mail message.
  7268. </summary>
  7269. <param name="events">The logging events to send.</param>
  7270. <remarks>
  7271. <para>
  7272. Sends the contents of the cyclic buffer as an e-mail message.
  7273. </para>
  7274. </remarks>
  7275. </member>
  7276. <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions">
  7277. <summary>
  7278. Activate the options on this appender.
  7279. </summary>
  7280. <remarks>
  7281. <para>
  7282. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  7283. activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must
  7284. be called on this object after the configuration properties have
  7285. been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this
  7286. object is in an undefined state and must not be used.
  7287. </para>
  7288. <para>
  7289. If any of the configuration properties are modified then
  7290. <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again.
  7291. </para>
  7292. </remarks>
  7293. </member>
  7294. <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout">
  7295. <summary>
  7296. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7297. </summary>
  7298. <value><c>true</c></value>
  7299. <remarks>
  7300. <para>
  7301. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7302. </para>
  7303. </remarks>
  7304. </member>
  7305. <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)">
  7306. <summary>
  7307. Convert a path into a fully qualified path.
  7308. </summary>
  7309. <param name="path">The path to convert.</param>
  7310. <returns>The fully qualified path.</returns>
  7311. <remarks>
  7312. <para>
  7313. Converts the path specified to a fully
  7314. qualified path. If the path is relative it is
  7315. taken as relative from the application base
  7316. directory.
  7317. </para>
  7318. </remarks>
  7319. </member>
  7320. <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext">
  7321. <summary>
  7322. The security context to use for privileged calls
  7323. </summary>
  7324. </member>
  7325. <member name="T:log4net.Appender.TelnetAppender">
  7326. <summary>
  7327. Appender that allows clients to connect via Telnet to receive log messages
  7328. </summary>
  7329. <remarks>
  7330. <para>
  7331. The TelnetAppender accepts socket connections and streams logging messages
  7332. back to the client.
  7333. The output is provided in a telnet-friendly way so that a log can be monitored
  7334. over a TCP/IP socket.
  7335. This allows simple remote monitoring of application logging.
  7336. </para>
  7337. <para>
  7338. The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port).
  7339. </para>
  7340. </remarks>
  7341. <author>Keith Long</author>
  7342. <author>Nicko Cadell</author>
  7343. </member>
  7344. <member name="M:log4net.Appender.TelnetAppender.#ctor">
  7345. <summary>
  7346. Default constructor
  7347. </summary>
  7348. <remarks>
  7349. <para>
  7350. Default constructor
  7351. </para>
  7352. </remarks>
  7353. </member>
  7354. <member name="F:log4net.Appender.TelnetAppender.declaringType">
  7355. <summary>
  7356. The fully qualified type of the TelnetAppender class.
  7357. </summary>
  7358. <remarks>
  7359. Used by the internal logger to record the Type of the
  7360. log message.
  7361. </remarks>
  7362. </member>
  7363. <member name="P:log4net.Appender.TelnetAppender.Port">
  7364. <summary>
  7365. Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  7366. </summary>
  7367. <value>
  7368. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  7369. indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  7370. </value>
  7371. <remarks>
  7372. <para>
  7373. The default value is 23 (the telnet port).
  7374. </para>
  7375. </remarks>
  7376. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort" />
  7377. or greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
  7378. </member>
  7379. <member name="M:log4net.Appender.TelnetAppender.OnClose">
  7380. <summary>
  7381. Overrides the parent method to close the socket handler
  7382. </summary>
  7383. <remarks>
  7384. <para>
  7385. Closes all the outstanding connections.
  7386. </para>
  7387. </remarks>
  7388. </member>
  7389. <member name="P:log4net.Appender.TelnetAppender.RequiresLayout">
  7390. <summary>
  7391. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7392. </summary>
  7393. <value><c>true</c></value>
  7394. <remarks>
  7395. <para>
  7396. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7397. </para>
  7398. </remarks>
  7399. </member>
  7400. <member name="M:log4net.Appender.TelnetAppender.ActivateOptions">
  7401. <summary>
  7402. Initialize the appender based on the options set.
  7403. </summary>
  7404. <remarks>
  7405. <para>
  7406. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  7407. activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must
  7408. be called on this object after the configuration properties have
  7409. been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this
  7410. object is in an undefined state and must not be used.
  7411. </para>
  7412. <para>
  7413. If any of the configuration properties are modified then
  7414. <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again.
  7415. </para>
  7416. <para>
  7417. Create the socket handler and wait for connections
  7418. </para>
  7419. </remarks>
  7420. </member>
  7421. <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)">
  7422. <summary>
  7423. Writes the logging event to each connected client.
  7424. </summary>
  7425. <param name="loggingEvent">The event to log.</param>
  7426. <remarks>
  7427. <para>
  7428. Writes the logging event to each connected client.
  7429. </para>
  7430. </remarks>
  7431. </member>
  7432. <member name="T:log4net.Appender.TelnetAppender.SocketHandler">
  7433. <summary>
  7434. Helper class to manage connected clients
  7435. </summary>
  7436. <remarks>
  7437. <para>
  7438. The SocketHandler class is used to accept connections from
  7439. clients. It is threaded so that clients can connect/disconnect
  7440. asynchronously.
  7441. </para>
  7442. </remarks>
  7443. </member>
  7444. <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient">
  7445. <summary>
  7446. Class that represents a client connected to this handler
  7447. </summary>
  7448. <remarks>
  7449. <para>
  7450. Class that represents a client connected to this handler
  7451. </para>
  7452. </remarks>
  7453. </member>
  7454. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)">
  7455. <summary>
  7456. Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/>
  7457. </summary>
  7458. <param name="socket">the client's socket</param>
  7459. <remarks>
  7460. <para>
  7461. Opens a stream writer on the socket.
  7462. </para>
  7463. </remarks>
  7464. </member>
  7465. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)">
  7466. <summary>
  7467. Write a string to the client
  7468. </summary>
  7469. <param name="message">string to send</param>
  7470. <remarks>
  7471. <para>
  7472. Write a string to the client
  7473. </para>
  7474. </remarks>
  7475. </member>
  7476. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose">
  7477. <summary>
  7478. Cleanup the clients connection
  7479. </summary>
  7480. <remarks>
  7481. <para>
  7482. Close the socket connection.
  7483. </para>
  7484. </remarks>
  7485. </member>
  7486. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)">
  7487. <summary>
  7488. Opens a new server port on <paramref ref="port"/>
  7489. </summary>
  7490. <param name="port">the local port to listen on for connections</param>
  7491. <remarks>
  7492. <para>
  7493. Creates a socket handler on the specified local server port.
  7494. </para>
  7495. </remarks>
  7496. </member>
  7497. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)">
  7498. <summary>
  7499. Sends a string message to each of the connected clients
  7500. </summary>
  7501. <param name="message">the text to send</param>
  7502. <remarks>
  7503. <para>
  7504. Sends a string message to each of the connected clients
  7505. </para>
  7506. </remarks>
  7507. </member>
  7508. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  7509. <summary>
  7510. Add a client to the internal clients list
  7511. </summary>
  7512. <param name="client">client to add</param>
  7513. </member>
  7514. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  7515. <summary>
  7516. Remove a client from the internal clients list
  7517. </summary>
  7518. <param name="client">client to remove</param>
  7519. </member>
  7520. <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections">
  7521. <summary>
  7522. Test if this handler has active connections
  7523. </summary>
  7524. <value>
  7525. <c>true</c> if this handler has active connections
  7526. </value>
  7527. <remarks>
  7528. <para>
  7529. This property will be <c>true</c> while this handler has
  7530. active connections, that is at least one connection that
  7531. the handler will attempt to send a message to.
  7532. </para>
  7533. </remarks>
  7534. </member>
  7535. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.OnConnect(System.IAsyncResult)">
  7536. <summary>
  7537. Callback used to accept a connection on the server socket
  7538. </summary>
  7539. <param name="asyncResult">The result of the asynchronous operation</param>
  7540. <remarks>
  7541. <para>
  7542. On connection adds to the list of connections
  7543. if there are two many open connections you will be disconnected
  7544. </para>
  7545. </remarks>
  7546. </member>
  7547. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose">
  7548. <summary>
  7549. Close all network connections
  7550. </summary>
  7551. <remarks>
  7552. <para>
  7553. Make sure we close all network connections
  7554. </para>
  7555. </remarks>
  7556. </member>
  7557. <member name="T:log4net.Appender.TextWriterAppender">
  7558. <summary>
  7559. Sends logging events to a <see cref="T:System.IO.TextWriter"/>.
  7560. </summary>
  7561. <remarks>
  7562. <para>
  7563. An Appender that writes to a <see cref="T:System.IO.TextWriter"/>.
  7564. </para>
  7565. <para>
  7566. This appender may be used stand alone if initialized with an appropriate
  7567. writer, however it is typically used as a base class for an appender that
  7568. can open a <see cref="T:System.IO.TextWriter"/> to write to.
  7569. </para>
  7570. </remarks>
  7571. <author>Nicko Cadell</author>
  7572. <author>Gert Driesen</author>
  7573. <author>Douglas de la Torre</author>
  7574. </member>
  7575. <member name="M:log4net.Appender.TextWriterAppender.#ctor">
  7576. <summary>
  7577. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class.
  7578. </summary>
  7579. <remarks>
  7580. <para>
  7581. Default constructor.
  7582. </para>
  7583. </remarks>
  7584. </member>
  7585. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)">
  7586. <summary>
  7587. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class and
  7588. sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized
  7589. with the specified <see cref="T:System.IO.Stream"/>.
  7590. </summary>
  7591. <param name="layout">The layout to use with this appender.</param>
  7592. <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param>
  7593. <remarks>
  7594. <para>
  7595. Obsolete constructor.
  7596. </para>
  7597. </remarks>
  7598. </member>
  7599. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)">
  7600. <summary>
  7601. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class and sets
  7602. the output destination to the specified <see cref="T:System.IO.StreamWriter" />.
  7603. </summary>
  7604. <param name="layout">The layout to use with this appender</param>
  7605. <param name="writer">The <see cref="T:System.IO.TextWriter" /> to output to</param>
  7606. <remarks>
  7607. The <see cref="T:System.IO.TextWriter" /> must have been previously opened.
  7608. </remarks>
  7609. <remarks>
  7610. <para>
  7611. Obsolete constructor.
  7612. </para>
  7613. </remarks>
  7614. </member>
  7615. <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush">
  7616. <summary>
  7617. Gets or set whether the appender will flush at the end
  7618. of each append operation.
  7619. </summary>
  7620. <value>
  7621. <para>
  7622. The default behavior is to flush at the end of each
  7623. append operation.
  7624. </para>
  7625. <para>
  7626. If this option is set to <c>false</c>, then the underlying
  7627. stream can defer persisting the logging event to a later
  7628. time.
  7629. </para>
  7630. </value>
  7631. <remarks>
  7632. Avoiding the flush operation at the end of each append results in
  7633. a performance gain of 10 to 20 percent. However, there is safety
  7634. trade-off involved in skipping flushing. Indeed, when flushing is
  7635. skipped, then it is likely that the last few log events will not
  7636. be recorded on disk when the application exits. This is a high
  7637. price to pay even for a 20% performance gain.
  7638. </remarks>
  7639. </member>
  7640. <member name="P:log4net.Appender.TextWriterAppender.Writer">
  7641. <summary>
  7642. Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go.
  7643. </summary>
  7644. <remarks>
  7645. <para>
  7646. The specified <see cref="T:System.IO.TextWriter"/> must be open and writable.
  7647. </para>
  7648. <para>
  7649. The <see cref="T:System.IO.TextWriter"/> will be closed when the appender
  7650. instance is closed.
  7651. </para>
  7652. <para>
  7653. <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail.
  7654. </para>
  7655. </remarks>
  7656. </member>
  7657. <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck">
  7658. <summary>
  7659. This method determines if there is a sense in attempting to append.
  7660. </summary>
  7661. <remarks>
  7662. <para>
  7663. This method checks if an output target has been set and if a
  7664. layout has been set.
  7665. </para>
  7666. </remarks>
  7667. <returns><c>false</c> if any of the preconditions fail.</returns>
  7668. </member>
  7669. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)">
  7670. <summary>
  7671. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  7672. method.
  7673. </summary>
  7674. <param name="loggingEvent">The event to log.</param>
  7675. <remarks>
  7676. <para>
  7677. Writes a log statement to the output stream if the output stream exists
  7678. and is writable.
  7679. </para>
  7680. <para>
  7681. The format of the output will depend on the appender's layout.
  7682. </para>
  7683. </remarks>
  7684. </member>
  7685. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
  7686. <summary>
  7687. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  7688. method.
  7689. </summary>
  7690. <param name="loggingEvents">The array of events to log.</param>
  7691. <remarks>
  7692. <para>
  7693. This method writes all the bulk logged events to the output writer
  7694. before flushing the stream.
  7695. </para>
  7696. </remarks>
  7697. </member>
  7698. <member name="M:log4net.Appender.TextWriterAppender.OnClose">
  7699. <summary>
  7700. Close this appender instance. The underlying stream or writer is also closed.
  7701. </summary>
  7702. <remarks>
  7703. Closed appenders cannot be reused.
  7704. </remarks>
  7705. </member>
  7706. <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler">
  7707. <summary>
  7708. Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying
  7709. <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender.
  7710. </summary>
  7711. <value>
  7712. The <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  7713. </value>
  7714. </member>
  7715. <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout">
  7716. <summary>
  7717. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7718. </summary>
  7719. <value><c>true</c></value>
  7720. <remarks>
  7721. <para>
  7722. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7723. </para>
  7724. </remarks>
  7725. </member>
  7726. <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter">
  7727. <summary>
  7728. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  7729. </summary>
  7730. <remarks>
  7731. <para>
  7732. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  7733. </para>
  7734. </remarks>
  7735. </member>
  7736. <member name="M:log4net.Appender.TextWriterAppender.CloseWriter">
  7737. <summary>
  7738. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  7739. </summary>
  7740. <remarks>
  7741. <para>
  7742. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  7743. </para>
  7744. </remarks>
  7745. </member>
  7746. <member name="M:log4net.Appender.TextWriterAppender.Reset">
  7747. <summary>
  7748. Clears internal references to the underlying <see cref="T:System.IO.TextWriter" />
  7749. and other variables.
  7750. </summary>
  7751. <remarks>
  7752. <para>
  7753. Subclasses can override this method for an alternate closing behavior.
  7754. </para>
  7755. </remarks>
  7756. </member>
  7757. <member name="M:log4net.Appender.TextWriterAppender.WriteFooter">
  7758. <summary>
  7759. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  7760. </summary>
  7761. <remarks>
  7762. <para>
  7763. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  7764. </para>
  7765. </remarks>
  7766. </member>
  7767. <member name="M:log4net.Appender.TextWriterAppender.WriteHeader">
  7768. <summary>
  7769. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  7770. </summary>
  7771. <remarks>
  7772. <para>
  7773. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  7774. </para>
  7775. </remarks>
  7776. </member>
  7777. <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter">
  7778. <summary>
  7779. Called to allow a subclass to lazily initialize the writer
  7780. </summary>
  7781. <remarks>
  7782. <para>
  7783. This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or
  7784. <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to
  7785. attempt to initialize the writer multiple times.
  7786. </para>
  7787. </remarks>
  7788. </member>
  7789. <member name="P:log4net.Appender.TextWriterAppender.QuietWriter">
  7790. <summary>
  7791. Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  7792. will be written to.
  7793. </summary>
  7794. <value>
  7795. The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written.
  7796. </value>
  7797. <remarks>
  7798. <para>
  7799. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  7800. will be written to.
  7801. </para>
  7802. </remarks>
  7803. </member>
  7804. <member name="F:log4net.Appender.TextWriterAppender.m_qtw">
  7805. <summary>
  7806. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  7807. will be written to.
  7808. </summary>
  7809. </member>
  7810. <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush">
  7811. <summary>
  7812. Immediate flush means that the underlying <see cref="T:System.IO.TextWriter" />
  7813. or output stream will be flushed at the end of each append operation.
  7814. </summary>
  7815. <remarks>
  7816. <para>
  7817. Immediate flush is slower but ensures that each append request is
  7818. actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to
  7819. <c>false</c>, then there is a good chance that the last few
  7820. logging events are not actually persisted if and when the application
  7821. crashes.
  7822. </para>
  7823. <para>
  7824. The default value is <c>true</c>.
  7825. </para>
  7826. </remarks>
  7827. </member>
  7828. <member name="F:log4net.Appender.TextWriterAppender.declaringType">
  7829. <summary>
  7830. The fully qualified type of the TextWriterAppender class.
  7831. </summary>
  7832. <remarks>
  7833. Used by the internal logger to record the Type of the
  7834. log message.
  7835. </remarks>
  7836. </member>
  7837. <member name="M:log4net.Appender.TextWriterAppender.Flush(System.Int32)">
  7838. <summary>
  7839. Flushes any buffered log data.
  7840. </summary>
  7841. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  7842. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  7843. </member>
  7844. <member name="T:log4net.Appender.TraceAppender">
  7845. <summary>
  7846. Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system.
  7847. </summary>
  7848. <remarks>
  7849. <para>
  7850. The application configuration file can be used to control what listeners
  7851. are actually used. See the MSDN documentation for the
  7852. <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the
  7853. trace system.
  7854. </para>
  7855. <para>
  7856. Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c>
  7857. method. The event's logger name is the default value for the category parameter
  7858. of the Write method.
  7859. </para>
  7860. <para>
  7861. <b>Compact Framework</b><br />
  7862. The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/>
  7863. class for any operation except <c>Assert</c>. When using the Compact Framework this
  7864. appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than
  7865. the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>.
  7866. </para>
  7867. </remarks>
  7868. <author>Douglas de la Torre</author>
  7869. <author>Nicko Cadell</author>
  7870. <author>Gert Driesen</author>
  7871. <author>Ron Grabowski</author>
  7872. </member>
  7873. <member name="M:log4net.Appender.TraceAppender.#ctor">
  7874. <summary>
  7875. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender" />.
  7876. </summary>
  7877. <remarks>
  7878. <para>
  7879. Default constructor.
  7880. </para>
  7881. </remarks>
  7882. </member>
  7883. <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)">
  7884. <summary>
  7885. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender" />
  7886. with a specified layout.
  7887. </summary>
  7888. <param name="layout">The layout to use with this appender.</param>
  7889. <remarks>
  7890. <para>
  7891. Obsolete constructor.
  7892. </para>
  7893. </remarks>
  7894. </member>
  7895. <member name="P:log4net.Appender.TraceAppender.ImmediateFlush">
  7896. <summary>
  7897. Gets or sets a value that indicates whether the appender will
  7898. flush at the end of each write.
  7899. </summary>
  7900. <remarks>
  7901. <para>The default behavior is to flush at the end of each
  7902. write. If the option is set to<c>false</c>, then the underlying
  7903. stream can defer writing to physical medium to a later time.
  7904. </para>
  7905. <para>
  7906. Avoiding the flush operation at the end of each append results
  7907. in a performance gain of 10 to 20 percent. However, there is safety
  7908. trade-off involved in skipping flushing. Indeed, when flushing is
  7909. skipped, then it is likely that the last few log events will not
  7910. be recorded on disk when the application exits. This is a high
  7911. price to pay even for a 20% performance gain.
  7912. </para>
  7913. </remarks>
  7914. </member>
  7915. <member name="P:log4net.Appender.TraceAppender.Category">
  7916. <summary>
  7917. The category parameter sent to the Trace method.
  7918. </summary>
  7919. <remarks>
  7920. <para>
  7921. Defaults to %logger which will use the logger name of the current
  7922. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  7923. </para>
  7924. <para>
  7925. </para>
  7926. </remarks>
  7927. </member>
  7928. <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)">
  7929. <summary>
  7930. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  7931. </summary>
  7932. <param name="loggingEvent">The event to log.</param>
  7933. <remarks>
  7934. <para>
  7935. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  7936. </para>
  7937. </remarks>
  7938. </member>
  7939. <member name="P:log4net.Appender.TraceAppender.RequiresLayout">
  7940. <summary>
  7941. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7942. </summary>
  7943. <value><c>true</c></value>
  7944. <remarks>
  7945. <para>
  7946. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7947. </para>
  7948. </remarks>
  7949. </member>
  7950. <member name="F:log4net.Appender.TraceAppender.m_immediateFlush">
  7951. <summary>
  7952. Immediate flush means that the underlying writer or output stream
  7953. will be flushed at the end of each append operation.
  7954. </summary>
  7955. <remarks>
  7956. <para>
  7957. Immediate flush is slower but ensures that each append request is
  7958. actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to
  7959. <c>false</c>, then there is a good chance that the last few
  7960. logs events are not actually written to persistent media if and
  7961. when the application crashes.
  7962. </para>
  7963. <para>
  7964. The default value is <c>true</c>.</para>
  7965. </remarks>
  7966. </member>
  7967. <member name="F:log4net.Appender.TraceAppender.m_category">
  7968. <summary>
  7969. Defaults to %logger
  7970. </summary>
  7971. </member>
  7972. <member name="M:log4net.Appender.TraceAppender.Flush(System.Int32)">
  7973. <summary>
  7974. Flushes any buffered log data.
  7975. </summary>
  7976. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  7977. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  7978. </member>
  7979. <member name="T:log4net.Appender.UdpAppender">
  7980. <summary>
  7981. Sends logging events as connectionless UDP datagrams to a remote host or a
  7982. multicast group using an <see cref="T:System.Net.Sockets.UdpClient" />.
  7983. </summary>
  7984. <remarks>
  7985. <para>
  7986. UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
  7987. </para>
  7988. <para>
  7989. To view the logging results, a custom application can be developed that listens for logging
  7990. events.
  7991. </para>
  7992. <para>
  7993. When decoding events send via this appender remember to use the same encoding
  7994. to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
  7995. property to specify the encoding to use.
  7996. </para>
  7997. </remarks>
  7998. <example>
  7999. This example shows how to log receive logging events that are sent
  8000. on IP address 244.0.0.1 and port 8080 to the console. The event is
  8001. encoded in the packet as a unicode string and it is decoded as such.
  8002. <code lang="C#">
  8003. IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
  8004. UdpClient udpClient;
  8005. byte[] buffer;
  8006. string loggingEvent;
  8007. try
  8008. {
  8009. udpClient = new UdpClient(8080);
  8010. while(true)
  8011. {
  8012. buffer = udpClient.Receive(ref remoteEndPoint);
  8013. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
  8014. Console.WriteLine(loggingEvent);
  8015. }
  8016. }
  8017. catch(Exception e)
  8018. {
  8019. Console.WriteLine(e.ToString());
  8020. }
  8021. </code>
  8022. <code lang="Visual Basic">
  8023. Dim remoteEndPoint as IPEndPoint
  8024. Dim udpClient as UdpClient
  8025. Dim buffer as Byte()
  8026. Dim loggingEvent as String
  8027. Try
  8028. remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
  8029. udpClient = new UdpClient(8080)
  8030. While True
  8031. buffer = udpClient.Receive(ByRef remoteEndPoint)
  8032. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
  8033. Console.WriteLine(loggingEvent)
  8034. Wend
  8035. Catch e As Exception
  8036. Console.WriteLine(e.ToString())
  8037. End Try
  8038. </code>
  8039. <para>
  8040. An example configuration section to log information using this appender to the
  8041. IP 224.0.0.1 on port 8080:
  8042. </para>
  8043. <code lang="XML" escaped="true">
  8044. <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
  8045. <remoteAddress value="224.0.0.1" />
  8046. <remotePort value="8080" />
  8047. <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline" />
  8048. </appender>
  8049. </code>
  8050. </example>
  8051. <author>Gert Driesen</author>
  8052. <author>Nicko Cadell</author>
  8053. </member>
  8054. <member name="M:log4net.Appender.UdpAppender.#ctor">
  8055. <summary>
  8056. Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender" /> class.
  8057. </summary>
  8058. <remarks>
  8059. The default constructor initializes all fields to their default values.
  8060. </remarks>
  8061. </member>
  8062. <member name="P:log4net.Appender.UdpAppender.RemoteAddress">
  8063. <summary>
  8064. Gets or sets the IP address of the remote host or multicast group to which
  8065. the underlying <see cref="T:System.Net.Sockets.UdpClient" /> should sent the logging event.
  8066. </summary>
  8067. <value>
  8068. The IP address of the remote host or multicast group to which the logging event
  8069. will be sent.
  8070. </value>
  8071. <remarks>
  8072. <para>
  8073. Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to
  8074. 239.255.255.255). Multicast packets can pass across different networks through routers, so
  8075. it is possible to use multicasts in an Internet scenario as long as your network provider
  8076. supports multicasting.
  8077. </para>
  8078. <para>
  8079. Hosts that want to receive particular multicast messages must register their interest by joining
  8080. the multicast group. Multicast messages are not sent to networks where no host has joined
  8081. the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate
  8082. them from normal host addresses, allowing nodes to easily detect if a message is of interest.
  8083. </para>
  8084. <para>
  8085. Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below:
  8086. </para>
  8087. <para>
  8088. <list type="table">
  8089. <listheader>
  8090. <term>IP Address</term>
  8091. <description>Description</description>
  8092. </listheader>
  8093. <item>
  8094. <term>224.0.0.1</term>
  8095. <description>
  8096. <para>
  8097. Sends a message to all system on the subnet.
  8098. </para>
  8099. </description>
  8100. </item>
  8101. <item>
  8102. <term>224.0.0.2</term>
  8103. <description>
  8104. <para>
  8105. Sends a message to all routers on the subnet.
  8106. </para>
  8107. </description>
  8108. </item>
  8109. <item>
  8110. <term>224.0.0.12</term>
  8111. <description>
  8112. <para>
  8113. The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet.
  8114. </para>
  8115. </description>
  8116. </item>
  8117. </list>
  8118. </para>
  8119. <para>
  8120. A complete list of actually reserved multicast addresses and their owners in the ranges
  8121. defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>.
  8122. </para>
  8123. <para>
  8124. The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative
  8125. addresses. These addresses can be reused with other local groups. Routers are typically
  8126. configured with filters to prevent multicast traffic in this range from flowing outside
  8127. of the local network.
  8128. </para>
  8129. </remarks>
  8130. </member>
  8131. <member name="P:log4net.Appender.UdpAppender.RemotePort">
  8132. <summary>
  8133. Gets or sets the TCP port number of the remote host or multicast group to which
  8134. the underlying <see cref="T:System.Net.Sockets.UdpClient" /> should sent the logging event.
  8135. </summary>
  8136. <value>
  8137. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  8138. indicating the TCP port number of the remote host or multicast group to which the logging event
  8139. will be sent.
  8140. </value>
  8141. <remarks>
  8142. The underlying <see cref="T:System.Net.Sockets.UdpClient" /> will send messages to this TCP port number
  8143. on the remote host or multicast group.
  8144. </remarks>
  8145. <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>
  8146. </member>
  8147. <member name="P:log4net.Appender.UdpAppender.LocalPort">
  8148. <summary>
  8149. Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  8150. </summary>
  8151. <value>
  8152. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  8153. indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  8154. </value>
  8155. <remarks>
  8156. <para>
  8157. The underlying <see cref="T:System.Net.Sockets.UdpClient" /> will bind to this port for sending messages.
  8158. </para>
  8159. <para>
  8160. Setting the value to 0 (the default) will cause the udp client not to bind to
  8161. a local port.
  8162. </para>
  8163. </remarks>
  8164. <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>
  8165. </member>
  8166. <member name="P:log4net.Appender.UdpAppender.Encoding">
  8167. <summary>
  8168. Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  8169. </summary>
  8170. <value>
  8171. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  8172. </value>
  8173. <remarks>
  8174. <para>
  8175. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  8176. </para>
  8177. </remarks>
  8178. </member>
  8179. <member name="P:log4net.Appender.UdpAppender.Client">
  8180. <summary>
  8181. Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient" />.
  8182. </summary>
  8183. <value>
  8184. The underlying <see cref="T:System.Net.Sockets.UdpClient" />.
  8185. </value>
  8186. <remarks>
  8187. <see cref="T:log4net.Appender.UdpAppender" /> creates a <see cref="T:System.Net.Sockets.UdpClient" /> to send logging events
  8188. over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender" /> can use this
  8189. property to get or set this <see cref="T:System.Net.Sockets.UdpClient" />. Use the underlying <see cref="T:System.Net.Sockets.UdpClient" />
  8190. returned from <see cref="P:log4net.Appender.UdpAppender.Client" /> if you require access beyond that which
  8191. <see cref="T:log4net.Appender.UdpAppender" /> provides.
  8192. </remarks>
  8193. </member>
  8194. <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint">
  8195. <summary>
  8196. Gets or sets the cached remote endpoint to which the logging events should be sent.
  8197. </summary>
  8198. <value>
  8199. The cached remote endpoint to which the logging events will be sent.
  8200. </value>
  8201. <remarks>
  8202. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions" /> method will initialize the remote endpoint
  8203. with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/>
  8204. properties.
  8205. </remarks>
  8206. </member>
  8207. <member name="M:log4net.Appender.UdpAppender.ActivateOptions">
  8208. <summary>
  8209. Initialize the appender based on the options set.
  8210. </summary>
  8211. <remarks>
  8212. <para>
  8213. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  8214. activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must
  8215. be called on this object after the configuration properties have
  8216. been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this
  8217. object is in an undefined state and must not be used.
  8218. </para>
  8219. <para>
  8220. If any of the configuration properties are modified then
  8221. <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again.
  8222. </para>
  8223. <para>
  8224. The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> was specified or
  8225. an invalid remote or local TCP port number was specified.
  8226. </para>
  8227. </remarks>
  8228. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> was not specified.</exception>
  8229. <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>
  8230. </member>
  8231. <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)">
  8232. <summary>
  8233. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  8234. </summary>
  8235. <param name="loggingEvent">The event to log.</param>
  8236. <remarks>
  8237. <para>
  8238. Sends the event using an UDP datagram.
  8239. </para>
  8240. <para>
  8241. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  8242. </para>
  8243. </remarks>
  8244. </member>
  8245. <member name="P:log4net.Appender.UdpAppender.RequiresLayout">
  8246. <summary>
  8247. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8248. </summary>
  8249. <value><c>true</c></value>
  8250. <remarks>
  8251. <para>
  8252. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8253. </para>
  8254. </remarks>
  8255. </member>
  8256. <member name="M:log4net.Appender.UdpAppender.OnClose">
  8257. <summary>
  8258. Closes the UDP connection and releases all resources associated with
  8259. this <see cref="T:log4net.Appender.UdpAppender" /> instance.
  8260. </summary>
  8261. <remarks>
  8262. <para>
  8263. Disables the underlying <see cref="T:System.Net.Sockets.UdpClient" /> and releases all managed
  8264. and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender" />.
  8265. </para>
  8266. </remarks>
  8267. </member>
  8268. <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection">
  8269. <summary>
  8270. Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient" /> connection.
  8271. </summary>
  8272. <remarks>
  8273. <para>
  8274. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the
  8275. port number from which you intend to communicate.
  8276. </para>
  8277. <para>
  8278. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  8279. </para>
  8280. </remarks>
  8281. </member>
  8282. <member name="F:log4net.Appender.UdpAppender.m_remoteAddress">
  8283. <summary>
  8284. The IP address of the remote host or multicast group to which
  8285. the logging event will be sent.
  8286. </summary>
  8287. </member>
  8288. <member name="F:log4net.Appender.UdpAppender.m_remotePort">
  8289. <summary>
  8290. The TCP port number of the remote host or multicast group to
  8291. which the logging event will be sent.
  8292. </summary>
  8293. </member>
  8294. <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint">
  8295. <summary>
  8296. The cached remote endpoint to which the logging events will be sent.
  8297. </summary>
  8298. </member>
  8299. <member name="F:log4net.Appender.UdpAppender.m_localPort">
  8300. <summary>
  8301. The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  8302. </summary>
  8303. </member>
  8304. <member name="F:log4net.Appender.UdpAppender.m_client">
  8305. <summary>
  8306. The <see cref="T:System.Net.Sockets.UdpClient" /> instance that will be used for sending the
  8307. logging events.
  8308. </summary>
  8309. </member>
  8310. <member name="F:log4net.Appender.UdpAppender.m_encoding">
  8311. <summary>
  8312. The encoding to use for the packet.
  8313. </summary>
  8314. </member>
  8315. <member name="T:log4net.Config.AliasDomainAttribute">
  8316. <summary>
  8317. Assembly level attribute that specifies a domain to alias to this assembly's repository.
  8318. </summary>
  8319. <remarks>
  8320. <para>
  8321. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  8322. </para>
  8323. <para>
  8324. An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>,
  8325. however this can be overridden by an assembly loaded before the target assembly.
  8326. </para>
  8327. <para>
  8328. An assembly can alias another assembly's domain to its repository by
  8329. specifying this attribute with the name of the target domain.
  8330. </para>
  8331. <para>
  8332. This attribute can only be specified on the assembly and may be used
  8333. as many times as necessary to alias all the required domains.
  8334. </para>
  8335. </remarks>
  8336. <author>Nicko Cadell</author>
  8337. <author>Gert Driesen</author>
  8338. </member>
  8339. <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)">
  8340. <summary>
  8341. Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute" /> class with
  8342. the specified domain to alias to this assembly's repository.
  8343. </summary>
  8344. <param name="name">The domain to alias to this assemby's repository.</param>
  8345. <remarks>
  8346. <para>
  8347. Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>.
  8348. </para>
  8349. </remarks>
  8350. </member>
  8351. <member name="T:log4net.Config.AliasRepositoryAttribute">
  8352. <summary>
  8353. Assembly level attribute that specifies a repository to alias to this assembly's repository.
  8354. </summary>
  8355. <remarks>
  8356. <para>
  8357. An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>,
  8358. however this can be overridden by an assembly loaded before the target assembly.
  8359. </para>
  8360. <para>
  8361. An assembly can alias another assembly's repository to its repository by
  8362. specifying this attribute with the name of the target repository.
  8363. </para>
  8364. <para>
  8365. This attribute can only be specified on the assembly and may be used
  8366. as many times as necessary to alias all the required repositories.
  8367. </para>
  8368. </remarks>
  8369. <author>Nicko Cadell</author>
  8370. <author>Gert Driesen</author>
  8371. </member>
  8372. <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)">
  8373. <summary>
  8374. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute" /> class with
  8375. the specified repository to alias to this assembly's repository.
  8376. </summary>
  8377. <param name="name">The repository to alias to this assemby's repository.</param>
  8378. <remarks>
  8379. <para>
  8380. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute" /> class with
  8381. the specified repository to alias to this assembly's repository.
  8382. </para>
  8383. </remarks>
  8384. </member>
  8385. <member name="P:log4net.Config.AliasRepositoryAttribute.Name">
  8386. <summary>
  8387. Gets or sets the repository to alias to this assemby's repository.
  8388. </summary>
  8389. <value>
  8390. The repository to alias to this assemby's repository.
  8391. </value>
  8392. <remarks>
  8393. <para>
  8394. The name of the repository to alias to this assemby's repository.
  8395. </para>
  8396. </remarks>
  8397. </member>
  8398. <member name="T:log4net.Config.BasicConfigurator">
  8399. <summary>
  8400. Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  8401. </summary>
  8402. <remarks>
  8403. <para>
  8404. Allows very simple programmatic configuration of log4net.
  8405. </para>
  8406. <para>
  8407. Only one appender can be configured using this configurator.
  8408. The appender is set at the root of the hierarchy and all logging
  8409. events will be delivered to that appender.
  8410. </para>
  8411. <para>
  8412. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  8413. they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions()"/> method
  8414. be called after the appenders properties have been configured.
  8415. </para>
  8416. </remarks>
  8417. <author>Nicko Cadell</author>
  8418. <author>Gert Driesen</author>
  8419. </member>
  8420. <member name="F:log4net.Config.BasicConfigurator.declaringType">
  8421. <summary>
  8422. The fully qualified type of the BasicConfigurator class.
  8423. </summary>
  8424. <remarks>
  8425. Used by the internal logger to record the Type of the
  8426. log message.
  8427. </remarks>
  8428. </member>
  8429. <member name="M:log4net.Config.BasicConfigurator.#ctor">
  8430. <summary>
  8431. Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator" /> class.
  8432. </summary>
  8433. <remarks>
  8434. <para>
  8435. Uses a private access modifier to prevent instantiation of this class.
  8436. </para>
  8437. </remarks>
  8438. </member>
  8439. <member name="M:log4net.Config.BasicConfigurator.Configure">
  8440. <summary>
  8441. Initializes the log4net system with a default configuration.
  8442. </summary>
  8443. <remarks>
  8444. <para>
  8445. Initializes the log4net logging system using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  8446. that will write to <c>Console.Out</c>. The log messages are
  8447. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  8448. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  8449. layout style.
  8450. </para>
  8451. </remarks>
  8452. </member>
  8453. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender[])">
  8454. <summary>
  8455. Initializes the log4net system using the specified appenders.
  8456. </summary>
  8457. <param name="appenders">The appenders to use to log all logging events.</param>
  8458. <remarks>
  8459. <para>
  8460. Initializes the log4net system using the specified appenders.
  8461. </para>
  8462. </remarks>
  8463. </member>
  8464. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender)">
  8465. <summary>
  8466. Initializes the log4net system using the specified appender.
  8467. </summary>
  8468. <param name="appender">The appender to use to log all logging events.</param>
  8469. <remarks>
  8470. <para>
  8471. Initializes the log4net system using the specified appender.
  8472. </para>
  8473. </remarks>
  8474. </member>
  8475. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8476. <summary>
  8477. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration.
  8478. </summary>
  8479. <param name="repository">The repository to configure.</param>
  8480. <remarks>
  8481. <para>
  8482. Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  8483. that will write to <c>Console.Out</c>. The log messages are
  8484. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  8485. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  8486. layout style.
  8487. </para>
  8488. </remarks>
  8489. </member>
  8490. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)">
  8491. <summary>
  8492. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8493. </summary>
  8494. <param name="repository">The repository to configure.</param>
  8495. <param name="appender">The appender to use to log all logging events.</param>
  8496. <remarks>
  8497. <para>
  8498. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8499. </para>
  8500. </remarks>
  8501. </member>
  8502. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender[])">
  8503. <summary>
  8504. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appenders.
  8505. </summary>
  8506. <param name="repository">The repository to configure.</param>
  8507. <param name="appenders">The appenders to use to log all logging events.</param>
  8508. <remarks>
  8509. <para>
  8510. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8511. </para>
  8512. </remarks>
  8513. </member>
  8514. <member name="T:log4net.Config.ConfiguratorAttribute">
  8515. <summary>
  8516. Base class for all log4net configuration attributes.
  8517. </summary>
  8518. <remarks>
  8519. This is an abstract class that must be extended by
  8520. specific configurators. This attribute allows the
  8521. configurator to be parameterized by an assembly level
  8522. attribute.
  8523. </remarks>
  8524. <author>Nicko Cadell</author>
  8525. <author>Gert Driesen</author>
  8526. </member>
  8527. <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)">
  8528. <summary>
  8529. Constructor used by subclasses.
  8530. </summary>
  8531. <param name="priority">the ordering priority for this configurator</param>
  8532. <remarks>
  8533. <para>
  8534. The <paramref name="priority"/> is used to order the configurator
  8535. attributes before they are invoked. Higher priority configurators are executed
  8536. before lower priority ones.
  8537. </para>
  8538. </remarks>
  8539. </member>
  8540. <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8541. <summary>
  8542. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  8543. </summary>
  8544. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8545. <param name="targetRepository">The repository to configure.</param>
  8546. <remarks>
  8547. <para>
  8548. Abstract method implemented by a subclass. When this method is called
  8549. the subclass should configure the <paramref name="targetRepository"/>.
  8550. </para>
  8551. </remarks>
  8552. </member>
  8553. <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)">
  8554. <summary>
  8555. Compare this instance to another ConfiguratorAttribute
  8556. </summary>
  8557. <param name="obj">the object to compare to</param>
  8558. <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns>
  8559. <remarks>
  8560. <para>
  8561. Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances.
  8562. Sorts by priority in descending order. Objects with the same priority are
  8563. randomly ordered.
  8564. </para>
  8565. </remarks>
  8566. </member>
  8567. <member name="T:log4net.Config.DomainAttribute">
  8568. <summary>
  8569. Assembly level attribute that specifies the logging domain for the assembly.
  8570. </summary>
  8571. <remarks>
  8572. <para>
  8573. <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b>
  8574. </para>
  8575. <para>
  8576. Assemblies are mapped to logging domains. Each domain has its own
  8577. logging repository. This attribute specified on the assembly controls
  8578. the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  8579. of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  8580. specifies the type of the repository objects to create for the domain. If
  8581. this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified
  8582. then the assembly will be part of the default shared logging domain.
  8583. </para>
  8584. <para>
  8585. This attribute can only be specified on the assembly and may only be used
  8586. once per assembly.
  8587. </para>
  8588. </remarks>
  8589. <author>Nicko Cadell</author>
  8590. <author>Gert Driesen</author>
  8591. </member>
  8592. <member name="M:log4net.Config.DomainAttribute.#ctor">
  8593. <summary>
  8594. Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute" /> class.
  8595. </summary>
  8596. <remarks>
  8597. <para>
  8598. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8599. </para>
  8600. </remarks>
  8601. </member>
  8602. <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)">
  8603. <summary>
  8604. Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute" /> class
  8605. with the name of the domain.
  8606. </summary>
  8607. <param name="name">The name of the domain.</param>
  8608. <remarks>
  8609. <para>
  8610. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8611. </para>
  8612. </remarks>
  8613. </member>
  8614. <member name="T:log4net.Config.DOMConfigurator">
  8615. <summary>
  8616. Use this class to initialize the log4net environment using an Xml tree.
  8617. </summary>
  8618. <remarks>
  8619. <para>
  8620. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8621. </para>
  8622. <para>
  8623. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  8624. </para>
  8625. </remarks>
  8626. <author>Nicko Cadell</author>
  8627. <author>Gert Driesen</author>
  8628. </member>
  8629. <member name="M:log4net.Config.DOMConfigurator.#ctor">
  8630. <summary>
  8631. Private constructor
  8632. </summary>
  8633. </member>
  8634. <member name="M:log4net.Config.DOMConfigurator.Configure">
  8635. <summary>
  8636. Automatically configures the log4net system based on the
  8637. application's configuration settings.
  8638. </summary>
  8639. <remarks>
  8640. <para>
  8641. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8642. </para>
  8643. Each application has a configuration file. This has the
  8644. same name as the application with '.config' appended.
  8645. This file is XML and calling this function prompts the
  8646. configurator to look in that file for a section called
  8647. <c>log4net</c> that contains the configuration data.
  8648. </remarks>
  8649. </member>
  8650. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8651. <summary>
  8652. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  8653. stored in the application's configuration file.
  8654. </summary>
  8655. <remarks>
  8656. <para>
  8657. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8658. </para>
  8659. Each application has a configuration file. This has the
  8660. same name as the application with '.config' appended.
  8661. This file is XML and calling this function prompts the
  8662. configurator to look in that file for a section called
  8663. <c>log4net</c> that contains the configuration data.
  8664. </remarks>
  8665. <param name="repository">The repository to configure.</param>
  8666. </member>
  8667. <member name="M:log4net.Config.DOMConfigurator.Configure(System.Xml.XmlElement)">
  8668. <summary>
  8669. Configures log4net using a <c>log4net</c> element
  8670. </summary>
  8671. <remarks>
  8672. <para>
  8673. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8674. </para>
  8675. Loads the log4net configuration from the XML element
  8676. supplied as <paramref name="element"/>.
  8677. </remarks>
  8678. <param name="element">The element to parse.</param>
  8679. </member>
  8680. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  8681. <summary>
  8682. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  8683. element.
  8684. </summary>
  8685. <remarks>
  8686. <para>
  8687. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8688. </para>
  8689. Loads the log4net configuration from the XML element
  8690. supplied as <paramref name="element"/>.
  8691. </remarks>
  8692. <param name="repository">The repository to configure.</param>
  8693. <param name="element">The element to parse.</param>
  8694. </member>
  8695. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)">
  8696. <summary>
  8697. Configures log4net using the specified configuration file.
  8698. </summary>
  8699. <param name="configFile">The XML file to load the configuration from.</param>
  8700. <remarks>
  8701. <para>
  8702. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8703. </para>
  8704. <para>
  8705. The configuration file must be valid XML. It must contain
  8706. at least one element called <c>log4net</c> that holds
  8707. the log4net configuration data.
  8708. </para>
  8709. <para>
  8710. The log4net configuration file can possible be specified in the application's
  8711. configuration file (either <c>MyAppName.exe.config</c> for a
  8712. normal application on <c>Web.config</c> for an ASP.NET application).
  8713. </para>
  8714. <example>
  8715. The following example configures log4net using a configuration file, of which the
  8716. location is stored in the application's configuration file :
  8717. </example>
  8718. <code lang="C#">
  8719. using log4net.Config;
  8720. using System.IO;
  8721. using System.Configuration;
  8722. ...
  8723. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  8724. </code>
  8725. <para>
  8726. In the <c>.config</c> file, the path to the log4net can be specified like this :
  8727. </para>
  8728. <code lang="XML" escaped="true">
  8729. <configuration>
  8730. <appSettings>
  8731. <add key="log4net-config-file" value="log.config"/>
  8732. </appSettings>
  8733. </configuration>
  8734. </code>
  8735. </remarks>
  8736. </member>
  8737. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.Stream)">
  8738. <summary>
  8739. Configures log4net using the specified configuration file.
  8740. </summary>
  8741. <param name="configStream">A stream to load the XML configuration from.</param>
  8742. <remarks>
  8743. <para>
  8744. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8745. </para>
  8746. <para>
  8747. The configuration data must be valid XML. It must contain
  8748. at least one element called <c>log4net</c> that holds
  8749. the log4net configuration data.
  8750. </para>
  8751. <para>
  8752. Note that this method will NOT close the stream parameter.
  8753. </para>
  8754. </remarks>
  8755. </member>
  8756. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8757. <summary>
  8758. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  8759. file.
  8760. </summary>
  8761. <param name="repository">The repository to configure.</param>
  8762. <param name="configFile">The XML file to load the configuration from.</param>
  8763. <remarks>
  8764. <para>
  8765. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8766. </para>
  8767. <para>
  8768. The configuration file must be valid XML. It must contain
  8769. at least one element called <c>log4net</c> that holds
  8770. the configuration data.
  8771. </para>
  8772. <para>
  8773. The log4net configuration file can possible be specified in the application's
  8774. configuration file (either <c>MyAppName.exe.config</c> for a
  8775. normal application on <c>Web.config</c> for an ASP.NET application).
  8776. </para>
  8777. <example>
  8778. The following example configures log4net using a configuration file, of which the
  8779. location is stored in the application's configuration file :
  8780. </example>
  8781. <code lang="C#">
  8782. using log4net.Config;
  8783. using System.IO;
  8784. using System.Configuration;
  8785. ...
  8786. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  8787. </code>
  8788. <para>
  8789. In the <c>.config</c> file, the path to the log4net can be specified like this :
  8790. </para>
  8791. <code lang="XML" escaped="true">
  8792. <configuration>
  8793. <appSettings>
  8794. <add key="log4net-config-file" value="log.config"/>
  8795. </appSettings>
  8796. </configuration>
  8797. </code>
  8798. </remarks>
  8799. </member>
  8800. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  8801. <summary>
  8802. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  8803. file.
  8804. </summary>
  8805. <param name="repository">The repository to configure.</param>
  8806. <param name="configStream">The stream to load the XML configuration from.</param>
  8807. <remarks>
  8808. <para>
  8809. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8810. </para>
  8811. <para>
  8812. The configuration data must be valid XML. It must contain
  8813. at least one element called <c>log4net</c> that holds
  8814. the configuration data.
  8815. </para>
  8816. <para>
  8817. Note that this method will NOT close the stream parameter.
  8818. </para>
  8819. </remarks>
  8820. </member>
  8821. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  8822. <summary>
  8823. Configures log4net using the file specified, monitors the file for changes
  8824. and reloads the configuration if a change is detected.
  8825. </summary>
  8826. <param name="configFile">The XML file to load the configuration from.</param>
  8827. <remarks>
  8828. <para>
  8829. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8830. </para>
  8831. <para>
  8832. The configuration file must be valid XML. It must contain
  8833. at least one element called <c>log4net</c> that holds
  8834. the configuration data.
  8835. </para>
  8836. <para>
  8837. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  8838. and depends on the behavior of that class.
  8839. </para>
  8840. <para>
  8841. For more information on how to configure log4net using
  8842. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  8843. </para>
  8844. </remarks>
  8845. <seealso cref="M:Configure(FileInfo)"/>
  8846. </member>
  8847. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8848. <summary>
  8849. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  8850. monitors the file for changes and reloads the configuration if a change
  8851. is detected.
  8852. </summary>
  8853. <param name="repository">The repository to configure.</param>
  8854. <param name="configFile">The XML file to load the configuration from.</param>
  8855. <remarks>
  8856. <para>
  8857. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8858. </para>
  8859. <para>
  8860. The configuration file must be valid XML. It must contain
  8861. at least one element called <c>log4net</c> that holds
  8862. the configuration data.
  8863. </para>
  8864. <para>
  8865. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  8866. and depends on the behavior of that class.
  8867. </para>
  8868. <para>
  8869. For more information on how to configure log4net using
  8870. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  8871. </para>
  8872. </remarks>
  8873. <seealso cref="M:Configure(FileInfo)"/>
  8874. </member>
  8875. <member name="T:log4net.Config.DOMConfiguratorAttribute">
  8876. <summary>
  8877. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  8878. </summary>
  8879. <remarks>
  8880. <para>
  8881. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  8882. </para>
  8883. <para>
  8884. This attribute may only be used at the assembly scope and can only
  8885. be used once per assembly.
  8886. </para>
  8887. <para>
  8888. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  8889. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  8890. methods.
  8891. </para>
  8892. </remarks>
  8893. <author>Nicko Cadell</author>
  8894. <author>Gert Driesen</author>
  8895. </member>
  8896. <member name="T:log4net.Config.Log4NetConfigurationSectionHandler">
  8897. <summary>
  8898. Class to register for the log4net section of the configuration file
  8899. </summary>
  8900. <remarks>
  8901. The log4net section of the configuration file needs to have a section
  8902. handler registered. This is the section handler used. It simply returns
  8903. the XML element that is the root of the section.
  8904. </remarks>
  8905. <example>
  8906. Example of registering the log4net section handler :
  8907. <code lang="XML" escaped="true">
  8908. <configuration>
  8909. <configSections>
  8910. <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  8911. </configSections>
  8912. <log4net>
  8913. log4net configuration XML goes here
  8914. </log4net>
  8915. </configuration>
  8916. </code>
  8917. </example>
  8918. <author>Nicko Cadell</author>
  8919. <author>Gert Driesen</author>
  8920. </member>
  8921. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.#ctor">
  8922. <summary>
  8923. Initializes a new instance of the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> class.
  8924. </summary>
  8925. <remarks>
  8926. <para>
  8927. Default constructor.
  8928. </para>
  8929. </remarks>
  8930. </member>
  8931. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.Create(System.Object,System.Object,System.Xml.XmlNode)">
  8932. <summary>
  8933. Parses the configuration section.
  8934. </summary>
  8935. <param name="parent">The configuration settings in a corresponding parent configuration section.</param>
  8936. <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>
  8937. <param name="section">The <see cref="T:System.Xml.XmlNode" /> for the log4net section.</param>
  8938. <returns>The <see cref="T:System.Xml.XmlNode" /> for the log4net section.</returns>
  8939. <remarks>
  8940. <para>
  8941. Returns the <see cref="T:System.Xml.XmlNode"/> containing the configuration data,
  8942. </para>
  8943. </remarks>
  8944. </member>
  8945. <member name="T:log4net.Config.PluginAttribute">
  8946. <summary>
  8947. Assembly level attribute that specifies a plugin to attach to
  8948. the repository.
  8949. </summary>
  8950. <remarks>
  8951. <para>
  8952. Specifies the type of a plugin to create and attach to the
  8953. assembly's repository. The plugin type must implement the
  8954. <see cref="T:log4net.Plugin.IPlugin"/> interface.
  8955. </para>
  8956. </remarks>
  8957. <author>Nicko Cadell</author>
  8958. <author>Gert Driesen</author>
  8959. </member>
  8960. <member name="M:log4net.Config.PluginAttribute.#ctor(System.String)">
  8961. <summary>
  8962. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute" /> class
  8963. with the specified type.
  8964. </summary>
  8965. <param name="typeName">The type name of plugin to create.</param>
  8966. <remarks>
  8967. <para>
  8968. Create the attribute with the plugin type specified.
  8969. </para>
  8970. <para>
  8971. Where possible use the constructor that takes a <see cref="T:System.Type"/>.
  8972. </para>
  8973. </remarks>
  8974. </member>
  8975. <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
  8976. <summary>
  8977. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute" /> class
  8978. with the specified type.
  8979. </summary>
  8980. <param name="type">The type of plugin to create.</param>
  8981. <remarks>
  8982. <para>
  8983. Create the attribute with the plugin type specified.
  8984. </para>
  8985. </remarks>
  8986. </member>
  8987. <member name="P:log4net.Config.PluginAttribute.Type">
  8988. <summary>
  8989. Gets or sets the type for the plugin.
  8990. </summary>
  8991. <value>
  8992. The type for the plugin.
  8993. </value>
  8994. <remarks>
  8995. <para>
  8996. The type for the plugin.
  8997. </para>
  8998. </remarks>
  8999. </member>
  9000. <member name="P:log4net.Config.PluginAttribute.TypeName">
  9001. <summary>
  9002. Gets or sets the type name for the plugin.
  9003. </summary>
  9004. <value>
  9005. The type name for the plugin.
  9006. </value>
  9007. <remarks>
  9008. <para>
  9009. The type name for the plugin.
  9010. </para>
  9011. <para>
  9012. Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
  9013. </para>
  9014. </remarks>
  9015. </member>
  9016. <member name="M:log4net.Config.PluginAttribute.CreatePlugin">
  9017. <summary>
  9018. Creates the plugin object defined by this attribute.
  9019. </summary>
  9020. <remarks>
  9021. <para>
  9022. Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as
  9023. specified by this attribute.
  9024. </para>
  9025. </remarks>
  9026. <returns>The plugin object.</returns>
  9027. </member>
  9028. <member name="M:log4net.Config.PluginAttribute.ToString">
  9029. <summary>
  9030. Returns a representation of the properties of this object.
  9031. </summary>
  9032. <remarks>
  9033. <para>
  9034. Overrides base class <see cref="M:Object.ToString()" /> method to
  9035. return a representation of the properties of this object.
  9036. </para>
  9037. </remarks>
  9038. <returns>A representation of the properties of this object</returns>
  9039. </member>
  9040. <member name="T:log4net.Config.RepositoryAttribute">
  9041. <summary>
  9042. Assembly level attribute that specifies the logging repository for the assembly.
  9043. </summary>
  9044. <remarks>
  9045. <para>
  9046. Assemblies are mapped to logging repository. This attribute specified
  9047. on the assembly controls
  9048. the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  9049. of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  9050. specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object
  9051. to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/>
  9052. is not specified then the assembly will be part of the default shared logging repository.
  9053. </para>
  9054. <para>
  9055. This attribute can only be specified on the assembly and may only be used
  9056. once per assembly.
  9057. </para>
  9058. </remarks>
  9059. <author>Nicko Cadell</author>
  9060. <author>Gert Driesen</author>
  9061. </member>
  9062. <member name="M:log4net.Config.RepositoryAttribute.#ctor">
  9063. <summary>
  9064. Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute" /> class.
  9065. </summary>
  9066. <remarks>
  9067. <para>
  9068. Default constructor.
  9069. </para>
  9070. </remarks>
  9071. </member>
  9072. <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)">
  9073. <summary>
  9074. Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute" /> class
  9075. with the name of the repository.
  9076. </summary>
  9077. <param name="name">The name of the repository.</param>
  9078. <remarks>
  9079. <para>
  9080. Initialize the attribute with the name for the assembly's repository.
  9081. </para>
  9082. </remarks>
  9083. </member>
  9084. <member name="P:log4net.Config.RepositoryAttribute.Name">
  9085. <summary>
  9086. Gets or sets the name of the logging repository.
  9087. </summary>
  9088. <value>
  9089. The string name to use as the name of the repository associated with this
  9090. assembly.
  9091. </value>
  9092. <remarks>
  9093. <para>
  9094. This value does not have to be unique. Several assemblies can share the
  9095. same repository. They will share the logging configuration of the repository.
  9096. </para>
  9097. </remarks>
  9098. </member>
  9099. <member name="P:log4net.Config.RepositoryAttribute.RepositoryType">
  9100. <summary>
  9101. Gets or sets the type of repository to create for this assembly.
  9102. </summary>
  9103. <value>
  9104. The type of repository to create for this assembly.
  9105. </value>
  9106. <remarks>
  9107. <para>
  9108. The type of the repository to create for the assembly.
  9109. The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/>
  9110. interface.
  9111. </para>
  9112. <para>
  9113. This will be the type of repository created when
  9114. the repository is created. If multiple assemblies reference the
  9115. same repository then the repository is only created once using the
  9116. <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType" /> of the first assembly to call into the
  9117. repository.
  9118. </para>
  9119. </remarks>
  9120. </member>
  9121. <member name="T:log4net.Config.SecurityContextProviderAttribute">
  9122. <summary>
  9123. Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>.
  9124. </summary>
  9125. <remarks>
  9126. <para>
  9127. This attribute may only be used at the assembly scope and can only
  9128. be used once per assembly.
  9129. </para>
  9130. <para>
  9131. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9132. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9133. methods.
  9134. </para>
  9135. </remarks>
  9136. <author>Nicko Cadell</author>
  9137. </member>
  9138. <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)">
  9139. <summary>
  9140. Construct provider attribute with type specified
  9141. </summary>
  9142. <param name="providerType">the type of the provider to use</param>
  9143. <remarks>
  9144. <para>
  9145. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  9146. class.
  9147. </para>
  9148. </remarks>
  9149. </member>
  9150. <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType">
  9151. <summary>
  9152. Gets or sets the type of the provider to use.
  9153. </summary>
  9154. <value>
  9155. the type of the provider to use.
  9156. </value>
  9157. <remarks>
  9158. <para>
  9159. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  9160. class.
  9161. </para>
  9162. </remarks>
  9163. </member>
  9164. <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9165. <summary>
  9166. Configures the SecurityContextProvider
  9167. </summary>
  9168. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9169. <param name="targetRepository">The repository to configure.</param>
  9170. <remarks>
  9171. <para>
  9172. Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified.
  9173. Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>.
  9174. </para>
  9175. </remarks>
  9176. </member>
  9177. <member name="F:log4net.Config.SecurityContextProviderAttribute.declaringType">
  9178. <summary>
  9179. The fully qualified type of the SecurityContextProviderAttribute class.
  9180. </summary>
  9181. <remarks>
  9182. Used by the internal logger to record the Type of the
  9183. log message.
  9184. </remarks>
  9185. </member>
  9186. <member name="T:log4net.Config.XmlConfigurator">
  9187. <summary>
  9188. Use this class to initialize the log4net environment using an Xml tree.
  9189. </summary>
  9190. <remarks>
  9191. <para>
  9192. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  9193. </para>
  9194. </remarks>
  9195. <author>Nicko Cadell</author>
  9196. <author>Gert Driesen</author>
  9197. </member>
  9198. <member name="M:log4net.Config.XmlConfigurator.#ctor">
  9199. <summary>
  9200. Private constructor
  9201. </summary>
  9202. </member>
  9203. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  9204. <summary>
  9205. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  9206. stored in the application's configuration file.
  9207. </summary>
  9208. <remarks>
  9209. <para>
  9210. Each application has a configuration file. This has the
  9211. same name as the application with '.config' appended.
  9212. This file is XML and calling this function prompts the
  9213. configurator to look in that file for a section called
  9214. <c>log4net</c> that contains the configuration data.
  9215. </para>
  9216. <para>
  9217. To use this method to configure log4net you must specify
  9218. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  9219. handler for the <c>log4net</c> configuration section. See the
  9220. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  9221. </para>
  9222. </remarks>
  9223. <param name="repository">The repository to configure.</param>
  9224. </member>
  9225. <member name="M:log4net.Config.XmlConfigurator.Configure">
  9226. <summary>
  9227. Automatically configures the log4net system based on the
  9228. application's configuration settings.
  9229. </summary>
  9230. <remarks>
  9231. <para>
  9232. Each application has a configuration file. This has the
  9233. same name as the application with '.config' appended.
  9234. This file is XML and calling this function prompts the
  9235. configurator to look in that file for a section called
  9236. <c>log4net</c> that contains the configuration data.
  9237. </para>
  9238. <para>
  9239. To use this method to configure log4net you must specify
  9240. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  9241. handler for the <c>log4net</c> configuration section. See the
  9242. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  9243. </para>
  9244. </remarks>
  9245. <seealso cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/>
  9246. </member>
  9247. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Xml.XmlElement)">
  9248. <summary>
  9249. Configures log4net using a <c>log4net</c> element
  9250. </summary>
  9251. <remarks>
  9252. <para>
  9253. Loads the log4net configuration from the XML element
  9254. supplied as <paramref name="element"/>.
  9255. </para>
  9256. </remarks>
  9257. <param name="element">The element to parse.</param>
  9258. </member>
  9259. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)">
  9260. <summary>
  9261. Configures log4net using the specified configuration file.
  9262. </summary>
  9263. <param name="configFile">The XML file to load the configuration from.</param>
  9264. <remarks>
  9265. <para>
  9266. The configuration file must be valid XML. It must contain
  9267. at least one element called <c>log4net</c> that holds
  9268. the log4net configuration data.
  9269. </para>
  9270. <para>
  9271. The log4net configuration file can possible be specified in the application's
  9272. configuration file (either <c>MyAppName.exe.config</c> for a
  9273. normal application on <c>Web.config</c> for an ASP.NET application).
  9274. </para>
  9275. <para>
  9276. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  9277. configuration. If this file is also a .NET .config file then you must specify
  9278. a configuration section for the <c>log4net</c> element otherwise .NET will
  9279. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  9280. <code lang="XML" escaped="true">
  9281. <configSections>
  9282. <section name="log4net" type="System.Configuration.IgnoreSectionHandler" />
  9283. </configSections>
  9284. </code>
  9285. </para>
  9286. <example>
  9287. The following example configures log4net using a configuration file, of which the
  9288. location is stored in the application's configuration file :
  9289. </example>
  9290. <code lang="C#">
  9291. using log4net.Config;
  9292. using System.IO;
  9293. using System.Configuration;
  9294. ...
  9295. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9296. </code>
  9297. <para>
  9298. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9299. </para>
  9300. <code lang="XML" escaped="true">
  9301. <configuration>
  9302. <appSettings>
  9303. <add key="log4net-config-file" value="log.config"/>
  9304. </appSettings>
  9305. </configuration>
  9306. </code>
  9307. </remarks>
  9308. </member>
  9309. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Uri)">
  9310. <summary>
  9311. Configures log4net using the specified configuration URI.
  9312. </summary>
  9313. <param name="configUri">A URI to load the XML configuration from.</param>
  9314. <remarks>
  9315. <para>
  9316. The configuration data must be valid XML. It must contain
  9317. at least one element called <c>log4net</c> that holds
  9318. the log4net configuration data.
  9319. </para>
  9320. <para>
  9321. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  9322. </para>
  9323. </remarks>
  9324. </member>
  9325. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.Stream)">
  9326. <summary>
  9327. Configures log4net using the specified configuration data stream.
  9328. </summary>
  9329. <param name="configStream">A stream to load the XML configuration from.</param>
  9330. <remarks>
  9331. <para>
  9332. The configuration data must be valid XML. It must contain
  9333. at least one element called <c>log4net</c> that holds
  9334. the log4net configuration data.
  9335. </para>
  9336. <para>
  9337. Note that this method will NOT close the stream parameter.
  9338. </para>
  9339. </remarks>
  9340. </member>
  9341. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9342. <summary>
  9343. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  9344. element.
  9345. </summary>
  9346. <remarks>
  9347. Loads the log4net configuration from the XML element
  9348. supplied as <paramref name="element"/>.
  9349. </remarks>
  9350. <param name="repository">The repository to configure.</param>
  9351. <param name="element">The element to parse.</param>
  9352. </member>
  9353. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9354. <summary>
  9355. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9356. file.
  9357. </summary>
  9358. <param name="repository">The repository to configure.</param>
  9359. <param name="configFile">The XML file to load the configuration from.</param>
  9360. <remarks>
  9361. <para>
  9362. The configuration file must be valid XML. It must contain
  9363. at least one element called <c>log4net</c> that holds
  9364. the configuration data.
  9365. </para>
  9366. <para>
  9367. The log4net configuration file can possible be specified in the application's
  9368. configuration file (either <c>MyAppName.exe.config</c> for a
  9369. normal application on <c>Web.config</c> for an ASP.NET application).
  9370. </para>
  9371. <para>
  9372. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  9373. configuration. If this file is also a .NET .config file then you must specify
  9374. a configuration section for the <c>log4net</c> element otherwise .NET will
  9375. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  9376. <code lang="XML" escaped="true">
  9377. <configSections>
  9378. <section name="log4net" type="System.Configuration.IgnoreSectionHandler" />
  9379. </configSections>
  9380. </code>
  9381. </para>
  9382. <example>
  9383. The following example configures log4net using a configuration file, of which the
  9384. location is stored in the application's configuration file :
  9385. </example>
  9386. <code lang="C#">
  9387. using log4net.Config;
  9388. using System.IO;
  9389. using System.Configuration;
  9390. ...
  9391. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9392. </code>
  9393. <para>
  9394. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9395. </para>
  9396. <code lang="XML" escaped="true">
  9397. <configuration>
  9398. <appSettings>
  9399. <add key="log4net-config-file" value="log.config"/>
  9400. </appSettings>
  9401. </configuration>
  9402. </code>
  9403. </remarks>
  9404. </member>
  9405. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)">
  9406. <summary>
  9407. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9408. URI.
  9409. </summary>
  9410. <param name="repository">The repository to configure.</param>
  9411. <param name="configUri">A URI to load the XML configuration from.</param>
  9412. <remarks>
  9413. <para>
  9414. The configuration data must be valid XML. It must contain
  9415. at least one element called <c>log4net</c> that holds
  9416. the configuration data.
  9417. </para>
  9418. <para>
  9419. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  9420. </para>
  9421. </remarks>
  9422. </member>
  9423. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  9424. <summary>
  9425. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9426. file.
  9427. </summary>
  9428. <param name="repository">The repository to configure.</param>
  9429. <param name="configStream">The stream to load the XML configuration from.</param>
  9430. <remarks>
  9431. <para>
  9432. The configuration data must be valid XML. It must contain
  9433. at least one element called <c>log4net</c> that holds
  9434. the configuration data.
  9435. </para>
  9436. <para>
  9437. Note that this method will NOT close the stream parameter.
  9438. </para>
  9439. </remarks>
  9440. </member>
  9441. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  9442. <summary>
  9443. Configures log4net using the file specified, monitors the file for changes
  9444. and reloads the configuration if a change is detected.
  9445. </summary>
  9446. <param name="configFile">The XML file to load the configuration from.</param>
  9447. <remarks>
  9448. <para>
  9449. The configuration file must be valid XML. It must contain
  9450. at least one element called <c>log4net</c> that holds
  9451. the configuration data.
  9452. </para>
  9453. <para>
  9454. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9455. and depends on the behavior of that class.
  9456. </para>
  9457. <para>
  9458. For more information on how to configure log4net using
  9459. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9460. </para>
  9461. </remarks>
  9462. <seealso cref="M:Configure(FileInfo)"/>
  9463. </member>
  9464. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9465. <summary>
  9466. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  9467. monitors the file for changes and reloads the configuration if a change
  9468. is detected.
  9469. </summary>
  9470. <param name="repository">The repository to configure.</param>
  9471. <param name="configFile">The XML file to load the configuration from.</param>
  9472. <remarks>
  9473. <para>
  9474. The configuration file must be valid XML. It must contain
  9475. at least one element called <c>log4net</c> that holds
  9476. the configuration data.
  9477. </para>
  9478. <para>
  9479. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9480. and depends on the behavior of that class.
  9481. </para>
  9482. <para>
  9483. For more information on how to configure log4net using
  9484. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9485. </para>
  9486. </remarks>
  9487. <seealso cref="M:Configure(FileInfo)"/>
  9488. </member>
  9489. <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler">
  9490. <summary>
  9491. Class used to watch config files.
  9492. </summary>
  9493. <remarks>
  9494. <para>
  9495. Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor
  9496. changes to a specified file. Because multiple change notifications
  9497. may be raised when the file is modified, a timer is used to
  9498. compress the notifications into a single event. The timer
  9499. waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering
  9500. the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/>
  9501. change notifications arrive while the timer is waiting it
  9502. is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to
  9503. elapse.
  9504. </para>
  9505. </remarks>
  9506. </member>
  9507. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile">
  9508. <summary>
  9509. Holds the FileInfo used to configure the XmlConfigurator
  9510. </summary>
  9511. </member>
  9512. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository">
  9513. <summary>
  9514. Holds the repository being configured.
  9515. </summary>
  9516. </member>
  9517. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer">
  9518. <summary>
  9519. The timer used to compress the notification events.
  9520. </summary>
  9521. </member>
  9522. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis">
  9523. <summary>
  9524. The default amount of time to wait after receiving notification
  9525. before reloading the config file.
  9526. </summary>
  9527. </member>
  9528. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_watcher">
  9529. <summary>
  9530. Watches file for changes. This object should be disposed when no longer
  9531. needed to free system handles on the watched resources.
  9532. </summary>
  9533. </member>
  9534. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9535. <summary>
  9536. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler" /> class to
  9537. watch a specified config file used to configure a repository.
  9538. </summary>
  9539. <param name="repository">The repository to configure.</param>
  9540. <param name="configFile">The configuration file to watch.</param>
  9541. <remarks>
  9542. <para>
  9543. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler" /> class.
  9544. </para>
  9545. </remarks>
  9546. </member>
  9547. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)">
  9548. <summary>
  9549. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  9550. </summary>
  9551. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  9552. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  9553. <remarks>
  9554. <para>
  9555. This handler reloads the configuration from the file when the event is fired.
  9556. </para>
  9557. </remarks>
  9558. </member>
  9559. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)">
  9560. <summary>
  9561. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  9562. </summary>
  9563. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  9564. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  9565. <remarks>
  9566. <para>
  9567. This handler reloads the configuration from the file when the event is fired.
  9568. </para>
  9569. </remarks>
  9570. </member>
  9571. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)">
  9572. <summary>
  9573. Called by the timer when the configuration has been updated.
  9574. </summary>
  9575. <param name="state">null</param>
  9576. </member>
  9577. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.Dispose">
  9578. <summary>
  9579. Release the handles held by the watcher and timer.
  9580. </summary>
  9581. </member>
  9582. <member name="M:log4net.Config.XmlConfigurator.InternalConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9583. <summary>
  9584. Configures the specified repository using a <c>log4net</c> element.
  9585. </summary>
  9586. <param name="repository">The hierarchy to configure.</param>
  9587. <param name="element">The element to parse.</param>
  9588. <remarks>
  9589. <para>
  9590. Loads the log4net configuration from the XML element
  9591. supplied as <paramref name="element"/>.
  9592. </para>
  9593. <para>
  9594. This method is ultimately called by one of the Configure methods
  9595. to load the configuration from an <see cref="T:System.Xml.XmlElement"/>.
  9596. </para>
  9597. </remarks>
  9598. </member>
  9599. <member name="F:log4net.Config.XmlConfigurator.m_repositoryName2ConfigAndWatchHandler">
  9600. <summary>
  9601. Maps repository names to ConfigAndWatchHandler instances to allow a particular
  9602. ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is
  9603. reconfigured.
  9604. </summary>
  9605. </member>
  9606. <member name="F:log4net.Config.XmlConfigurator.declaringType">
  9607. <summary>
  9608. The fully qualified type of the XmlConfigurator class.
  9609. </summary>
  9610. <remarks>
  9611. Used by the internal logger to record the Type of the
  9612. log message.
  9613. </remarks>
  9614. </member>
  9615. <member name="T:log4net.Config.XmlConfiguratorAttribute">
  9616. <summary>
  9617. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  9618. </summary>
  9619. <remarks>
  9620. <para>
  9621. This attribute may only be used at the assembly scope and can only
  9622. be used once per assembly.
  9623. </para>
  9624. <para>
  9625. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9626. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9627. methods.
  9628. </para>
  9629. <para>
  9630. If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>
  9631. properties are set the configuration is loaded from the application's .config file.
  9632. If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the
  9633. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property
  9634. specifies a path to a file to load the config from. The path is relative to the
  9635. application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  9636. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name.
  9637. The config file must be located in the application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  9638. For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to
  9639. <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or
  9640. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties.
  9641. </para>
  9642. <para>
  9643. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/>
  9644. to watch the configuration file for changes.
  9645. </para>
  9646. <note>
  9647. <para>
  9648. Log4net will only look for assembly level configuration attributes once.
  9649. When using the log4net assembly level attributes to control the configuration
  9650. of log4net you must ensure that the first call to any of the
  9651. <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration
  9652. attributes.
  9653. </para>
  9654. <para>
  9655. If you cannot guarantee the order in which log4net calls will be made from
  9656. different assemblies you must use programmatic configuration instead, i.e.
  9657. call the <see cref="M:XmlConfigurator.Configure()"/> method directly.
  9658. </para>
  9659. </note>
  9660. </remarks>
  9661. <author>Nicko Cadell</author>
  9662. <author>Gert Driesen</author>
  9663. </member>
  9664. <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor">
  9665. <summary>
  9666. Default constructor
  9667. </summary>
  9668. <remarks>
  9669. <para>
  9670. Default constructor
  9671. </para>
  9672. </remarks>
  9673. </member>
  9674. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile">
  9675. <summary>
  9676. Gets or sets the filename of the configuration file.
  9677. </summary>
  9678. <value>
  9679. The filename of the configuration file.
  9680. </value>
  9681. <remarks>
  9682. <para>
  9683. If specified, this is the name of the configuration file to use with
  9684. the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the
  9685. <b>application base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>).
  9686. </para>
  9687. <para>
  9688. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  9689. </para>
  9690. </remarks>
  9691. </member>
  9692. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension">
  9693. <summary>
  9694. Gets or sets the extension of the configuration file.
  9695. </summary>
  9696. <value>
  9697. The extension of the configuration file.
  9698. </value>
  9699. <remarks>
  9700. <para>
  9701. If specified this is the extension for the configuration file.
  9702. The path to the config file is built by using the <b>application
  9703. base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>),
  9704. the <b>assembly file name</b> and the config file extension.
  9705. </para>
  9706. <para>
  9707. If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then
  9708. possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or
  9709. <c>MyClassLibrary.dll.MyExt</c>.
  9710. </para>
  9711. <para>
  9712. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  9713. </para>
  9714. </remarks>
  9715. </member>
  9716. <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch">
  9717. <summary>
  9718. Gets or sets a value indicating whether to watch the configuration file.
  9719. </summary>
  9720. <value>
  9721. <c>true</c> if the configuration should be watched, <c>false</c> otherwise.
  9722. </value>
  9723. <remarks>
  9724. <para>
  9725. If this flag is specified and set to <c>true</c> then the framework
  9726. will watch the configuration file and will reload the config each time
  9727. the file is modified.
  9728. </para>
  9729. <para>
  9730. The config file can only be watched if it is loaded from local disk.
  9731. In a No-Touch (Smart Client) deployment where the application is downloaded
  9732. from a web server the config file may not reside on the local disk
  9733. and therefore it may not be able to watch it.
  9734. </para>
  9735. <note>
  9736. Watching configuration is not supported on the SSCLI.
  9737. </note>
  9738. </remarks>
  9739. </member>
  9740. <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9741. <summary>
  9742. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9743. </summary>
  9744. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9745. <param name="targetRepository">The repository to configure.</param>
  9746. <remarks>
  9747. <para>
  9748. Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>.
  9749. The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  9750. class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to
  9751. configure it.
  9752. </para>
  9753. </remarks>
  9754. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetRepository" /> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception>
  9755. </member>
  9756. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9757. <summary>
  9758. Attempt to load configuration from the local file system
  9759. </summary>
  9760. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9761. <param name="targetRepository">The repository to configure.</param>
  9762. </member>
  9763. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9764. <summary>
  9765. Configure the specified repository using a <see cref="T:System.IO.FileInfo"/>
  9766. </summary>
  9767. <param name="targetRepository">The repository to configure.</param>
  9768. <param name="configFile">the FileInfo pointing to the config file</param>
  9769. </member>
  9770. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9771. <summary>
  9772. Attempt to load configuration from a URI
  9773. </summary>
  9774. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9775. <param name="targetRepository">The repository to configure.</param>
  9776. </member>
  9777. <member name="F:log4net.Config.XmlConfiguratorAttribute.declaringType">
  9778. <summary>
  9779. The fully qualified type of the XmlConfiguratorAttribute class.
  9780. </summary>
  9781. <remarks>
  9782. Used by the internal logger to record the Type of the
  9783. log message.
  9784. </remarks>
  9785. </member>
  9786. <member name="T:log4net.Core.CompactRepositorySelector">
  9787. <summary>
  9788. The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable
  9789. for use with the compact framework
  9790. </summary>
  9791. <remarks>
  9792. <para>
  9793. This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple
  9794. mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9795. object.
  9796. </para>
  9797. <para>
  9798. The .NET Compact Framework 1.0 does not support retrieving assembly
  9799. level attributes therefore unlike the <c>DefaultRepositorySelector</c>
  9800. this selector does not examine the calling assembly for attributes.
  9801. </para>
  9802. </remarks>
  9803. <author>Nicko Cadell</author>
  9804. </member>
  9805. <member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)">
  9806. <summary>
  9807. Create a new repository selector
  9808. </summary>
  9809. <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9810. <remarks>
  9811. <para>
  9812. Create an new compact repository selector.
  9813. The default type for repositories must be specified,
  9814. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  9815. </para>
  9816. </remarks>
  9817. <exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception>
  9818. <exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception>
  9819. </member>
  9820. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)">
  9821. <summary>
  9822. Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly
  9823. </summary>
  9824. <param name="assembly">not used</param>
  9825. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9826. <remarks>
  9827. <para>
  9828. The <paramref name="assembly"/> argument is not used. This selector does not create a
  9829. separate repository for each assembly.
  9830. </para>
  9831. <para>
  9832. As a named repository is not specified the default repository is
  9833. returned. The default repository is named <c>log4net-default-repository</c>.
  9834. </para>
  9835. </remarks>
  9836. </member>
  9837. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)">
  9838. <summary>
  9839. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>
  9840. </summary>
  9841. <param name="repositoryName">the name of the repository to lookup</param>
  9842. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9843. <remarks>
  9844. <para>
  9845. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default
  9846. repository is <c>log4net-default-repository</c>. Other repositories
  9847. must be created using the <see cref="M:CreateRepository(string, Type)"/>.
  9848. If the named repository does not exist an exception is thrown.
  9849. </para>
  9850. </remarks>
  9851. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  9852. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception>
  9853. </member>
  9854. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  9855. <summary>
  9856. Create a new repository for the assembly specified
  9857. </summary>
  9858. <param name="assembly">not used</param>
  9859. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9860. <returns>the repository created</returns>
  9861. <remarks>
  9862. <para>
  9863. The <paramref name="assembly"/> argument is not used. This selector does not create a
  9864. separate repository for each assembly.
  9865. </para>
  9866. <para>
  9867. If the <paramref name="repositoryType"/> is <c>null</c> then the
  9868. default repository type specified to the constructor is used.
  9869. </para>
  9870. <para>
  9871. As a named repository is not specified the default repository is
  9872. returned. The default repository is named <c>log4net-default-repository</c>.
  9873. </para>
  9874. </remarks>
  9875. </member>
  9876. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)">
  9877. <summary>
  9878. Create a new repository for the repository specified
  9879. </summary>
  9880. <param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9881. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9882. If this param is null then the default repository type is used.</param>
  9883. <returns>the repository created</returns>
  9884. <remarks>
  9885. <para>
  9886. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  9887. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  9888. same repository specified will return the same repository instance.
  9889. </para>
  9890. <para>
  9891. If the named repository already exists an exception will be thrown.
  9892. </para>
  9893. <para>
  9894. If <paramref name="repositoryType"/> is <c>null</c> then the default
  9895. repository type specified to the constructor is used.
  9896. </para>
  9897. </remarks>
  9898. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  9899. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception>
  9900. </member>
  9901. <member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)">
  9902. <summary>
  9903. Test if a named repository exists
  9904. </summary>
  9905. <param name="repositoryName">the named repository to check</param>
  9906. <returns><c>true</c> if the repository exists</returns>
  9907. <remarks>
  9908. <para>
  9909. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  9910. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  9911. a repository.
  9912. </para>
  9913. </remarks>
  9914. </member>
  9915. <member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories">
  9916. <summary>
  9917. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  9918. </summary>
  9919. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  9920. <remarks>
  9921. <para>
  9922. Gets an array of all of the repositories created by this selector.
  9923. </para>
  9924. </remarks>
  9925. </member>
  9926. <member name="F:log4net.Core.CompactRepositorySelector.declaringType">
  9927. <summary>
  9928. The fully qualified type of the CompactRepositorySelector class.
  9929. </summary>
  9930. <remarks>
  9931. Used by the internal logger to record the Type of the
  9932. log message.
  9933. </remarks>
  9934. </member>
  9935. <member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">
  9936. <summary>
  9937. Event to notify that a logger repository has been created.
  9938. </summary>
  9939. <value>
  9940. Event to notify that a logger repository has been created.
  9941. </value>
  9942. <remarks>
  9943. <para>
  9944. Event raised when a new repository is created.
  9945. The event source will be this selector. The event args will
  9946. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  9947. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9948. </para>
  9949. </remarks>
  9950. </member>
  9951. <member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  9952. <summary>
  9953. Notify the registered listeners that the repository has been created
  9954. </summary>
  9955. <param name="repository">The repository that has been created</param>
  9956. <remarks>
  9957. <para>
  9958. Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event>
  9959. event.
  9960. </para>
  9961. </remarks>
  9962. </member>
  9963. <member name="T:log4net.Core.DefaultRepositorySelector">
  9964. <summary>
  9965. The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface.
  9966. </summary>
  9967. <remarks>
  9968. <para>
  9969. Uses attributes defined on the calling assembly to determine how to
  9970. configure the hierarchy for the repository.
  9971. </para>
  9972. </remarks>
  9973. <author>Nicko Cadell</author>
  9974. <author>Gert Driesen</author>
  9975. </member>
  9976. <member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent">
  9977. <summary>
  9978. Event to notify that a logger repository has been created.
  9979. </summary>
  9980. <value>
  9981. Event to notify that a logger repository has been created.
  9982. </value>
  9983. <remarks>
  9984. <para>
  9985. Event raised when a new repository is created.
  9986. The event source will be this selector. The event args will
  9987. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  9988. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9989. </para>
  9990. </remarks>
  9991. </member>
  9992. <member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)">
  9993. <summary>
  9994. Creates a new repository selector.
  9995. </summary>
  9996. <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9997. <remarks>
  9998. <para>
  9999. Create an new repository selector.
  10000. The default type for repositories must be specified,
  10001. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  10002. </para>
  10003. </remarks>
  10004. <exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null" />.</exception>
  10005. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception>
  10006. </member>
  10007. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10008. <summary>
  10009. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10010. </summary>
  10011. <param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10012. <remarks>
  10013. <para>
  10014. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
  10015. to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
  10016. attribute on the <paramref name="repositoryAssembly"/>.
  10017. </para>
  10018. <para>
  10019. The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  10020. implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10021. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10022. </para>
  10023. <para>
  10024. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
  10025. any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
  10026. the <paramref name="repositoryAssembly"/>.
  10027. </para>
  10028. </remarks>
  10029. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
  10030. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  10031. </member>
  10032. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
  10033. <summary>
  10034. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.
  10035. </summary>
  10036. <param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10037. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns>
  10038. <remarks>
  10039. <para>
  10040. Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c>
  10041. a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository
  10042. does not exist a <see cref="T:log4net.Core.LogException"/> is thrown.
  10043. </para>
  10044. <para>
  10045. Use <see cref="M:CreateRepository(string, Type)"/> to create a repository.
  10046. </para>
  10047. </remarks>
  10048. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null" />.</exception>
  10049. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception>
  10050. </member>
  10051. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10052. <summary>
  10053. Create a new repository for the assembly specified
  10054. </summary>
  10055. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10056. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10057. <returns>The repository created.</returns>
  10058. <remarks>
  10059. <para>
  10060. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10061. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10062. same assembly specified will return the same repository instance.
  10063. </para>
  10064. <para>
  10065. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  10066. the repository to create can be overridden by specifying the
  10067. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10068. <paramref name="repositoryAssembly"/>. The default values are to use the
  10069. <paramref name="repositoryType"/> implementation of the
  10070. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10071. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10072. </para>
  10073. <para>
  10074. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  10075. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10076. attributes defined on the <paramref name="repositoryAssembly"/>.
  10077. </para>
  10078. <para>
  10079. If a repository for the <paramref name="repositoryAssembly"/> already exists
  10080. that repository will be returned. An error will not be raised and that
  10081. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  10082. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10083. assembly may be used to override the repository type specified in
  10084. <paramref name="repositoryType"/>.
  10085. </para>
  10086. </remarks>
  10087. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  10088. </member>
  10089. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)">
  10090. <summary>
  10091. Creates a new repository for the assembly specified.
  10092. </summary>
  10093. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10094. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10095. <param name="repositoryName">The name to assign to the created repository</param>
  10096. <param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param>
  10097. <returns>The repository created.</returns>
  10098. <remarks>
  10099. <para>
  10100. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10101. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10102. same assembly specified will return the same repository instance.
  10103. </para>
  10104. <para>
  10105. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  10106. the repository to create can be overridden by specifying the
  10107. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10108. <paramref name="repositoryAssembly"/>. The default values are to use the
  10109. <paramref name="repositoryType"/> implementation of the
  10110. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10111. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10112. </para>
  10113. <para>
  10114. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  10115. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10116. attributes defined on the <paramref name="repositoryAssembly"/>.
  10117. </para>
  10118. <para>
  10119. If a repository for the <paramref name="repositoryAssembly"/> already exists
  10120. that repository will be returned. An error will not be raised and that
  10121. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  10122. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10123. assembly may be used to override the repository type specified in
  10124. <paramref name="repositoryType"/>.
  10125. </para>
  10126. </remarks>
  10127. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  10128. </member>
  10129. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)">
  10130. <summary>
  10131. Creates a new repository for the specified repository.
  10132. </summary>
  10133. <param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10134. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10135. If this param is <see langword="null" /> then the default repository type is used.</param>
  10136. <returns>The new repository.</returns>
  10137. <remarks>
  10138. <para>
  10139. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10140. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10141. same repository specified will return the same repository instance.
  10142. </para>
  10143. </remarks>
  10144. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null" />.</exception>
  10145. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception>
  10146. </member>
  10147. <member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)">
  10148. <summary>
  10149. Test if a named repository exists
  10150. </summary>
  10151. <param name="repositoryName">the named repository to check</param>
  10152. <returns><c>true</c> if the repository exists</returns>
  10153. <remarks>
  10154. <para>
  10155. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  10156. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  10157. a repository.
  10158. </para>
  10159. </remarks>
  10160. </member>
  10161. <member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories">
  10162. <summary>
  10163. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  10164. </summary>
  10165. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  10166. <remarks>
  10167. <para>
  10168. Gets an array of all of the repositories created by this selector.
  10169. </para>
  10170. </remarks>
  10171. </member>
  10172. <member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)">
  10173. <summary>
  10174. Aliases a repository to an existing repository.
  10175. </summary>
  10176. <param name="repositoryAlias">The repository to alias.</param>
  10177. <param name="repositoryTarget">The repository that the repository is aliased to.</param>
  10178. <remarks>
  10179. <para>
  10180. The repository specified will be aliased to the repository when created.
  10181. The repository must not already exist.
  10182. </para>
  10183. <para>
  10184. When the repository is created it must utilize the same repository type as
  10185. the repository it is aliased to, otherwise the aliasing will fail.
  10186. </para>
  10187. </remarks>
  10188. <exception cref="T:System.ArgumentNullException">
  10189. <para><paramref name="repositoryAlias" /> is <see langword="null" />.</para>
  10190. <para>-or-</para>
  10191. <para><paramref name="repositoryTarget" /> is <see langword="null" />.</para>
  10192. </exception>
  10193. </member>
  10194. <member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  10195. <summary>
  10196. Notifies the registered listeners that the repository has been created.
  10197. </summary>
  10198. <param name="repository">The repository that has been created.</param>
  10199. <remarks>
  10200. <para>
  10201. Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  10202. </para>
  10203. </remarks>
  10204. </member>
  10205. <member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)">
  10206. <summary>
  10207. Gets the repository name and repository type for the specified assembly.
  10208. </summary>
  10209. <param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param>
  10210. <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>
  10211. <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>
  10212. <exception cref="T:System.ArgumentNullException"><paramref name="assembly" /> is <see langword="null" />.</exception>
  10213. </member>
  10214. <member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10215. <summary>
  10216. Configures the repository using information from the assembly.
  10217. </summary>
  10218. <param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10219. attributes which define the configuration for the repository.</param>
  10220. <param name="repository">The repository to configure.</param>
  10221. <exception cref="T:System.ArgumentNullException">
  10222. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  10223. <para>-or-</para>
  10224. <para><paramref name="repository" /> is <see langword="null" />.</para>
  10225. </exception>
  10226. </member>
  10227. <member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10228. <summary>
  10229. Loads the attribute defined plugins on the assembly.
  10230. </summary>
  10231. <param name="assembly">The assembly that contains the attributes.</param>
  10232. <param name="repository">The repository to add the plugins to.</param>
  10233. <exception cref="T:System.ArgumentNullException">
  10234. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  10235. <para>-or-</para>
  10236. <para><paramref name="repository" /> is <see langword="null" />.</para>
  10237. </exception>
  10238. </member>
  10239. <member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10240. <summary>
  10241. Loads the attribute defined aliases on the assembly.
  10242. </summary>
  10243. <param name="assembly">The assembly that contains the attributes.</param>
  10244. <param name="repository">The repository to alias to.</param>
  10245. <exception cref="T:System.ArgumentNullException">
  10246. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  10247. <para>-or-</para>
  10248. <para><paramref name="repository" /> is <see langword="null" />.</para>
  10249. </exception>
  10250. </member>
  10251. <member name="F:log4net.Core.DefaultRepositorySelector.declaringType">
  10252. <summary>
  10253. The fully qualified type of the DefaultRepositorySelector class.
  10254. </summary>
  10255. <remarks>
  10256. Used by the internal logger to record the Type of the
  10257. log message.
  10258. </remarks>
  10259. </member>
  10260. <member name="T:log4net.Core.ErrorCode">
  10261. <summary>
  10262. Defined error codes that can be passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  10263. </summary>
  10264. <remarks>
  10265. <para>
  10266. Values passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  10267. </para>
  10268. </remarks>
  10269. <author>Nicko Cadell</author>
  10270. </member>
  10271. <member name="F:log4net.Core.ErrorCode.GenericFailure">
  10272. <summary>
  10273. A general error
  10274. </summary>
  10275. </member>
  10276. <member name="F:log4net.Core.ErrorCode.WriteFailure">
  10277. <summary>
  10278. Error while writing output
  10279. </summary>
  10280. </member>
  10281. <member name="F:log4net.Core.ErrorCode.FlushFailure">
  10282. <summary>
  10283. Failed to flush file
  10284. </summary>
  10285. </member>
  10286. <member name="F:log4net.Core.ErrorCode.CloseFailure">
  10287. <summary>
  10288. Failed to close file
  10289. </summary>
  10290. </member>
  10291. <member name="F:log4net.Core.ErrorCode.FileOpenFailure">
  10292. <summary>
  10293. Unable to open output file
  10294. </summary>
  10295. </member>
  10296. <member name="F:log4net.Core.ErrorCode.MissingLayout">
  10297. <summary>
  10298. No layout specified
  10299. </summary>
  10300. </member>
  10301. <member name="F:log4net.Core.ErrorCode.AddressParseFailure">
  10302. <summary>
  10303. Failed to parse address
  10304. </summary>
  10305. </member>
  10306. <member name="T:log4net.Core.ExceptionEvaluator">
  10307. <summary>
  10308. An evaluator that triggers on an Exception type
  10309. </summary>
  10310. <remarks>
  10311. <para>
  10312. This evaluator will trigger if the type of the Exception
  10313. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  10314. is equal to a Type in <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. ///
  10315. </para>
  10316. </remarks>
  10317. <author>Drew Schaeffer</author>
  10318. </member>
  10319. <member name="F:log4net.Core.ExceptionEvaluator.m_type">
  10320. <summary>
  10321. The type that causes the trigger to fire.
  10322. </summary>
  10323. </member>
  10324. <member name="F:log4net.Core.ExceptionEvaluator.m_triggerOnSubclass">
  10325. <summary>
  10326. Causes subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/> to cause the trigger to fire.
  10327. </summary>
  10328. </member>
  10329. <member name="M:log4net.Core.ExceptionEvaluator.#ctor">
  10330. <summary>
  10331. Default ctor to allow dynamic creation through a configurator.
  10332. </summary>
  10333. </member>
  10334. <member name="M:log4net.Core.ExceptionEvaluator.#ctor(System.Type,System.Boolean)">
  10335. <summary>
  10336. Constructs an evaluator and initializes to trigger on <paramref name="exType"/>
  10337. </summary>
  10338. <param name="exType">the type that triggers this evaluator.</param>
  10339. <param name="triggerOnSubClass">If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.</param>
  10340. </member>
  10341. <member name="P:log4net.Core.ExceptionEvaluator.ExceptionType">
  10342. <summary>
  10343. The type that triggers this evaluator.
  10344. </summary>
  10345. </member>
  10346. <member name="P:log4net.Core.ExceptionEvaluator.TriggerOnSubclass">
  10347. <summary>
  10348. If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10349. </summary>
  10350. </member>
  10351. <member name="M:log4net.Core.ExceptionEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10352. <summary>
  10353. Is this <paramref name="loggingEvent"/> the triggering event?
  10354. </summary>
  10355. <param name="loggingEvent">The event to check</param>
  10356. <returns>This method returns <c>true</c>, if the logging event Exception
  10357. Type is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10358. Otherwise it returns <c>false</c></returns>
  10359. <remarks>
  10360. <para>
  10361. This evaluator will trigger if the Exception Type of the event
  10362. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  10363. is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10364. </para>
  10365. </remarks>
  10366. </member>
  10367. <member name="T:log4net.Core.IAppenderAttachable">
  10368. <summary>
  10369. Interface for attaching appenders to objects.
  10370. </summary>
  10371. <remarks>
  10372. <para>
  10373. Interface for attaching, removing and retrieving appenders.
  10374. </para>
  10375. </remarks>
  10376. <author>Nicko Cadell</author>
  10377. <author>Gert Driesen</author>
  10378. </member>
  10379. <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)">
  10380. <summary>
  10381. Attaches an appender.
  10382. </summary>
  10383. <param name="appender">The appender to add.</param>
  10384. <remarks>
  10385. <para>
  10386. Add the specified appender. The implementation may
  10387. choose to allow or deny duplicate appenders.
  10388. </para>
  10389. </remarks>
  10390. </member>
  10391. <member name="P:log4net.Core.IAppenderAttachable.Appenders">
  10392. <summary>
  10393. Gets all attached appenders.
  10394. </summary>
  10395. <value>
  10396. A collection of attached appenders.
  10397. </value>
  10398. <remarks>
  10399. <para>
  10400. Gets a collection of attached appenders.
  10401. If there are no attached appenders the
  10402. implementation should return an empty
  10403. collection rather than <c>null</c>.
  10404. </para>
  10405. </remarks>
  10406. </member>
  10407. <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)">
  10408. <summary>
  10409. Gets an attached appender with the specified name.
  10410. </summary>
  10411. <param name="name">The name of the appender to get.</param>
  10412. <returns>
  10413. The appender with the name specified, or <c>null</c> if no appender with the
  10414. specified name is found.
  10415. </returns>
  10416. <remarks>
  10417. <para>
  10418. Returns an attached appender with the <paramref name="name"/> specified.
  10419. If no appender with the specified name is found <c>null</c> will be
  10420. returned.
  10421. </para>
  10422. </remarks>
  10423. </member>
  10424. <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders">
  10425. <summary>
  10426. Removes all attached appenders.
  10427. </summary>
  10428. <remarks>
  10429. <para>
  10430. Removes and closes all attached appenders
  10431. </para>
  10432. </remarks>
  10433. </member>
  10434. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)">
  10435. <summary>
  10436. Removes the specified appender from the list of attached appenders.
  10437. </summary>
  10438. <param name="appender">The appender to remove.</param>
  10439. <returns>The appender removed from the list</returns>
  10440. <remarks>
  10441. <para>
  10442. The appender removed is not closed.
  10443. If you are discarding the appender you must call
  10444. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  10445. </para>
  10446. </remarks>
  10447. </member>
  10448. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)">
  10449. <summary>
  10450. Removes the appender with the specified name from the list of appenders.
  10451. </summary>
  10452. <param name="name">The name of the appender to remove.</param>
  10453. <returns>The appender removed from the list</returns>
  10454. <remarks>
  10455. <para>
  10456. The appender removed is not closed.
  10457. If you are discarding the appender you must call
  10458. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  10459. </para>
  10460. </remarks>
  10461. </member>
  10462. <member name="T:log4net.Core.IErrorHandler">
  10463. <summary>
  10464. Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler" />.
  10465. </summary>
  10466. <remarks>
  10467. <para>
  10468. Error handling is a particularly tedious to get right because by
  10469. definition errors are hard to predict and to reproduce.
  10470. </para>
  10471. </remarks>
  10472. <author>Nicko Cadell</author>
  10473. <author>Gert Driesen</author>
  10474. </member>
  10475. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  10476. <summary>
  10477. Handles the error and information about the error condition is passed as
  10478. a parameter.
  10479. </summary>
  10480. <param name="message">The message associated with the error.</param>
  10481. <param name="e">The <see cref="T:System.Exception" /> that was thrown when the error occurred.</param>
  10482. <param name="errorCode">The error code associated with the error.</param>
  10483. <remarks>
  10484. <para>
  10485. Handles the error and information about the error condition is passed as
  10486. a parameter.
  10487. </para>
  10488. </remarks>
  10489. </member>
  10490. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)">
  10491. <summary>
  10492. Prints the error message passed as a parameter.
  10493. </summary>
  10494. <param name="message">The message associated with the error.</param>
  10495. <param name="e">The <see cref="T:System.Exception" /> that was thrown when the error occurred.</param>
  10496. <remarks>
  10497. <para>
  10498. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  10499. </para>
  10500. </remarks>
  10501. </member>
  10502. <member name="M:log4net.Core.IErrorHandler.Error(System.String)">
  10503. <summary>
  10504. Prints the error message passed as a parameter.
  10505. </summary>
  10506. <param name="message">The message associated with the error.</param>
  10507. <remarks>
  10508. <para>
  10509. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  10510. </para>
  10511. </remarks>
  10512. </member>
  10513. <member name="T:log4net.Core.IFixingRequired">
  10514. <summary>
  10515. Interface for objects that require fixing.
  10516. </summary>
  10517. <remarks>
  10518. <para>
  10519. Interface that indicates that the object requires fixing before it
  10520. can be taken outside the context of the appender's
  10521. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  10522. </para>
  10523. <para>
  10524. When objects that implement this interface are stored
  10525. in the context properties maps <see cref="T:log4net.GlobalContext"/>
  10526. <see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/>
  10527. <see cref="P:log4net.ThreadContext.Properties"/> are fixed
  10528. (see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/>
  10529. method will be called.
  10530. </para>
  10531. </remarks>
  10532. <author>Nicko Cadell</author>
  10533. </member>
  10534. <member name="M:log4net.Core.IFixingRequired.GetFixedObject">
  10535. <summary>
  10536. Get a portable version of this object
  10537. </summary>
  10538. <returns>the portable instance of this object</returns>
  10539. <remarks>
  10540. <para>
  10541. Get a portable instance object that represents the current
  10542. state of this object. The portable object can be stored
  10543. and logged from any thread with identical results.
  10544. </para>
  10545. </remarks>
  10546. </member>
  10547. <member name="T:log4net.Core.ILogger">
  10548. <summary>
  10549. Interface that all loggers implement
  10550. </summary>
  10551. <remarks>
  10552. <para>
  10553. This interface supports logging events and testing if a level
  10554. is enabled for logging.
  10555. </para>
  10556. <para>
  10557. These methods will not throw exceptions. Note to implementor, ensure
  10558. that the implementation of these methods cannot allow an exception
  10559. to be thrown to the caller.
  10560. </para>
  10561. </remarks>
  10562. <author>Nicko Cadell</author>
  10563. <author>Gert Driesen</author>
  10564. </member>
  10565. <member name="P:log4net.Core.ILogger.Name">
  10566. <summary>
  10567. Gets the name of the logger.
  10568. </summary>
  10569. <value>
  10570. The name of the logger.
  10571. </value>
  10572. <remarks>
  10573. <para>
  10574. The name of this logger
  10575. </para>
  10576. </remarks>
  10577. </member>
  10578. <member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  10579. <summary>
  10580. This generic form is intended to be used by wrappers.
  10581. </summary>
  10582. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  10583. the stack boundary into the logging system for this call.</param>
  10584. <param name="level">The level of the message to be logged.</param>
  10585. <param name="message">The message object to log.</param>
  10586. <param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param>
  10587. <remarks>
  10588. <para>
  10589. Generates a logging event for the specified <paramref name="level"/> using
  10590. the <paramref name="message"/> and <paramref name="exception"/>.
  10591. </para>
  10592. </remarks>
  10593. </member>
  10594. <member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)">
  10595. <summary>
  10596. This is the most generic printing method that is intended to be used
  10597. by wrappers.
  10598. </summary>
  10599. <param name="logEvent">The event being logged.</param>
  10600. <remarks>
  10601. <para>
  10602. Logs the specified logging event through this logger.
  10603. </para>
  10604. </remarks>
  10605. </member>
  10606. <member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)">
  10607. <summary>
  10608. Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter.
  10609. </summary>
  10610. <param name="level">The level to check.</param>
  10611. <returns>
  10612. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  10613. </returns>
  10614. <remarks>
  10615. <para>
  10616. Test if this logger is going to log events of the specified <paramref name="level"/>.
  10617. </para>
  10618. </remarks>
  10619. </member>
  10620. <member name="P:log4net.Core.ILogger.Repository">
  10621. <summary>
  10622. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  10623. <c>Logger</c> instance is attached to.
  10624. </summary>
  10625. <value>
  10626. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this logger belongs to.
  10627. </value>
  10628. <remarks>
  10629. <para>
  10630. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  10631. <c>Logger</c> instance is attached to.
  10632. </para>
  10633. </remarks>
  10634. </member>
  10635. <member name="T:log4net.Core.ILoggerWrapper">
  10636. <summary>
  10637. Base interface for all wrappers
  10638. </summary>
  10639. <remarks>
  10640. <para>
  10641. Base interface for all wrappers.
  10642. </para>
  10643. <para>
  10644. All wrappers must implement this interface.
  10645. </para>
  10646. </remarks>
  10647. <author>Nicko Cadell</author>
  10648. </member>
  10649. <member name="P:log4net.Core.ILoggerWrapper.Logger">
  10650. <summary>
  10651. Get the implementation behind this wrapper object.
  10652. </summary>
  10653. <value>
  10654. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object.
  10655. </value>
  10656. <remarks>
  10657. <para>
  10658. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this
  10659. object. The <c>Logger</c> object may not
  10660. be the same object as this object because of logger decorators.
  10661. This gets the actual underlying objects that is used to process
  10662. the log events.
  10663. </para>
  10664. </remarks>
  10665. </member>
  10666. <member name="T:log4net.Core.IOptionHandler">
  10667. <summary>
  10668. Interface used to delay activate a configured object.
  10669. </summary>
  10670. <remarks>
  10671. <para>
  10672. This allows an object to defer activation of its options until all
  10673. options have been set. This is required for components which have
  10674. related options that remain ambiguous until all are set.
  10675. </para>
  10676. <para>
  10677. If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method
  10678. must be called by the container after its all the configured properties have been set
  10679. and before the component can be used.
  10680. </para>
  10681. </remarks>
  10682. <author>Nicko Cadell</author>
  10683. </member>
  10684. <member name="M:log4net.Core.IOptionHandler.ActivateOptions">
  10685. <summary>
  10686. Activate the options that were previously set with calls to properties.
  10687. </summary>
  10688. <remarks>
  10689. <para>
  10690. This allows an object to defer activation of its options until all
  10691. options have been set. This is required for components which have
  10692. related options that remain ambiguous until all are set.
  10693. </para>
  10694. <para>
  10695. If a component implements this interface then this method must be called
  10696. after its properties have been set before the component can be used.
  10697. </para>
  10698. </remarks>
  10699. </member>
  10700. <member name="T:log4net.Core.LoggerRepositoryCreationEventHandler">
  10701. <summary>
  10702. Delegate used to handle logger repository creation event notifications
  10703. </summary>
  10704. <param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param>
  10705. <param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args
  10706. that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param>
  10707. <remarks>
  10708. <para>
  10709. Delegate used to handle logger repository creation event notifications.
  10710. </para>
  10711. </remarks>
  10712. </member>
  10713. <member name="T:log4net.Core.LoggerRepositoryCreationEventArgs">
  10714. <summary>
  10715. Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  10716. </summary>
  10717. <remarks>
  10718. <para>
  10719. A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/>
  10720. event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created.
  10721. </para>
  10722. </remarks>
  10723. </member>
  10724. <member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository">
  10725. <summary>
  10726. The <see cref="T:log4net.Repository.ILoggerRepository"/> created
  10727. </summary>
  10728. </member>
  10729. <member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)">
  10730. <summary>
  10731. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  10732. </summary>
  10733. <param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param>
  10734. <remarks>
  10735. <para>
  10736. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  10737. </para>
  10738. </remarks>
  10739. </member>
  10740. <member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository">
  10741. <summary>
  10742. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10743. </summary>
  10744. <value>
  10745. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10746. </value>
  10747. <remarks>
  10748. <para>
  10749. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10750. </para>
  10751. </remarks>
  10752. </member>
  10753. <member name="T:log4net.Core.IRepositorySelector">
  10754. <summary>
  10755. Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10756. </summary>
  10757. <remarks>
  10758. <para>
  10759. The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/>
  10760. to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/>
  10761. to return to the caller.
  10762. </para>
  10763. </remarks>
  10764. <author>Nicko Cadell</author>
  10765. <author>Gert Driesen</author>
  10766. </member>
  10767. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10768. <summary>
  10769. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10770. </summary>
  10771. <param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10772. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns>
  10773. <remarks>
  10774. <para>
  10775. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10776. </para>
  10777. <para>
  10778. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  10779. is made is not defined. The implementation may choose any method for
  10780. this association. The results of this method must be repeatable, i.e.
  10781. when called again with the same arguments the result must be the
  10782. save value.
  10783. </para>
  10784. </remarks>
  10785. </member>
  10786. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)">
  10787. <summary>
  10788. Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10789. </summary>
  10790. <param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10791. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  10792. <remarks>
  10793. Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by
  10794. calling <see cref="M:CreateRepository(string,Type)"/>.
  10795. </remarks>
  10796. </member>
  10797. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10798. <summary>
  10799. Creates a new repository for the assembly specified.
  10800. </summary>
  10801. <param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10802. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10803. <returns>The repository created.</returns>
  10804. <remarks>
  10805. <para>
  10806. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain
  10807. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10808. same assembly specified will return the same repository instance.
  10809. </para>
  10810. <para>
  10811. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  10812. is made is not defined. The implementation may choose any method for
  10813. this association.
  10814. </para>
  10815. </remarks>
  10816. </member>
  10817. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)">
  10818. <summary>
  10819. Creates a new repository with the name specified.
  10820. </summary>
  10821. <param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10822. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10823. <returns>The repository created.</returns>
  10824. <remarks>
  10825. <para>
  10826. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name
  10827. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10828. same name will return the same repository instance.
  10829. </para>
  10830. </remarks>
  10831. </member>
  10832. <member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)">
  10833. <summary>
  10834. Test if a named repository exists
  10835. </summary>
  10836. <param name="repositoryName">the named repository to check</param>
  10837. <returns><c>true</c> if the repository exists</returns>
  10838. <remarks>
  10839. <para>
  10840. Test if a named repository exists. Use <see cref="M:CreateRepository(Assembly, Type)"/>
  10841. to create a new repository and <see cref="M:GetRepository(Assembly)"/> to retrieve
  10842. a repository.
  10843. </para>
  10844. </remarks>
  10845. </member>
  10846. <member name="M:log4net.Core.IRepositorySelector.GetAllRepositories">
  10847. <summary>
  10848. Gets an array of all currently defined repositories.
  10849. </summary>
  10850. <returns>
  10851. An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by
  10852. this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns>
  10853. <remarks>
  10854. <para>
  10855. Gets an array of all of the repositories created by this selector.
  10856. </para>
  10857. </remarks>
  10858. </member>
  10859. <member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent">
  10860. <summary>
  10861. Event to notify that a logger repository has been created.
  10862. </summary>
  10863. <value>
  10864. Event to notify that a logger repository has been created.
  10865. </value>
  10866. <remarks>
  10867. <para>
  10868. Event raised when a new repository is created.
  10869. The event source will be this selector. The event args will
  10870. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  10871. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10872. </para>
  10873. </remarks>
  10874. </member>
  10875. <member name="T:log4net.Core.ITriggeringEventEvaluator">
  10876. <summary>
  10877. Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action
  10878. </summary>
  10879. <remarks>
  10880. <para>
  10881. Implementations of this interface allow certain appenders to decide
  10882. when to perform an appender specific action.
  10883. </para>
  10884. <para>
  10885. The action or behavior triggered is defined by the implementation.
  10886. </para>
  10887. </remarks>
  10888. <author>Nicko Cadell</author>
  10889. </member>
  10890. <member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10891. <summary>
  10892. Test if this event triggers the action
  10893. </summary>
  10894. <param name="loggingEvent">The event to check</param>
  10895. <returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns>
  10896. <remarks>
  10897. <para>
  10898. Return <c>true</c> if this event triggers the action
  10899. </para>
  10900. </remarks>
  10901. </member>
  10902. <member name="T:log4net.Core.Level">
  10903. <summary>
  10904. Defines the default set of levels recognized by the system.
  10905. </summary>
  10906. <remarks>
  10907. <para>
  10908. Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>.
  10909. </para>
  10910. <para>
  10911. Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative
  10912. ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/>
  10913. are deemed to be equivalent.
  10914. </para>
  10915. <para>
  10916. The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/>
  10917. and each repository can have different levels defined. The levels are stored
  10918. in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are
  10919. looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>.
  10920. </para>
  10921. <para>
  10922. When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but
  10923. the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is
  10924. <see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map.
  10925. </para>
  10926. <para>
  10927. Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The
  10928. <see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default
  10929. the display name is the same as the level name, but this can be used to alias levels
  10930. or to localize the log output.
  10931. </para>
  10932. <para>
  10933. Some of the predefined levels recognized by the system are:
  10934. </para>
  10935. <list type="bullet">
  10936. <item>
  10937. <description><see cref="F:log4net.Core.Level.Off"/>.</description>
  10938. </item>
  10939. <item>
  10940. <description><see cref="F:log4net.Core.Level.Fatal"/>.</description>
  10941. </item>
  10942. <item>
  10943. <description><see cref="F:log4net.Core.Level.Error"/>.</description>
  10944. </item>
  10945. <item>
  10946. <description><see cref="F:log4net.Core.Level.Warn"/>.</description>
  10947. </item>
  10948. <item>
  10949. <description><see cref="F:log4net.Core.Level.Info"/>.</description>
  10950. </item>
  10951. <item>
  10952. <description><see cref="F:log4net.Core.Level.Debug"/>.</description>
  10953. </item>
  10954. <item>
  10955. <description><see cref="F:log4net.Core.Level.All"/>.</description>
  10956. </item>
  10957. </list>
  10958. </remarks>
  10959. <author>Nicko Cadell</author>
  10960. <author>Gert Driesen</author>
  10961. </member>
  10962. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)">
  10963. <summary>
  10964. Constructor
  10965. </summary>
  10966. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  10967. <param name="levelName">The string name of this level.</param>
  10968. <param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param>
  10969. <remarks>
  10970. <para>
  10971. Initializes a new instance of the <see cref="T:log4net.Core.Level" /> class with
  10972. the specified level name and value.
  10973. </para>
  10974. </remarks>
  10975. </member>
  10976. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)">
  10977. <summary>
  10978. Constructor
  10979. </summary>
  10980. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  10981. <param name="levelName">The string name of this level.</param>
  10982. <remarks>
  10983. <para>
  10984. Initializes a new instance of the <see cref="T:log4net.Core.Level" /> class with
  10985. the specified level name and value.
  10986. </para>
  10987. </remarks>
  10988. </member>
  10989. <member name="P:log4net.Core.Level.Name">
  10990. <summary>
  10991. Gets the name of this level.
  10992. </summary>
  10993. <value>
  10994. The name of this level.
  10995. </value>
  10996. <remarks>
  10997. <para>
  10998. Gets the name of this level.
  10999. </para>
  11000. </remarks>
  11001. </member>
  11002. <member name="P:log4net.Core.Level.Value">
  11003. <summary>
  11004. Gets the value of this level.
  11005. </summary>
  11006. <value>
  11007. The value of this level.
  11008. </value>
  11009. <remarks>
  11010. <para>
  11011. Gets the value of this level.
  11012. </para>
  11013. </remarks>
  11014. </member>
  11015. <member name="P:log4net.Core.Level.DisplayName">
  11016. <summary>
  11017. Gets the display name of this level.
  11018. </summary>
  11019. <value>
  11020. The display name of this level.
  11021. </value>
  11022. <remarks>
  11023. <para>
  11024. Gets the display name of this level.
  11025. </para>
  11026. </remarks>
  11027. </member>
  11028. <member name="M:log4net.Core.Level.ToString">
  11029. <summary>
  11030. Returns the <see cref="T:System.String" /> representation of the current
  11031. <see cref="T:log4net.Core.Level" />.
  11032. </summary>
  11033. <returns>
  11034. A <see cref="T:System.String" /> representation of the current <see cref="T:log4net.Core.Level" />.
  11035. </returns>
  11036. <remarks>
  11037. <para>
  11038. Returns the level <see cref="P:log4net.Core.Level.Name"/>.
  11039. </para>
  11040. </remarks>
  11041. </member>
  11042. <member name="M:log4net.Core.Level.Equals(System.Object)">
  11043. <summary>
  11044. Compares levels.
  11045. </summary>
  11046. <param name="o">The object to compare against.</param>
  11047. <returns><c>true</c> if the objects are equal.</returns>
  11048. <remarks>
  11049. <para>
  11050. Compares the levels of <see cref="T:log4net.Core.Level" /> instances, and
  11051. defers to base class if the target object is not a <see cref="T:log4net.Core.Level" />
  11052. instance.
  11053. </para>
  11054. </remarks>
  11055. </member>
  11056. <member name="M:log4net.Core.Level.GetHashCode">
  11057. <summary>
  11058. Returns a hash code
  11059. </summary>
  11060. <returns>A hash code for the current <see cref="T:log4net.Core.Level" />.</returns>
  11061. <remarks>
  11062. <para>
  11063. Returns a hash code suitable for use in hashing algorithms and data
  11064. structures like a hash table.
  11065. </para>
  11066. <para>
  11067. Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>.
  11068. </para>
  11069. </remarks>
  11070. </member>
  11071. <member name="M:log4net.Core.Level.CompareTo(System.Object)">
  11072. <summary>
  11073. Compares this instance to a specified object and returns an
  11074. indication of their relative values.
  11075. </summary>
  11076. <param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null" /> to compare with this instance.</param>
  11077. <returns>
  11078. A 32-bit signed integer that indicates the relative order of the
  11079. values compared. The return value has these meanings:
  11080. <list type="table">
  11081. <listheader>
  11082. <term>Value</term>
  11083. <description>Meaning</description>
  11084. </listheader>
  11085. <item>
  11086. <term>Less than zero</term>
  11087. <description>This instance is less than <paramref name="r" />.</description>
  11088. </item>
  11089. <item>
  11090. <term>Zero</term>
  11091. <description>This instance is equal to <paramref name="r" />.</description>
  11092. </item>
  11093. <item>
  11094. <term>Greater than zero</term>
  11095. <description>
  11096. <para>This instance is greater than <paramref name="r" />.</para>
  11097. <para>-or-</para>
  11098. <para><paramref name="r" /> is <see langword="null" />.</para>
  11099. </description>
  11100. </item>
  11101. </list>
  11102. </returns>
  11103. <remarks>
  11104. <para>
  11105. <paramref name="r" /> must be an instance of <see cref="T:log4net.Core.Level" />
  11106. or <see langword="null" />; otherwise, an exception is thrown.
  11107. </para>
  11108. </remarks>
  11109. <exception cref="T:System.ArgumentException"><paramref name="r" /> is not a <see cref="T:log4net.Core.Level" />.</exception>
  11110. </member>
  11111. <member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)">
  11112. <summary>
  11113. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  11114. is greater than another specified <see cref="T:log4net.Core.Level" />.
  11115. </summary>
  11116. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  11117. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  11118. <returns>
  11119. <c>true</c> if <paramref name="l" /> is greater than
  11120. <paramref name="r" />; otherwise, <c>false</c>.
  11121. </returns>
  11122. <remarks>
  11123. <para>
  11124. Compares two levels.
  11125. </para>
  11126. </remarks>
  11127. </member>
  11128. <member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)">
  11129. <summary>
  11130. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  11131. is less than another specified <see cref="T:log4net.Core.Level" />.
  11132. </summary>
  11133. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  11134. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  11135. <returns>
  11136. <c>true</c> if <paramref name="l" /> is less than
  11137. <paramref name="r" />; otherwise, <c>false</c>.
  11138. </returns>
  11139. <remarks>
  11140. <para>
  11141. Compares two levels.
  11142. </para>
  11143. </remarks>
  11144. </member>
  11145. <member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  11146. <summary>
  11147. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  11148. is greater than or equal to another specified <see cref="T:log4net.Core.Level" />.
  11149. </summary>
  11150. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  11151. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  11152. <returns>
  11153. <c>true</c> if <paramref name="l" /> is greater than or equal to
  11154. <paramref name="r" />; otherwise, <c>false</c>.
  11155. </returns>
  11156. <remarks>
  11157. <para>
  11158. Compares two levels.
  11159. </para>
  11160. </remarks>
  11161. </member>
  11162. <member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  11163. <summary>
  11164. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  11165. is less than or equal to another specified <see cref="T:log4net.Core.Level" />.
  11166. </summary>
  11167. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  11168. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  11169. <returns>
  11170. <c>true</c> if <paramref name="l" /> is less than or equal to
  11171. <paramref name="r" />; otherwise, <c>false</c>.
  11172. </returns>
  11173. <remarks>
  11174. <para>
  11175. Compares two levels.
  11176. </para>
  11177. </remarks>
  11178. </member>
  11179. <member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)">
  11180. <summary>
  11181. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level" />
  11182. objects have the same value.
  11183. </summary>
  11184. <param name="l">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  11185. <param name="r">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  11186. <returns>
  11187. <c>true</c> if the value of <paramref name="l" /> is the same as the
  11188. value of <paramref name="r" />; otherwise, <c>false</c>.
  11189. </returns>
  11190. <remarks>
  11191. <para>
  11192. Compares two levels.
  11193. </para>
  11194. </remarks>
  11195. </member>
  11196. <member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)">
  11197. <summary>
  11198. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level" />
  11199. objects have different values.
  11200. </summary>
  11201. <param name="l">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  11202. <param name="r">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  11203. <returns>
  11204. <c>true</c> if the value of <paramref name="l" /> is different from
  11205. the value of <paramref name="r" />; otherwise, <c>false</c>.
  11206. </returns>
  11207. <remarks>
  11208. <para>
  11209. Compares two levels.
  11210. </para>
  11211. </remarks>
  11212. </member>
  11213. <member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)">
  11214. <summary>
  11215. Compares two specified <see cref="T:log4net.Core.Level"/> instances.
  11216. </summary>
  11217. <param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param>
  11218. <param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param>
  11219. <returns>
  11220. A 32-bit signed integer that indicates the relative order of the
  11221. two values compared. The return value has these meanings:
  11222. <list type="table">
  11223. <listheader>
  11224. <term>Value</term>
  11225. <description>Meaning</description>
  11226. </listheader>
  11227. <item>
  11228. <term>Less than zero</term>
  11229. <description><paramref name="l" /> is less than <paramref name="r" />.</description>
  11230. </item>
  11231. <item>
  11232. <term>Zero</term>
  11233. <description><paramref name="l" /> is equal to <paramref name="r" />.</description>
  11234. </item>
  11235. <item>
  11236. <term>Greater than zero</term>
  11237. <description><paramref name="l" /> is greater than <paramref name="r" />.</description>
  11238. </item>
  11239. </list>
  11240. </returns>
  11241. <remarks>
  11242. <para>
  11243. Compares two levels.
  11244. </para>
  11245. </remarks>
  11246. </member>
  11247. <member name="F:log4net.Core.Level.Off">
  11248. <summary>
  11249. The <see cref="F:log4net.Core.Level.Off" /> level designates a higher level than all the rest.
  11250. </summary>
  11251. </member>
  11252. <member name="F:log4net.Core.Level.Log4Net_Debug">
  11253. <summary>
  11254. The <see cref="F:log4net.Core.Level.Emergency" /> level designates very severe error events.
  11255. System unusable, emergencies.
  11256. </summary>
  11257. </member>
  11258. <member name="F:log4net.Core.Level.Emergency">
  11259. <summary>
  11260. The <see cref="F:log4net.Core.Level.Emergency" /> level designates very severe error events.
  11261. System unusable, emergencies.
  11262. </summary>
  11263. </member>
  11264. <member name="F:log4net.Core.Level.Fatal">
  11265. <summary>
  11266. The <see cref="F:log4net.Core.Level.Fatal" /> level designates very severe error events
  11267. that will presumably lead the application to abort.
  11268. </summary>
  11269. </member>
  11270. <member name="F:log4net.Core.Level.Alert">
  11271. <summary>
  11272. The <see cref="F:log4net.Core.Level.Alert" /> level designates very severe error events.
  11273. Take immediate action, alerts.
  11274. </summary>
  11275. </member>
  11276. <member name="F:log4net.Core.Level.Critical">
  11277. <summary>
  11278. The <see cref="F:log4net.Core.Level.Critical" /> level designates very severe error events.
  11279. Critical condition, critical.
  11280. </summary>
  11281. </member>
  11282. <member name="F:log4net.Core.Level.Severe">
  11283. <summary>
  11284. The <see cref="F:log4net.Core.Level.Severe" /> level designates very severe error events.
  11285. </summary>
  11286. </member>
  11287. <member name="F:log4net.Core.Level.Error">
  11288. <summary>
  11289. The <see cref="F:log4net.Core.Level.Error" /> level designates error events that might
  11290. still allow the application to continue running.
  11291. </summary>
  11292. </member>
  11293. <member name="F:log4net.Core.Level.Warn">
  11294. <summary>
  11295. The <see cref="F:log4net.Core.Level.Warn" /> level designates potentially harmful
  11296. situations.
  11297. </summary>
  11298. </member>
  11299. <member name="F:log4net.Core.Level.Notice">
  11300. <summary>
  11301. The <see cref="F:log4net.Core.Level.Notice" /> level designates informational messages
  11302. that highlight the progress of the application at the highest level.
  11303. </summary>
  11304. </member>
  11305. <member name="F:log4net.Core.Level.Info">
  11306. <summary>
  11307. The <see cref="F:log4net.Core.Level.Info" /> level designates informational messages that
  11308. highlight the progress of the application at coarse-grained level.
  11309. </summary>
  11310. </member>
  11311. <member name="F:log4net.Core.Level.Debug">
  11312. <summary>
  11313. The <see cref="F:log4net.Core.Level.Debug" /> level designates fine-grained informational
  11314. events that are most useful to debug an application.
  11315. </summary>
  11316. </member>
  11317. <member name="F:log4net.Core.Level.Fine">
  11318. <summary>
  11319. The <see cref="F:log4net.Core.Level.Fine" /> level designates fine-grained informational
  11320. events that are most useful to debug an application.
  11321. </summary>
  11322. </member>
  11323. <member name="F:log4net.Core.Level.Trace">
  11324. <summary>
  11325. The <see cref="F:log4net.Core.Level.Trace" /> level designates fine-grained informational
  11326. events that are most useful to debug an application.
  11327. </summary>
  11328. </member>
  11329. <member name="F:log4net.Core.Level.Finer">
  11330. <summary>
  11331. The <see cref="F:log4net.Core.Level.Finer" /> level designates fine-grained informational
  11332. events that are most useful to debug an application.
  11333. </summary>
  11334. </member>
  11335. <member name="F:log4net.Core.Level.Verbose">
  11336. <summary>
  11337. The <see cref="F:log4net.Core.Level.Verbose" /> level designates fine-grained informational
  11338. events that are most useful to debug an application.
  11339. </summary>
  11340. </member>
  11341. <member name="F:log4net.Core.Level.Finest">
  11342. <summary>
  11343. The <see cref="F:log4net.Core.Level.Finest" /> level designates fine-grained informational
  11344. events that are most useful to debug an application.
  11345. </summary>
  11346. </member>
  11347. <member name="F:log4net.Core.Level.All">
  11348. <summary>
  11349. The <see cref="F:log4net.Core.Level.All" /> level designates the lowest level possible.
  11350. </summary>
  11351. </member>
  11352. <member name="T:log4net.Core.LevelCollection">
  11353. <summary>
  11354. A strongly-typed collection of <see cref="T:log4net.Core.Level"/> objects.
  11355. </summary>
  11356. <author>Nicko Cadell</author>
  11357. </member>
  11358. <member name="T:log4net.Core.LevelCollection.ILevelCollectionEnumerator">
  11359. <summary>
  11360. Supports type-safe iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  11361. </summary>
  11362. </member>
  11363. <member name="P:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Current">
  11364. <summary>
  11365. Gets the current element in the collection.
  11366. </summary>
  11367. </member>
  11368. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.MoveNext">
  11369. <summary>
  11370. Advances the enumerator to the next element in the collection.
  11371. </summary>
  11372. <returns>
  11373. <c>true</c> if the enumerator was successfully advanced to the next element;
  11374. <c>false</c> if the enumerator has passed the end of the collection.
  11375. </returns>
  11376. <exception cref="T:System.InvalidOperationException">
  11377. The collection was modified after the enumerator was created.
  11378. </exception>
  11379. </member>
  11380. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Reset">
  11381. <summary>
  11382. Sets the enumerator to its initial position, before the first element in the collection.
  11383. </summary>
  11384. </member>
  11385. <member name="M:log4net.Core.LevelCollection.ReadOnly(log4net.Core.LevelCollection)">
  11386. <summary>
  11387. Creates a read-only wrapper for a <c>LevelCollection</c> instance.
  11388. </summary>
  11389. <param name="list">list to create a readonly wrapper arround</param>
  11390. <returns>
  11391. A <c>LevelCollection</c> wrapper that is read-only.
  11392. </returns>
  11393. </member>
  11394. <member name="M:log4net.Core.LevelCollection.#ctor">
  11395. <summary>
  11396. Initializes a new instance of the <c>LevelCollection</c> class
  11397. that is empty and has the default initial capacity.
  11398. </summary>
  11399. </member>
  11400. <member name="M:log4net.Core.LevelCollection.#ctor(System.Int32)">
  11401. <summary>
  11402. Initializes a new instance of the <c>LevelCollection</c> class
  11403. that has the specified initial capacity.
  11404. </summary>
  11405. <param name="capacity">
  11406. The number of elements that the new <c>LevelCollection</c> is initially capable of storing.
  11407. </param>
  11408. </member>
  11409. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection)">
  11410. <summary>
  11411. Initializes a new instance of the <c>LevelCollection</c> class
  11412. that contains elements copied from the specified <c>LevelCollection</c>.
  11413. </summary>
  11414. <param name="c">The <c>LevelCollection</c> whose elements are copied to the new collection.</param>
  11415. </member>
  11416. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.Level[])">
  11417. <summary>
  11418. Initializes a new instance of the <c>LevelCollection</c> class
  11419. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> array.
  11420. </summary>
  11421. <param name="a">The <see cref="T:log4net.Core.Level"/> array whose elements are copied to the new list.</param>
  11422. </member>
  11423. <member name="M:log4net.Core.LevelCollection.#ctor(System.Collections.ICollection)">
  11424. <summary>
  11425. Initializes a new instance of the <c>LevelCollection</c> class
  11426. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> collection.
  11427. </summary>
  11428. <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements are copied to the new list.</param>
  11429. </member>
  11430. <member name="T:log4net.Core.LevelCollection.Tag">
  11431. <summary>
  11432. Type visible only to our subclasses
  11433. Used to access protected constructor
  11434. </summary>
  11435. </member>
  11436. <member name="F:log4net.Core.LevelCollection.Tag.Default">
  11437. <summary>
  11438. A value
  11439. </summary>
  11440. </member>
  11441. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection.Tag)">
  11442. <summary>
  11443. Allow subclasses to avoid our default constructors
  11444. </summary>
  11445. <param name="tag"></param>
  11446. </member>
  11447. <member name="P:log4net.Core.LevelCollection.Count">
  11448. <summary>
  11449. Gets the number of elements actually contained in the <c>LevelCollection</c>.
  11450. </summary>
  11451. </member>
  11452. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[])">
  11453. <summary>
  11454. Copies the entire <c>LevelCollection</c> to a one-dimensional
  11455. <see cref="T:log4net.Core.Level"/> array.
  11456. </summary>
  11457. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  11458. </member>
  11459. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[],System.Int32)">
  11460. <summary>
  11461. Copies the entire <c>LevelCollection</c> to a one-dimensional
  11462. <see cref="T:log4net.Core.Level"/> array, starting at the specified index of the target array.
  11463. </summary>
  11464. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  11465. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  11466. </member>
  11467. <member name="P:log4net.Core.LevelCollection.IsSynchronized">
  11468. <summary>
  11469. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  11470. </summary>
  11471. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  11472. </member>
  11473. <member name="P:log4net.Core.LevelCollection.SyncRoot">
  11474. <summary>
  11475. Gets an object that can be used to synchronize access to the collection.
  11476. </summary>
  11477. </member>
  11478. <member name="P:log4net.Core.LevelCollection.Item(System.Int32)">
  11479. <summary>
  11480. Gets or sets the <see cref="T:log4net.Core.Level"/> at the specified index.
  11481. </summary>
  11482. <param name="index">The zero-based index of the element to get or set.</param>
  11483. <exception cref="T:System.ArgumentOutOfRangeException">
  11484. <para><paramref name="index"/> is less than zero</para>
  11485. <para>-or-</para>
  11486. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11487. </exception>
  11488. </member>
  11489. <member name="M:log4net.Core.LevelCollection.Add(log4net.Core.Level)">
  11490. <summary>
  11491. Adds a <see cref="T:log4net.Core.Level"/> to the end of the <c>LevelCollection</c>.
  11492. </summary>
  11493. <param name="item">The <see cref="T:log4net.Core.Level"/> to be added to the end of the <c>LevelCollection</c>.</param>
  11494. <returns>The index at which the value has been added.</returns>
  11495. </member>
  11496. <member name="M:log4net.Core.LevelCollection.Clear">
  11497. <summary>
  11498. Removes all elements from the <c>LevelCollection</c>.
  11499. </summary>
  11500. </member>
  11501. <member name="M:log4net.Core.LevelCollection.Clone">
  11502. <summary>
  11503. Creates a shallow copy of the <see cref="T:log4net.Core.LevelCollection"/>.
  11504. </summary>
  11505. <returns>A new <see cref="T:log4net.Core.LevelCollection"/> with a shallow copy of the collection data.</returns>
  11506. </member>
  11507. <member name="M:log4net.Core.LevelCollection.Contains(log4net.Core.Level)">
  11508. <summary>
  11509. Determines whether a given <see cref="T:log4net.Core.Level"/> is in the <c>LevelCollection</c>.
  11510. </summary>
  11511. <param name="item">The <see cref="T:log4net.Core.Level"/> to check for.</param>
  11512. <returns><c>true</c> if <paramref name="item"/> is found in the <c>LevelCollection</c>; otherwise, <c>false</c>.</returns>
  11513. </member>
  11514. <member name="M:log4net.Core.LevelCollection.IndexOf(log4net.Core.Level)">
  11515. <summary>
  11516. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Core.Level"/>
  11517. in the <c>LevelCollection</c>.
  11518. </summary>
  11519. <param name="item">The <see cref="T:log4net.Core.Level"/> to locate in the <c>LevelCollection</c>.</param>
  11520. <returns>
  11521. The zero-based index of the first occurrence of <paramref name="item"/>
  11522. in the entire <c>LevelCollection</c>, if found; otherwise, -1.
  11523. </returns>
  11524. </member>
  11525. <member name="M:log4net.Core.LevelCollection.Insert(System.Int32,log4net.Core.Level)">
  11526. <summary>
  11527. Inserts an element into the <c>LevelCollection</c> at the specified index.
  11528. </summary>
  11529. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  11530. <param name="item">The <see cref="T:log4net.Core.Level"/> to insert.</param>
  11531. <exception cref="T:System.ArgumentOutOfRangeException">
  11532. <para><paramref name="index"/> is less than zero</para>
  11533. <para>-or-</para>
  11534. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11535. </exception>
  11536. </member>
  11537. <member name="M:log4net.Core.LevelCollection.Remove(log4net.Core.Level)">
  11538. <summary>
  11539. Removes the first occurrence of a specific <see cref="T:log4net.Core.Level"/> from the <c>LevelCollection</c>.
  11540. </summary>
  11541. <param name="item">The <see cref="T:log4net.Core.Level"/> to remove from the <c>LevelCollection</c>.</param>
  11542. <exception cref="T:System.ArgumentException">
  11543. The specified <see cref="T:log4net.Core.Level"/> was not found in the <c>LevelCollection</c>.
  11544. </exception>
  11545. </member>
  11546. <member name="M:log4net.Core.LevelCollection.RemoveAt(System.Int32)">
  11547. <summary>
  11548. Removes the element at the specified index of the <c>LevelCollection</c>.
  11549. </summary>
  11550. <param name="index">The zero-based index of the element to remove.</param>
  11551. <exception cref="T:System.ArgumentOutOfRangeException">
  11552. <para><paramref name="index"/> is less than zero</para>
  11553. <para>-or-</para>
  11554. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11555. </exception>
  11556. </member>
  11557. <member name="P:log4net.Core.LevelCollection.IsFixedSize">
  11558. <summary>
  11559. Gets a value indicating whether the collection has a fixed size.
  11560. </summary>
  11561. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  11562. </member>
  11563. <member name="P:log4net.Core.LevelCollection.IsReadOnly">
  11564. <summary>
  11565. Gets a value indicating whether the IList is read-only.
  11566. </summary>
  11567. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  11568. </member>
  11569. <member name="M:log4net.Core.LevelCollection.GetEnumerator">
  11570. <summary>
  11571. Returns an enumerator that can iterate through the <c>LevelCollection</c>.
  11572. </summary>
  11573. <returns>An <see cref="T:log4net.Core.LevelCollection.Enumerator"/> for the entire <c>LevelCollection</c>.</returns>
  11574. </member>
  11575. <member name="P:log4net.Core.LevelCollection.Capacity">
  11576. <summary>
  11577. Gets or sets the number of elements the <c>LevelCollection</c> can contain.
  11578. </summary>
  11579. </member>
  11580. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.LevelCollection)">
  11581. <summary>
  11582. Adds the elements of another <c>LevelCollection</c> to the current <c>LevelCollection</c>.
  11583. </summary>
  11584. <param name="x">The <c>LevelCollection</c> whose elements should be added to the end of the current <c>LevelCollection</c>.</param>
  11585. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11586. </member>
  11587. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.Level[])">
  11588. <summary>
  11589. Adds the elements of a <see cref="T:log4net.Core.Level"/> array to the current <c>LevelCollection</c>.
  11590. </summary>
  11591. <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>
  11592. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11593. </member>
  11594. <member name="M:log4net.Core.LevelCollection.AddRange(System.Collections.ICollection)">
  11595. <summary>
  11596. Adds the elements of a <see cref="T:log4net.Core.Level"/> collection to the current <c>LevelCollection</c>.
  11597. </summary>
  11598. <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>
  11599. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11600. </member>
  11601. <member name="M:log4net.Core.LevelCollection.TrimToSize">
  11602. <summary>
  11603. Sets the capacity to the actual number of elements.
  11604. </summary>
  11605. </member>
  11606. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32)">
  11607. <exception cref="T:System.ArgumentOutOfRangeException">
  11608. <para><paramref name="i"/> is less than zero</para>
  11609. <para>-or-</para>
  11610. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11611. </exception>
  11612. </member>
  11613. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32,System.Boolean)">
  11614. <exception cref="T:System.ArgumentOutOfRangeException">
  11615. <para><paramref name="i"/> is less than zero</para>
  11616. <para>-or-</para>
  11617. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11618. </exception>
  11619. </member>
  11620. <member name="T:log4net.Core.LevelCollection.Enumerator">
  11621. <summary>
  11622. Supports simple iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  11623. </summary>
  11624. </member>
  11625. <member name="M:log4net.Core.LevelCollection.Enumerator.#ctor(log4net.Core.LevelCollection)">
  11626. <summary>
  11627. Initializes a new instance of the <c>Enumerator</c> class.
  11628. </summary>
  11629. <param name="tc"></param>
  11630. </member>
  11631. <member name="P:log4net.Core.LevelCollection.Enumerator.Current">
  11632. <summary>
  11633. Gets the current element in the collection.
  11634. </summary>
  11635. </member>
  11636. <member name="M:log4net.Core.LevelCollection.Enumerator.MoveNext">
  11637. <summary>
  11638. Advances the enumerator to the next element in the collection.
  11639. </summary>
  11640. <returns>
  11641. <c>true</c> if the enumerator was successfully advanced to the next element;
  11642. <c>false</c> if the enumerator has passed the end of the collection.
  11643. </returns>
  11644. <exception cref="T:System.InvalidOperationException">
  11645. The collection was modified after the enumerator was created.
  11646. </exception>
  11647. </member>
  11648. <member name="M:log4net.Core.LevelCollection.Enumerator.Reset">
  11649. <summary>
  11650. Sets the enumerator to its initial position, before the first element in the collection.
  11651. </summary>
  11652. </member>
  11653. <member name="T:log4net.Core.LevelEvaluator">
  11654. <summary>
  11655. An evaluator that triggers at a threshold level
  11656. </summary>
  11657. <remarks>
  11658. <para>
  11659. This evaluator will trigger if the level of the event
  11660. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11661. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11662. level.
  11663. </para>
  11664. </remarks>
  11665. <author>Nicko Cadell</author>
  11666. </member>
  11667. <member name="F:log4net.Core.LevelEvaluator.m_threshold">
  11668. <summary>
  11669. The threshold for triggering
  11670. </summary>
  11671. </member>
  11672. <member name="M:log4net.Core.LevelEvaluator.#ctor">
  11673. <summary>
  11674. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  11675. </summary>
  11676. <remarks>
  11677. <para>
  11678. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  11679. </para>
  11680. <para>
  11681. This evaluator will trigger if the level of the event
  11682. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11683. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11684. level.
  11685. </para>
  11686. </remarks>
  11687. </member>
  11688. <member name="M:log4net.Core.LevelEvaluator.#ctor(log4net.Core.Level)">
  11689. <summary>
  11690. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  11691. </summary>
  11692. <param name="threshold">the threshold to trigger at</param>
  11693. <remarks>
  11694. <para>
  11695. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  11696. </para>
  11697. <para>
  11698. This evaluator will trigger if the level of the event
  11699. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11700. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11701. level.
  11702. </para>
  11703. </remarks>
  11704. </member>
  11705. <member name="P:log4net.Core.LevelEvaluator.Threshold">
  11706. <summary>
  11707. the threshold to trigger at
  11708. </summary>
  11709. <value>
  11710. The <see cref="T:log4net.Core.Level"/> that will cause this evaluator to trigger
  11711. </value>
  11712. <remarks>
  11713. <para>
  11714. This evaluator will trigger if the level of the event
  11715. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11716. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11717. level.
  11718. </para>
  11719. </remarks>
  11720. </member>
  11721. <member name="M:log4net.Core.LevelEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  11722. <summary>
  11723. Is this <paramref name="loggingEvent"/> the triggering event?
  11724. </summary>
  11725. <param name="loggingEvent">The event to check</param>
  11726. <returns>This method returns <c>true</c>, if the event level
  11727. is equal or higher than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>.
  11728. Otherwise it returns <c>false</c></returns>
  11729. <remarks>
  11730. <para>
  11731. This evaluator will trigger if the level of the event
  11732. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11733. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11734. level.
  11735. </para>
  11736. </remarks>
  11737. </member>
  11738. <member name="T:log4net.Core.LevelMap">
  11739. <summary>
  11740. Mapping between string name and Level object
  11741. </summary>
  11742. <remarks>
  11743. <para>
  11744. Mapping between string name and <see cref="T:log4net.Core.Level"/> object.
  11745. This mapping is held separately for each <see cref="T:log4net.Repository.ILoggerRepository"/>.
  11746. The level name is case insensitive.
  11747. </para>
  11748. </remarks>
  11749. <author>Nicko Cadell</author>
  11750. </member>
  11751. <member name="F:log4net.Core.LevelMap.m_mapName2Level">
  11752. <summary>
  11753. Mapping from level name to Level object. The
  11754. level name is case insensitive
  11755. </summary>
  11756. </member>
  11757. <member name="M:log4net.Core.LevelMap.#ctor">
  11758. <summary>
  11759. Construct the level map
  11760. </summary>
  11761. <remarks>
  11762. <para>
  11763. Construct the level map.
  11764. </para>
  11765. </remarks>
  11766. </member>
  11767. <member name="M:log4net.Core.LevelMap.Clear">
  11768. <summary>
  11769. Clear the internal maps of all levels
  11770. </summary>
  11771. <remarks>
  11772. <para>
  11773. Clear the internal maps of all levels
  11774. </para>
  11775. </remarks>
  11776. </member>
  11777. <member name="P:log4net.Core.LevelMap.Item(System.String)">
  11778. <summary>
  11779. Lookup a <see cref="T:log4net.Core.Level"/> by name
  11780. </summary>
  11781. <param name="name">The name of the Level to lookup</param>
  11782. <returns>a Level from the map with the name specified</returns>
  11783. <remarks>
  11784. <para>
  11785. Returns the <see cref="T:log4net.Core.Level"/> from the
  11786. map with the name specified. If the no level is
  11787. found then <c>null</c> is returned.
  11788. </para>
  11789. </remarks>
  11790. </member>
  11791. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32)">
  11792. <summary>
  11793. Create a new Level and add it to the map
  11794. </summary>
  11795. <param name="name">the string to display for the Level</param>
  11796. <param name="value">the level value to give to the Level</param>
  11797. <remarks>
  11798. <para>
  11799. Create a new Level and add it to the map
  11800. </para>
  11801. </remarks>
  11802. <seealso cref="M:Add(string,int,string)"/>
  11803. </member>
  11804. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32,System.String)">
  11805. <summary>
  11806. Create a new Level and add it to the map
  11807. </summary>
  11808. <param name="name">the string to display for the Level</param>
  11809. <param name="value">the level value to give to the Level</param>
  11810. <param name="displayName">the display name to give to the Level</param>
  11811. <remarks>
  11812. <para>
  11813. Create a new Level and add it to the map
  11814. </para>
  11815. </remarks>
  11816. </member>
  11817. <member name="M:log4net.Core.LevelMap.Add(log4net.Core.Level)">
  11818. <summary>
  11819. Add a Level to the map
  11820. </summary>
  11821. <param name="level">the Level to add</param>
  11822. <remarks>
  11823. <para>
  11824. Add a Level to the map
  11825. </para>
  11826. </remarks>
  11827. </member>
  11828. <member name="P:log4net.Core.LevelMap.AllLevels">
  11829. <summary>
  11830. Return all possible levels as a list of Level objects.
  11831. </summary>
  11832. <returns>all possible levels as a list of Level objects</returns>
  11833. <remarks>
  11834. <para>
  11835. Return all possible levels as a list of Level objects.
  11836. </para>
  11837. </remarks>
  11838. </member>
  11839. <member name="M:log4net.Core.LevelMap.LookupWithDefault(log4net.Core.Level)">
  11840. <summary>
  11841. Lookup a named level from the map
  11842. </summary>
  11843. <param name="defaultLevel">the name of the level to lookup is taken from this level.
  11844. If the level is not set on the map then this level is added</param>
  11845. <returns>the level in the map with the name specified</returns>
  11846. <remarks>
  11847. <para>
  11848. Lookup a named level from the map. The name of the level to lookup is taken
  11849. from the <see cref="P:log4net.Core.Level.Name"/> property of the <paramref name="defaultLevel"/>
  11850. argument.
  11851. </para>
  11852. <para>
  11853. If no level with the specified name is found then the
  11854. <paramref name="defaultLevel"/> argument is added to the level map
  11855. and returned.
  11856. </para>
  11857. </remarks>
  11858. </member>
  11859. <member name="T:log4net.Core.LocationInfo">
  11860. <summary>
  11861. The internal representation of caller location information.
  11862. </summary>
  11863. <remarks>
  11864. <para>
  11865. This class uses the <c>System.Diagnostics.StackTrace</c> class to generate
  11866. a call stack. The caller's information is then extracted from this stack.
  11867. </para>
  11868. <para>
  11869. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  11870. .NET Compact Framework 1.0 therefore caller location information is not
  11871. available on that framework.
  11872. </para>
  11873. <para>
  11874. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  11875. </para>
  11876. <para>
  11877. "StackTrace information will be most informative with Debug build configurations.
  11878. By default, Debug builds include debug symbols, while Release builds do not. The
  11879. debug symbols contain most of the file, method name, line number, and column
  11880. information used in constructing StackFrame and StackTrace objects. StackTrace
  11881. might not report as many method calls as expected, due to code transformations
  11882. that occur during optimization."
  11883. </para>
  11884. <para>
  11885. This means that in a Release build the caller information may be incomplete or may
  11886. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  11887. </para>
  11888. </remarks>
  11889. <author>Nicko Cadell</author>
  11890. <author>Gert Driesen</author>
  11891. </member>
  11892. <member name="M:log4net.Core.LocationInfo.#ctor(System.Type)">
  11893. <summary>
  11894. Constructor
  11895. </summary>
  11896. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  11897. the stack boundary into the logging system for this call.</param>
  11898. <remarks>
  11899. <para>
  11900. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo" />
  11901. class based on the current thread.
  11902. </para>
  11903. </remarks>
  11904. </member>
  11905. <member name="M:log4net.Core.LocationInfo.#ctor(System.String,System.String,System.String,System.String)">
  11906. <summary>
  11907. Constructor
  11908. </summary>
  11909. <param name="className">The fully qualified class name.</param>
  11910. <param name="methodName">The method name.</param>
  11911. <param name="fileName">The file name.</param>
  11912. <param name="lineNumber">The line number of the method within the file.</param>
  11913. <remarks>
  11914. <para>
  11915. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo" />
  11916. class with the specified data.
  11917. </para>
  11918. </remarks>
  11919. </member>
  11920. <member name="P:log4net.Core.LocationInfo.ClassName">
  11921. <summary>
  11922. Gets the fully qualified class name of the caller making the logging
  11923. request.
  11924. </summary>
  11925. <value>
  11926. The fully qualified class name of the caller making the logging
  11927. request.
  11928. </value>
  11929. <remarks>
  11930. <para>
  11931. Gets the fully qualified class name of the caller making the logging
  11932. request.
  11933. </para>
  11934. </remarks>
  11935. </member>
  11936. <member name="P:log4net.Core.LocationInfo.FileName">
  11937. <summary>
  11938. Gets the file name of the caller.
  11939. </summary>
  11940. <value>
  11941. The file name of the caller.
  11942. </value>
  11943. <remarks>
  11944. <para>
  11945. Gets the file name of the caller.
  11946. </para>
  11947. </remarks>
  11948. </member>
  11949. <member name="P:log4net.Core.LocationInfo.LineNumber">
  11950. <summary>
  11951. Gets the line number of the caller.
  11952. </summary>
  11953. <value>
  11954. The line number of the caller.
  11955. </value>
  11956. <remarks>
  11957. <para>
  11958. Gets the line number of the caller.
  11959. </para>
  11960. </remarks>
  11961. </member>
  11962. <member name="P:log4net.Core.LocationInfo.MethodName">
  11963. <summary>
  11964. Gets the method name of the caller.
  11965. </summary>
  11966. <value>
  11967. The method name of the caller.
  11968. </value>
  11969. <remarks>
  11970. <para>
  11971. Gets the method name of the caller.
  11972. </para>
  11973. </remarks>
  11974. </member>
  11975. <member name="P:log4net.Core.LocationInfo.FullInfo">
  11976. <summary>
  11977. Gets all available caller information
  11978. </summary>
  11979. <value>
  11980. All available caller information, in the format
  11981. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  11982. </value>
  11983. <remarks>
  11984. <para>
  11985. Gets all available caller information, in the format
  11986. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  11987. </para>
  11988. </remarks>
  11989. </member>
  11990. <member name="P:log4net.Core.LocationInfo.StackFrames">
  11991. <summary>
  11992. Gets the stack frames from the stack trace of the caller making the log request
  11993. </summary>
  11994. </member>
  11995. <member name="F:log4net.Core.LocationInfo.declaringType">
  11996. <summary>
  11997. The fully qualified type of the LocationInfo class.
  11998. </summary>
  11999. <remarks>
  12000. Used by the internal logger to record the Type of the
  12001. log message.
  12002. </remarks>
  12003. </member>
  12004. <member name="F:log4net.Core.LocationInfo.NA">
  12005. <summary>
  12006. When location information is not available the constant
  12007. <c>NA</c> is returned. Current value of this string
  12008. constant is <b>?</b>.
  12009. </summary>
  12010. </member>
  12011. <member name="T:log4net.Core.LogException">
  12012. <summary>
  12013. Exception base type for log4net.
  12014. </summary>
  12015. <remarks>
  12016. <para>
  12017. This type extends <see cref="T:System.ApplicationException"/>. It
  12018. does not add any new functionality but does differentiate the
  12019. type of exception being thrown.
  12020. </para>
  12021. </remarks>
  12022. <author>Nicko Cadell</author>
  12023. <author>Gert Driesen</author>
  12024. </member>
  12025. <member name="M:log4net.Core.LogException.#ctor">
  12026. <summary>
  12027. Constructor
  12028. </summary>
  12029. <remarks>
  12030. <para>
  12031. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class.
  12032. </para>
  12033. </remarks>
  12034. </member>
  12035. <member name="M:log4net.Core.LogException.#ctor(System.String)">
  12036. <summary>
  12037. Constructor
  12038. </summary>
  12039. <param name="message">A message to include with the exception.</param>
  12040. <remarks>
  12041. <para>
  12042. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class with
  12043. the specified message.
  12044. </para>
  12045. </remarks>
  12046. </member>
  12047. <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)">
  12048. <summary>
  12049. Constructor
  12050. </summary>
  12051. <param name="message">A message to include with the exception.</param>
  12052. <param name="innerException">A nested exception to include.</param>
  12053. <remarks>
  12054. <para>
  12055. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class
  12056. with the specified message and inner exception.
  12057. </para>
  12058. </remarks>
  12059. </member>
  12060. <member name="M:log4net.Core.LogException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  12061. <summary>
  12062. Serialization constructor
  12063. </summary>
  12064. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
  12065. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  12066. <remarks>
  12067. <para>
  12068. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class
  12069. with serialized data.
  12070. </para>
  12071. </remarks>
  12072. </member>
  12073. <member name="T:log4net.Core.LoggerManager">
  12074. <summary>
  12075. Static manager that controls the creation of repositories
  12076. </summary>
  12077. <remarks>
  12078. <para>
  12079. Static manager that controls the creation of repositories
  12080. </para>
  12081. <para>
  12082. This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>)
  12083. to provide access to the <see cref="T:log4net.Core.ILogger"/> objects.
  12084. </para>
  12085. <para>
  12086. This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to
  12087. lookup and create repositories. The selector can be set either programmatically using
  12088. the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c>
  12089. AppSetting in the applications config file to the fully qualified type name of the
  12090. selector to use.
  12091. </para>
  12092. </remarks>
  12093. <author>Nicko Cadell</author>
  12094. <author>Gert Driesen</author>
  12095. </member>
  12096. <member name="M:log4net.Core.LoggerManager.#ctor">
  12097. <summary>
  12098. Private constructor to prevent instances. Only static methods should be used.
  12099. </summary>
  12100. <remarks>
  12101. <para>
  12102. Private constructor to prevent instances. Only static methods should be used.
  12103. </para>
  12104. </remarks>
  12105. </member>
  12106. <member name="M:log4net.Core.LoggerManager.#cctor">
  12107. <summary>
  12108. Hook the shutdown event
  12109. </summary>
  12110. <remarks>
  12111. <para>
  12112. On the full .NET runtime, the static constructor hooks up the
  12113. <c>AppDomain.ProcessExit</c> and <c>AppDomain.DomainUnload</c>> events.
  12114. These are used to shutdown the log4net system as the application exits.
  12115. </para>
  12116. </remarks>
  12117. </member>
  12118. <member name="M:log4net.Core.LoggerManager.RegisterAppDomainEvents">
  12119. <summary>
  12120. Register for ProcessExit and DomainUnload events on the AppDomain
  12121. </summary>
  12122. <remarks>
  12123. <para>
  12124. This needs to be in a separate method because the events make
  12125. a LinkDemand for the ControlAppDomain SecurityPermission. Because
  12126. this is a LinkDemand it is demanded at JIT time. Therefore we cannot
  12127. catch the exception in the method itself, we have to catch it in the
  12128. caller.
  12129. </para>
  12130. </remarks>
  12131. </member>
  12132. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.String)">
  12133. <summary>
  12134. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12135. </summary>
  12136. <param name="repository">the repository to lookup in</param>
  12137. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  12138. <remarks>
  12139. <para>
  12140. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  12141. by the <paramref name="repository"/> argument.
  12142. </para>
  12143. </remarks>
  12144. </member>
  12145. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.Reflection.Assembly)">
  12146. <summary>
  12147. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12148. </summary>
  12149. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12150. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  12151. </member>
  12152. <member name="M:log4net.Core.LoggerManager.GetRepository(System.String)">
  12153. <summary>
  12154. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12155. </summary>
  12156. <param name="repository">the repository to lookup in</param>
  12157. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  12158. <remarks>
  12159. <para>
  12160. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  12161. by the <paramref name="repository"/> argument.
  12162. </para>
  12163. </remarks>
  12164. </member>
  12165. <member name="M:log4net.Core.LoggerManager.GetRepository(System.Reflection.Assembly)">
  12166. <summary>
  12167. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12168. </summary>
  12169. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12170. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  12171. <remarks>
  12172. <para>
  12173. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12174. </para>
  12175. </remarks>
  12176. </member>
  12177. <member name="M:log4net.Core.LoggerManager.Exists(System.String,System.String)">
  12178. <summary>
  12179. Returns the named logger if it exists.
  12180. </summary>
  12181. <param name="repository">The repository to lookup in.</param>
  12182. <param name="name">The fully qualified logger name to look for.</param>
  12183. <returns>
  12184. The logger found, or <c>null</c> if the named logger does not exist in the
  12185. specified repository.
  12186. </returns>
  12187. <remarks>
  12188. <para>
  12189. If the named logger exists (in the specified repository) then it
  12190. returns a reference to the logger, otherwise it returns
  12191. <c>null</c>.
  12192. </para>
  12193. </remarks>
  12194. </member>
  12195. <member name="M:log4net.Core.LoggerManager.Exists(System.Reflection.Assembly,System.String)">
  12196. <summary>
  12197. Returns the named logger if it exists.
  12198. </summary>
  12199. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12200. <param name="name">The fully qualified logger name to look for.</param>
  12201. <returns>
  12202. The logger found, or <c>null</c> if the named logger does not exist in the
  12203. specified assembly's repository.
  12204. </returns>
  12205. <remarks>
  12206. <para>
  12207. If the named logger exists (in the specified assembly's repository) then it
  12208. returns a reference to the logger, otherwise it returns
  12209. <c>null</c>.
  12210. </para>
  12211. </remarks>
  12212. </member>
  12213. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.String)">
  12214. <summary>
  12215. Returns all the currently defined loggers in the specified repository.
  12216. </summary>
  12217. <param name="repository">The repository to lookup in.</param>
  12218. <returns>All the defined loggers.</returns>
  12219. <remarks>
  12220. <para>
  12221. The root logger is <b>not</b> included in the returned array.
  12222. </para>
  12223. </remarks>
  12224. </member>
  12225. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.Reflection.Assembly)">
  12226. <summary>
  12227. Returns all the currently defined loggers in the specified assembly's repository.
  12228. </summary>
  12229. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12230. <returns>All the defined loggers.</returns>
  12231. <remarks>
  12232. <para>
  12233. The root logger is <b>not</b> included in the returned array.
  12234. </para>
  12235. </remarks>
  12236. </member>
  12237. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.String)">
  12238. <summary>
  12239. Retrieves or creates a named logger.
  12240. </summary>
  12241. <param name="repository">The repository to lookup in.</param>
  12242. <param name="name">The name of the logger to retrieve.</param>
  12243. <returns>The logger with the name specified.</returns>
  12244. <remarks>
  12245. <para>
  12246. Retrieves a logger named as the <paramref name="name"/>
  12247. parameter. If the named logger already exists, then the
  12248. existing instance will be returned. Otherwise, a new instance is
  12249. created.
  12250. </para>
  12251. <para>
  12252. By default, loggers do not have a set level but inherit
  12253. it from the hierarchy. This is one of the central features of
  12254. log4net.
  12255. </para>
  12256. </remarks>
  12257. </member>
  12258. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.String)">
  12259. <summary>
  12260. Retrieves or creates a named logger.
  12261. </summary>
  12262. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12263. <param name="name">The name of the logger to retrieve.</param>
  12264. <returns>The logger with the name specified.</returns>
  12265. <remarks>
  12266. <para>
  12267. Retrieves a logger named as the <paramref name="name"/>
  12268. parameter. If the named logger already exists, then the
  12269. existing instance will be returned. Otherwise, a new instance is
  12270. created.
  12271. </para>
  12272. <para>
  12273. By default, loggers do not have a set level but inherit
  12274. it from the hierarchy. This is one of the central features of
  12275. log4net.
  12276. </para>
  12277. </remarks>
  12278. </member>
  12279. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.Type)">
  12280. <summary>
  12281. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  12282. </summary>
  12283. <param name="repository">The repository to lookup in.</param>
  12284. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  12285. <returns>The logger with the name specified.</returns>
  12286. <remarks>
  12287. <para>
  12288. Gets the logger for the fully qualified name of the type specified.
  12289. </para>
  12290. </remarks>
  12291. </member>
  12292. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.Type)">
  12293. <summary>
  12294. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  12295. </summary>
  12296. <param name="repositoryAssembly">the assembly to use to lookup the repository</param>
  12297. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  12298. <returns>The logger with the name specified.</returns>
  12299. <remarks>
  12300. <para>
  12301. Gets the logger for the fully qualified name of the type specified.
  12302. </para>
  12303. </remarks>
  12304. </member>
  12305. <member name="M:log4net.Core.LoggerManager.Shutdown">
  12306. <summary>
  12307. Shuts down the log4net system.
  12308. </summary>
  12309. <remarks>
  12310. <para>
  12311. Calling this method will <b>safely</b> close and remove all
  12312. appenders in all the loggers including root contained in all the
  12313. default repositories.
  12314. </para>
  12315. <para>
  12316. Some appenders need to be closed before the application exists.
  12317. Otherwise, pending logging events might be lost.
  12318. </para>
  12319. <para>
  12320. The <c>shutdown</c> method is careful to close nested
  12321. appenders before closing regular appenders. This is allows
  12322. configurations where a regular appender is attached to a logger
  12323. and again to a nested appender.
  12324. </para>
  12325. </remarks>
  12326. </member>
  12327. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.String)">
  12328. <summary>
  12329. Shuts down the repository for the repository specified.
  12330. </summary>
  12331. <param name="repository">The repository to shutdown.</param>
  12332. <remarks>
  12333. <para>
  12334. Calling this method will <b>safely</b> close and remove all
  12335. appenders in all the loggers including root contained in the
  12336. repository for the <paramref name="repository"/> specified.
  12337. </para>
  12338. <para>
  12339. Some appenders need to be closed before the application exists.
  12340. Otherwise, pending logging events might be lost.
  12341. </para>
  12342. <para>
  12343. The <c>shutdown</c> method is careful to close nested
  12344. appenders before closing regular appenders. This is allows
  12345. configurations where a regular appender is attached to a logger
  12346. and again to a nested appender.
  12347. </para>
  12348. </remarks>
  12349. </member>
  12350. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.Reflection.Assembly)">
  12351. <summary>
  12352. Shuts down the repository for the repository specified.
  12353. </summary>
  12354. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12355. <remarks>
  12356. <para>
  12357. Calling this method will <b>safely</b> close and remove all
  12358. appenders in all the loggers including root contained in the
  12359. repository for the repository. The repository is looked up using
  12360. the <paramref name="repositoryAssembly"/> specified.
  12361. </para>
  12362. <para>
  12363. Some appenders need to be closed before the application exists.
  12364. Otherwise, pending logging events might be lost.
  12365. </para>
  12366. <para>
  12367. The <c>shutdown</c> method is careful to close nested
  12368. appenders before closing regular appenders. This is allows
  12369. configurations where a regular appender is attached to a logger
  12370. and again to a nested appender.
  12371. </para>
  12372. </remarks>
  12373. </member>
  12374. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.String)">
  12375. <summary>
  12376. Resets all values contained in this repository instance to their defaults.
  12377. </summary>
  12378. <param name="repository">The repository to reset.</param>
  12379. <remarks>
  12380. <para>
  12381. Resets all values contained in the repository instance to their
  12382. defaults. This removes all appenders from all loggers, sets
  12383. the level of all non-root loggers to <c>null</c>,
  12384. sets their additivity flag to <c>true</c> and sets the level
  12385. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  12386. message disabling is set its default "off" value.
  12387. </para>
  12388. </remarks>
  12389. </member>
  12390. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.Reflection.Assembly)">
  12391. <summary>
  12392. Resets all values contained in this repository instance to their defaults.
  12393. </summary>
  12394. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  12395. <remarks>
  12396. <para>
  12397. Resets all values contained in the repository instance to their
  12398. defaults. This removes all appenders from all loggers, sets
  12399. the level of all non-root loggers to <c>null</c>,
  12400. sets their additivity flag to <c>true</c> and sets the level
  12401. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  12402. message disabling is set its default "off" value.
  12403. </para>
  12404. </remarks>
  12405. </member>
  12406. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String)">
  12407. <summary>
  12408. Creates a repository with the specified name.
  12409. </summary>
  12410. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  12411. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12412. <remarks>
  12413. <para>
  12414. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12415. </para>
  12416. <para>
  12417. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  12418. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  12419. </para>
  12420. <para>
  12421. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12422. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  12423. </para>
  12424. </remarks>
  12425. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12426. </member>
  12427. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String)">
  12428. <summary>
  12429. Creates a repository with the specified name.
  12430. </summary>
  12431. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  12432. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12433. <remarks>
  12434. <para>
  12435. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  12436. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  12437. </para>
  12438. <para>
  12439. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12440. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  12441. </para>
  12442. </remarks>
  12443. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12444. </member>
  12445. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String,System.Type)">
  12446. <summary>
  12447. Creates a repository with the specified name and repository type.
  12448. </summary>
  12449. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  12450. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12451. and has a no arg constructor. An instance of this type will be created to act
  12452. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12453. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12454. <remarks>
  12455. <para>
  12456. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12457. </para>
  12458. <para>
  12459. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12460. An Exception will be thrown if the repository already exists.
  12461. </para>
  12462. </remarks>
  12463. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12464. </member>
  12465. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String,System.Type)">
  12466. <summary>
  12467. Creates a repository with the specified name and repository type.
  12468. </summary>
  12469. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  12470. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12471. and has a no arg constructor. An instance of this type will be created to act
  12472. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12473. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12474. <remarks>
  12475. <para>
  12476. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12477. An Exception will be thrown if the repository already exists.
  12478. </para>
  12479. </remarks>
  12480. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12481. </member>
  12482. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  12483. <summary>
  12484. Creates a repository for the specified assembly and repository type.
  12485. </summary>
  12486. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  12487. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12488. and has a no arg constructor. An instance of this type will be created to act
  12489. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12490. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12491. <remarks>
  12492. <para>
  12493. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12494. </para>
  12495. <para>
  12496. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  12497. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  12498. same assembly specified will return the same repository instance.
  12499. </para>
  12500. </remarks>
  12501. </member>
  12502. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  12503. <summary>
  12504. Creates a repository for the specified assembly and repository type.
  12505. </summary>
  12506. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  12507. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12508. and has a no arg constructor. An instance of this type will be created to act
  12509. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12510. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12511. <remarks>
  12512. <para>
  12513. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  12514. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  12515. same assembly specified will return the same repository instance.
  12516. </para>
  12517. </remarks>
  12518. </member>
  12519. <member name="M:log4net.Core.LoggerManager.GetAllRepositories">
  12520. <summary>
  12521. Gets an array of all currently defined repositories.
  12522. </summary>
  12523. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  12524. <remarks>
  12525. <para>
  12526. Gets an array of all currently defined repositories.
  12527. </para>
  12528. </remarks>
  12529. </member>
  12530. <member name="P:log4net.Core.LoggerManager.RepositorySelector">
  12531. <summary>
  12532. Gets or sets the repository selector used by the <see cref="T:log4net.LogManager" />.
  12533. </summary>
  12534. <value>
  12535. The repository selector used by the <see cref="T:log4net.LogManager" />.
  12536. </value>
  12537. <remarks>
  12538. <para>
  12539. The repository selector (<see cref="T:log4net.Core.IRepositorySelector"/>) is used by
  12540. the <see cref="T:log4net.LogManager"/> to create and select repositories
  12541. (<see cref="T:log4net.Repository.ILoggerRepository"/>).
  12542. </para>
  12543. <para>
  12544. The caller to <see cref="T:log4net.LogManager"/> supplies either a string name
  12545. or an assembly (if not supplied the assembly is inferred using
  12546. <see cref="M:Assembly.GetCallingAssembly()"/>).
  12547. </para>
  12548. <para>
  12549. This context is used by the selector to lookup a specific repository.
  12550. </para>
  12551. <para>
  12552. For the full .NET Framework, the default repository is <c>DefaultRepositorySelector</c>;
  12553. for the .NET Compact Framework <c>CompactRepositorySelector</c> is the default
  12554. repository.
  12555. </para>
  12556. </remarks>
  12557. </member>
  12558. <member name="M:log4net.Core.LoggerManager.GetVersionInfo">
  12559. <summary>
  12560. Internal method to get pertinent version info.
  12561. </summary>
  12562. <returns>A string of version info.</returns>
  12563. </member>
  12564. <member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)">
  12565. <summary>
  12566. Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires
  12567. </summary>
  12568. <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
  12569. <param name="e">null</param>
  12570. <remarks>
  12571. <para>
  12572. Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires.
  12573. </para>
  12574. <para>
  12575. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  12576. </para>
  12577. </remarks>
  12578. </member>
  12579. <member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)">
  12580. <summary>
  12581. Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires
  12582. </summary>
  12583. <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
  12584. <param name="e">null</param>
  12585. <remarks>
  12586. <para>
  12587. Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires.
  12588. </para>
  12589. <para>
  12590. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  12591. </para>
  12592. </remarks>
  12593. </member>
  12594. <member name="F:log4net.Core.LoggerManager.declaringType">
  12595. <summary>
  12596. The fully qualified type of the LoggerManager class.
  12597. </summary>
  12598. <remarks>
  12599. Used by the internal logger to record the Type of the
  12600. log message.
  12601. </remarks>
  12602. </member>
  12603. <member name="F:log4net.Core.LoggerManager.s_repositorySelector">
  12604. <summary>
  12605. Initialize the default repository selector
  12606. </summary>
  12607. </member>
  12608. <member name="T:log4net.Core.LoggerWrapperImpl">
  12609. <summary>
  12610. Implementation of the <see cref="T:log4net.Core.ILoggerWrapper"/> interface.
  12611. </summary>
  12612. <remarks>
  12613. <para>
  12614. This class should be used as the base for all wrapper implementations.
  12615. </para>
  12616. </remarks>
  12617. <author>Nicko Cadell</author>
  12618. <author>Gert Driesen</author>
  12619. </member>
  12620. <member name="M:log4net.Core.LoggerWrapperImpl.#ctor(log4net.Core.ILogger)">
  12621. <summary>
  12622. Constructs a new wrapper for the specified logger.
  12623. </summary>
  12624. <param name="logger">The logger to wrap.</param>
  12625. <remarks>
  12626. <para>
  12627. Constructs a new wrapper for the specified logger.
  12628. </para>
  12629. </remarks>
  12630. </member>
  12631. <member name="P:log4net.Core.LoggerWrapperImpl.Logger">
  12632. <summary>
  12633. Gets the implementation behind this wrapper object.
  12634. </summary>
  12635. <value>
  12636. The <see cref="T:log4net.Core.ILogger"/> object that this object is implementing.
  12637. </value>
  12638. <remarks>
  12639. <para>
  12640. The <c>Logger</c> object may not be the same object as this object
  12641. because of logger decorators.
  12642. </para>
  12643. <para>
  12644. This gets the actual underlying objects that is used to process
  12645. the log events.
  12646. </para>
  12647. </remarks>
  12648. </member>
  12649. <member name="F:log4net.Core.LoggerWrapperImpl.m_logger">
  12650. <summary>
  12651. The logger that this object is wrapping
  12652. </summary>
  12653. </member>
  12654. <member name="T:log4net.Core.LoggingEventData">
  12655. <summary>
  12656. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  12657. </summary>
  12658. <remarks>
  12659. <para>
  12660. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  12661. </para>
  12662. </remarks>
  12663. <author>Nicko Cadell</author>
  12664. </member>
  12665. <member name="F:log4net.Core.LoggingEventData.LoggerName">
  12666. <summary>
  12667. The logger name.
  12668. </summary>
  12669. <remarks>
  12670. <para>
  12671. The logger name.
  12672. </para>
  12673. </remarks>
  12674. </member>
  12675. <member name="F:log4net.Core.LoggingEventData.Level">
  12676. <summary>
  12677. Level of logging event.
  12678. </summary>
  12679. <remarks>
  12680. <para>
  12681. Level of logging event. Level cannot be Serializable
  12682. because it is a flyweight. Due to its special serialization it
  12683. cannot be declared final either.
  12684. </para>
  12685. </remarks>
  12686. </member>
  12687. <member name="F:log4net.Core.LoggingEventData.Message">
  12688. <summary>
  12689. The application supplied message.
  12690. </summary>
  12691. <remarks>
  12692. <para>
  12693. The application supplied message of logging event.
  12694. </para>
  12695. </remarks>
  12696. </member>
  12697. <member name="F:log4net.Core.LoggingEventData.ThreadName">
  12698. <summary>
  12699. The name of thread
  12700. </summary>
  12701. <remarks>
  12702. <para>
  12703. The name of thread in which this logging event was generated
  12704. </para>
  12705. </remarks>
  12706. </member>
  12707. <member name="F:log4net.Core.LoggingEventData.TimeStamp">
  12708. <summary>
  12709. Gets or sets the local time the event was logged
  12710. </summary>
  12711. <remarks>
  12712. <para>
  12713. Prefer using the <see cref="P:log4net.Core.LoggingEventData.TimeStampUtc"/> setter, since local time can be ambiguous.
  12714. </para>
  12715. </remarks>
  12716. </member>
  12717. <member name="P:log4net.Core.LoggingEventData.TimeStampUtc">
  12718. <summary>
  12719. Gets or sets the UTC time the event was logged
  12720. </summary>
  12721. <remarks>
  12722. <para>
  12723. The TimeStamp is stored in the UTC time zone.
  12724. </para>
  12725. </remarks>
  12726. </member>
  12727. <member name="F:log4net.Core.LoggingEventData.LocationInfo">
  12728. <summary>
  12729. Location information for the caller.
  12730. </summary>
  12731. <remarks>
  12732. <para>
  12733. Location information for the caller.
  12734. </para>
  12735. </remarks>
  12736. </member>
  12737. <member name="F:log4net.Core.LoggingEventData.UserName">
  12738. <summary>
  12739. String representation of the user
  12740. </summary>
  12741. <remarks>
  12742. <para>
  12743. String representation of the user's windows name,
  12744. like DOMAIN\username
  12745. </para>
  12746. </remarks>
  12747. </member>
  12748. <member name="F:log4net.Core.LoggingEventData.Identity">
  12749. <summary>
  12750. String representation of the identity.
  12751. </summary>
  12752. <remarks>
  12753. <para>
  12754. String representation of the current thread's principal identity.
  12755. </para>
  12756. </remarks>
  12757. </member>
  12758. <member name="F:log4net.Core.LoggingEventData.ExceptionString">
  12759. <summary>
  12760. The string representation of the exception
  12761. </summary>
  12762. <remarks>
  12763. <para>
  12764. The string representation of the exception
  12765. </para>
  12766. </remarks>
  12767. </member>
  12768. <member name="F:log4net.Core.LoggingEventData.Domain">
  12769. <summary>
  12770. String representation of the AppDomain.
  12771. </summary>
  12772. <remarks>
  12773. <para>
  12774. String representation of the AppDomain.
  12775. </para>
  12776. </remarks>
  12777. </member>
  12778. <member name="F:log4net.Core.LoggingEventData.Properties">
  12779. <summary>
  12780. Additional event specific properties
  12781. </summary>
  12782. <remarks>
  12783. <para>
  12784. A logger or an appender may attach additional
  12785. properties to specific events. These properties
  12786. have a string key and an object value.
  12787. </para>
  12788. </remarks>
  12789. </member>
  12790. <member name="T:log4net.Core.FixFlags">
  12791. <summary>
  12792. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  12793. </summary>
  12794. <remarks>
  12795. <para>
  12796. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  12797. </para>
  12798. </remarks>
  12799. <author>Nicko Cadell</author>
  12800. </member>
  12801. <member name="F:log4net.Core.FixFlags.Mdc">
  12802. <summary>
  12803. Fix the MDC
  12804. </summary>
  12805. </member>
  12806. <member name="F:log4net.Core.FixFlags.Ndc">
  12807. <summary>
  12808. Fix the NDC
  12809. </summary>
  12810. </member>
  12811. <member name="F:log4net.Core.FixFlags.Message">
  12812. <summary>
  12813. Fix the rendered message
  12814. </summary>
  12815. </member>
  12816. <member name="F:log4net.Core.FixFlags.ThreadName">
  12817. <summary>
  12818. Fix the thread name
  12819. </summary>
  12820. </member>
  12821. <member name="F:log4net.Core.FixFlags.LocationInfo">
  12822. <summary>
  12823. Fix the callers location information
  12824. </summary>
  12825. <remarks>
  12826. CAUTION: Very slow to generate
  12827. </remarks>
  12828. </member>
  12829. <member name="F:log4net.Core.FixFlags.UserName">
  12830. <summary>
  12831. Fix the callers windows user name
  12832. </summary>
  12833. <remarks>
  12834. CAUTION: Slow to generate
  12835. </remarks>
  12836. </member>
  12837. <member name="F:log4net.Core.FixFlags.Domain">
  12838. <summary>
  12839. Fix the domain friendly name
  12840. </summary>
  12841. </member>
  12842. <member name="F:log4net.Core.FixFlags.Identity">
  12843. <summary>
  12844. Fix the callers principal name
  12845. </summary>
  12846. <remarks>
  12847. CAUTION: May be slow to generate
  12848. </remarks>
  12849. </member>
  12850. <member name="F:log4net.Core.FixFlags.Exception">
  12851. <summary>
  12852. Fix the exception text
  12853. </summary>
  12854. </member>
  12855. <member name="F:log4net.Core.FixFlags.Properties">
  12856. <summary>
  12857. Fix the event properties. Active properties must implement <see cref="T:log4net.Core.IFixingRequired"/> in order to be eligible for fixing.
  12858. </summary>
  12859. </member>
  12860. <member name="F:log4net.Core.FixFlags.None">
  12861. <summary>
  12862. No fields fixed
  12863. </summary>
  12864. </member>
  12865. <member name="F:log4net.Core.FixFlags.All">
  12866. <summary>
  12867. All fields fixed
  12868. </summary>
  12869. </member>
  12870. <member name="F:log4net.Core.FixFlags.Partial">
  12871. <summary>
  12872. Partial fields fixed
  12873. </summary>
  12874. <remarks>
  12875. <para>
  12876. This set of partial fields gives good performance. The following fields are fixed:
  12877. </para>
  12878. <list type="bullet">
  12879. <item><description><see cref="F:log4net.Core.FixFlags.Message"/></description></item>
  12880. <item><description><see cref="F:log4net.Core.FixFlags.ThreadName"/></description></item>
  12881. <item><description><see cref="F:log4net.Core.FixFlags.Exception"/></description></item>
  12882. <item><description><see cref="F:log4net.Core.FixFlags.Domain"/></description></item>
  12883. <item><description><see cref="F:log4net.Core.FixFlags.Properties"/></description></item>
  12884. </list>
  12885. </remarks>
  12886. </member>
  12887. <member name="T:log4net.Core.LoggingEvent">
  12888. <summary>
  12889. The internal representation of logging events.
  12890. </summary>
  12891. <remarks>
  12892. <para>
  12893. When an affirmative decision is made to log then a
  12894. <see cref="T:log4net.Core.LoggingEvent"/> instance is created. This instance
  12895. is passed around to the different log4net components.
  12896. </para>
  12897. <para>
  12898. This class is of concern to those wishing to extend log4net.
  12899. </para>
  12900. <para>
  12901. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  12902. are considered volatile, that is the values are correct at the
  12903. time the event is delivered to appenders, but will not be consistent
  12904. at any time afterwards. If an event is to be stored and then processed
  12905. at a later time these volatile values must be fixed by calling
  12906. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  12907. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  12908. is essential to maintaining data consistency.
  12909. </para>
  12910. </remarks>
  12911. <author>Nicko Cadell</author>
  12912. <author>Gert Driesen</author>
  12913. <author>Douglas de la Torre</author>
  12914. <author>Daniel Cazzulino</author>
  12915. </member>
  12916. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,System.String,log4net.Core.Level,System.Object,System.Exception)">
  12917. <summary>
  12918. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  12919. from the supplied parameters.
  12920. </summary>
  12921. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12922. the stack boundary into the logging system for this call.</param>
  12923. <param name="repository">The repository this event is logged in.</param>
  12924. <param name="loggerName">The name of the logger of this event.</param>
  12925. <param name="level">The level of this event.</param>
  12926. <param name="message">The message of this event.</param>
  12927. <param name="exception">The exception for this event.</param>
  12928. <remarks>
  12929. <para>
  12930. Except <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>, <see cref="P:log4net.Core.LoggingEvent.Level"/> and <see cref="P:log4net.Core.LoggingEvent.LoggerName"/>,
  12931. all fields of <c>LoggingEvent</c> are filled when actually needed. Call
  12932. <see cref="M:FixVolatileData()"/> to cache all data locally
  12933. to prevent inconsistencies.
  12934. </para>
  12935. <para>This method is called by the log4net framework
  12936. to create a logging event.
  12937. </para>
  12938. </remarks>
  12939. </member>
  12940. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)">
  12941. <summary>
  12942. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  12943. using specific data.
  12944. </summary>
  12945. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12946. the stack boundary into the logging system for this call.</param>
  12947. <param name="repository">The repository this event is logged in.</param>
  12948. <param name="data">Data used to initialize the logging event.</param>
  12949. <param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param>
  12950. <remarks>
  12951. <para>
  12952. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  12953. to be created independently of the log4net framework. This can
  12954. be useful if you require a custom serialization scheme.
  12955. </para>
  12956. <para>
  12957. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  12958. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  12959. </para>
  12960. <para>
  12961. The <paramref name="fixedData"/> parameter should be used to specify which fields in the
  12962. <paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/>
  12963. will be captured from the environment if requested or fixed.
  12964. </para>
  12965. </remarks>
  12966. </member>
  12967. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)">
  12968. <summary>
  12969. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  12970. using specific data.
  12971. </summary>
  12972. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12973. the stack boundary into the logging system for this call.</param>
  12974. <param name="repository">The repository this event is logged in.</param>
  12975. <param name="data">Data used to initialize the logging event.</param>
  12976. <remarks>
  12977. <para>
  12978. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  12979. to be created independently of the log4net framework. This can
  12980. be useful if you require a custom serialization scheme.
  12981. </para>
  12982. <para>
  12983. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  12984. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  12985. </para>
  12986. <para>
  12987. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  12988. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  12989. parameter and no other data should be captured from the environment.
  12990. </para>
  12991. </remarks>
  12992. </member>
  12993. <member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)">
  12994. <summary>
  12995. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  12996. using specific data.
  12997. </summary>
  12998. <param name="data">Data used to initialize the logging event.</param>
  12999. <remarks>
  13000. <para>
  13001. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  13002. to be created independently of the log4net framework. This can
  13003. be useful if you require a custom serialization scheme.
  13004. </para>
  13005. <para>
  13006. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  13007. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  13008. </para>
  13009. <para>
  13010. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  13011. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  13012. parameter and no other data should be captured from the environment.
  13013. </para>
  13014. </remarks>
  13015. </member>
  13016. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13017. <summary>
  13018. Serialization constructor
  13019. </summary>
  13020. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  13021. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  13022. <remarks>
  13023. <para>
  13024. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  13025. with serialized data.
  13026. </para>
  13027. </remarks>
  13028. </member>
  13029. <member name="P:log4net.Core.LoggingEvent.StartTime">
  13030. <summary>
  13031. Gets the time when the current process started.
  13032. </summary>
  13033. <value>
  13034. This is the time when this process started.
  13035. </value>
  13036. <remarks>
  13037. <para>
  13038. The TimeStamp is stored internally in UTC and converted to the local time zone for this computer.
  13039. </para>
  13040. <para>
  13041. Tries to get the start time for the current process.
  13042. Failing that it returns the time of the first call to
  13043. this property.
  13044. </para>
  13045. <para>
  13046. Note that AppDomains may be loaded and unloaded within the
  13047. same process without the process terminating and therefore
  13048. without the process start time being reset.
  13049. </para>
  13050. </remarks>
  13051. </member>
  13052. <member name="P:log4net.Core.LoggingEvent.StartTimeUtc">
  13053. <summary>
  13054. Gets the UTC time when the current process started.
  13055. </summary>
  13056. <value>
  13057. This is the UTC time when this process started.
  13058. </value>
  13059. <remarks>
  13060. <para>
  13061. Tries to get the start time for the current process.
  13062. Failing that it returns the time of the first call to
  13063. this property.
  13064. </para>
  13065. <para>
  13066. Note that AppDomains may be loaded and unloaded within the
  13067. same process without the process terminating and therefore
  13068. without the process start time being reset.
  13069. </para>
  13070. </remarks>
  13071. </member>
  13072. <member name="P:log4net.Core.LoggingEvent.Level">
  13073. <summary>
  13074. Gets the <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  13075. </summary>
  13076. <value>
  13077. The <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  13078. </value>
  13079. <remarks>
  13080. <para>
  13081. Gets the <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  13082. </para>
  13083. </remarks>
  13084. </member>
  13085. <member name="P:log4net.Core.LoggingEvent.TimeStamp">
  13086. <summary>
  13087. Gets the time of the logging event.
  13088. </summary>
  13089. <value>
  13090. The time of the logging event.
  13091. </value>
  13092. <remarks>
  13093. <para>
  13094. The TimeStamp is stored in UTC and converted to the local time zone for this computer.
  13095. </para>
  13096. </remarks>
  13097. </member>
  13098. <member name="P:log4net.Core.LoggingEvent.TimeStampUtc">
  13099. <summary>
  13100. Gets UTC the time of the logging event.
  13101. </summary>
  13102. <value>
  13103. The UTC time of the logging event.
  13104. </value>
  13105. </member>
  13106. <member name="P:log4net.Core.LoggingEvent.LoggerName">
  13107. <summary>
  13108. Gets the name of the logger that logged the event.
  13109. </summary>
  13110. <value>
  13111. The name of the logger that logged the event.
  13112. </value>
  13113. <remarks>
  13114. <para>
  13115. Gets the name of the logger that logged the event.
  13116. </para>
  13117. </remarks>
  13118. </member>
  13119. <member name="P:log4net.Core.LoggingEvent.LocationInformation">
  13120. <summary>
  13121. Gets the location information for this logging event.
  13122. </summary>
  13123. <value>
  13124. The location information for this logging event.
  13125. </value>
  13126. <remarks>
  13127. <para>
  13128. The collected information is cached for future use.
  13129. </para>
  13130. <para>
  13131. See the <see cref="T:log4net.Core.LocationInfo"/> class for more information on
  13132. supported frameworks and the different behavior in Debug and
  13133. Release builds.
  13134. </para>
  13135. </remarks>
  13136. </member>
  13137. <member name="P:log4net.Core.LoggingEvent.MessageObject">
  13138. <summary>
  13139. Gets the message object used to initialize this event.
  13140. </summary>
  13141. <value>
  13142. The message object used to initialize this event.
  13143. </value>
  13144. <remarks>
  13145. <para>
  13146. Gets the message object used to initialize this event.
  13147. Note that this event may not have a valid message object.
  13148. If the event is serialized the message object will not
  13149. be transferred. To get the text of the message the
  13150. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property must be used
  13151. not this property.
  13152. </para>
  13153. <para>
  13154. If there is no defined message object for this event then
  13155. null will be returned.
  13156. </para>
  13157. </remarks>
  13158. </member>
  13159. <member name="P:log4net.Core.LoggingEvent.ExceptionObject">
  13160. <summary>
  13161. Gets the exception object used to initialize this event.
  13162. </summary>
  13163. <value>
  13164. The exception object used to initialize this event.
  13165. </value>
  13166. <remarks>
  13167. <para>
  13168. Gets the exception object used to initialize this event.
  13169. Note that this event may not have a valid exception object.
  13170. If the event is serialized the exception object will not
  13171. be transferred. To get the text of the exception the
  13172. <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> method must be used
  13173. not this property.
  13174. </para>
  13175. <para>
  13176. If there is no defined exception object for this event then
  13177. null will be returned.
  13178. </para>
  13179. </remarks>
  13180. </member>
  13181. <member name="P:log4net.Core.LoggingEvent.Repository">
  13182. <summary>
  13183. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  13184. </summary>
  13185. <remarks>
  13186. <para>
  13187. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  13188. </para>
  13189. </remarks>
  13190. </member>
  13191. <member name="M:log4net.Core.LoggingEvent.EnsureRepository(log4net.Repository.ILoggerRepository)">
  13192. <summary>
  13193. Ensure that the repository is set.
  13194. </summary>
  13195. <param name="repository">the value for the repository</param>
  13196. </member>
  13197. <member name="P:log4net.Core.LoggingEvent.RenderedMessage">
  13198. <summary>
  13199. Gets the message, rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13200. </summary>
  13201. <value>
  13202. The message rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13203. </value>
  13204. <remarks>
  13205. <para>
  13206. The collected information is cached for future use.
  13207. </para>
  13208. </remarks>
  13209. </member>
  13210. <member name="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)">
  13211. <summary>
  13212. Write the rendered message to a TextWriter
  13213. </summary>
  13214. <param name="writer">the writer to write the message to</param>
  13215. <remarks>
  13216. <para>
  13217. Unlike the <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property this method
  13218. does store the message data in the internal cache. Therefore
  13219. if called only once this method should be faster than the
  13220. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property, however if the message is
  13221. to be accessed multiple times then the property will be more efficient.
  13222. </para>
  13223. </remarks>
  13224. </member>
  13225. <member name="P:log4net.Core.LoggingEvent.ThreadName">
  13226. <summary>
  13227. Gets the name of the current thread.
  13228. </summary>
  13229. <value>
  13230. The name of the current thread, or the thread ID when
  13231. the name is not available.
  13232. </value>
  13233. <remarks>
  13234. <para>
  13235. The collected information is cached for future use.
  13236. </para>
  13237. </remarks>
  13238. </member>
  13239. <member name="P:log4net.Core.LoggingEvent.UserName">
  13240. <summary>
  13241. Gets the name of the current user.
  13242. </summary>
  13243. <value>
  13244. The name of the current user, or <c>NOT AVAILABLE</c> when the
  13245. underlying runtime has no support for retrieving the name of the
  13246. current user.
  13247. </value>
  13248. <remarks>
  13249. <para>
  13250. Calls <c>WindowsIdentity.GetCurrent().Name</c> to get the name of
  13251. the current windows user.
  13252. </para>
  13253. <para>
  13254. To improve performance, we could cache the string representation of
  13255. the name, and reuse that as long as the identity stayed constant.
  13256. Once the identity changed, we would need to re-assign and re-render
  13257. the string.
  13258. </para>
  13259. <para>
  13260. However, the <c>WindowsIdentity.GetCurrent()</c> call seems to
  13261. return different objects every time, so the current implementation
  13262. doesn't do this type of caching.
  13263. </para>
  13264. <para>
  13265. Timing for these operations:
  13266. </para>
  13267. <list type="table">
  13268. <listheader>
  13269. <term>Method</term>
  13270. <description>Results</description>
  13271. </listheader>
  13272. <item>
  13273. <term><c>WindowsIdentity.GetCurrent()</c></term>
  13274. <description>10000 loops, 00:00:00.2031250 seconds</description>
  13275. </item>
  13276. <item>
  13277. <term><c>WindowsIdentity.GetCurrent().Name</c></term>
  13278. <description>10000 loops, 00:00:08.0468750 seconds</description>
  13279. </item>
  13280. </list>
  13281. <para>
  13282. This means we could speed things up almost 40 times by caching the
  13283. value of the <c>WindowsIdentity.GetCurrent().Name</c> property, since
  13284. this takes (8.04-0.20) = 7.84375 seconds.
  13285. </para>
  13286. </remarks>
  13287. </member>
  13288. <member name="P:log4net.Core.LoggingEvent.Identity">
  13289. <summary>
  13290. Gets the identity of the current thread principal.
  13291. </summary>
  13292. <value>
  13293. The string name of the identity of the current thread principal.
  13294. </value>
  13295. <remarks>
  13296. <para>
  13297. Calls <c>System.Threading.Thread.CurrentPrincipal.Identity.Name</c> to get
  13298. the name of the current thread principal.
  13299. </para>
  13300. </remarks>
  13301. </member>
  13302. <member name="P:log4net.Core.LoggingEvent.Domain">
  13303. <summary>
  13304. Gets the AppDomain friendly name.
  13305. </summary>
  13306. <value>
  13307. The AppDomain friendly name.
  13308. </value>
  13309. <remarks>
  13310. <para>
  13311. Gets the AppDomain friendly name.
  13312. </para>
  13313. </remarks>
  13314. </member>
  13315. <member name="P:log4net.Core.LoggingEvent.Properties">
  13316. <summary>
  13317. Additional event specific properties.
  13318. </summary>
  13319. <value>
  13320. Additional event specific properties.
  13321. </value>
  13322. <remarks>
  13323. <para>
  13324. A logger or an appender may attach additional
  13325. properties to specific events. These properties
  13326. have a string key and an object value.
  13327. </para>
  13328. <para>
  13329. This property is for events that have been added directly to
  13330. this event. The aggregate properties (which include these
  13331. event properties) can be retrieved using <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/>
  13332. and <see cref="M:log4net.Core.LoggingEvent.GetProperties"/>.
  13333. </para>
  13334. <para>
  13335. Once the properties have been fixed <see cref="P:log4net.Core.LoggingEvent.Fix"/> this property
  13336. returns the combined cached properties. This ensures that updates to
  13337. this property are always reflected in the underlying storage. When
  13338. returning the combined properties there may be more keys in the
  13339. Dictionary than expected.
  13340. </para>
  13341. </remarks>
  13342. </member>
  13343. <member name="P:log4net.Core.LoggingEvent.Fix">
  13344. <summary>
  13345. The fixed fields in this event
  13346. </summary>
  13347. <value>
  13348. The set of fields that are fixed in this event
  13349. </value>
  13350. <remarks>
  13351. <para>
  13352. Fields will not be fixed if they have previously been fixed.
  13353. It is not possible to 'unfix' a field.
  13354. </para>
  13355. </remarks>
  13356. </member>
  13357. <member name="M:log4net.Core.LoggingEvent.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13358. <summary>
  13359. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  13360. </summary>
  13361. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
  13362. <param name="context">The destination for this serialization.</param>
  13363. <remarks>
  13364. <para>
  13365. The data in this event must be fixed before it can be serialized.
  13366. </para>
  13367. <para>
  13368. The <see cref="M:FixVolatileData()"/> method must be called during the
  13369. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method call if this event
  13370. is to be used outside that method.
  13371. </para>
  13372. </remarks>
  13373. </member>
  13374. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData">
  13375. <summary>
  13376. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent" />.
  13377. </summary>
  13378. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  13379. <remarks>
  13380. <para>
  13381. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  13382. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  13383. </para>
  13384. <para>
  13385. Does a <see cref="F:log4net.Core.FixFlags.Partial"/> fix of the data
  13386. in the logging event before returning the event data.
  13387. </para>
  13388. </remarks>
  13389. </member>
  13390. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)">
  13391. <summary>
  13392. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent" />.
  13393. </summary>
  13394. <param name="fixFlags">The set of data to ensure is fixed in the LoggingEventData</param>
  13395. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  13396. <remarks>
  13397. <para>
  13398. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  13399. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  13400. </para>
  13401. </remarks>
  13402. </member>
  13403. <member name="M:log4net.Core.LoggingEvent.GetExceptionStrRep">
  13404. <summary>
  13405. Returns this event's exception's rendered using the
  13406. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13407. </summary>
  13408. <returns>
  13409. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13410. </returns>
  13411. <remarks>
  13412. <para>
  13413. <b>Obsolete. Use <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> instead.</b>
  13414. </para>
  13415. </remarks>
  13416. </member>
  13417. <member name="M:log4net.Core.LoggingEvent.GetExceptionString">
  13418. <summary>
  13419. Returns this event's exception's rendered using the
  13420. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13421. </summary>
  13422. <returns>
  13423. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13424. </returns>
  13425. <remarks>
  13426. <para>
  13427. Returns this event's exception's rendered using the
  13428. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13429. </para>
  13430. </remarks>
  13431. </member>
  13432. <member name="M:log4net.Core.LoggingEvent.FixVolatileData">
  13433. <summary>
  13434. Fix instance fields that hold volatile data.
  13435. </summary>
  13436. <remarks>
  13437. <para>
  13438. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  13439. are considered volatile, that is the values are correct at the
  13440. time the event is delivered to appenders, but will not be consistent
  13441. at any time afterwards. If an event is to be stored and then processed
  13442. at a later time these volatile values must be fixed by calling
  13443. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  13444. incurred by calling <see cref="M:FixVolatileData()"/> but it
  13445. is essential to maintaining data consistency.
  13446. </para>
  13447. <para>
  13448. Calling <see cref="M:FixVolatileData()"/> is equivalent to
  13449. calling <see cref="M:FixVolatileData(bool)"/> passing the parameter
  13450. <c>false</c>.
  13451. </para>
  13452. <para>
  13453. See <see cref="M:FixVolatileData(bool)"/> for more
  13454. information.
  13455. </para>
  13456. </remarks>
  13457. </member>
  13458. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)">
  13459. <summary>
  13460. Fixes instance fields that hold volatile data.
  13461. </summary>
  13462. <param name="fastButLoose">Set to <c>true</c> to not fix data that takes a long time to fix.</param>
  13463. <remarks>
  13464. <para>
  13465. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  13466. are considered volatile, that is the values are correct at the
  13467. time the event is delivered to appenders, but will not be consistent
  13468. at any time afterwards. If an event is to be stored and then processed
  13469. at a later time these volatile values must be fixed by calling
  13470. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  13471. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  13472. is essential to maintaining data consistency.
  13473. </para>
  13474. <para>
  13475. The <paramref name="fastButLoose"/> param controls the data that
  13476. is fixed. Some of the data that can be fixed takes a long time to
  13477. generate, therefore if you do not require those settings to be fixed
  13478. they can be ignored by setting the <paramref name="fastButLoose"/> param
  13479. to <c>true</c>. This setting will ignore the <see cref="P:log4net.Core.LoggingEvent.LocationInformation"/>
  13480. and <see cref="P:log4net.Core.LoggingEvent.UserName"/> settings.
  13481. </para>
  13482. <para>
  13483. Set <paramref name="fastButLoose"/> to <c>false</c> to ensure that all
  13484. settings are fixed.
  13485. </para>
  13486. </remarks>
  13487. </member>
  13488. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)">
  13489. <summary>
  13490. Fix the fields specified by the <see cref="T:log4net.Core.FixFlags"/> parameter
  13491. </summary>
  13492. <param name="flags">the fields to fix</param>
  13493. <remarks>
  13494. <para>
  13495. Only fields specified in the <paramref name="flags"/> will be fixed.
  13496. Fields will not be fixed if they have previously been fixed.
  13497. It is not possible to 'unfix' a field.
  13498. </para>
  13499. </remarks>
  13500. </member>
  13501. <member name="M:log4net.Core.LoggingEvent.LookupProperty(System.String)">
  13502. <summary>
  13503. Lookup a composite property in this event
  13504. </summary>
  13505. <param name="key">the key for the property to lookup</param>
  13506. <returns>the value for the property</returns>
  13507. <remarks>
  13508. <para>
  13509. This event has composite properties that combine together properties from
  13510. several different contexts in the following order:
  13511. <list type="definition">
  13512. <item>
  13513. <term>this events properties</term>
  13514. <description>
  13515. This event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  13516. properties are specific to this event only.
  13517. </description>
  13518. </item>
  13519. <item>
  13520. <term>the thread properties</term>
  13521. <description>
  13522. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  13523. thread. These properties are shared by all events logged on this thread.
  13524. </description>
  13525. </item>
  13526. <item>
  13527. <term>the global properties</term>
  13528. <description>
  13529. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  13530. properties are shared by all the threads in the AppDomain.
  13531. </description>
  13532. </item>
  13533. </list>
  13534. </para>
  13535. </remarks>
  13536. </member>
  13537. <member name="M:log4net.Core.LoggingEvent.GetProperties">
  13538. <summary>
  13539. Get all the composite properties in this event
  13540. </summary>
  13541. <returns>the <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the properties</returns>
  13542. <remarks>
  13543. <para>
  13544. See <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> for details of the composite properties
  13545. stored by the event.
  13546. </para>
  13547. <para>
  13548. This method returns a single <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the
  13549. properties defined for this event.
  13550. </para>
  13551. </remarks>
  13552. </member>
  13553. <member name="F:log4net.Core.LoggingEvent.m_data">
  13554. <summary>
  13555. The internal logging event data.
  13556. </summary>
  13557. </member>
  13558. <member name="F:log4net.Core.LoggingEvent.m_compositeProperties">
  13559. <summary>
  13560. The internal logging event data.
  13561. </summary>
  13562. </member>
  13563. <member name="F:log4net.Core.LoggingEvent.m_eventProperties">
  13564. <summary>
  13565. The internal logging event data.
  13566. </summary>
  13567. </member>
  13568. <member name="F:log4net.Core.LoggingEvent.m_callerStackBoundaryDeclaringType">
  13569. <summary>
  13570. The fully qualified Type of the calling
  13571. logger class in the stack frame (i.e. the declaring type of the method).
  13572. </summary>
  13573. </member>
  13574. <member name="F:log4net.Core.LoggingEvent.m_message">
  13575. <summary>
  13576. The application supplied message of logging event.
  13577. </summary>
  13578. </member>
  13579. <member name="F:log4net.Core.LoggingEvent.m_thrownException">
  13580. <summary>
  13581. The exception that was thrown.
  13582. </summary>
  13583. <remarks>
  13584. This is not serialized. The string representation
  13585. is serialized instead.
  13586. </remarks>
  13587. </member>
  13588. <member name="F:log4net.Core.LoggingEvent.m_repository">
  13589. <summary>
  13590. The repository that generated the logging event
  13591. </summary>
  13592. <remarks>
  13593. This is not serialized.
  13594. </remarks>
  13595. </member>
  13596. <member name="F:log4net.Core.LoggingEvent.m_fixFlags">
  13597. <summary>
  13598. The fix state for this event
  13599. </summary>
  13600. <remarks>
  13601. These flags indicate which fields have been fixed.
  13602. Not serialized.
  13603. </remarks>
  13604. </member>
  13605. <member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable">
  13606. <summary>
  13607. Indicated that the internal cache is updateable (ie not fixed)
  13608. </summary>
  13609. <remarks>
  13610. This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler
  13611. changes in the caching strategy.
  13612. </remarks>
  13613. </member>
  13614. <member name="F:log4net.Core.LoggingEvent.HostNameProperty">
  13615. <summary>
  13616. The key into the Properties map for the host name value.
  13617. </summary>
  13618. </member>
  13619. <member name="F:log4net.Core.LoggingEvent.IdentityProperty">
  13620. <summary>
  13621. The key into the Properties map for the thread identity value.
  13622. </summary>
  13623. </member>
  13624. <member name="F:log4net.Core.LoggingEvent.UserNameProperty">
  13625. <summary>
  13626. The key into the Properties map for the user name value.
  13627. </summary>
  13628. </member>
  13629. <member name="T:log4net.Core.LogImpl">
  13630. <summary>
  13631. Implementation of <see cref="T:log4net.ILog"/> wrapper interface.
  13632. </summary>
  13633. <remarks>
  13634. <para>
  13635. This implementation of the <see cref="T:log4net.ILog"/> interface
  13636. forwards to the <see cref="T:log4net.Core.ILogger"/> held by the base class.
  13637. </para>
  13638. <para>
  13639. This logger has methods to allow the caller to log at the following
  13640. levels:
  13641. </para>
  13642. <list type="definition">
  13643. <item>
  13644. <term>DEBUG</term>
  13645. <description>
  13646. The <see cref="M:Debug(object)"/> and <see cref="M:DebugFormat(string, object[])"/> methods log messages
  13647. at the <c>DEBUG</c> level. That is the level with that name defined in the
  13648. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13649. for this level is <see cref="F:log4net.Core.Level.Debug"/>. The <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  13650. property tests if this level is enabled for logging.
  13651. </description>
  13652. </item>
  13653. <item>
  13654. <term>INFO</term>
  13655. <description>
  13656. The <see cref="M:Info(object)"/> and <see cref="M:InfoFormat(string, object[])"/> methods log messages
  13657. at the <c>INFO</c> level. That is the level with that name defined in the
  13658. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13659. for this level is <see cref="F:log4net.Core.Level.Info"/>. The <see cref="P:log4net.Core.LogImpl.IsInfoEnabled"/>
  13660. property tests if this level is enabled for logging.
  13661. </description>
  13662. </item>
  13663. <item>
  13664. <term>WARN</term>
  13665. <description>
  13666. The <see cref="M:Warn(object)"/> and <see cref="M:WarnFormat(string, object[])"/> methods log messages
  13667. at the <c>WARN</c> level. That is the level with that name defined in the
  13668. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13669. for this level is <see cref="F:log4net.Core.Level.Warn"/>. The <see cref="P:log4net.Core.LogImpl.IsWarnEnabled"/>
  13670. property tests if this level is enabled for logging.
  13671. </description>
  13672. </item>
  13673. <item>
  13674. <term>ERROR</term>
  13675. <description>
  13676. The <see cref="M:Error(object)"/> and <see cref="M:ErrorFormat(string, object[])"/> methods log messages
  13677. at the <c>ERROR</c> level. That is the level with that name defined in the
  13678. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13679. for this level is <see cref="F:log4net.Core.Level.Error"/>. The <see cref="P:log4net.Core.LogImpl.IsErrorEnabled"/>
  13680. property tests if this level is enabled for logging.
  13681. </description>
  13682. </item>
  13683. <item>
  13684. <term>FATAL</term>
  13685. <description>
  13686. The <see cref="M:Fatal(object)"/> and <see cref="M:FatalFormat(string, object[])"/> methods log messages
  13687. at the <c>FATAL</c> level. That is the level with that name defined in the
  13688. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13689. for this level is <see cref="F:log4net.Core.Level.Fatal"/>. The <see cref="P:log4net.Core.LogImpl.IsFatalEnabled"/>
  13690. property tests if this level is enabled for logging.
  13691. </description>
  13692. </item>
  13693. </list>
  13694. <para>
  13695. The values for these levels and their semantic meanings can be changed by
  13696. configuring the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> for the repository.
  13697. </para>
  13698. </remarks>
  13699. <author>Nicko Cadell</author>
  13700. <author>Gert Driesen</author>
  13701. </member>
  13702. <member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)">
  13703. <summary>
  13704. Construct a new wrapper for the specified logger.
  13705. </summary>
  13706. <param name="logger">The logger to wrap.</param>
  13707. <remarks>
  13708. <para>
  13709. Construct a new wrapper for the specified logger.
  13710. </para>
  13711. </remarks>
  13712. </member>
  13713. <member name="M:log4net.Core.LogImpl.ReloadLevels(log4net.Repository.ILoggerRepository)">
  13714. <summary>
  13715. Virtual method called when the configuration of the repository changes
  13716. </summary>
  13717. <param name="repository">the repository holding the levels</param>
  13718. <remarks>
  13719. <para>
  13720. Virtual method called when the configuration of the repository changes
  13721. </para>
  13722. </remarks>
  13723. </member>
  13724. <member name="M:log4net.Core.LogImpl.Debug(System.Object)">
  13725. <summary>
  13726. Logs a message object with the <c>DEBUG</c> level.
  13727. </summary>
  13728. <param name="message">The message object to log.</param>
  13729. <remarks>
  13730. <para>
  13731. This method first checks if this logger is <c>DEBUG</c>
  13732. enabled by comparing the level of this logger with the
  13733. <c>DEBUG</c> level. If this logger is
  13734. <c>DEBUG</c> enabled, then it converts the message object
  13735. (passed as parameter) to a string by invoking the appropriate
  13736. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13737. proceeds to call all the registered appenders in this logger
  13738. and also higher in the hierarchy depending on the value of the
  13739. additivity flag.
  13740. </para>
  13741. <para>
  13742. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13743. to this method will print the name of the <see cref="T:System.Exception"/>
  13744. but no stack trace. To print a stack trace use the
  13745. <see cref="M:Debug(object,Exception)"/> form instead.
  13746. </para>
  13747. </remarks>
  13748. </member>
  13749. <member name="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)">
  13750. <summary>
  13751. Logs a message object with the <c>DEBUG</c> level
  13752. </summary>
  13753. <param name="message">The message object to log.</param>
  13754. <param name="exception">The exception to log, including its stack trace.</param>
  13755. <remarks>
  13756. <para>
  13757. Logs a message object with the <c>DEBUG</c> level including
  13758. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> passed
  13759. as a parameter.
  13760. </para>
  13761. <para>
  13762. See the <see cref="M:Debug(object)"/> form for more detailed information.
  13763. </para>
  13764. </remarks>
  13765. <seealso cref="M:Debug(object)"/>
  13766. </member>
  13767. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
  13768. <summary>
  13769. Logs a formatted message string with the <c>DEBUG</c> level.
  13770. </summary>
  13771. <param name="format">A String containing zero or more format items</param>
  13772. <param name="args">An Object array containing zero or more objects to format</param>
  13773. <remarks>
  13774. <para>
  13775. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13776. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13777. of the formatting.
  13778. </para>
  13779. <para>
  13780. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13781. format provider. To specify a localized provider use the
  13782. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  13783. </para>
  13784. <para>
  13785. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13786. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  13787. methods instead.
  13788. </para>
  13789. </remarks>
  13790. </member>
  13791. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)">
  13792. <summary>
  13793. Logs a formatted message string with the <c>DEBUG</c> level.
  13794. </summary>
  13795. <param name="format">A String containing zero or more format items</param>
  13796. <param name="arg0">An Object to format</param>
  13797. <remarks>
  13798. <para>
  13799. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13800. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13801. of the formatting.
  13802. </para>
  13803. <para>
  13804. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13805. format provider. To specify a localized provider use the
  13806. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  13807. </para>
  13808. <para>
  13809. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13810. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  13811. methods instead.
  13812. </para>
  13813. </remarks>
  13814. </member>
  13815. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)">
  13816. <summary>
  13817. Logs a formatted message string with the <c>DEBUG</c> level.
  13818. </summary>
  13819. <param name="format">A String containing zero or more format items</param>
  13820. <param name="arg0">An Object to format</param>
  13821. <param name="arg1">An Object to format</param>
  13822. <remarks>
  13823. <para>
  13824. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13825. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13826. of the formatting.
  13827. </para>
  13828. <para>
  13829. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13830. format provider. To specify a localized provider use the
  13831. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  13832. </para>
  13833. <para>
  13834. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13835. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  13836. methods instead.
  13837. </para>
  13838. </remarks>
  13839. </member>
  13840. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  13841. <summary>
  13842. Logs a formatted message string with the <c>DEBUG</c> level.
  13843. </summary>
  13844. <param name="format">A String containing zero or more format items</param>
  13845. <param name="arg0">An Object to format</param>
  13846. <param name="arg1">An Object to format</param>
  13847. <param name="arg2">An Object to format</param>
  13848. <remarks>
  13849. <para>
  13850. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13851. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13852. of the formatting.
  13853. </para>
  13854. <para>
  13855. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13856. format provider. To specify a localized provider use the
  13857. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  13858. </para>
  13859. <para>
  13860. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13861. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  13862. methods instead.
  13863. </para>
  13864. </remarks>
  13865. </member>
  13866. <member name="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  13867. <summary>
  13868. Logs a formatted message string with the <c>DEBUG</c> level.
  13869. </summary>
  13870. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  13871. <param name="format">A String containing zero or more format items</param>
  13872. <param name="args">An Object array containing zero or more objects to format</param>
  13873. <remarks>
  13874. <para>
  13875. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13876. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13877. of the formatting.
  13878. </para>
  13879. <para>
  13880. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13881. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  13882. methods instead.
  13883. </para>
  13884. </remarks>
  13885. </member>
  13886. <member name="M:log4net.Core.LogImpl.Info(System.Object)">
  13887. <summary>
  13888. Logs a message object with the <c>INFO</c> level.
  13889. </summary>
  13890. <param name="message">The message object to log.</param>
  13891. <remarks>
  13892. <para>
  13893. This method first checks if this logger is <c>INFO</c>
  13894. enabled by comparing the level of this logger with the
  13895. <c>INFO</c> level. If this logger is
  13896. <c>INFO</c> enabled, then it converts the message object
  13897. (passed as parameter) to a string by invoking the appropriate
  13898. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13899. proceeds to call all the registered appenders in this logger
  13900. and also higher in the hierarchy depending on the value of
  13901. the additivity flag.
  13902. </para>
  13903. <para>
  13904. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13905. to this method will print the name of the <see cref="T:System.Exception"/>
  13906. but no stack trace. To print a stack trace use the
  13907. <see cref="M:Info(object,Exception)"/> form instead.
  13908. </para>
  13909. </remarks>
  13910. </member>
  13911. <member name="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)">
  13912. <summary>
  13913. Logs a message object with the <c>INFO</c> level.
  13914. </summary>
  13915. <param name="message">The message object to log.</param>
  13916. <param name="exception">The exception to log, including its stack trace.</param>
  13917. <remarks>
  13918. <para>
  13919. Logs a message object with the <c>INFO</c> level including
  13920. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  13921. passed as a parameter.
  13922. </para>
  13923. <para>
  13924. See the <see cref="M:Info(object)"/> form for more detailed information.
  13925. </para>
  13926. </remarks>
  13927. <seealso cref="M:Info(object)"/>
  13928. </member>
  13929. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])">
  13930. <summary>
  13931. Logs a formatted message string with the <c>INFO</c> level.
  13932. </summary>
  13933. <param name="format">A String containing zero or more format items</param>
  13934. <param name="args">An Object array containing zero or more objects to format</param>
  13935. <remarks>
  13936. <para>
  13937. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13938. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13939. of the formatting.
  13940. </para>
  13941. <para>
  13942. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13943. format provider. To specify a localized provider use the
  13944. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  13945. </para>
  13946. <para>
  13947. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13948. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  13949. methods instead.
  13950. </para>
  13951. </remarks>
  13952. </member>
  13953. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)">
  13954. <summary>
  13955. Logs a formatted message string with the <c>INFO</c> level.
  13956. </summary>
  13957. <param name="format">A String containing zero or more format items</param>
  13958. <param name="arg0">An Object to format</param>
  13959. <remarks>
  13960. <para>
  13961. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13962. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13963. of the formatting.
  13964. </para>
  13965. <para>
  13966. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13967. format provider. To specify a localized provider use the
  13968. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  13969. </para>
  13970. <para>
  13971. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13972. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  13973. methods instead.
  13974. </para>
  13975. </remarks>
  13976. </member>
  13977. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)">
  13978. <summary>
  13979. Logs a formatted message string with the <c>INFO</c> level.
  13980. </summary>
  13981. <param name="format">A String containing zero or more format items</param>
  13982. <param name="arg0">An Object to format</param>
  13983. <param name="arg1">An Object to format</param>
  13984. <remarks>
  13985. <para>
  13986. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13987. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13988. of the formatting.
  13989. </para>
  13990. <para>
  13991. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13992. format provider. To specify a localized provider use the
  13993. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  13994. </para>
  13995. <para>
  13996. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13997. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  13998. methods instead.
  13999. </para>
  14000. </remarks>
  14001. </member>
  14002. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  14003. <summary>
  14004. Logs a formatted message string with the <c>INFO</c> level.
  14005. </summary>
  14006. <param name="format">A String containing zero or more format items</param>
  14007. <param name="arg0">An Object to format</param>
  14008. <param name="arg1">An Object to format</param>
  14009. <param name="arg2">An Object to format</param>
  14010. <remarks>
  14011. <para>
  14012. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14013. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14014. of the formatting.
  14015. </para>
  14016. <para>
  14017. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14018. format provider. To specify a localized provider use the
  14019. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  14020. </para>
  14021. <para>
  14022. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14023. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14024. methods instead.
  14025. </para>
  14026. </remarks>
  14027. </member>
  14028. <member name="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  14029. <summary>
  14030. Logs a formatted message string with the <c>INFO</c> level.
  14031. </summary>
  14032. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14033. <param name="format">A String containing zero or more format items</param>
  14034. <param name="args">An Object array containing zero or more objects to format</param>
  14035. <remarks>
  14036. <para>
  14037. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14038. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14039. of the formatting.
  14040. </para>
  14041. <para>
  14042. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14043. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14044. methods instead.
  14045. </para>
  14046. </remarks>
  14047. </member>
  14048. <member name="M:log4net.Core.LogImpl.Warn(System.Object)">
  14049. <summary>
  14050. Logs a message object with the <c>WARN</c> level.
  14051. </summary>
  14052. <param name="message">the message object to log</param>
  14053. <remarks>
  14054. <para>
  14055. This method first checks if this logger is <c>WARN</c>
  14056. enabled by comparing the level of this logger with the
  14057. <c>WARN</c> level. If this logger is
  14058. <c>WARN</c> enabled, then it converts the message object
  14059. (passed as parameter) to a string by invoking the appropriate
  14060. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14061. proceeds to call all the registered appenders in this logger and
  14062. also higher in the hierarchy depending on the value of the
  14063. additivity flag.
  14064. </para>
  14065. <para>
  14066. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  14067. method will print the name of the <see cref="T:System.Exception"/> but no
  14068. stack trace. To print a stack trace use the
  14069. <see cref="M:Warn(object,Exception)"/> form instead.
  14070. </para>
  14071. </remarks>
  14072. </member>
  14073. <member name="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)">
  14074. <summary>
  14075. Logs a message object with the <c>WARN</c> level
  14076. </summary>
  14077. <param name="message">The message object to log.</param>
  14078. <param name="exception">The exception to log, including its stack trace.</param>
  14079. <remarks>
  14080. <para>
  14081. Logs a message object with the <c>WARN</c> level including
  14082. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14083. passed as a parameter.
  14084. </para>
  14085. <para>
  14086. See the <see cref="M:Warn(object)"/> form for more detailed information.
  14087. </para>
  14088. </remarks>
  14089. <seealso cref="M:Warn(object)"/>
  14090. </member>
  14091. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])">
  14092. <summary>
  14093. Logs a formatted message string with the <c>WARN</c> level.
  14094. </summary>
  14095. <param name="format">A String containing zero or more format items</param>
  14096. <param name="args">An Object array containing zero or more objects to format</param>
  14097. <remarks>
  14098. <para>
  14099. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14100. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14101. of the formatting.
  14102. </para>
  14103. <para>
  14104. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14105. format provider. To specify a localized provider use the
  14106. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14107. </para>
  14108. <para>
  14109. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14110. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14111. methods instead.
  14112. </para>
  14113. </remarks>
  14114. </member>
  14115. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)">
  14116. <summary>
  14117. Logs a formatted message string with the <c>WARN</c> level.
  14118. </summary>
  14119. <param name="format">A String containing zero or more format items</param>
  14120. <param name="arg0">An Object to format</param>
  14121. <remarks>
  14122. <para>
  14123. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14124. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14125. of the formatting.
  14126. </para>
  14127. <para>
  14128. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14129. format provider. To specify a localized provider use the
  14130. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14131. </para>
  14132. <para>
  14133. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14134. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14135. methods instead.
  14136. </para>
  14137. </remarks>
  14138. </member>
  14139. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)">
  14140. <summary>
  14141. Logs a formatted message string with the <c>WARN</c> level.
  14142. </summary>
  14143. <param name="format">A String containing zero or more format items</param>
  14144. <param name="arg0">An Object to format</param>
  14145. <param name="arg1">An Object to format</param>
  14146. <remarks>
  14147. <para>
  14148. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14149. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14150. of the formatting.
  14151. </para>
  14152. <para>
  14153. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14154. format provider. To specify a localized provider use the
  14155. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14156. </para>
  14157. <para>
  14158. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14159. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14160. methods instead.
  14161. </para>
  14162. </remarks>
  14163. </member>
  14164. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  14165. <summary>
  14166. Logs a formatted message string with the <c>WARN</c> level.
  14167. </summary>
  14168. <param name="format">A String containing zero or more format items</param>
  14169. <param name="arg0">An Object to format</param>
  14170. <param name="arg1">An Object to format</param>
  14171. <param name="arg2">An Object to format</param>
  14172. <remarks>
  14173. <para>
  14174. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14175. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14176. of the formatting.
  14177. </para>
  14178. <para>
  14179. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14180. format provider. To specify a localized provider use the
  14181. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14182. </para>
  14183. <para>
  14184. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14185. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14186. methods instead.
  14187. </para>
  14188. </remarks>
  14189. </member>
  14190. <member name="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  14191. <summary>
  14192. Logs a formatted message string with the <c>WARN</c> level.
  14193. </summary>
  14194. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14195. <param name="format">A String containing zero or more format items</param>
  14196. <param name="args">An Object array containing zero or more objects to format</param>
  14197. <remarks>
  14198. <para>
  14199. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14200. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14201. of the formatting.
  14202. </para>
  14203. <para>
  14204. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14205. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14206. methods instead.
  14207. </para>
  14208. </remarks>
  14209. </member>
  14210. <member name="M:log4net.Core.LogImpl.Error(System.Object)">
  14211. <summary>
  14212. Logs a message object with the <c>ERROR</c> level.
  14213. </summary>
  14214. <param name="message">The message object to log.</param>
  14215. <remarks>
  14216. <para>
  14217. This method first checks if this logger is <c>ERROR</c>
  14218. enabled by comparing the level of this logger with the
  14219. <c>ERROR</c> level. If this logger is
  14220. <c>ERROR</c> enabled, then it converts the message object
  14221. (passed as parameter) to a string by invoking the appropriate
  14222. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14223. proceeds to call all the registered appenders in this logger and
  14224. also higher in the hierarchy depending on the value of the
  14225. additivity flag.
  14226. </para>
  14227. <para>
  14228. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  14229. method will print the name of the <see cref="T:System.Exception"/> but no
  14230. stack trace. To print a stack trace use the
  14231. <see cref="M:Error(object,Exception)"/> form instead.
  14232. </para>
  14233. </remarks>
  14234. </member>
  14235. <member name="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)">
  14236. <summary>
  14237. Logs a message object with the <c>ERROR</c> level
  14238. </summary>
  14239. <param name="message">The message object to log.</param>
  14240. <param name="exception">The exception to log, including its stack trace.</param>
  14241. <remarks>
  14242. <para>
  14243. Logs a message object with the <c>ERROR</c> level including
  14244. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14245. passed as a parameter.
  14246. </para>
  14247. <para>
  14248. See the <see cref="M:Error(object)"/> form for more detailed information.
  14249. </para>
  14250. </remarks>
  14251. <seealso cref="M:Error(object)"/>
  14252. </member>
  14253. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])">
  14254. <summary>
  14255. Logs a formatted message string with the <c>ERROR</c> level.
  14256. </summary>
  14257. <param name="format">A String containing zero or more format items</param>
  14258. <param name="args">An Object array containing zero or more objects to format</param>
  14259. <remarks>
  14260. <para>
  14261. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14262. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14263. of the formatting.
  14264. </para>
  14265. <para>
  14266. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14267. format provider. To specify a localized provider use the
  14268. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14269. </para>
  14270. <para>
  14271. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14272. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14273. methods instead.
  14274. </para>
  14275. </remarks>
  14276. </member>
  14277. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)">
  14278. <summary>
  14279. Logs a formatted message string with the <c>ERROR</c> level.
  14280. </summary>
  14281. <param name="format">A String containing zero or more format items</param>
  14282. <param name="arg0">An Object to format</param>
  14283. <remarks>
  14284. <para>
  14285. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14286. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14287. of the formatting.
  14288. </para>
  14289. <para>
  14290. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14291. format provider. To specify a localized provider use the
  14292. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14293. </para>
  14294. <para>
  14295. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14296. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14297. methods instead.
  14298. </para>
  14299. </remarks>
  14300. </member>
  14301. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)">
  14302. <summary>
  14303. Logs a formatted message string with the <c>ERROR</c> level.
  14304. </summary>
  14305. <param name="format">A String containing zero or more format items</param>
  14306. <param name="arg0">An Object to format</param>
  14307. <param name="arg1">An Object to format</param>
  14308. <remarks>
  14309. <para>
  14310. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14311. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14312. of the formatting.
  14313. </para>
  14314. <para>
  14315. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14316. format provider. To specify a localized provider use the
  14317. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14318. </para>
  14319. <para>
  14320. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14321. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14322. methods instead.
  14323. </para>
  14324. </remarks>
  14325. </member>
  14326. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  14327. <summary>
  14328. Logs a formatted message string with the <c>ERROR</c> level.
  14329. </summary>
  14330. <param name="format">A String containing zero or more format items</param>
  14331. <param name="arg0">An Object to format</param>
  14332. <param name="arg1">An Object to format</param>
  14333. <param name="arg2">An Object to format</param>
  14334. <remarks>
  14335. <para>
  14336. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14337. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14338. of the formatting.
  14339. </para>
  14340. <para>
  14341. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14342. format provider. To specify a localized provider use the
  14343. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  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)"/>
  14348. methods instead.
  14349. </para>
  14350. </remarks>
  14351. </member>
  14352. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  14353. <summary>
  14354. Logs a formatted message string with the <c>ERROR</c> level.
  14355. </summary>
  14356. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14357. <param name="format">A String containing zero or more format items</param>
  14358. <param name="args">An Object array containing zero or more objects to format</param>
  14359. <remarks>
  14360. <para>
  14361. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14362. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14363. of the formatting.
  14364. </para>
  14365. <para>
  14366. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14367. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14368. methods instead.
  14369. </para>
  14370. </remarks>
  14371. </member>
  14372. <member name="M:log4net.Core.LogImpl.Fatal(System.Object)">
  14373. <summary>
  14374. Logs a message object with the <c>FATAL</c> level.
  14375. </summary>
  14376. <param name="message">The message object to log.</param>
  14377. <remarks>
  14378. <para>
  14379. This method first checks if this logger is <c>FATAL</c>
  14380. enabled by comparing the level of this logger with the
  14381. <c>FATAL</c> level. If this logger is
  14382. <c>FATAL</c> enabled, then it converts the message object
  14383. (passed as parameter) to a string by invoking the appropriate
  14384. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14385. proceeds to call all the registered appenders in this logger and
  14386. also higher in the hierarchy depending on the value of the
  14387. additivity flag.
  14388. </para>
  14389. <para>
  14390. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  14391. method will print the name of the <see cref="T:System.Exception"/> but no
  14392. stack trace. To print a stack trace use the
  14393. <see cref="M:Fatal(object,Exception)"/> form instead.
  14394. </para>
  14395. </remarks>
  14396. </member>
  14397. <member name="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)">
  14398. <summary>
  14399. Logs a message object with the <c>FATAL</c> level
  14400. </summary>
  14401. <param name="message">The message object to log.</param>
  14402. <param name="exception">The exception to log, including its stack trace.</param>
  14403. <remarks>
  14404. <para>
  14405. Logs a message object with the <c>FATAL</c> level including
  14406. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14407. passed as a parameter.
  14408. </para>
  14409. <para>
  14410. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  14411. </para>
  14412. </remarks>
  14413. <seealso cref="M:Fatal(object)"/>
  14414. </member>
  14415. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
  14416. <summary>
  14417. Logs a formatted message string with the <c>FATAL</c> level.
  14418. </summary>
  14419. <param name="format">A String containing zero or more format items</param>
  14420. <param name="args">An Object array containing zero or more objects to format</param>
  14421. <remarks>
  14422. <para>
  14423. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14424. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14425. of the formatting.
  14426. </para>
  14427. <para>
  14428. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14429. format provider. To specify a localized provider use the
  14430. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  14431. </para>
  14432. <para>
  14433. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14434. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14435. methods instead.
  14436. </para>
  14437. </remarks>
  14438. </member>
  14439. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)">
  14440. <summary>
  14441. Logs a formatted message string with the <c>FATAL</c> level.
  14442. </summary>
  14443. <param name="format">A String containing zero or more format items</param>
  14444. <param name="arg0">An Object to format</param>
  14445. <remarks>
  14446. <para>
  14447. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14448. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14449. of the formatting.
  14450. </para>
  14451. <para>
  14452. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14453. format provider. To specify a localized provider use the
  14454. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  14455. </para>
  14456. <para>
  14457. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14458. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14459. methods instead.
  14460. </para>
  14461. </remarks>
  14462. </member>
  14463. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)">
  14464. <summary>
  14465. Logs a formatted message string with the <c>FATAL</c> level.
  14466. </summary>
  14467. <param name="format">A String containing zero or more format items</param>
  14468. <param name="arg0">An Object to format</param>
  14469. <param name="arg1">An Object to format</param>
  14470. <remarks>
  14471. <para>
  14472. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14473. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14474. of the formatting.
  14475. </para>
  14476. <para>
  14477. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14478. format provider. To specify a localized provider use the
  14479. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  14480. </para>
  14481. <para>
  14482. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14483. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14484. methods instead.
  14485. </para>
  14486. </remarks>
  14487. </member>
  14488. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  14489. <summary>
  14490. Logs a formatted message string with the <c>FATAL</c> level.
  14491. </summary>
  14492. <param name="format">A String containing zero or more format items</param>
  14493. <param name="arg0">An Object to format</param>
  14494. <param name="arg1">An Object to format</param>
  14495. <param name="arg2">An Object to format</param>
  14496. <remarks>
  14497. <para>
  14498. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14499. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14500. of the formatting.
  14501. </para>
  14502. <para>
  14503. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14504. format provider. To specify a localized provider use the
  14505. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  14506. </para>
  14507. <para>
  14508. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14509. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14510. methods instead.
  14511. </para>
  14512. </remarks>
  14513. </member>
  14514. <member name="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  14515. <summary>
  14516. Logs a formatted message string with the <c>FATAL</c> level.
  14517. </summary>
  14518. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14519. <param name="format">A String containing zero or more format items</param>
  14520. <param name="args">An Object array containing zero or more objects to format</param>
  14521. <remarks>
  14522. <para>
  14523. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14524. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14525. of the formatting.
  14526. </para>
  14527. <para>
  14528. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14529. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14530. methods instead.
  14531. </para>
  14532. </remarks>
  14533. </member>
  14534. <member name="P:log4net.Core.LogImpl.IsDebugEnabled">
  14535. <summary>
  14536. Checks if this logger is enabled for the <c>DEBUG</c>
  14537. level.
  14538. </summary>
  14539. <value>
  14540. <c>true</c> if this logger is enabled for <c>DEBUG</c> events,
  14541. <c>false</c> otherwise.
  14542. </value>
  14543. <remarks>
  14544. <para>
  14545. This function is intended to lessen the computational cost of
  14546. disabled log debug statements.
  14547. </para>
  14548. <para>
  14549. For some <c>log</c> Logger object, when you write:
  14550. </para>
  14551. <code lang="C#">
  14552. log.Debug("This is entry number: " + i );
  14553. </code>
  14554. <para>
  14555. You incur the cost constructing the message, concatenation in
  14556. this case, regardless of whether the message is logged or not.
  14557. </para>
  14558. <para>
  14559. If you are worried about speed, then you should write:
  14560. </para>
  14561. <code lang="C#">
  14562. if (log.IsDebugEnabled())
  14563. {
  14564. log.Debug("This is entry number: " + i );
  14565. }
  14566. </code>
  14567. <para>
  14568. This way you will not incur the cost of parameter
  14569. construction if debugging is disabled for <c>log</c>. On
  14570. the other hand, if the <c>log</c> is debug enabled, you
  14571. will incur the cost of evaluating whether the logger is debug
  14572. enabled twice. Once in <c>IsDebugEnabled</c> and once in
  14573. the <c>Debug</c>. This is an insignificant overhead
  14574. since evaluating a logger takes about 1% of the time it
  14575. takes to actually log.
  14576. </para>
  14577. </remarks>
  14578. </member>
  14579. <member name="P:log4net.Core.LogImpl.IsInfoEnabled">
  14580. <summary>
  14581. Checks if this logger is enabled for the <c>INFO</c> level.
  14582. </summary>
  14583. <value>
  14584. <c>true</c> if this logger is enabled for <c>INFO</c> events,
  14585. <c>false</c> otherwise.
  14586. </value>
  14587. <remarks>
  14588. <para>
  14589. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  14590. of using this method.
  14591. </para>
  14592. </remarks>
  14593. <seealso cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  14594. </member>
  14595. <member name="P:log4net.Core.LogImpl.IsWarnEnabled">
  14596. <summary>
  14597. Checks if this logger is enabled for the <c>WARN</c> level.
  14598. </summary>
  14599. <value>
  14600. <c>true</c> if this logger is enabled for <c>WARN</c> events,
  14601. <c>false</c> otherwise.
  14602. </value>
  14603. <remarks>
  14604. <para>
  14605. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  14606. of using this method.
  14607. </para>
  14608. </remarks>
  14609. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14610. </member>
  14611. <member name="P:log4net.Core.LogImpl.IsErrorEnabled">
  14612. <summary>
  14613. Checks if this logger is enabled for the <c>ERROR</c> level.
  14614. </summary>
  14615. <value>
  14616. <c>true</c> if this logger is enabled for <c>ERROR</c> events,
  14617. <c>false</c> otherwise.
  14618. </value>
  14619. <remarks>
  14620. <para>
  14621. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  14622. </para>
  14623. </remarks>
  14624. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14625. </member>
  14626. <member name="P:log4net.Core.LogImpl.IsFatalEnabled">
  14627. <summary>
  14628. Checks if this logger is enabled for the <c>FATAL</c> level.
  14629. </summary>
  14630. <value>
  14631. <c>true</c> if this logger is enabled for <c>FATAL</c> events,
  14632. <c>false</c> otherwise.
  14633. </value>
  14634. <remarks>
  14635. <para>
  14636. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  14637. </para>
  14638. </remarks>
  14639. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14640. </member>
  14641. <member name="M:log4net.Core.LogImpl.LoggerRepositoryConfigurationChanged(System.Object,System.EventArgs)">
  14642. <summary>
  14643. Event handler for the <see cref="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"/> event
  14644. </summary>
  14645. <param name="sender">the repository</param>
  14646. <param name="e">Empty</param>
  14647. </member>
  14648. <member name="F:log4net.Core.LogImpl.ThisDeclaringType">
  14649. <summary>
  14650. The fully qualified name of this declaring type not the type of any subclass.
  14651. </summary>
  14652. </member>
  14653. <member name="T:log4net.Core.MethodItem">
  14654. <summary>
  14655. provides method information without actually referencing a System.Reflection.MethodBase
  14656. as that would require that the containing assembly is loaded.
  14657. </summary>
  14658. </member>
  14659. <member name="M:log4net.Core.MethodItem.#ctor">
  14660. <summary>
  14661. constructs a method item for an unknown method.
  14662. </summary>
  14663. </member>
  14664. <member name="M:log4net.Core.MethodItem.#ctor(System.String)">
  14665. <summary>
  14666. constructs a method item from the name of the method.
  14667. </summary>
  14668. <param name="name"></param>
  14669. </member>
  14670. <member name="M:log4net.Core.MethodItem.#ctor(System.String,System.String[])">
  14671. <summary>
  14672. constructs a method item from the name of the method and its parameters.
  14673. </summary>
  14674. <param name="name"></param>
  14675. <param name="parameters"></param>
  14676. </member>
  14677. <member name="M:log4net.Core.MethodItem.#ctor(System.Reflection.MethodBase)">
  14678. <summary>
  14679. constructs a method item from a method base by determining the method name and its parameters.
  14680. </summary>
  14681. <param name="methodBase"></param>
  14682. </member>
  14683. <member name="P:log4net.Core.MethodItem.Name">
  14684. <summary>
  14685. Gets the method name of the caller making the logging
  14686. request.
  14687. </summary>
  14688. <value>
  14689. The method name of the caller making the logging
  14690. request.
  14691. </value>
  14692. <remarks>
  14693. <para>
  14694. Gets the method name of the caller making the logging
  14695. request.
  14696. </para>
  14697. </remarks>
  14698. </member>
  14699. <member name="P:log4net.Core.MethodItem.Parameters">
  14700. <summary>
  14701. Gets the method parameters of the caller making
  14702. the logging request.
  14703. </summary>
  14704. <value>
  14705. The method parameters of the caller making
  14706. the logging request
  14707. </value>
  14708. <remarks>
  14709. <para>
  14710. Gets the method parameters of the caller making
  14711. the logging request.
  14712. </para>
  14713. </remarks>
  14714. </member>
  14715. <member name="F:log4net.Core.MethodItem.declaringType">
  14716. <summary>
  14717. The fully qualified type of the StackFrameItem class.
  14718. </summary>
  14719. <remarks>
  14720. Used by the internal logger to record the Type of the
  14721. log message.
  14722. </remarks>
  14723. </member>
  14724. <member name="F:log4net.Core.MethodItem.NA">
  14725. <summary>
  14726. When location information is not available the constant
  14727. <c>NA</c> is returned. Current value of this string
  14728. constant is <b>?</b>.
  14729. </summary>
  14730. </member>
  14731. <member name="T:log4net.Core.SecurityContext">
  14732. <summary>
  14733. A SecurityContext used by log4net when interacting with protected resources
  14734. </summary>
  14735. <remarks>
  14736. <para>
  14737. A SecurityContext used by log4net when interacting with protected resources
  14738. for example with operating system services. This can be used to impersonate
  14739. a principal that has been granted privileges on the system resources.
  14740. </para>
  14741. </remarks>
  14742. <author>Nicko Cadell</author>
  14743. </member>
  14744. <member name="M:log4net.Core.SecurityContext.Impersonate(System.Object)">
  14745. <summary>
  14746. Impersonate this SecurityContext
  14747. </summary>
  14748. <param name="state">State supplied by the caller</param>
  14749. <returns>An <see cref="T:System.IDisposable"/> instance that will
  14750. revoke the impersonation of this SecurityContext, or <c>null</c></returns>
  14751. <remarks>
  14752. <para>
  14753. Impersonate this security context. Further calls on the current
  14754. thread should now be made in the security context provided
  14755. by this object. When the <see cref="T:System.IDisposable"/> result
  14756. <see cref="M:System.IDisposable.Dispose"/> method is called the security
  14757. context of the thread should be reverted to the state it was in
  14758. before <see cref="M:log4net.Core.SecurityContext.Impersonate(System.Object)"/> was called.
  14759. </para>
  14760. </remarks>
  14761. </member>
  14762. <member name="T:log4net.Core.SecurityContextProvider">
  14763. <summary>
  14764. The <see cref="T:log4net.Core.SecurityContextProvider"/> providers default <see cref="T:log4net.Core.SecurityContext"/> instances.
  14765. </summary>
  14766. <remarks>
  14767. <para>
  14768. A configured component that interacts with potentially protected system
  14769. resources uses a <see cref="T:log4net.Core.SecurityContext"/> to provide the elevated
  14770. privileges required. If the <see cref="T:log4net.Core.SecurityContext"/> object has
  14771. been not been explicitly provided to the component then the component
  14772. will request one from this <see cref="T:log4net.Core.SecurityContextProvider"/>.
  14773. </para>
  14774. <para>
  14775. By default the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is
  14776. an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> which returns only
  14777. <see cref="T:log4net.Util.NullSecurityContext"/> objects. This is a reasonable default
  14778. where the privileges required are not know by the system.
  14779. </para>
  14780. <para>
  14781. This default behavior can be overridden by subclassing the <see cref="T:log4net.Core.SecurityContextProvider"/>
  14782. and overriding the <see cref="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"/> method to return
  14783. the desired <see cref="T:log4net.Core.SecurityContext"/> objects. The default provider
  14784. can be replaced by programmatically setting the value of the
  14785. <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> property.
  14786. </para>
  14787. <para>
  14788. An alternative is to use the <c>log4net.Config.SecurityContextProviderAttribute</c>
  14789. This attribute can be applied to an assembly in the same way as the
  14790. <c>log4net.Config.XmlConfiguratorAttribute"</c>. The attribute takes
  14791. the type to use as the <see cref="T:log4net.Core.SecurityContextProvider"/> as an argument.
  14792. </para>
  14793. </remarks>
  14794. <author>Nicko Cadell</author>
  14795. </member>
  14796. <member name="F:log4net.Core.SecurityContextProvider.s_defaultProvider">
  14797. <summary>
  14798. The default provider
  14799. </summary>
  14800. </member>
  14801. <member name="P:log4net.Core.SecurityContextProvider.DefaultProvider">
  14802. <summary>
  14803. Gets or sets the default SecurityContextProvider
  14804. </summary>
  14805. <value>
  14806. The default SecurityContextProvider
  14807. </value>
  14808. <remarks>
  14809. <para>
  14810. The default provider is used by configured components that
  14811. require a <see cref="T:log4net.Core.SecurityContext"/> and have not had one
  14812. given to them.
  14813. </para>
  14814. <para>
  14815. By default this is an instance of <see cref="T:log4net.Core.SecurityContextProvider"/>
  14816. that returns <see cref="T:log4net.Util.NullSecurityContext"/> objects.
  14817. </para>
  14818. <para>
  14819. The default provider can be set programmatically by setting
  14820. the value of this property to a sub class of <see cref="T:log4net.Core.SecurityContextProvider"/>
  14821. that has the desired behavior.
  14822. </para>
  14823. </remarks>
  14824. </member>
  14825. <member name="M:log4net.Core.SecurityContextProvider.#ctor">
  14826. <summary>
  14827. Protected default constructor to allow subclassing
  14828. </summary>
  14829. <remarks>
  14830. <para>
  14831. Protected default constructor to allow subclassing
  14832. </para>
  14833. </remarks>
  14834. </member>
  14835. <member name="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)">
  14836. <summary>
  14837. Create a SecurityContext for a consumer
  14838. </summary>
  14839. <param name="consumer">The consumer requesting the SecurityContext</param>
  14840. <returns>An impersonation context</returns>
  14841. <remarks>
  14842. <para>
  14843. The default implementation is to return a <see cref="T:log4net.Util.NullSecurityContext"/>.
  14844. </para>
  14845. <para>
  14846. Subclasses should override this method to provide their own
  14847. behavior.
  14848. </para>
  14849. </remarks>
  14850. </member>
  14851. <member name="T:log4net.Core.StackFrameItem">
  14852. <summary>
  14853. provides stack frame information without actually referencing a System.Diagnostics.StackFrame
  14854. as that would require that the containing assembly is loaded.
  14855. </summary>
  14856. </member>
  14857. <member name="M:log4net.Core.StackFrameItem.#ctor(System.Diagnostics.StackFrame)">
  14858. <summary>
  14859. returns a stack frame item from a stack frame. This
  14860. </summary>
  14861. <param name="frame"></param>
  14862. <returns></returns>
  14863. </member>
  14864. <member name="P:log4net.Core.StackFrameItem.ClassName">
  14865. <summary>
  14866. Gets the fully qualified class name of the caller making the logging
  14867. request.
  14868. </summary>
  14869. <value>
  14870. The fully qualified class name of the caller making the logging
  14871. request.
  14872. </value>
  14873. <remarks>
  14874. <para>
  14875. Gets the fully qualified class name of the caller making the logging
  14876. request.
  14877. </para>
  14878. </remarks>
  14879. </member>
  14880. <member name="P:log4net.Core.StackFrameItem.FileName">
  14881. <summary>
  14882. Gets the file name of the caller.
  14883. </summary>
  14884. <value>
  14885. The file name of the caller.
  14886. </value>
  14887. <remarks>
  14888. <para>
  14889. Gets the file name of the caller.
  14890. </para>
  14891. </remarks>
  14892. </member>
  14893. <member name="P:log4net.Core.StackFrameItem.LineNumber">
  14894. <summary>
  14895. Gets the line number of the caller.
  14896. </summary>
  14897. <value>
  14898. The line number of the caller.
  14899. </value>
  14900. <remarks>
  14901. <para>
  14902. Gets the line number of the caller.
  14903. </para>
  14904. </remarks>
  14905. </member>
  14906. <member name="P:log4net.Core.StackFrameItem.Method">
  14907. <summary>
  14908. Gets the method name of the caller.
  14909. </summary>
  14910. <value>
  14911. The method name of the caller.
  14912. </value>
  14913. <remarks>
  14914. <para>
  14915. Gets the method name of the caller.
  14916. </para>
  14917. </remarks>
  14918. </member>
  14919. <member name="P:log4net.Core.StackFrameItem.FullInfo">
  14920. <summary>
  14921. Gets all available caller information
  14922. </summary>
  14923. <value>
  14924. All available caller information, in the format
  14925. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  14926. </value>
  14927. <remarks>
  14928. <para>
  14929. Gets all available caller information, in the format
  14930. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  14931. </para>
  14932. </remarks>
  14933. </member>
  14934. <member name="F:log4net.Core.StackFrameItem.declaringType">
  14935. <summary>
  14936. The fully qualified type of the StackFrameItem class.
  14937. </summary>
  14938. <remarks>
  14939. Used by the internal logger to record the Type of the
  14940. log message.
  14941. </remarks>
  14942. </member>
  14943. <member name="F:log4net.Core.StackFrameItem.NA">
  14944. <summary>
  14945. When location information is not available the constant
  14946. <c>NA</c> is returned. Current value of this string
  14947. constant is <b>?</b>.
  14948. </summary>
  14949. </member>
  14950. <member name="T:log4net.Core.TimeEvaluator">
  14951. <summary>
  14952. An evaluator that triggers after specified number of seconds.
  14953. </summary>
  14954. <remarks>
  14955. <para>
  14956. This evaluator will trigger if the specified time period
  14957. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  14958. </para>
  14959. </remarks>
  14960. <author>Robert Sevcik</author>
  14961. </member>
  14962. <member name="F:log4net.Core.TimeEvaluator.m_interval">
  14963. <summary>
  14964. The time threshold for triggering in seconds. Zero means it won't trigger at all.
  14965. </summary>
  14966. </member>
  14967. <member name="F:log4net.Core.TimeEvaluator.m_lastTimeUtc">
  14968. <summary>
  14969. The UTC time of last check. This gets updated when the object is created and when the evaluator triggers.
  14970. </summary>
  14971. </member>
  14972. <member name="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL">
  14973. <summary>
  14974. The default time threshold for triggering in seconds. Zero means it won't trigger at all.
  14975. </summary>
  14976. </member>
  14977. <member name="M:log4net.Core.TimeEvaluator.#ctor">
  14978. <summary>
  14979. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  14980. </summary>
  14981. <remarks>
  14982. <para>
  14983. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  14984. </para>
  14985. <para>
  14986. This evaluator will trigger if the specified time period
  14987. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  14988. </para>
  14989. </remarks>
  14990. </member>
  14991. <member name="M:log4net.Core.TimeEvaluator.#ctor(System.Int32)">
  14992. <summary>
  14993. Create a new evaluator using the specified time threshold in seconds.
  14994. </summary>
  14995. <param name="interval">
  14996. The time threshold in seconds to trigger after.
  14997. Zero means it won't trigger at all.
  14998. </param>
  14999. <remarks>
  15000. <para>
  15001. Create a new evaluator using the specified time threshold in seconds.
  15002. </para>
  15003. <para>
  15004. This evaluator will trigger if the specified time period
  15005. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15006. </para>
  15007. </remarks>
  15008. </member>
  15009. <member name="P:log4net.Core.TimeEvaluator.Interval">
  15010. <summary>
  15011. The time threshold in seconds to trigger after
  15012. </summary>
  15013. <value>
  15014. The time threshold in seconds to trigger after.
  15015. Zero means it won't trigger at all.
  15016. </value>
  15017. <remarks>
  15018. <para>
  15019. This evaluator will trigger if the specified time period
  15020. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15021. </para>
  15022. </remarks>
  15023. </member>
  15024. <member name="M:log4net.Core.TimeEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  15025. <summary>
  15026. Is this <paramref name="loggingEvent"/> the triggering event?
  15027. </summary>
  15028. <param name="loggingEvent">The event to check</param>
  15029. <returns>This method returns <c>true</c>, if the specified time period
  15030. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check..
  15031. Otherwise it returns <c>false</c></returns>
  15032. <remarks>
  15033. <para>
  15034. This evaluator will trigger if the specified time period
  15035. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15036. </para>
  15037. </remarks>
  15038. </member>
  15039. <member name="T:log4net.Core.WrapperCreationHandler">
  15040. <summary>
  15041. Delegate used to handle creation of new wrappers.
  15042. </summary>
  15043. <param name="logger">The logger to wrap in a wrapper.</param>
  15044. <remarks>
  15045. <para>
  15046. Delegate used to handle creation of new wrappers. This delegate
  15047. is called from the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  15048. method to construct the wrapper for the specified logger.
  15049. </para>
  15050. <para>
  15051. The delegate to use is supplied to the <see cref="T:log4net.Core.WrapperMap"/>
  15052. constructor.
  15053. </para>
  15054. </remarks>
  15055. </member>
  15056. <member name="T:log4net.Core.WrapperMap">
  15057. <summary>
  15058. Maps between logger objects and wrapper objects.
  15059. </summary>
  15060. <remarks>
  15061. <para>
  15062. This class maintains a mapping between <see cref="T:log4net.Core.ILogger"/> objects and
  15063. <see cref="T:log4net.Core.ILoggerWrapper"/> objects. Use the <see cref="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"/> method to
  15064. lookup the <see cref="T:log4net.Core.ILoggerWrapper"/> for the specified <see cref="T:log4net.Core.ILogger"/>.
  15065. </para>
  15066. <para>
  15067. New wrapper instances are created by the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  15068. method. The default behavior is for this method to delegate construction
  15069. of the wrapper to the <see cref="T:log4net.Core.WrapperCreationHandler"/> delegate supplied
  15070. to the constructor. This allows specialization of the behavior without
  15071. requiring subclassing of this type.
  15072. </para>
  15073. </remarks>
  15074. <author>Nicko Cadell</author>
  15075. <author>Gert Driesen</author>
  15076. </member>
  15077. <member name="M:log4net.Core.WrapperMap.#ctor(log4net.Core.WrapperCreationHandler)">
  15078. <summary>
  15079. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap" />
  15080. </summary>
  15081. <param name="createWrapperHandler">The handler to use to create the wrapper objects.</param>
  15082. <remarks>
  15083. <para>
  15084. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap" /> class with
  15085. the specified handler to create the wrapper objects.
  15086. </para>
  15087. </remarks>
  15088. </member>
  15089. <member name="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)">
  15090. <summary>
  15091. Gets the wrapper object for the specified logger.
  15092. </summary>
  15093. <returns>The wrapper object for the specified logger</returns>
  15094. <remarks>
  15095. <para>
  15096. If the logger is null then the corresponding wrapper is null.
  15097. </para>
  15098. <para>
  15099. Looks up the wrapper it it has previously been requested and
  15100. returns it. If the wrapper has never been requested before then
  15101. the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> virtual method is
  15102. called.
  15103. </para>
  15104. </remarks>
  15105. </member>
  15106. <member name="P:log4net.Core.WrapperMap.Repositories">
  15107. <summary>
  15108. Gets the map of logger repositories.
  15109. </summary>
  15110. <value>
  15111. Map of logger repositories.
  15112. </value>
  15113. <remarks>
  15114. <para>
  15115. Gets the hashtable that is keyed on <see cref="T:log4net.Repository.ILoggerRepository"/>. The
  15116. values are hashtables keyed on <see cref="T:log4net.Core.ILogger"/> with the
  15117. value being the corresponding <see cref="T:log4net.Core.ILoggerWrapper"/>.
  15118. </para>
  15119. </remarks>
  15120. </member>
  15121. <member name="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)">
  15122. <summary>
  15123. Creates the wrapper object for the specified logger.
  15124. </summary>
  15125. <param name="logger">The logger to wrap in a wrapper.</param>
  15126. <returns>The wrapper object for the logger.</returns>
  15127. <remarks>
  15128. <para>
  15129. This implementation uses the <see cref="T:log4net.Core.WrapperCreationHandler"/>
  15130. passed to the constructor to create the wrapper. This method
  15131. can be overridden in a subclass.
  15132. </para>
  15133. </remarks>
  15134. </member>
  15135. <member name="M:log4net.Core.WrapperMap.RepositoryShutdown(log4net.Repository.ILoggerRepository)">
  15136. <summary>
  15137. Called when a monitored repository shutdown event is received.
  15138. </summary>
  15139. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down</param>
  15140. <remarks>
  15141. <para>
  15142. This method is called when a <see cref="T:log4net.Repository.ILoggerRepository"/> that this
  15143. <see cref="T:log4net.Core.WrapperMap"/> is holding loggers for has signaled its shutdown
  15144. event <see cref="E:log4net.Repository.ILoggerRepository.ShutdownEvent"/>. The default
  15145. behavior of this method is to release the references to the loggers
  15146. and their wrappers generated for this repository.
  15147. </para>
  15148. </remarks>
  15149. </member>
  15150. <member name="M:log4net.Core.WrapperMap.ILoggerRepository_Shutdown(System.Object,System.EventArgs)">
  15151. <summary>
  15152. Event handler for repository shutdown event.
  15153. </summary>
  15154. <param name="sender">The sender of the event.</param>
  15155. <param name="e">The event args.</param>
  15156. </member>
  15157. <member name="F:log4net.Core.WrapperMap.m_repositories">
  15158. <summary>
  15159. Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings
  15160. </summary>
  15161. </member>
  15162. <member name="F:log4net.Core.WrapperMap.m_createWrapperHandler">
  15163. <summary>
  15164. The handler to use to create the extension wrapper objects.
  15165. </summary>
  15166. </member>
  15167. <member name="F:log4net.Core.WrapperMap.m_shutdownHandler">
  15168. <summary>
  15169. Internal reference to the delegate used to register for repository shutdown events.
  15170. </summary>
  15171. </member>
  15172. <member name="T:log4net.DateFormatter.AbsoluteTimeDateFormatter">
  15173. <summary>
  15174. Formats a <see cref="T:System.DateTime"/> as <c>"HH:mm:ss,fff"</c>.
  15175. </summary>
  15176. <remarks>
  15177. <para>
  15178. Formats a <see cref="T:System.DateTime"/> in the format <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  15179. </para>
  15180. </remarks>
  15181. <author>Nicko Cadell</author>
  15182. <author>Gert Driesen</author>
  15183. </member>
  15184. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  15185. <summary>
  15186. Renders the date into a string. Format is <c>"HH:mm:ss"</c>.
  15187. </summary>
  15188. <param name="dateToFormat">The date to render into a string.</param>
  15189. <param name="buffer">The string builder to write to.</param>
  15190. <remarks>
  15191. <para>
  15192. Subclasses should override this method to render the date
  15193. into a string using a precision up to the second. This method
  15194. will be called at most once per second and the result will be
  15195. reused if it is needed again during the same second.
  15196. </para>
  15197. </remarks>
  15198. </member>
  15199. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  15200. <summary>
  15201. Renders the date into a string. Format is "HH:mm:ss,fff".
  15202. </summary>
  15203. <param name="dateToFormat">The date to render into a string.</param>
  15204. <param name="writer">The writer to write to.</param>
  15205. <remarks>
  15206. <para>
  15207. Uses the <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> method to generate the
  15208. time string up to the seconds and then appends the current
  15209. milliseconds. The results from <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> are
  15210. cached and <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> is called at most once
  15211. per second.
  15212. </para>
  15213. <para>
  15214. Sub classes should override <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/>
  15215. rather than <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/>.
  15216. </para>
  15217. </remarks>
  15218. </member>
  15219. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.AbsoluteTimeDateFormat">
  15220. <summary>
  15221. String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is <b>ABSOLUTE</b>.
  15222. </summary>
  15223. </member>
  15224. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.DateAndTimeDateFormat">
  15225. <summary>
  15226. String constant used to specify DateTimeDateFormat in layouts. Current value is <b>DATE</b>.
  15227. </summary>
  15228. </member>
  15229. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.Iso8601TimeDateFormat">
  15230. <summary>
  15231. String constant used to specify ISO8601DateFormat in layouts. Current value is <b>ISO8601</b>.
  15232. </summary>
  15233. </member>
  15234. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeToTheSecond">
  15235. <summary>
  15236. Last stored time with precision up to the second.
  15237. </summary>
  15238. </member>
  15239. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeBuf">
  15240. <summary>
  15241. Last stored time with precision up to the second, formatted
  15242. as a string.
  15243. </summary>
  15244. </member>
  15245. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeStrings">
  15246. <summary>
  15247. Last stored time with precision up to the second, formatted
  15248. as a string.
  15249. </summary>
  15250. </member>
  15251. <member name="T:log4net.DateFormatter.DateTimeDateFormatter">
  15252. <summary>
  15253. Formats a <see cref="T:System.DateTime"/> as <c>"dd MMM yyyy HH:mm:ss,fff"</c>
  15254. </summary>
  15255. <remarks>
  15256. <para>
  15257. Formats a <see cref="T:System.DateTime"/> in the format
  15258. <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example,
  15259. <c>"06 Nov 1994 15:49:37,459"</c>.
  15260. </para>
  15261. </remarks>
  15262. <author>Nicko Cadell</author>
  15263. <author>Gert Driesen</author>
  15264. <author>Angelika Schnagl</author>
  15265. </member>
  15266. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.#ctor">
  15267. <summary>
  15268. Default constructor.
  15269. </summary>
  15270. <remarks>
  15271. <para>
  15272. Initializes a new instance of the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter" /> class.
  15273. </para>
  15274. </remarks>
  15275. </member>
  15276. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  15277. <summary>
  15278. Formats the date without the milliseconds part
  15279. </summary>
  15280. <param name="dateToFormat">The date to format.</param>
  15281. <param name="buffer">The string builder to write to.</param>
  15282. <remarks>
  15283. <para>
  15284. Formats a DateTime in the format <c>"dd MMM yyyy HH:mm:ss"</c>
  15285. for example, <c>"06 Nov 1994 15:49:37"</c>.
  15286. </para>
  15287. <para>
  15288. The base class will append the <c>",fff"</c> milliseconds section.
  15289. This method will only be called at most once per second.
  15290. </para>
  15291. </remarks>
  15292. </member>
  15293. <member name="F:log4net.DateFormatter.DateTimeDateFormatter.m_dateTimeFormatInfo">
  15294. <summary>
  15295. The format info for the invariant culture.
  15296. </summary>
  15297. </member>
  15298. <member name="T:log4net.DateFormatter.IDateFormatter">
  15299. <summary>
  15300. Render a <see cref="T:System.DateTime"/> as a string.
  15301. </summary>
  15302. <remarks>
  15303. <para>
  15304. Interface to abstract the rendering of a <see cref="T:System.DateTime"/>
  15305. instance into a string.
  15306. </para>
  15307. <para>
  15308. The <see cref="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/> method is used to render the
  15309. date to a text writer.
  15310. </para>
  15311. </remarks>
  15312. <author>Nicko Cadell</author>
  15313. <author>Gert Driesen</author>
  15314. </member>
  15315. <member name="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  15316. <summary>
  15317. Formats the specified date as a string.
  15318. </summary>
  15319. <param name="dateToFormat">The date to format.</param>
  15320. <param name="writer">The writer to write to.</param>
  15321. <remarks>
  15322. <para>
  15323. Format the <see cref="T:System.DateTime"/> as a string and write it
  15324. to the <see cref="T:System.IO.TextWriter"/> provided.
  15325. </para>
  15326. </remarks>
  15327. </member>
  15328. <member name="T:log4net.DateFormatter.Iso8601DateFormatter">
  15329. <summary>
  15330. Formats the <see cref="T:System.DateTime"/> as <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  15331. </summary>
  15332. <remarks>
  15333. <para>
  15334. Formats the <see cref="T:System.DateTime"/> specified as a string: <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  15335. </para>
  15336. </remarks>
  15337. <author>Nicko Cadell</author>
  15338. <author>Gert Driesen</author>
  15339. </member>
  15340. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.#ctor">
  15341. <summary>
  15342. Default constructor
  15343. </summary>
  15344. <remarks>
  15345. <para>
  15346. Initializes a new instance of the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter" /> class.
  15347. </para>
  15348. </remarks>
  15349. </member>
  15350. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  15351. <summary>
  15352. Formats the date without the milliseconds part
  15353. </summary>
  15354. <param name="dateToFormat">The date to format.</param>
  15355. <param name="buffer">The string builder to write to.</param>
  15356. <remarks>
  15357. <para>
  15358. Formats the date specified as a string: <c>"yyyy-MM-dd HH:mm:ss"</c>.
  15359. </para>
  15360. <para>
  15361. The base class will append the <c>",fff"</c> milliseconds section.
  15362. This method will only be called at most once per second.
  15363. </para>
  15364. </remarks>
  15365. </member>
  15366. <member name="T:log4net.DateFormatter.SimpleDateFormatter">
  15367. <summary>
  15368. Formats the <see cref="T:System.DateTime"/> using the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  15369. </summary>
  15370. <remarks>
  15371. <para>
  15372. Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  15373. </para>
  15374. </remarks>
  15375. <author>Nicko Cadell</author>
  15376. <author>Gert Driesen</author>
  15377. </member>
  15378. <member name="M:log4net.DateFormatter.SimpleDateFormatter.#ctor(System.String)">
  15379. <summary>
  15380. Constructor
  15381. </summary>
  15382. <param name="format">The format string.</param>
  15383. <remarks>
  15384. <para>
  15385. Initializes a new instance of the <see cref="T:log4net.DateFormatter.SimpleDateFormatter" /> class
  15386. with the specified format string.
  15387. </para>
  15388. <para>
  15389. The format string must be compatible with the options
  15390. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  15391. </para>
  15392. </remarks>
  15393. </member>
  15394. <member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  15395. <summary>
  15396. Formats the date using <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  15397. </summary>
  15398. <param name="dateToFormat">The date to convert to a string.</param>
  15399. <param name="writer">The writer to write to.</param>
  15400. <remarks>
  15401. <para>
  15402. Uses the date format string supplied to the constructor to call
  15403. the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method to format the date.
  15404. </para>
  15405. </remarks>
  15406. </member>
  15407. <member name="F:log4net.DateFormatter.SimpleDateFormatter.m_formatString">
  15408. <summary>
  15409. The format string used to format the <see cref="T:System.DateTime" />.
  15410. </summary>
  15411. <remarks>
  15412. <para>
  15413. The format string must be compatible with the options
  15414. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  15415. </para>
  15416. </remarks>
  15417. </member>
  15418. <member name="T:log4net.Filter.DenyAllFilter">
  15419. <summary>
  15420. This filter drops all <see cref="T:log4net.Core.LoggingEvent"/>.
  15421. </summary>
  15422. <remarks>
  15423. <para>
  15424. You can add this filter to the end of a filter chain to
  15425. switch from the default "accept all unless instructed otherwise"
  15426. filtering behavior to a "deny all unless instructed otherwise"
  15427. behavior.
  15428. </para>
  15429. </remarks>
  15430. <author>Nicko Cadell</author>
  15431. <author>Gert Driesen</author>
  15432. </member>
  15433. <member name="M:log4net.Filter.DenyAllFilter.#ctor">
  15434. <summary>
  15435. Default constructor
  15436. </summary>
  15437. </member>
  15438. <member name="M:log4net.Filter.DenyAllFilter.Decide(log4net.Core.LoggingEvent)">
  15439. <summary>
  15440. Always returns the integer constant <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  15441. </summary>
  15442. <param name="loggingEvent">the LoggingEvent to filter</param>
  15443. <returns>Always returns <see cref="F:log4net.Filter.FilterDecision.Deny"/></returns>
  15444. <remarks>
  15445. <para>
  15446. Ignores the event being logged and just returns
  15447. <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This can be used to change the default filter
  15448. chain behavior from <see cref="F:log4net.Filter.FilterDecision.Accept"/> to <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This filter
  15449. should only be used as the last filter in the chain
  15450. as any further filters will be ignored!
  15451. </para>
  15452. </remarks>
  15453. </member>
  15454. <member name="T:log4net.Filter.FilterDecision">
  15455. <summary>
  15456. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  15457. </summary>
  15458. <remarks>
  15459. <para>
  15460. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  15461. </para>
  15462. </remarks>
  15463. </member>
  15464. <member name="F:log4net.Filter.FilterDecision.Deny">
  15465. <summary>
  15466. The log event must be dropped immediately without
  15467. consulting with the remaining filters, if any, in the chain.
  15468. </summary>
  15469. </member>
  15470. <member name="F:log4net.Filter.FilterDecision.Neutral">
  15471. <summary>
  15472. This filter is neutral with respect to the log event.
  15473. The remaining filters, if any, should be consulted for a final decision.
  15474. </summary>
  15475. </member>
  15476. <member name="F:log4net.Filter.FilterDecision.Accept">
  15477. <summary>
  15478. The log event must be logged immediately without
  15479. consulting with the remaining filters, if any, in the chain.
  15480. </summary>
  15481. </member>
  15482. <member name="T:log4net.Filter.FilterSkeleton">
  15483. <summary>
  15484. Subclass this type to implement customized logging event filtering
  15485. </summary>
  15486. <remarks>
  15487. <para>
  15488. Users should extend this class to implement customized logging
  15489. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  15490. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  15491. appenders, have built-in filtering rules. It is suggested that you
  15492. first use and understand the built-in rules before rushing to write
  15493. your own custom filters.
  15494. </para>
  15495. <para>
  15496. This abstract class assumes and also imposes that filters be
  15497. organized in a linear chain. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/>
  15498. method of each filter is called sequentially, in the order of their
  15499. addition to the chain.
  15500. </para>
  15501. <para>
  15502. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> method must return one
  15503. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  15504. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  15505. </para>
  15506. <para>
  15507. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  15508. immediately without consulting with the remaining filters.
  15509. </para>
  15510. <para>
  15511. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  15512. in the chain is consulted. If there are no more filters in the
  15513. chain, then the log event is logged. Thus, in the presence of no
  15514. filters, the default behavior is to log all logging events.
  15515. </para>
  15516. <para>
  15517. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  15518. event is logged without consulting the remaining filters.
  15519. </para>
  15520. <para>
  15521. The philosophy of log4net filters is largely inspired from the
  15522. Linux ipchains.
  15523. </para>
  15524. </remarks>
  15525. <author>Nicko Cadell</author>
  15526. <author>Gert Driesen</author>
  15527. </member>
  15528. <member name="F:log4net.Filter.FilterSkeleton.m_next">
  15529. <summary>
  15530. Points to the next filter in the filter chain.
  15531. </summary>
  15532. <remarks>
  15533. <para>
  15534. See <see cref="P:log4net.Filter.FilterSkeleton.Next"/> for more information.
  15535. </para>
  15536. </remarks>
  15537. </member>
  15538. <member name="M:log4net.Filter.FilterSkeleton.ActivateOptions">
  15539. <summary>
  15540. Initialize the filter with the options set
  15541. </summary>
  15542. <remarks>
  15543. <para>
  15544. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  15545. activation scheme. The <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> method must
  15546. be called on this object after the configuration properties have
  15547. been set. Until <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> is called this
  15548. object is in an undefined state and must not be used.
  15549. </para>
  15550. <para>
  15551. If any of the configuration properties are modified then
  15552. <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> must be called again.
  15553. </para>
  15554. <para>
  15555. Typically filter's options become active immediately on set,
  15556. however this method must still be called.
  15557. </para>
  15558. </remarks>
  15559. </member>
  15560. <member name="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)">
  15561. <summary>
  15562. Decide if the <see cref="T:log4net.Core.LoggingEvent"/> should be logged through an appender.
  15563. </summary>
  15564. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> to decide upon</param>
  15565. <returns>The decision of the filter</returns>
  15566. <remarks>
  15567. <para>
  15568. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  15569. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  15570. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  15571. the event will be logged without consulting with other filters in
  15572. the chain.
  15573. </para>
  15574. <para>
  15575. This method is marked <c>abstract</c> and must be implemented
  15576. in a subclass.
  15577. </para>
  15578. </remarks>
  15579. </member>
  15580. <member name="P:log4net.Filter.FilterSkeleton.Next">
  15581. <summary>
  15582. Property to get and set the next filter
  15583. </summary>
  15584. <value>
  15585. The next filter in the chain
  15586. </value>
  15587. <remarks>
  15588. <para>
  15589. Filters are typically composed into chains. This property allows the next filter in
  15590. the chain to be accessed.
  15591. </para>
  15592. </remarks>
  15593. </member>
  15594. <member name="T:log4net.Filter.IFilter">
  15595. <summary>
  15596. Implement this interface to provide customized logging event filtering
  15597. </summary>
  15598. <remarks>
  15599. <para>
  15600. Users should implement this interface to implement customized logging
  15601. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  15602. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  15603. appenders, have built-in filtering rules. It is suggested that you
  15604. first use and understand the built-in rules before rushing to write
  15605. your own custom filters.
  15606. </para>
  15607. <para>
  15608. This abstract class assumes and also imposes that filters be
  15609. organized in a linear chain. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  15610. method of each filter is called sequentially, in the order of their
  15611. addition to the chain.
  15612. </para>
  15613. <para>
  15614. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> method must return one
  15615. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  15616. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  15617. </para>
  15618. <para>
  15619. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  15620. immediately without consulting with the remaining filters.
  15621. </para>
  15622. <para>
  15623. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  15624. in the chain is consulted. If there are no more filters in the
  15625. chain, then the log event is logged. Thus, in the presence of no
  15626. filters, the default behavior is to log all logging events.
  15627. </para>
  15628. <para>
  15629. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  15630. event is logged without consulting the remaining filters.
  15631. </para>
  15632. <para>
  15633. The philosophy of log4net filters is largely inspired from the
  15634. Linux ipchains.
  15635. </para>
  15636. </remarks>
  15637. <author>Nicko Cadell</author>
  15638. <author>Gert Driesen</author>
  15639. </member>
  15640. <member name="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)">
  15641. <summary>
  15642. Decide if the logging event should be logged through an appender.
  15643. </summary>
  15644. <param name="loggingEvent">The LoggingEvent to decide upon</param>
  15645. <returns>The decision of the filter</returns>
  15646. <remarks>
  15647. <para>
  15648. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  15649. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  15650. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  15651. the event will be logged without consulting with other filters in
  15652. the chain.
  15653. </para>
  15654. </remarks>
  15655. </member>
  15656. <member name="P:log4net.Filter.IFilter.Next">
  15657. <summary>
  15658. Property to get and set the next filter
  15659. </summary>
  15660. <value>
  15661. The next filter in the chain
  15662. </value>
  15663. <remarks>
  15664. <para>
  15665. Filters are typically composed into chains. This property allows the next filter in
  15666. the chain to be accessed.
  15667. </para>
  15668. </remarks>
  15669. </member>
  15670. <member name="T:log4net.Filter.LevelMatchFilter">
  15671. <summary>
  15672. This is a very simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  15673. </summary>
  15674. <remarks>
  15675. <para>
  15676. The filter admits two options <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> and
  15677. <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If there is an exact match between the value
  15678. of the <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> option and the <see cref="T:log4net.Core.Level"/> of the
  15679. <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
  15680. case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set
  15681. to <c>true</c>, if it is <c>false</c> then
  15682. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then
  15683. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  15684. </para>
  15685. </remarks>
  15686. <author>Nicko Cadell</author>
  15687. <author>Gert Driesen</author>
  15688. </member>
  15689. <member name="F:log4net.Filter.LevelMatchFilter.m_acceptOnMatch">
  15690. <summary>
  15691. flag to indicate if the filter should <see cref="F:log4net.Filter.FilterDecision.Accept"/> on a match
  15692. </summary>
  15693. </member>
  15694. <member name="F:log4net.Filter.LevelMatchFilter.m_levelToMatch">
  15695. <summary>
  15696. the <see cref="T:log4net.Core.Level"/> to match against
  15697. </summary>
  15698. </member>
  15699. <member name="M:log4net.Filter.LevelMatchFilter.#ctor">
  15700. <summary>
  15701. Default constructor
  15702. </summary>
  15703. </member>
  15704. <member name="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch">
  15705. <summary>
  15706. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/>
  15707. </summary>
  15708. <remarks>
  15709. <para>
  15710. The <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> property is a flag that determines
  15711. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  15712. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  15713. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  15714. </para>
  15715. <para>
  15716. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  15717. </para>
  15718. </remarks>
  15719. </member>
  15720. <member name="P:log4net.Filter.LevelMatchFilter.LevelToMatch">
  15721. <summary>
  15722. The <see cref="T:log4net.Core.Level"/> that the filter will match
  15723. </summary>
  15724. <remarks>
  15725. <para>
  15726. The level that this filter will attempt to match against the
  15727. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  15728. the result depends on the value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>.
  15729. </para>
  15730. </remarks>
  15731. </member>
  15732. <member name="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)">
  15733. <summary>
  15734. Tests if the <see cref="T:log4net.Core.Level"/> of the logging event matches that of the filter
  15735. </summary>
  15736. <param name="loggingEvent">the event to filter</param>
  15737. <returns>see remarks</returns>
  15738. <remarks>
  15739. <para>
  15740. If the <see cref="T:log4net.Core.Level"/> of the event matches the level of the
  15741. filter then the result of the function depends on the
  15742. value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then
  15743. the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it
  15744. will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then
  15745. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  15746. </para>
  15747. </remarks>
  15748. </member>
  15749. <member name="T:log4net.Filter.LevelRangeFilter">
  15750. <summary>
  15751. This is a simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  15752. </summary>
  15753. <remarks>
  15754. <para>
  15755. The filter admits three options <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  15756. that determine the range of priorities that are matched, and
  15757. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. If there is a match between the range
  15758. of priorities and the <see cref="T:log4net.Core.Level"/> of the <see cref="T:log4net.Core.LoggingEvent"/>, then the
  15759. <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"/>
  15760. option value is set to <c>true</c>, if it is <c>false</c>
  15761. then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If there is no match, <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  15762. </para>
  15763. </remarks>
  15764. <author>Nicko Cadell</author>
  15765. <author>Gert Driesen</author>
  15766. </member>
  15767. <member name="F:log4net.Filter.LevelRangeFilter.m_acceptOnMatch">
  15768. <summary>
  15769. Flag to indicate the behavior when matching a <see cref="T:log4net.Core.Level"/>
  15770. </summary>
  15771. </member>
  15772. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMin">
  15773. <summary>
  15774. the minimum <see cref="T:log4net.Core.Level"/> value to match
  15775. </summary>
  15776. </member>
  15777. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMax">
  15778. <summary>
  15779. the maximum <see cref="T:log4net.Core.Level"/> value to match
  15780. </summary>
  15781. </member>
  15782. <member name="M:log4net.Filter.LevelRangeFilter.#ctor">
  15783. <summary>
  15784. Default constructor
  15785. </summary>
  15786. </member>
  15787. <member name="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch">
  15788. <summary>
  15789. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  15790. </summary>
  15791. <remarks>
  15792. <para>
  15793. The <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> property is a flag that determines
  15794. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  15795. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  15796. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  15797. </para>
  15798. <para>
  15799. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  15800. </para>
  15801. </remarks>
  15802. </member>
  15803. <member name="P:log4net.Filter.LevelRangeFilter.LevelMin">
  15804. <summary>
  15805. Set the minimum matched <see cref="T:log4net.Core.Level"/>
  15806. </summary>
  15807. <remarks>
  15808. <para>
  15809. The minimum level that this filter will attempt to match against the
  15810. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  15811. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  15812. </para>
  15813. </remarks>
  15814. </member>
  15815. <member name="P:log4net.Filter.LevelRangeFilter.LevelMax">
  15816. <summary>
  15817. Sets the maximum matched <see cref="T:log4net.Core.Level"/>
  15818. </summary>
  15819. <remarks>
  15820. <para>
  15821. The maximum level that this filter will attempt to match against the
  15822. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  15823. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  15824. </para>
  15825. </remarks>
  15826. </member>
  15827. <member name="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)">
  15828. <summary>
  15829. Check if the event should be logged.
  15830. </summary>
  15831. <param name="loggingEvent">the logging event to check</param>
  15832. <returns>see remarks</returns>
  15833. <remarks>
  15834. <para>
  15835. If the <see cref="T:log4net.Core.Level"/> of the logging event is outside the range
  15836. matched by this filter then <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  15837. is returned. If the <see cref="T:log4net.Core.Level"/> is matched then the value of
  15838. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> is checked. If it is true then
  15839. <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, otherwise
  15840. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned.
  15841. </para>
  15842. </remarks>
  15843. </member>
  15844. <member name="T:log4net.Filter.LoggerMatchFilter">
  15845. <summary>
  15846. Simple filter to match a string in the event's logger name.
  15847. </summary>
  15848. <remarks>
  15849. <para>
  15850. The works very similar to the <see cref="T:log4net.Filter.LevelMatchFilter"/>. It admits two
  15851. options <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> and <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. If the
  15852. <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <see cref="T:log4net.Core.LoggingEvent"/> starts
  15853. with the value of the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> option, then the
  15854. <see cref="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
  15855. case the <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> option value is set to <c>true</c>,
  15856. if it is <c>false</c> then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  15857. </para>
  15858. </remarks>
  15859. <author>Daniel Cazzulino</author>
  15860. </member>
  15861. <member name="F:log4net.Filter.LoggerMatchFilter.m_acceptOnMatch">
  15862. <summary>
  15863. Flag to indicate the behavior when we have a match
  15864. </summary>
  15865. </member>
  15866. <member name="F:log4net.Filter.LoggerMatchFilter.m_loggerToMatch">
  15867. <summary>
  15868. The logger name string to substring match against the event
  15869. </summary>
  15870. </member>
  15871. <member name="M:log4net.Filter.LoggerMatchFilter.#ctor">
  15872. <summary>
  15873. Default constructor
  15874. </summary>
  15875. </member>
  15876. <member name="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch">
  15877. <summary>
  15878. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>
  15879. </summary>
  15880. <remarks>
  15881. <para>
  15882. The <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> property is a flag that determines
  15883. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  15884. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  15885. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  15886. </para>
  15887. <para>
  15888. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  15889. </para>
  15890. </remarks>
  15891. </member>
  15892. <member name="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch">
  15893. <summary>
  15894. The <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> that the filter will match
  15895. </summary>
  15896. <remarks>
  15897. <para>
  15898. This filter will attempt to match this value against logger name in
  15899. the following way. The match will be done against the beginning of the
  15900. logger name (using <see cref="M:String.StartsWith(string)"/>). The match is
  15901. case sensitive. If a match is found then
  15902. the result depends on the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>.
  15903. </para>
  15904. </remarks>
  15905. </member>
  15906. <member name="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)">
  15907. <summary>
  15908. Check if this filter should allow the event to be logged
  15909. </summary>
  15910. <param name="loggingEvent">the event being logged</param>
  15911. <returns>see remarks</returns>
  15912. <remarks>
  15913. <para>
  15914. The rendered message is matched against the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>.
  15915. If the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> equals the beginning of
  15916. the incoming <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> (<see cref="M:String.StartsWith(string)"/>)
  15917. then a match will have occurred. If no match occurs
  15918. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  15919. allowing other filters to check the event. If a match occurs then
  15920. the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> is checked. If it is
  15921. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  15922. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  15923. </para>
  15924. </remarks>
  15925. </member>
  15926. <member name="T:log4net.Filter.MdcFilter">
  15927. <summary>
  15928. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  15929. </summary>
  15930. <remarks>
  15931. <para>
  15932. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  15933. </para>
  15934. <para>
  15935. As the MDC has been replaced with layered properties the
  15936. <see cref="T:log4net.Filter.PropertyFilter"/> should be used instead.
  15937. </para>
  15938. </remarks>
  15939. <author>Nicko Cadell</author>
  15940. <author>Gert Driesen</author>
  15941. </member>
  15942. <member name="T:log4net.Filter.NdcFilter">
  15943. <summary>
  15944. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  15945. </summary>
  15946. <remarks>
  15947. <para>
  15948. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  15949. </para>
  15950. <para>
  15951. As the MDC has been replaced with named stacks stored in the
  15952. properties collections the <see cref="T:log4net.Filter.PropertyFilter"/> should
  15953. be used instead.
  15954. </para>
  15955. </remarks>
  15956. <author>Nicko Cadell</author>
  15957. <author>Gert Driesen</author>
  15958. </member>
  15959. <member name="M:log4net.Filter.NdcFilter.#ctor">
  15960. <summary>
  15961. Default constructor
  15962. </summary>
  15963. <remarks>
  15964. <para>
  15965. Sets the <see cref="P:log4net.Filter.PropertyFilter.Key"/> to <c>"NDC"</c>.
  15966. </para>
  15967. </remarks>
  15968. </member>
  15969. <member name="T:log4net.Filter.PropertyFilter">
  15970. <summary>
  15971. Simple filter to match a string an event property
  15972. </summary>
  15973. <remarks>
  15974. <para>
  15975. Simple filter to match a string in the value for a
  15976. specific event property
  15977. </para>
  15978. </remarks>
  15979. <author>Nicko Cadell</author>
  15980. </member>
  15981. <member name="F:log4net.Filter.PropertyFilter.m_key">
  15982. <summary>
  15983. The key to use to lookup the string from the event properties
  15984. </summary>
  15985. </member>
  15986. <member name="M:log4net.Filter.PropertyFilter.#ctor">
  15987. <summary>
  15988. Default constructor
  15989. </summary>
  15990. </member>
  15991. <member name="P:log4net.Filter.PropertyFilter.Key">
  15992. <summary>
  15993. The key to lookup in the event properties and then match against.
  15994. </summary>
  15995. <remarks>
  15996. <para>
  15997. The key name to use to lookup in the properties map of the
  15998. <see cref="T:log4net.Core.LoggingEvent"/>. The match will be performed against
  15999. the value of this property if it exists.
  16000. </para>
  16001. </remarks>
  16002. </member>
  16003. <member name="M:log4net.Filter.PropertyFilter.Decide(log4net.Core.LoggingEvent)">
  16004. <summary>
  16005. Check if this filter should allow the event to be logged
  16006. </summary>
  16007. <param name="loggingEvent">the event being logged</param>
  16008. <returns>see remarks</returns>
  16009. <remarks>
  16010. <para>
  16011. The event property for the <see cref="P:log4net.Filter.PropertyFilter.Key"/> is matched against
  16012. the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  16013. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  16014. the property value then a match will have occurred. If no match occurs
  16015. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  16016. allowing other filters to check the event. If a match occurs then
  16017. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  16018. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  16019. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16020. </para>
  16021. </remarks>
  16022. </member>
  16023. <member name="T:log4net.Filter.StringMatchFilter">
  16024. <summary>
  16025. Simple filter to match a string in the rendered message
  16026. </summary>
  16027. <remarks>
  16028. <para>
  16029. Simple filter to match a string in the rendered message
  16030. </para>
  16031. </remarks>
  16032. <author>Nicko Cadell</author>
  16033. <author>Gert Driesen</author>
  16034. </member>
  16035. <member name="F:log4net.Filter.StringMatchFilter.m_acceptOnMatch">
  16036. <summary>
  16037. Flag to indicate the behavior when we have a match
  16038. </summary>
  16039. </member>
  16040. <member name="F:log4net.Filter.StringMatchFilter.m_stringToMatch">
  16041. <summary>
  16042. The string to substring match against the message
  16043. </summary>
  16044. </member>
  16045. <member name="F:log4net.Filter.StringMatchFilter.m_stringRegexToMatch">
  16046. <summary>
  16047. A string regex to match
  16048. </summary>
  16049. </member>
  16050. <member name="F:log4net.Filter.StringMatchFilter.m_regexToMatch">
  16051. <summary>
  16052. A regex object to match (generated from m_stringRegexToMatch)
  16053. </summary>
  16054. </member>
  16055. <member name="M:log4net.Filter.StringMatchFilter.#ctor">
  16056. <summary>
  16057. Default constructor
  16058. </summary>
  16059. </member>
  16060. <member name="M:log4net.Filter.StringMatchFilter.ActivateOptions">
  16061. <summary>
  16062. Initialize and precompile the Regex if required
  16063. </summary>
  16064. <remarks>
  16065. <para>
  16066. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16067. activation scheme. The <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> method must
  16068. be called on this object after the configuration properties have
  16069. been set. Until <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> is called this
  16070. object is in an undefined state and must not be used.
  16071. </para>
  16072. <para>
  16073. If any of the configuration properties are modified then
  16074. <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> must be called again.
  16075. </para>
  16076. </remarks>
  16077. </member>
  16078. <member name="P:log4net.Filter.StringMatchFilter.AcceptOnMatch">
  16079. <summary>
  16080. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  16081. </summary>
  16082. <remarks>
  16083. <para>
  16084. The <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> property is a flag that determines
  16085. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16086. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16087. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  16088. </para>
  16089. <para>
  16090. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16091. </para>
  16092. </remarks>
  16093. </member>
  16094. <member name="P:log4net.Filter.StringMatchFilter.StringToMatch">
  16095. <summary>
  16096. Sets the static string to match
  16097. </summary>
  16098. <remarks>
  16099. <para>
  16100. The string that will be substring matched against
  16101. the rendered message. If the message contains this
  16102. string then the filter will match. If a match is found then
  16103. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  16104. </para>
  16105. <para>
  16106. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  16107. must be specified.
  16108. </para>
  16109. </remarks>
  16110. </member>
  16111. <member name="P:log4net.Filter.StringMatchFilter.RegexToMatch">
  16112. <summary>
  16113. Sets the regular expression to match
  16114. </summary>
  16115. <remarks>
  16116. <para>
  16117. The regular expression pattern that will be matched against
  16118. the rendered message. If the message matches this
  16119. pattern then the filter will match. If a match is found then
  16120. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  16121. </para>
  16122. <para>
  16123. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  16124. must be specified.
  16125. </para>
  16126. </remarks>
  16127. </member>
  16128. <member name="M:log4net.Filter.StringMatchFilter.Decide(log4net.Core.LoggingEvent)">
  16129. <summary>
  16130. Check if this filter should allow the event to be logged
  16131. </summary>
  16132. <param name="loggingEvent">the event being logged</param>
  16133. <returns>see remarks</returns>
  16134. <remarks>
  16135. <para>
  16136. The rendered message is matched against the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  16137. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  16138. the message then a match will have occurred. If no match occurs
  16139. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  16140. allowing other filters to check the event. If a match occurs then
  16141. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  16142. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  16143. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16144. </para>
  16145. </remarks>
  16146. </member>
  16147. <member name="T:log4net.GlobalContext">
  16148. <summary>
  16149. The log4net Global Context.
  16150. </summary>
  16151. <remarks>
  16152. <para>
  16153. The <c>GlobalContext</c> provides a location for global debugging
  16154. information to be stored.
  16155. </para>
  16156. <para>
  16157. The global context has a properties map and these properties can
  16158. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  16159. supports selecting and outputing these properties.
  16160. </para>
  16161. <para>
  16162. By default the <c>log4net:HostName</c> property is set to the name of
  16163. the current machine.
  16164. </para>
  16165. </remarks>
  16166. <example>
  16167. <code lang="C#">
  16168. GlobalContext.Properties["hostname"] = Environment.MachineName;
  16169. </code>
  16170. </example>
  16171. <threadsafety static="true" instance="true" />
  16172. <author>Nicko Cadell</author>
  16173. </member>
  16174. <member name="M:log4net.GlobalContext.#ctor">
  16175. <summary>
  16176. Private Constructor.
  16177. </summary>
  16178. <remarks>
  16179. Uses a private access modifier to prevent instantiation of this class.
  16180. </remarks>
  16181. </member>
  16182. <member name="P:log4net.GlobalContext.Properties">
  16183. <summary>
  16184. The global properties map.
  16185. </summary>
  16186. <value>
  16187. The global properties map.
  16188. </value>
  16189. <remarks>
  16190. <para>
  16191. The global properties map.
  16192. </para>
  16193. </remarks>
  16194. </member>
  16195. <member name="F:log4net.GlobalContext.s_properties">
  16196. <summary>
  16197. The global context properties instance
  16198. </summary>
  16199. </member>
  16200. <member name="T:log4net.ILog">
  16201. <summary>
  16202. The ILog interface is use by application to log messages into
  16203. the log4net framework.
  16204. </summary>
  16205. <remarks>
  16206. <para>
  16207. Use the <see cref="T:log4net.LogManager"/> to obtain logger instances
  16208. that implement this interface. The <see cref="M:LogManager.GetLogger(Assembly,Type)"/>
  16209. static method is used to get logger instances.
  16210. </para>
  16211. <para>
  16212. This class contains methods for logging at different levels and also
  16213. has properties for determining if those logging levels are
  16214. enabled in the current configuration.
  16215. </para>
  16216. <para>
  16217. This interface can be implemented in different ways. This documentation
  16218. specifies reasonable behavior that a caller can expect from the actual
  16219. implementation, however different implementations reserve the right to
  16220. do things differently.
  16221. </para>
  16222. </remarks>
  16223. <example>Simple example of logging messages
  16224. <code lang="C#">
  16225. ILog log = LogManager.GetLogger("application-log");
  16226. log.Info("Application Start");
  16227. log.Debug("This is a debug message");
  16228. if (log.IsDebugEnabled)
  16229. {
  16230. log.Debug("This is another debug message");
  16231. }
  16232. </code>
  16233. </example>
  16234. <seealso cref="T:log4net.LogManager"/>
  16235. <seealso cref="M:LogManager.GetLogger(Assembly, Type)"/>
  16236. <author>Nicko Cadell</author>
  16237. <author>Gert Driesen</author>
  16238. </member>
  16239. <member name="M:log4net.ILog.Debug(System.Object)">
  16240. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  16241. <summary>
  16242. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16243. </summary>
  16244. <param name="message">The message object to log.</param>
  16245. <remarks>
  16246. <para>
  16247. This method first checks if this logger is <c>DEBUG</c>
  16248. enabled by comparing the level of this logger with the
  16249. <see cref="F:log4net.Core.Level.Debug"/> level. If this logger is
  16250. <c>DEBUG</c> enabled, then it converts the message object
  16251. (passed as parameter) to a string by invoking the appropriate
  16252. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  16253. proceeds to call all the registered appenders in this logger
  16254. and also higher in the hierarchy depending on the value of
  16255. the additivity flag.
  16256. </para>
  16257. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  16258. to this method will print the name of the <see cref="T:System.Exception"/>
  16259. but no stack trace. To print a stack trace use the
  16260. <see cref="M:Debug(object,Exception)"/> form instead.
  16261. </para>
  16262. </remarks>
  16263. <seealso cref="M:Debug(object,Exception)"/>
  16264. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16265. </member>
  16266. <member name="M:log4net.ILog.Debug(System.Object,System.Exception)">
  16267. <summary>
  16268. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  16269. the stack trace of the <see cref="T:System.Exception"/> passed
  16270. as a parameter.
  16271. </summary>
  16272. <param name="message">The message object to log.</param>
  16273. <param name="exception">The exception to log, including its stack trace.</param>
  16274. <remarks>
  16275. <para>
  16276. See the <see cref="M:Debug(object)"/> form for more detailed information.
  16277. </para>
  16278. </remarks>
  16279. <seealso cref="M:Debug(object)"/>
  16280. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16281. </member>
  16282. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object[])">
  16283. <overloads>Log a formatted string with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  16284. <summary>
  16285. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16286. </summary>
  16287. <param name="format">A String containing zero or more format items</param>
  16288. <param name="args">An Object array containing zero or more objects to format</param>
  16289. <remarks>
  16290. <para>
  16291. The message is formatted using the <c>String.Format</c> method. See
  16292. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16293. of the formatting.
  16294. </para>
  16295. <para>
  16296. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16297. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  16298. methods instead.
  16299. </para>
  16300. </remarks>
  16301. <seealso cref="M:Debug(object)"/>
  16302. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16303. </member>
  16304. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object)">
  16305. <summary>
  16306. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16307. </summary>
  16308. <param name="format">A String containing zero or more format items</param>
  16309. <param name="arg0">An Object to format</param>
  16310. <remarks>
  16311. <para>
  16312. The message is formatted using the <c>String.Format</c> method. See
  16313. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16314. of the formatting.
  16315. </para>
  16316. <para>
  16317. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16318. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  16319. methods instead.
  16320. </para>
  16321. </remarks>
  16322. <seealso cref="M:Debug(object)"/>
  16323. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16324. </member>
  16325. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)">
  16326. <summary>
  16327. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16328. </summary>
  16329. <param name="format">A String containing zero or more format items</param>
  16330. <param name="arg0">An Object to format</param>
  16331. <param name="arg1">An Object to format</param>
  16332. <remarks>
  16333. <para>
  16334. The message is formatted using the <c>String.Format</c> method. See
  16335. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16336. of the formatting.
  16337. </para>
  16338. <para>
  16339. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16340. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  16341. methods instead.
  16342. </para>
  16343. </remarks>
  16344. <seealso cref="M:Debug(object)"/>
  16345. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16346. </member>
  16347. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  16348. <summary>
  16349. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16350. </summary>
  16351. <param name="format">A String containing zero or more format items</param>
  16352. <param name="arg0">An Object to format</param>
  16353. <param name="arg1">An Object to format</param>
  16354. <param name="arg2">An Object to format</param>
  16355. <remarks>
  16356. <para>
  16357. The message is formatted using the <c>String.Format</c> method. See
  16358. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16359. of the formatting.
  16360. </para>
  16361. <para>
  16362. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16363. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  16364. methods instead.
  16365. </para>
  16366. </remarks>
  16367. <seealso cref="M:Debug(object)"/>
  16368. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16369. </member>
  16370. <member name="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  16371. <summary>
  16372. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16373. </summary>
  16374. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  16375. <param name="format">A String containing zero or more format items</param>
  16376. <param name="args">An Object array containing zero or more objects to format</param>
  16377. <remarks>
  16378. <para>
  16379. The message is formatted using the <c>String.Format</c> method. See
  16380. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16381. of the formatting.
  16382. </para>
  16383. <para>
  16384. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16385. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  16386. methods instead.
  16387. </para>
  16388. </remarks>
  16389. <seealso cref="M:Debug(object)"/>
  16390. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16391. </member>
  16392. <member name="M:log4net.ILog.Info(System.Object)">
  16393. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  16394. <summary>
  16395. Logs a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  16396. </summary>
  16397. <remarks>
  16398. <para>
  16399. This method first checks if this logger is <c>INFO</c>
  16400. enabled by comparing the level of this logger with the
  16401. <see cref="F:log4net.Core.Level.Info"/> level. If this logger is
  16402. <c>INFO</c> enabled, then it converts the message object
  16403. (passed as parameter) to a string by invoking the appropriate
  16404. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  16405. proceeds to call all the registered appenders in this logger
  16406. and also higher in the hierarchy depending on the value of the
  16407. additivity flag.
  16408. </para>
  16409. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  16410. to this method will print the name of the <see cref="T:System.Exception"/>
  16411. but no stack trace. To print a stack trace use the
  16412. <see cref="M:Info(object,Exception)"/> form instead.
  16413. </para>
  16414. </remarks>
  16415. <param name="message">The message object to log.</param>
  16416. <seealso cref="M:Info(object,Exception)"/>
  16417. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16418. </member>
  16419. <member name="M:log4net.ILog.Info(System.Object,System.Exception)">
  16420. <summary>
  16421. Logs a message object with the <c>INFO</c> level including
  16422. the stack trace of the <see cref="T:System.Exception"/> passed
  16423. as a parameter.
  16424. </summary>
  16425. <param name="message">The message object to log.</param>
  16426. <param name="exception">The exception to log, including its stack trace.</param>
  16427. <remarks>
  16428. <para>
  16429. See the <see cref="M:Info(object)"/> form for more detailed information.
  16430. </para>
  16431. </remarks>
  16432. <seealso cref="M:Info(object)"/>
  16433. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16434. </member>
  16435. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
  16436. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  16437. <summary>
  16438. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  16439. </summary>
  16440. <param name="format">A String containing zero or more format items</param>
  16441. <param name="args">An Object array containing zero or more objects to format</param>
  16442. <remarks>
  16443. <para>
  16444. The message is formatted using the <c>String.Format</c> method. See
  16445. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16446. of the formatting.
  16447. </para>
  16448. <para>
  16449. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16450. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  16451. methods instead.
  16452. </para>
  16453. </remarks>
  16454. <seealso cref="M:Info(object,Exception)"/>
  16455. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16456. </member>
  16457. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object)">
  16458. <summary>
  16459. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  16460. </summary>
  16461. <param name="format">A String containing zero or more format items</param>
  16462. <param name="arg0">An Object to format</param>
  16463. <remarks>
  16464. <para>
  16465. The message is formatted using the <c>String.Format</c> method. See
  16466. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16467. of the formatting.
  16468. </para>
  16469. <para>
  16470. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16471. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  16472. methods instead.
  16473. </para>
  16474. </remarks>
  16475. <seealso cref="M:Info(object)"/>
  16476. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16477. </member>
  16478. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)">
  16479. <summary>
  16480. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  16481. </summary>
  16482. <param name="format">A String containing zero or more format items</param>
  16483. <param name="arg0">An Object to format</param>
  16484. <param name="arg1">An Object to format</param>
  16485. <remarks>
  16486. <para>
  16487. The message is formatted using the <c>String.Format</c> method. See
  16488. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16489. of the formatting.
  16490. </para>
  16491. <para>
  16492. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16493. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  16494. methods instead.
  16495. </para>
  16496. </remarks>
  16497. <seealso cref="M:Info(object)"/>
  16498. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16499. </member>
  16500. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  16501. <summary>
  16502. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  16503. </summary>
  16504. <param name="format">A String containing zero or more format items</param>
  16505. <param name="arg0">An Object to format</param>
  16506. <param name="arg1">An Object to format</param>
  16507. <param name="arg2">An Object to format</param>
  16508. <remarks>
  16509. <para>
  16510. The message is formatted using the <c>String.Format</c> method. See
  16511. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16512. of the formatting.
  16513. </para>
  16514. <para>
  16515. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16516. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  16517. methods instead.
  16518. </para>
  16519. </remarks>
  16520. <seealso cref="M:Info(object)"/>
  16521. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16522. </member>
  16523. <member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  16524. <summary>
  16525. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  16526. </summary>
  16527. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  16528. <param name="format">A String containing zero or more format items</param>
  16529. <param name="args">An Object array containing zero or more objects to format</param>
  16530. <remarks>
  16531. <para>
  16532. The message is formatted using the <c>String.Format</c> method. See
  16533. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16534. of the formatting.
  16535. </para>
  16536. <para>
  16537. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16538. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  16539. methods instead.
  16540. </para>
  16541. </remarks>
  16542. <seealso cref="M:Info(object,Exception)"/>
  16543. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16544. </member>
  16545. <member name="M:log4net.ILog.Warn(System.Object)">
  16546. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  16547. <summary>
  16548. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16549. </summary>
  16550. <remarks>
  16551. <para>
  16552. This method first checks if this logger is <c>WARN</c>
  16553. enabled by comparing the level of this logger with the
  16554. <see cref="F:log4net.Core.Level.Warn"/> level. If this logger is
  16555. <c>WARN</c> enabled, then it converts the message object
  16556. (passed as parameter) to a string by invoking the appropriate
  16557. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  16558. proceeds to call all the registered appenders in this logger
  16559. and also higher in the hierarchy depending on the value of the
  16560. additivity flag.
  16561. </para>
  16562. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  16563. to this method will print the name of the <see cref="T:System.Exception"/>
  16564. but no stack trace. To print a stack trace use the
  16565. <see cref="M:Warn(object,Exception)"/> form instead.
  16566. </para>
  16567. </remarks>
  16568. <param name="message">The message object to log.</param>
  16569. <seealso cref="M:Warn(object,Exception)"/>
  16570. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16571. </member>
  16572. <member name="M:log4net.ILog.Warn(System.Object,System.Exception)">
  16573. <summary>
  16574. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  16575. the stack trace of the <see cref="T:System.Exception"/> passed
  16576. as a parameter.
  16577. </summary>
  16578. <param name="message">The message object to log.</param>
  16579. <param name="exception">The exception to log, including its stack trace.</param>
  16580. <remarks>
  16581. <para>
  16582. See the <see cref="M:Warn(object)"/> form for more detailed information.
  16583. </para>
  16584. </remarks>
  16585. <seealso cref="M:Warn(object)"/>
  16586. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16587. </member>
  16588. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object[])">
  16589. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  16590. <summary>
  16591. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16592. </summary>
  16593. <param name="format">A String containing zero or more format items</param>
  16594. <param name="args">An Object array containing zero or more objects to format</param>
  16595. <remarks>
  16596. <para>
  16597. The message is formatted using the <c>String.Format</c> method. See
  16598. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16599. of the formatting.
  16600. </para>
  16601. <para>
  16602. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16603. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  16604. methods instead.
  16605. </para>
  16606. </remarks>
  16607. <seealso cref="M:Warn(object,Exception)"/>
  16608. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16609. </member>
  16610. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object)">
  16611. <summary>
  16612. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16613. </summary>
  16614. <param name="format">A String containing zero or more format items</param>
  16615. <param name="arg0">An Object to format</param>
  16616. <remarks>
  16617. <para>
  16618. The message is formatted using the <c>String.Format</c> method. See
  16619. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16620. of the formatting.
  16621. </para>
  16622. <para>
  16623. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16624. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  16625. methods instead.
  16626. </para>
  16627. </remarks>
  16628. <seealso cref="M:Warn(object)"/>
  16629. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16630. </member>
  16631. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)">
  16632. <summary>
  16633. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16634. </summary>
  16635. <param name="format">A String containing zero or more format items</param>
  16636. <param name="arg0">An Object to format</param>
  16637. <param name="arg1">An Object to format</param>
  16638. <remarks>
  16639. <para>
  16640. The message is formatted using the <c>String.Format</c> method. See
  16641. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16642. of the formatting.
  16643. </para>
  16644. <para>
  16645. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16646. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  16647. methods instead.
  16648. </para>
  16649. </remarks>
  16650. <seealso cref="M:Warn(object)"/>
  16651. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16652. </member>
  16653. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  16654. <summary>
  16655. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16656. </summary>
  16657. <param name="format">A String containing zero or more format items</param>
  16658. <param name="arg0">An Object to format</param>
  16659. <param name="arg1">An Object to format</param>
  16660. <param name="arg2">An Object to format</param>
  16661. <remarks>
  16662. <para>
  16663. The message is formatted using the <c>String.Format</c> method. See
  16664. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16665. of the formatting.
  16666. </para>
  16667. <para>
  16668. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16669. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  16670. methods instead.
  16671. </para>
  16672. </remarks>
  16673. <seealso cref="M:Warn(object)"/>
  16674. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16675. </member>
  16676. <member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  16677. <summary>
  16678. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16679. </summary>
  16680. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  16681. <param name="format">A String containing zero or more format items</param>
  16682. <param name="args">An Object array containing zero or more objects to format</param>
  16683. <remarks>
  16684. <para>
  16685. The message is formatted using the <c>String.Format</c> method. See
  16686. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16687. of the formatting.
  16688. </para>
  16689. <para>
  16690. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16691. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  16692. methods instead.
  16693. </para>
  16694. </remarks>
  16695. <seealso cref="M:Warn(object,Exception)"/>
  16696. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16697. </member>
  16698. <member name="M:log4net.ILog.Error(System.Object)">
  16699. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  16700. <summary>
  16701. Logs a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  16702. </summary>
  16703. <param name="message">The message object to log.</param>
  16704. <remarks>
  16705. <para>
  16706. This method first checks if this logger is <c>ERROR</c>
  16707. enabled by comparing the level of this logger with the
  16708. <see cref="F:log4net.Core.Level.Error"/> level. If this logger is
  16709. <c>ERROR</c> enabled, then it converts the message object
  16710. (passed as parameter) to a string by invoking the appropriate
  16711. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  16712. proceeds to call all the registered appenders in this logger
  16713. and also higher in the hierarchy depending on the value of the
  16714. additivity flag.
  16715. </para>
  16716. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  16717. to this method will print the name of the <see cref="T:System.Exception"/>
  16718. but no stack trace. To print a stack trace use the
  16719. <see cref="M:Error(object,Exception)"/> form instead.
  16720. </para>
  16721. </remarks>
  16722. <seealso cref="M:Error(object,Exception)"/>
  16723. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16724. </member>
  16725. <member name="M:log4net.ILog.Error(System.Object,System.Exception)">
  16726. <summary>
  16727. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  16728. the stack trace of the <see cref="T:System.Exception"/> passed
  16729. as a parameter.
  16730. </summary>
  16731. <param name="message">The message object to log.</param>
  16732. <param name="exception">The exception to log, including its stack trace.</param>
  16733. <remarks>
  16734. <para>
  16735. See the <see cref="M:Error(object)"/> form for more detailed information.
  16736. </para>
  16737. </remarks>
  16738. <seealso cref="M:Error(object)"/>
  16739. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16740. </member>
  16741. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object[])">
  16742. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  16743. <summary>
  16744. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  16745. </summary>
  16746. <param name="format">A String containing zero or more format items</param>
  16747. <param name="args">An Object array containing zero or more objects to format</param>
  16748. <remarks>
  16749. <para>
  16750. The message is formatted using the <c>String.Format</c> method. See
  16751. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16752. of the formatting.
  16753. </para>
  16754. <para>
  16755. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16756. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  16757. methods instead.
  16758. </para>
  16759. </remarks>
  16760. <seealso cref="M:Error(object,Exception)"/>
  16761. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16762. </member>
  16763. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)">
  16764. <summary>
  16765. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  16766. </summary>
  16767. <param name="format">A String containing zero or more format items</param>
  16768. <param name="arg0">An Object to format</param>
  16769. <remarks>
  16770. <para>
  16771. The message is formatted using the <c>String.Format</c> method. See
  16772. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16773. of the formatting.
  16774. </para>
  16775. <para>
  16776. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16777. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  16778. methods instead.
  16779. </para>
  16780. </remarks>
  16781. <seealso cref="M:Error(object)"/>
  16782. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16783. </member>
  16784. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)">
  16785. <summary>
  16786. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  16787. </summary>
  16788. <param name="format">A String containing zero or more format items</param>
  16789. <param name="arg0">An Object to format</param>
  16790. <param name="arg1">An Object to format</param>
  16791. <remarks>
  16792. <para>
  16793. The message is formatted using the <c>String.Format</c> method. See
  16794. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16795. of the formatting.
  16796. </para>
  16797. <para>
  16798. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16799. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  16800. methods instead.
  16801. </para>
  16802. </remarks>
  16803. <seealso cref="M:Error(object)"/>
  16804. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16805. </member>
  16806. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  16807. <summary>
  16808. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  16809. </summary>
  16810. <param name="format">A String containing zero or more format items</param>
  16811. <param name="arg0">An Object to format</param>
  16812. <param name="arg1">An Object to format</param>
  16813. <param name="arg2">An Object to format</param>
  16814. <remarks>
  16815. <para>
  16816. The message is formatted using the <c>String.Format</c> method. See
  16817. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16818. of the formatting.
  16819. </para>
  16820. <para>
  16821. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16822. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  16823. methods instead.
  16824. </para>
  16825. </remarks>
  16826. <seealso cref="M:Error(object)"/>
  16827. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16828. </member>
  16829. <member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  16830. <summary>
  16831. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  16832. </summary>
  16833. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  16834. <param name="format">A String containing zero or more format items</param>
  16835. <param name="args">An Object array containing zero or more objects to format</param>
  16836. <remarks>
  16837. <para>
  16838. The message is formatted using the <c>String.Format</c> method. See
  16839. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16840. of the formatting.
  16841. </para>
  16842. <para>
  16843. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16844. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  16845. methods instead.
  16846. </para>
  16847. </remarks>
  16848. <seealso cref="M:Error(object,Exception)"/>
  16849. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16850. </member>
  16851. <member name="M:log4net.ILog.Fatal(System.Object)">
  16852. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  16853. <summary>
  16854. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16855. </summary>
  16856. <remarks>
  16857. <para>
  16858. This method first checks if this logger is <c>FATAL</c>
  16859. enabled by comparing the level of this logger with the
  16860. <see cref="F:log4net.Core.Level.Fatal"/> level. If this logger is
  16861. <c>FATAL</c> enabled, then it converts the message object
  16862. (passed as parameter) to a string by invoking the appropriate
  16863. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  16864. proceeds to call all the registered appenders in this logger
  16865. and also higher in the hierarchy depending on the value of the
  16866. additivity flag.
  16867. </para>
  16868. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  16869. to this method will print the name of the <see cref="T:System.Exception"/>
  16870. but no stack trace. To print a stack trace use the
  16871. <see cref="M:Fatal(object,Exception)"/> form instead.
  16872. </para>
  16873. </remarks>
  16874. <param name="message">The message object to log.</param>
  16875. <seealso cref="M:Fatal(object,Exception)"/>
  16876. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16877. </member>
  16878. <member name="M:log4net.ILog.Fatal(System.Object,System.Exception)">
  16879. <summary>
  16880. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  16881. the stack trace of the <see cref="T:System.Exception"/> passed
  16882. as a parameter.
  16883. </summary>
  16884. <param name="message">The message object to log.</param>
  16885. <param name="exception">The exception to log, including its stack trace.</param>
  16886. <remarks>
  16887. <para>
  16888. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  16889. </para>
  16890. </remarks>
  16891. <seealso cref="M:Fatal(object)"/>
  16892. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16893. </member>
  16894. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object[])">
  16895. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  16896. <summary>
  16897. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16898. </summary>
  16899. <param name="format">A String containing zero or more format items</param>
  16900. <param name="args">An Object array containing zero or more objects to format</param>
  16901. <remarks>
  16902. <para>
  16903. The message is formatted using the <c>String.Format</c> method. See
  16904. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16905. of the formatting.
  16906. </para>
  16907. <para>
  16908. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16909. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  16910. methods instead.
  16911. </para>
  16912. </remarks>
  16913. <seealso cref="M:Fatal(object,Exception)"/>
  16914. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16915. </member>
  16916. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object)">
  16917. <summary>
  16918. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16919. </summary>
  16920. <param name="format">A String containing zero or more format items</param>
  16921. <param name="arg0">An Object to format</param>
  16922. <remarks>
  16923. <para>
  16924. The message is formatted using the <c>String.Format</c> method. See
  16925. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16926. of the formatting.
  16927. </para>
  16928. <para>
  16929. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16930. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  16931. methods instead.
  16932. </para>
  16933. </remarks>
  16934. <seealso cref="M:Fatal(object)"/>
  16935. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16936. </member>
  16937. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)">
  16938. <summary>
  16939. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16940. </summary>
  16941. <param name="format">A String containing zero or more format items</param>
  16942. <param name="arg0">An Object to format</param>
  16943. <param name="arg1">An Object to format</param>
  16944. <remarks>
  16945. <para>
  16946. The message is formatted using the <c>String.Format</c> method. See
  16947. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16948. of the formatting.
  16949. </para>
  16950. <para>
  16951. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16952. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  16953. methods instead.
  16954. </para>
  16955. </remarks>
  16956. <seealso cref="M:Fatal(object)"/>
  16957. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16958. </member>
  16959. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  16960. <summary>
  16961. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16962. </summary>
  16963. <param name="format">A String containing zero or more format items</param>
  16964. <param name="arg0">An Object to format</param>
  16965. <param name="arg1">An Object to format</param>
  16966. <param name="arg2">An Object to format</param>
  16967. <remarks>
  16968. <para>
  16969. The message is formatted using the <c>String.Format</c> method. See
  16970. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16971. of the formatting.
  16972. </para>
  16973. <para>
  16974. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16975. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  16976. methods instead.
  16977. </para>
  16978. </remarks>
  16979. <seealso cref="M:Fatal(object)"/>
  16980. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16981. </member>
  16982. <member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  16983. <summary>
  16984. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16985. </summary>
  16986. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  16987. <param name="format">A String containing zero or more format items</param>
  16988. <param name="args">An Object array containing zero or more objects to format</param>
  16989. <remarks>
  16990. <para>
  16991. The message is formatted using the <c>String.Format</c> method. See
  16992. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16993. of the formatting.
  16994. </para>
  16995. <para>
  16996. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16997. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  16998. methods instead.
  16999. </para>
  17000. </remarks>
  17001. <seealso cref="M:Fatal(object,Exception)"/>
  17002. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  17003. </member>
  17004. <member name="P:log4net.ILog.IsDebugEnabled">
  17005. <summary>
  17006. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Debug"/> level.
  17007. </summary>
  17008. <value>
  17009. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Debug"/> events, <c>false</c> otherwise.
  17010. </value>
  17011. <remarks>
  17012. <para>
  17013. This function is intended to lessen the computational cost of
  17014. disabled log debug statements.
  17015. </para>
  17016. <para> For some ILog interface <c>log</c>, when you write:</para>
  17017. <code lang="C#">
  17018. log.Debug("This is entry number: " + i );
  17019. </code>
  17020. <para>
  17021. You incur the cost constructing the message, string construction and concatenation in
  17022. this case, regardless of whether the message is logged or not.
  17023. </para>
  17024. <para>
  17025. If you are worried about speed (who isn't), then you should write:
  17026. </para>
  17027. <code lang="C#">
  17028. if (log.IsDebugEnabled)
  17029. {
  17030. log.Debug("This is entry number: " + i );
  17031. }
  17032. </code>
  17033. <para>
  17034. This way you will not incur the cost of parameter
  17035. construction if debugging is disabled for <c>log</c>. On
  17036. the other hand, if the <c>log</c> is debug enabled, you
  17037. will incur the cost of evaluating whether the logger is debug
  17038. enabled twice. Once in <see cref="P:log4net.ILog.IsDebugEnabled"/> and once in
  17039. the <see cref="M:Debug(object)"/>. This is an insignificant overhead
  17040. since evaluating a logger takes about 1% of the time it
  17041. takes to actually log. This is the preferred style of logging.
  17042. </para>
  17043. <para>Alternatively if your logger is available statically then the is debug
  17044. enabled state can be stored in a static variable like this:
  17045. </para>
  17046. <code lang="C#">
  17047. private static readonly bool isDebugEnabled = log.IsDebugEnabled;
  17048. </code>
  17049. <para>
  17050. Then when you come to log you can write:
  17051. </para>
  17052. <code lang="C#">
  17053. if (isDebugEnabled)
  17054. {
  17055. log.Debug("This is entry number: " + i );
  17056. }
  17057. </code>
  17058. <para>
  17059. This way the debug enabled state is only queried once
  17060. when the class is loaded. Using a <c>private static readonly</c>
  17061. variable is the most efficient because it is a run time constant
  17062. and can be heavily optimized by the JIT compiler.
  17063. </para>
  17064. <para>
  17065. Of course if you use a static readonly variable to
  17066. hold the enabled state of the logger then you cannot
  17067. change the enabled state at runtime to vary the logging
  17068. that is produced. You have to decide if you need absolute
  17069. speed or runtime flexibility.
  17070. </para>
  17071. </remarks>
  17072. <seealso cref="M:Debug(object)"/>
  17073. <seealso cref="M:DebugFormat(IFormatProvider, string, object[])"/>
  17074. </member>
  17075. <member name="P:log4net.ILog.IsInfoEnabled">
  17076. <summary>
  17077. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Info"/> level.
  17078. </summary>
  17079. <value>
  17080. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Info"/> events, <c>false</c> otherwise.
  17081. </value>
  17082. <remarks>
  17083. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  17084. </remarks>
  17085. <seealso cref="M:Info(object)"/>
  17086. <seealso cref="M:InfoFormat(IFormatProvider, string, object[])"/>
  17087. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  17088. </member>
  17089. <member name="P:log4net.ILog.IsWarnEnabled">
  17090. <summary>
  17091. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Warn"/> level.
  17092. </summary>
  17093. <value>
  17094. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Warn"/> events, <c>false</c> otherwise.
  17095. </value>
  17096. <remarks>
  17097. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  17098. </remarks>
  17099. <seealso cref="M:Warn(object)"/>
  17100. <seealso cref="M:WarnFormat(IFormatProvider, string, object[])"/>
  17101. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  17102. </member>
  17103. <member name="P:log4net.ILog.IsErrorEnabled">
  17104. <summary>
  17105. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Error"/> level.
  17106. </summary>
  17107. <value>
  17108. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Error"/> events, <c>false</c> otherwise.
  17109. </value>
  17110. <remarks>
  17111. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  17112. </remarks>
  17113. <seealso cref="M:Error(object)"/>
  17114. <seealso cref="M:ErrorFormat(IFormatProvider, string, object[])"/>
  17115. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  17116. </member>
  17117. <member name="P:log4net.ILog.IsFatalEnabled">
  17118. <summary>
  17119. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Fatal"/> level.
  17120. </summary>
  17121. <value>
  17122. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Fatal"/> events, <c>false</c> otherwise.
  17123. </value>
  17124. <remarks>
  17125. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  17126. </remarks>
  17127. <seealso cref="M:Fatal(object)"/>
  17128. <seealso cref="M:FatalFormat(IFormatProvider, string, object[])"/>
  17129. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  17130. </member>
  17131. <member name="T:log4net.Layout.DynamicPatternLayout">
  17132. <summary>
  17133. A flexible layout configurable with pattern string that re-evaluates on each call.
  17134. </summary>
  17135. <remarks>
  17136. <para>This class is built on <see cref="T:log4net.Layout.PatternLayout"></see> and provides all the
  17137. features and capabilities of PatternLayout. PatternLayout is a 'static' class
  17138. in that its layout is done once at configuration time. This class will recreate
  17139. the layout on each reference.</para>
  17140. <para>One important difference between PatternLayout and DynamicPatternLayout is the
  17141. treatment of the Header and Footer parameters in the configuration. The Header and Footer
  17142. parameters for DynamicPatternLayout must be syntactically in the form of a PatternString,
  17143. but should not be marked as type log4net.Util.PatternString. Doing so causes the
  17144. pattern to be statically converted at configuration time and causes DynamicPatternLayout
  17145. to perform the same as PatternLayout.</para>
  17146. <para>Please see <see cref="T:log4net.Layout.PatternLayout"/> for complete documentation.</para>
  17147. <example>
  17148. &lt;layout type="log4net.Layout.DynamicPatternLayout"&gt;
  17149. &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;
  17150. &lt;param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /&gt;
  17151. &lt;/layout&gt;
  17152. </example>
  17153. </remarks>
  17154. </member>
  17155. <member name="F:log4net.Layout.DynamicPatternLayout.m_headerPatternString">
  17156. <summary>
  17157. The header PatternString
  17158. </summary>
  17159. </member>
  17160. <member name="F:log4net.Layout.DynamicPatternLayout.m_footerPatternString">
  17161. <summary>
  17162. The footer PatternString
  17163. </summary>
  17164. </member>
  17165. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor">
  17166. <summary>
  17167. Constructs a DynamicPatternLayout using the DefaultConversionPattern
  17168. </summary>
  17169. <remarks>
  17170. <para>
  17171. The default pattern just produces the application supplied message.
  17172. </para>
  17173. </remarks>
  17174. </member>
  17175. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor(System.String)">
  17176. <summary>
  17177. Constructs a DynamicPatternLayout using the supplied conversion pattern
  17178. </summary>
  17179. <param name="pattern">the pattern to use</param>
  17180. <remarks>
  17181. </remarks>
  17182. </member>
  17183. <member name="P:log4net.Layout.DynamicPatternLayout.Header">
  17184. <summary>
  17185. The header for the layout format.
  17186. </summary>
  17187. <value>the layout header</value>
  17188. <remarks>
  17189. <para>
  17190. The Header text will be appended before any logging events
  17191. are formatted and appended.
  17192. </para>
  17193. The pattern will be formatted on each get operation.
  17194. </remarks>
  17195. </member>
  17196. <member name="P:log4net.Layout.DynamicPatternLayout.Footer">
  17197. <summary>
  17198. The footer for the layout format.
  17199. </summary>
  17200. <value>the layout footer</value>
  17201. <remarks>
  17202. <para>
  17203. The Footer text will be appended after all the logging events
  17204. have been formatted and appended.
  17205. </para>
  17206. The pattern will be formatted on each get operation.
  17207. </remarks>
  17208. </member>
  17209. <member name="T:log4net.Layout.ExceptionLayout">
  17210. <summary>
  17211. A Layout that renders only the Exception text from the logging event
  17212. </summary>
  17213. <remarks>
  17214. <para>
  17215. A Layout that renders only the Exception text from the logging event.
  17216. </para>
  17217. <para>
  17218. This Layout should only be used with appenders that utilize multiple
  17219. layouts (e.g. <see cref="T:log4net.Appender.AdoNetAppender"/>).
  17220. </para>
  17221. </remarks>
  17222. <author>Nicko Cadell</author>
  17223. <author>Gert Driesen</author>
  17224. </member>
  17225. <member name="M:log4net.Layout.ExceptionLayout.#ctor">
  17226. <summary>
  17227. Default constructor
  17228. </summary>
  17229. <remarks>
  17230. <para>
  17231. Constructs a ExceptionLayout
  17232. </para>
  17233. </remarks>
  17234. </member>
  17235. <member name="M:log4net.Layout.ExceptionLayout.ActivateOptions">
  17236. <summary>
  17237. Activate component options
  17238. </summary>
  17239. <remarks>
  17240. <para>
  17241. Part of the <see cref="T:log4net.Core.IOptionHandler"/> component activation
  17242. framework.
  17243. </para>
  17244. <para>
  17245. This method does nothing as options become effective immediately.
  17246. </para>
  17247. </remarks>
  17248. </member>
  17249. <member name="M:log4net.Layout.ExceptionLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17250. <summary>
  17251. Gets the exception text from the logging event
  17252. </summary>
  17253. <param name="writer">The TextWriter to write the formatted event to</param>
  17254. <param name="loggingEvent">the event being logged</param>
  17255. <remarks>
  17256. <para>
  17257. Write the exception string to the <see cref="T:System.IO.TextWriter"/>.
  17258. The exception string is retrieved from <see cref="M:LoggingEvent.GetExceptionString()"/>.
  17259. </para>
  17260. </remarks>
  17261. </member>
  17262. <member name="T:log4net.Layout.ILayout">
  17263. <summary>
  17264. Interface implemented by layout objects
  17265. </summary>
  17266. <remarks>
  17267. <para>
  17268. An <see cref="T:log4net.Layout.ILayout"/> object is used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  17269. as text. The <see cref="M:Format(TextWriter,LoggingEvent)"/> method is called by an
  17270. appender to transform the <see cref="T:log4net.Core.LoggingEvent"/> into a string.
  17271. </para>
  17272. <para>
  17273. The layout can also supply <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  17274. text that is appender before any events and after all the events respectively.
  17275. </para>
  17276. </remarks>
  17277. <author>Nicko Cadell</author>
  17278. <author>Gert Driesen</author>
  17279. </member>
  17280. <member name="M:log4net.Layout.ILayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17281. <summary>
  17282. Implement this method to create your own layout format.
  17283. </summary>
  17284. <param name="writer">The TextWriter to write the formatted event to</param>
  17285. <param name="loggingEvent">The event to format</param>
  17286. <remarks>
  17287. <para>
  17288. This method is called by an appender to format
  17289. the <paramref name="loggingEvent"/> as text and output to a writer.
  17290. </para>
  17291. <para>
  17292. If the caller does not have a <see cref="T:System.IO.TextWriter"/> and prefers the
  17293. event to be formatted as a <see cref="T:System.String"/> then the following
  17294. code can be used to format the event into a <see cref="T:System.IO.StringWriter"/>.
  17295. </para>
  17296. <code lang="C#">
  17297. StringWriter writer = new StringWriter();
  17298. Layout.Format(writer, loggingEvent);
  17299. string formattedEvent = writer.ToString();
  17300. </code>
  17301. </remarks>
  17302. </member>
  17303. <member name="P:log4net.Layout.ILayout.ContentType">
  17304. <summary>
  17305. The content type output by this layout.
  17306. </summary>
  17307. <value>The content type</value>
  17308. <remarks>
  17309. <para>
  17310. The content type output by this layout.
  17311. </para>
  17312. <para>
  17313. This is a MIME type e.g. <c>"text/plain"</c>.
  17314. </para>
  17315. </remarks>
  17316. </member>
  17317. <member name="P:log4net.Layout.ILayout.Header">
  17318. <summary>
  17319. The header for the layout format.
  17320. </summary>
  17321. <value>the layout header</value>
  17322. <remarks>
  17323. <para>
  17324. The Header text will be appended before any logging events
  17325. are formatted and appended.
  17326. </para>
  17327. </remarks>
  17328. </member>
  17329. <member name="P:log4net.Layout.ILayout.Footer">
  17330. <summary>
  17331. The footer for the layout format.
  17332. </summary>
  17333. <value>the layout footer</value>
  17334. <remarks>
  17335. <para>
  17336. The Footer text will be appended after all the logging events
  17337. have been formatted and appended.
  17338. </para>
  17339. </remarks>
  17340. </member>
  17341. <member name="P:log4net.Layout.ILayout.IgnoresException">
  17342. <summary>
  17343. Flag indicating if this layout handle exceptions
  17344. </summary>
  17345. <value><c>false</c> if this layout handles exceptions</value>
  17346. <remarks>
  17347. <para>
  17348. If this layout handles the exception object contained within
  17349. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  17350. <c>false</c>. Otherwise, if the layout ignores the exception
  17351. object, then the layout should return <c>true</c>.
  17352. </para>
  17353. </remarks>
  17354. </member>
  17355. <member name="T:log4net.Layout.IRawLayout">
  17356. <summary>
  17357. Interface for raw layout objects
  17358. </summary>
  17359. <remarks>
  17360. <para>
  17361. Interface used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  17362. to an object.
  17363. </para>
  17364. <para>
  17365. This interface should not be confused with the
  17366. <see cref="T:log4net.Layout.ILayout"/> interface. This interface is used in
  17367. only certain specialized situations where a raw object is
  17368. required rather than a formatted string. The <see cref="T:log4net.Layout.ILayout"/>
  17369. is not generally useful than this interface.
  17370. </para>
  17371. </remarks>
  17372. <author>Nicko Cadell</author>
  17373. <author>Gert Driesen</author>
  17374. </member>
  17375. <member name="M:log4net.Layout.IRawLayout.Format(log4net.Core.LoggingEvent)">
  17376. <summary>
  17377. Implement this method to create your own layout format.
  17378. </summary>
  17379. <param name="loggingEvent">The event to format</param>
  17380. <returns>returns the formatted event</returns>
  17381. <remarks>
  17382. <para>
  17383. Implement this method to create your own layout format.
  17384. </para>
  17385. </remarks>
  17386. </member>
  17387. <member name="T:log4net.Layout.Layout2RawLayoutAdapter">
  17388. <summary>
  17389. Adapts any <see cref="T:log4net.Layout.ILayout"/> to a <see cref="T:log4net.Layout.IRawLayout"/>
  17390. </summary>
  17391. <remarks>
  17392. <para>
  17393. Where an <see cref="T:log4net.Layout.IRawLayout"/> is required this adapter
  17394. allows a <see cref="T:log4net.Layout.ILayout"/> to be specified.
  17395. </para>
  17396. </remarks>
  17397. <author>Nicko Cadell</author>
  17398. <author>Gert Driesen</author>
  17399. </member>
  17400. <member name="F:log4net.Layout.Layout2RawLayoutAdapter.m_layout">
  17401. <summary>
  17402. The layout to adapt
  17403. </summary>
  17404. </member>
  17405. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.#ctor(log4net.Layout.ILayout)">
  17406. <summary>
  17407. Construct a new adapter
  17408. </summary>
  17409. <param name="layout">the layout to adapt</param>
  17410. <remarks>
  17411. <para>
  17412. Create the adapter for the specified <paramref name="layout"/>.
  17413. </para>
  17414. </remarks>
  17415. </member>
  17416. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.Format(log4net.Core.LoggingEvent)">
  17417. <summary>
  17418. Format the logging event as an object.
  17419. </summary>
  17420. <param name="loggingEvent">The event to format</param>
  17421. <returns>returns the formatted event</returns>
  17422. <remarks>
  17423. <para>
  17424. Format the logging event as an object.
  17425. </para>
  17426. <para>
  17427. Uses the <see cref="T:log4net.Layout.ILayout"/> object supplied to
  17428. the constructor to perform the formatting.
  17429. </para>
  17430. </remarks>
  17431. </member>
  17432. <member name="T:log4net.Layout.LayoutSkeleton">
  17433. <summary>
  17434. Extend this abstract class to create your own log layout format.
  17435. </summary>
  17436. <remarks>
  17437. <para>
  17438. This is the base implementation of the <see cref="T:log4net.Layout.ILayout"/>
  17439. interface. Most layout objects should extend this class.
  17440. </para>
  17441. </remarks>
  17442. <remarks>
  17443. <note type="inheritinfo">
  17444. <para>
  17445. Subclasses must implement the <see cref="M:Format(TextWriter,LoggingEvent)"/>
  17446. method.
  17447. </para>
  17448. <para>
  17449. Subclasses should set the <see cref="P:log4net.Layout.LayoutSkeleton.IgnoresException"/> in their default
  17450. constructor.
  17451. </para>
  17452. </note>
  17453. </remarks>
  17454. <author>Nicko Cadell</author>
  17455. <author>Gert Driesen</author>
  17456. </member>
  17457. <member name="F:log4net.Layout.LayoutSkeleton.m_header">
  17458. <summary>
  17459. The header text
  17460. </summary>
  17461. <remarks>
  17462. <para>
  17463. See <see cref="P:log4net.Layout.LayoutSkeleton.Header"/> for more information.
  17464. </para>
  17465. </remarks>
  17466. </member>
  17467. <member name="F:log4net.Layout.LayoutSkeleton.m_footer">
  17468. <summary>
  17469. The footer text
  17470. </summary>
  17471. <remarks>
  17472. <para>
  17473. See <see cref="P:log4net.Layout.LayoutSkeleton.Footer"/> for more information.
  17474. </para>
  17475. </remarks>
  17476. </member>
  17477. <member name="F:log4net.Layout.LayoutSkeleton.m_ignoresException">
  17478. <summary>
  17479. Flag indicating if this layout handles exceptions
  17480. </summary>
  17481. <remarks>
  17482. <para>
  17483. <c>false</c> if this layout handles exceptions
  17484. </para>
  17485. </remarks>
  17486. </member>
  17487. <member name="M:log4net.Layout.LayoutSkeleton.#ctor">
  17488. <summary>
  17489. Empty default constructor
  17490. </summary>
  17491. <remarks>
  17492. <para>
  17493. Empty default constructor
  17494. </para>
  17495. </remarks>
  17496. </member>
  17497. <member name="M:log4net.Layout.LayoutSkeleton.ActivateOptions">
  17498. <summary>
  17499. Activate component options
  17500. </summary>
  17501. <remarks>
  17502. <para>
  17503. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17504. activation scheme. The <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> method must
  17505. be called on this object after the configuration properties have
  17506. been set. Until <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> is called this
  17507. object is in an undefined state and must not be used.
  17508. </para>
  17509. <para>
  17510. If any of the configuration properties are modified then
  17511. <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> must be called again.
  17512. </para>
  17513. <para>
  17514. This method must be implemented by the subclass.
  17515. </para>
  17516. </remarks>
  17517. </member>
  17518. <member name="M:log4net.Layout.LayoutSkeleton.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17519. <summary>
  17520. Implement this method to create your own layout format.
  17521. </summary>
  17522. <param name="writer">The TextWriter to write the formatted event to</param>
  17523. <param name="loggingEvent">The event to format</param>
  17524. <remarks>
  17525. <para>
  17526. This method is called by an appender to format
  17527. the <paramref name="loggingEvent"/> as text.
  17528. </para>
  17529. </remarks>
  17530. </member>
  17531. <member name="M:log4net.Layout.LayoutSkeleton.Format(log4net.Core.LoggingEvent)">
  17532. <summary>
  17533. Convenience method for easily formatting the logging event into a string variable.
  17534. </summary>
  17535. <param name="loggingEvent"></param>
  17536. <remarks>
  17537. Creates a new StringWriter instance to store the formatted logging event.
  17538. </remarks>
  17539. </member>
  17540. <member name="P:log4net.Layout.LayoutSkeleton.ContentType">
  17541. <summary>
  17542. The content type output by this layout.
  17543. </summary>
  17544. <value>The content type is <c>"text/plain"</c></value>
  17545. <remarks>
  17546. <para>
  17547. The content type output by this layout.
  17548. </para>
  17549. <para>
  17550. This base class uses the value <c>"text/plain"</c>.
  17551. To change this value a subclass must override this
  17552. property.
  17553. </para>
  17554. </remarks>
  17555. </member>
  17556. <member name="P:log4net.Layout.LayoutSkeleton.Header">
  17557. <summary>
  17558. The header for the layout format.
  17559. </summary>
  17560. <value>the layout header</value>
  17561. <remarks>
  17562. <para>
  17563. The Header text will be appended before any logging events
  17564. are formatted and appended.
  17565. </para>
  17566. </remarks>
  17567. </member>
  17568. <member name="P:log4net.Layout.LayoutSkeleton.Footer">
  17569. <summary>
  17570. The footer for the layout format.
  17571. </summary>
  17572. <value>the layout footer</value>
  17573. <remarks>
  17574. <para>
  17575. The Footer text will be appended after all the logging events
  17576. have been formatted and appended.
  17577. </para>
  17578. </remarks>
  17579. </member>
  17580. <member name="P:log4net.Layout.LayoutSkeleton.IgnoresException">
  17581. <summary>
  17582. Flag indicating if this layout handles exceptions
  17583. </summary>
  17584. <value><c>false</c> if this layout handles exceptions</value>
  17585. <remarks>
  17586. <para>
  17587. If this layout handles the exception object contained within
  17588. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  17589. <c>false</c>. Otherwise, if the layout ignores the exception
  17590. object, then the layout should return <c>true</c>.
  17591. </para>
  17592. <para>
  17593. Set this value to override a this default setting. The default
  17594. value is <c>true</c>, this layout does not handle the exception.
  17595. </para>
  17596. </remarks>
  17597. </member>
  17598. <member name="T:log4net.Layout.PatternLayout">
  17599. <summary>
  17600. A flexible layout configurable with pattern string.
  17601. </summary>
  17602. <remarks>
  17603. <para>
  17604. The goal of this class is to <see cref="M:PatternLayout.Format(TextWriter,LoggingEvent)"/> a
  17605. <see cref="T:log4net.Core.LoggingEvent"/> as a string. The results
  17606. depend on the <i>conversion pattern</i>.
  17607. </para>
  17608. <para>
  17609. The conversion pattern is closely related to the conversion
  17610. pattern of the printf function in C. A conversion pattern is
  17611. composed of literal text and format control expressions called
  17612. <i>conversion specifiers</i>.
  17613. </para>
  17614. <para>
  17615. <i>You are free to insert any literal text within the conversion
  17616. pattern.</i>
  17617. </para>
  17618. <para>
  17619. Each conversion specifier starts with a percent sign (%) and is
  17620. followed by optional <i>format modifiers</i> and a <i>conversion
  17621. pattern name</i>. The conversion pattern name specifies the type of
  17622. data, e.g. logger, level, date, thread name. The format
  17623. modifiers control such things as field width, padding, left and
  17624. right justification. The following is a simple example.
  17625. </para>
  17626. <para>
  17627. Let the conversion pattern be <b>"%-5level [%thread]: %message%newline"</b> and assume
  17628. that the log4net environment was set to use a PatternLayout. Then the
  17629. statements
  17630. </para>
  17631. <code lang="C#">
  17632. ILog log = LogManager.GetLogger(typeof(TestApp));
  17633. log.Debug("Message 1");
  17634. log.Warn("Message 2");
  17635. </code>
  17636. <para>would yield the output</para>
  17637. <code>
  17638. DEBUG [main]: Message 1
  17639. WARN [main]: Message 2
  17640. </code>
  17641. <para>
  17642. Note that there is no explicit separator between text and
  17643. conversion specifiers. The pattern parser knows when it has reached
  17644. the end of a conversion specifier when it reads a conversion
  17645. character. In the example above the conversion specifier
  17646. <b>%-5level</b> means the level of the logging event should be left
  17647. justified to a width of five characters.
  17648. </para>
  17649. <para>
  17650. The recognized conversion pattern names are:
  17651. </para>
  17652. <list type="table">
  17653. <listheader>
  17654. <term>Conversion Pattern Name</term>
  17655. <description>Effect</description>
  17656. </listheader>
  17657. <item>
  17658. <term>a</term>
  17659. <description>Equivalent to <b>appdomain</b></description>
  17660. </item>
  17661. <item>
  17662. <term>appdomain</term>
  17663. <description>
  17664. Used to output the friendly name of the AppDomain where the
  17665. logging event was generated.
  17666. </description>
  17667. </item>
  17668. <item>
  17669. <term>aspnet-cache</term>
  17670. <description>
  17671. <para>
  17672. 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>
  17673. </para>
  17674. <para>
  17675. This pattern is not available for Compact Framework or Client Profile assemblies.
  17676. </para>
  17677. </description>
  17678. </item>
  17679. <item>
  17680. <term>aspnet-context</term>
  17681. <description>
  17682. <para>
  17683. 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>
  17684. </para>
  17685. <para>
  17686. This pattern is not available for Compact Framework or Client Profile assemblies.
  17687. </para>
  17688. </description>
  17689. </item>
  17690. <item>
  17691. <term>aspnet-request</term>
  17692. <description>
  17693. <para>
  17694. 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>
  17695. </para>
  17696. <para>
  17697. This pattern is not available for Compact Framework or Client Profile assemblies.
  17698. </para>
  17699. </description>
  17700. </item>
  17701. <item>
  17702. <term>aspnet-session</term>
  17703. <description>
  17704. <para>
  17705. 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>
  17706. </para>
  17707. <para>
  17708. This pattern is not available for Compact Framework or Client Profile assemblies.
  17709. </para>
  17710. </description>
  17711. </item>
  17712. <item>
  17713. <term>c</term>
  17714. <description>Equivalent to <b>logger</b></description>
  17715. </item>
  17716. <item>
  17717. <term>C</term>
  17718. <description>Equivalent to <b>type</b></description>
  17719. </item>
  17720. <item>
  17721. <term>class</term>
  17722. <description>Equivalent to <b>type</b></description>
  17723. </item>
  17724. <item>
  17725. <term>d</term>
  17726. <description>Equivalent to <b>date</b></description>
  17727. </item>
  17728. <item>
  17729. <term>date</term>
  17730. <description>
  17731. <para>
  17732. Used to output the date of the logging event in the local time zone.
  17733. To output the date in universal time use the <c>%utcdate</c> pattern.
  17734. The date conversion
  17735. specifier may be followed by a <i>date format specifier</i> enclosed
  17736. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  17737. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  17738. given then ISO8601 format is
  17739. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  17740. </para>
  17741. <para>
  17742. The date format specifier admits the same syntax as the
  17743. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  17744. </para>
  17745. <para>
  17746. For better results it is recommended to use the log4net date
  17747. formatters. These can be specified using one of the strings
  17748. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  17749. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  17750. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  17751. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  17752. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  17753. </para>
  17754. <para>
  17755. These dedicated date formatters perform significantly
  17756. better than <see cref="M:DateTime.ToString(string)"/>.
  17757. </para>
  17758. </description>
  17759. </item>
  17760. <item>
  17761. <term>exception</term>
  17762. <description>
  17763. <para>
  17764. Used to output the exception passed in with the log message.
  17765. </para>
  17766. <para>
  17767. If an exception object is stored in the logging event
  17768. it will be rendered into the pattern output with a
  17769. trailing newline.
  17770. If there is no exception then nothing will be output
  17771. and no trailing newline will be appended.
  17772. It is typical to put a newline before the exception
  17773. and to have the exception as the last data in the pattern.
  17774. </para>
  17775. </description>
  17776. </item>
  17777. <item>
  17778. <term>F</term>
  17779. <description>Equivalent to <b>file</b></description>
  17780. </item>
  17781. <item>
  17782. <term>file</term>
  17783. <description>
  17784. <para>
  17785. Used to output the file name where the logging request was
  17786. issued.
  17787. </para>
  17788. <para>
  17789. <b>WARNING</b> Generating caller location information is
  17790. extremely slow. Its use should be avoided unless execution speed
  17791. is not an issue.
  17792. </para>
  17793. <para>
  17794. See the note below on the availability of caller location information.
  17795. </para>
  17796. </description>
  17797. </item>
  17798. <item>
  17799. <term>identity</term>
  17800. <description>
  17801. <para>
  17802. Used to output the user name for the currently active user
  17803. (Principal.Identity.Name).
  17804. </para>
  17805. <para>
  17806. <b>WARNING</b> Generating caller information is
  17807. extremely slow. Its use should be avoided unless execution speed
  17808. is not an issue.
  17809. </para>
  17810. </description>
  17811. </item>
  17812. <item>
  17813. <term>l</term>
  17814. <description>Equivalent to <b>location</b></description>
  17815. </item>
  17816. <item>
  17817. <term>L</term>
  17818. <description>Equivalent to <b>line</b></description>
  17819. </item>
  17820. <item>
  17821. <term>location</term>
  17822. <description>
  17823. <para>
  17824. Used to output location information of the caller which generated
  17825. the logging event.
  17826. </para>
  17827. <para>
  17828. The location information depends on the CLI implementation but
  17829. usually consists of the fully qualified name of the calling
  17830. method followed by the callers source the file name and line
  17831. number between parentheses.
  17832. </para>
  17833. <para>
  17834. The location information can be very useful. However, its
  17835. generation is <b>extremely</b> slow. Its use should be avoided
  17836. unless execution speed is not an issue.
  17837. </para>
  17838. <para>
  17839. See the note below on the availability of caller location information.
  17840. </para>
  17841. </description>
  17842. </item>
  17843. <item>
  17844. <term>level</term>
  17845. <description>
  17846. <para>
  17847. Used to output the level of the logging event.
  17848. </para>
  17849. </description>
  17850. </item>
  17851. <item>
  17852. <term>line</term>
  17853. <description>
  17854. <para>
  17855. Used to output the line number from where the logging request
  17856. was issued.
  17857. </para>
  17858. <para>
  17859. <b>WARNING</b> Generating caller location information is
  17860. extremely slow. Its use should be avoided unless execution speed
  17861. is not an issue.
  17862. </para>
  17863. <para>
  17864. See the note below on the availability of caller location information.
  17865. </para>
  17866. </description>
  17867. </item>
  17868. <item>
  17869. <term>logger</term>
  17870. <description>
  17871. <para>
  17872. Used to output the logger of the logging event. The
  17873. logger conversion specifier can be optionally followed by
  17874. <i>precision specifier</i>, that is a decimal constant in
  17875. brackets.
  17876. </para>
  17877. <para>
  17878. If a precision specifier is given, then only the corresponding
  17879. number of right most components of the logger name will be
  17880. printed. By default the logger name is printed in full.
  17881. </para>
  17882. <para>
  17883. For example, for the logger name "a.b.c" the pattern
  17884. <b>%logger{2}</b> will output "b.c".
  17885. </para>
  17886. </description>
  17887. </item>
  17888. <item>
  17889. <term>m</term>
  17890. <description>Equivalent to <b>message</b></description>
  17891. </item>
  17892. <item>
  17893. <term>M</term>
  17894. <description>Equivalent to <b>method</b></description>
  17895. </item>
  17896. <item>
  17897. <term>message</term>
  17898. <description>
  17899. <para>
  17900. Used to output the application supplied message associated with
  17901. the logging event.
  17902. </para>
  17903. </description>
  17904. </item>
  17905. <item>
  17906. <term>mdc</term>
  17907. <description>
  17908. <para>
  17909. The MDC (old name for the ThreadContext.Properties) is now part of the
  17910. combined event properties. This pattern is supported for compatibility
  17911. but is equivalent to <b>property</b>.
  17912. </para>
  17913. </description>
  17914. </item>
  17915. <item>
  17916. <term>method</term>
  17917. <description>
  17918. <para>
  17919. Used to output the method name where the logging request was
  17920. issued.
  17921. </para>
  17922. <para>
  17923. <b>WARNING</b> Generating caller location information is
  17924. extremely slow. Its use should be avoided unless execution speed
  17925. is not an issue.
  17926. </para>
  17927. <para>
  17928. See the note below on the availability of caller location information.
  17929. </para>
  17930. </description>
  17931. </item>
  17932. <item>
  17933. <term>n</term>
  17934. <description>Equivalent to <b>newline</b></description>
  17935. </item>
  17936. <item>
  17937. <term>newline</term>
  17938. <description>
  17939. <para>
  17940. Outputs the platform dependent line separator character or
  17941. characters.
  17942. </para>
  17943. <para>
  17944. This conversion pattern offers the same performance as using
  17945. non-portable line separator strings such as "\n", or "\r\n".
  17946. Thus, it is the preferred way of specifying a line separator.
  17947. </para>
  17948. </description>
  17949. </item>
  17950. <item>
  17951. <term>ndc</term>
  17952. <description>
  17953. <para>
  17954. Used to output the NDC (nested diagnostic context) associated
  17955. with the thread that generated the logging event.
  17956. </para>
  17957. </description>
  17958. </item>
  17959. <item>
  17960. <term>p</term>
  17961. <description>Equivalent to <b>level</b></description>
  17962. </item>
  17963. <item>
  17964. <term>P</term>
  17965. <description>Equivalent to <b>property</b></description>
  17966. </item>
  17967. <item>
  17968. <term>properties</term>
  17969. <description>Equivalent to <b>property</b></description>
  17970. </item>
  17971. <item>
  17972. <term>property</term>
  17973. <description>
  17974. <para>
  17975. Used to output the an event specific property. The key to
  17976. lookup must be specified within braces and directly following the
  17977. pattern specifier, e.g. <b>%property{user}</b> would include the value
  17978. from the property that is keyed by the string 'user'. Each property value
  17979. that is to be included in the log must be specified separately.
  17980. Properties are added to events by loggers or appenders. By default
  17981. the <c>log4net:HostName</c> property is set to the name of machine on
  17982. which the event was originally logged.
  17983. </para>
  17984. <para>
  17985. If no key is specified, e.g. <b>%property</b> then all the keys and their
  17986. values are printed in a comma separated list.
  17987. </para>
  17988. <para>
  17989. The properties of an event are combined from a number of different
  17990. contexts. These are listed below in the order in which they are searched.
  17991. </para>
  17992. <list type="definition">
  17993. <item>
  17994. <term>the event properties</term>
  17995. <description>
  17996. The event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  17997. properties are specific to this event only.
  17998. </description>
  17999. </item>
  18000. <item>
  18001. <term>the thread properties</term>
  18002. <description>
  18003. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  18004. thread. These properties are shared by all events logged on this thread.
  18005. </description>
  18006. </item>
  18007. <item>
  18008. <term>the global properties</term>
  18009. <description>
  18010. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  18011. properties are shared by all the threads in the AppDomain.
  18012. </description>
  18013. </item>
  18014. </list>
  18015. </description>
  18016. </item>
  18017. <item>
  18018. <term>r</term>
  18019. <description>Equivalent to <b>timestamp</b></description>
  18020. </item>
  18021. <item>
  18022. <term>stacktrace</term>
  18023. <description>
  18024. <para>
  18025. Used to output the stack trace of the logging event
  18026. The stack trace level specifier may be enclosed
  18027. between braces. For example, <b>%stacktrace{level}</b>.
  18028. If no stack trace level specifier is given then 1 is assumed
  18029. </para>
  18030. <para>
  18031. Output uses the format:
  18032. type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1
  18033. </para>
  18034. <para>
  18035. This pattern is not available for Compact Framework assemblies.
  18036. </para>
  18037. </description>
  18038. </item>
  18039. <item>
  18040. <term>stacktracedetail</term>
  18041. <description>
  18042. <para>
  18043. Used to output the stack trace of the logging event
  18044. The stack trace level specifier may be enclosed
  18045. between braces. For example, <b>%stacktracedetail{level}</b>.
  18046. If no stack trace level specifier is given then 1 is assumed
  18047. </para>
  18048. <para>
  18049. Output uses the format:
  18050. type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...)
  18051. </para>
  18052. <para>
  18053. This pattern is not available for Compact Framework assemblies.
  18054. </para>
  18055. </description>
  18056. </item>
  18057. <item>
  18058. <term>t</term>
  18059. <description>Equivalent to <b>thread</b></description>
  18060. </item>
  18061. <item>
  18062. <term>timestamp</term>
  18063. <description>
  18064. <para>
  18065. Used to output the number of milliseconds elapsed since the start
  18066. of the application until the creation of the logging event.
  18067. </para>
  18068. </description>
  18069. </item>
  18070. <item>
  18071. <term>thread</term>
  18072. <description>
  18073. <para>
  18074. Used to output the name of the thread that generated the
  18075. logging event. Uses the thread number if no name is available.
  18076. </para>
  18077. </description>
  18078. </item>
  18079. <item>
  18080. <term>type</term>
  18081. <description>
  18082. <para>
  18083. Used to output the fully qualified type name of the caller
  18084. issuing the logging request. This conversion specifier
  18085. can be optionally followed by <i>precision specifier</i>, that
  18086. is a decimal constant in brackets.
  18087. </para>
  18088. <para>
  18089. If a precision specifier is given, then only the corresponding
  18090. number of right most components of the class name will be
  18091. printed. By default the class name is output in fully qualified form.
  18092. </para>
  18093. <para>
  18094. For example, for the class name "log4net.Layout.PatternLayout", the
  18095. pattern <b>%type{1}</b> will output "PatternLayout".
  18096. </para>
  18097. <para>
  18098. <b>WARNING</b> Generating the caller class information is
  18099. slow. Thus, its use should be avoided unless execution speed is
  18100. not an issue.
  18101. </para>
  18102. <para>
  18103. See the note below on the availability of caller location information.
  18104. </para>
  18105. </description>
  18106. </item>
  18107. <item>
  18108. <term>u</term>
  18109. <description>Equivalent to <b>identity</b></description>
  18110. </item>
  18111. <item>
  18112. <term>username</term>
  18113. <description>
  18114. <para>
  18115. Used to output the WindowsIdentity for the currently
  18116. active user.
  18117. </para>
  18118. <para>
  18119. <b>WARNING</b> Generating caller WindowsIdentity information is
  18120. extremely slow. Its use should be avoided unless execution speed
  18121. is not an issue.
  18122. </para>
  18123. </description>
  18124. </item>
  18125. <item>
  18126. <term>utcdate</term>
  18127. <description>
  18128. <para>
  18129. Used to output the date of the logging event in universal time.
  18130. The date conversion
  18131. specifier may be followed by a <i>date format specifier</i> enclosed
  18132. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  18133. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  18134. given then ISO8601 format is
  18135. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  18136. </para>
  18137. <para>
  18138. The date format specifier admits the same syntax as the
  18139. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  18140. </para>
  18141. <para>
  18142. For better results it is recommended to use the log4net date
  18143. formatters. These can be specified using one of the strings
  18144. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  18145. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  18146. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  18147. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  18148. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  18149. </para>
  18150. <para>
  18151. These dedicated date formatters perform significantly
  18152. better than <see cref="M:DateTime.ToString(string)"/>.
  18153. </para>
  18154. </description>
  18155. </item>
  18156. <item>
  18157. <term>w</term>
  18158. <description>Equivalent to <b>username</b></description>
  18159. </item>
  18160. <item>
  18161. <term>x</term>
  18162. <description>Equivalent to <b>ndc</b></description>
  18163. </item>
  18164. <item>
  18165. <term>X</term>
  18166. <description>Equivalent to <b>mdc</b></description>
  18167. </item>
  18168. <item>
  18169. <term>%</term>
  18170. <description>
  18171. <para>
  18172. The sequence %% outputs a single percent sign.
  18173. </para>
  18174. </description>
  18175. </item>
  18176. </list>
  18177. <para>
  18178. The single letter patterns are deprecated in favor of the
  18179. longer more descriptive pattern names.
  18180. </para>
  18181. <para>
  18182. By default the relevant information is output as is. However,
  18183. with the aid of format modifiers it is possible to change the
  18184. minimum field width, the maximum field width and justification.
  18185. </para>
  18186. <para>
  18187. The optional format modifier is placed between the percent sign
  18188. and the conversion pattern name.
  18189. </para>
  18190. <para>
  18191. The first optional format modifier is the <i>left justification
  18192. flag</i> which is just the minus (-) character. Then comes the
  18193. optional <i>minimum field width</i> modifier. This is a decimal
  18194. constant that represents the minimum number of characters to
  18195. output. If the data item requires fewer characters, it is padded on
  18196. either the left or the right until the minimum width is
  18197. reached. The default is to pad on the left (right justify) but you
  18198. can specify right padding with the left justification flag. The
  18199. padding character is space. If the data item is larger than the
  18200. minimum field width, the field is expanded to accommodate the
  18201. data. The value is never truncated.
  18202. </para>
  18203. <para>
  18204. This behavior can be changed using the <i>maximum field
  18205. width</i> modifier which is designated by a period followed by a
  18206. decimal constant. If the data item is longer than the maximum
  18207. field, then the extra characters are removed from the
  18208. <i>beginning</i> of the data item and not from the end. For
  18209. example, it the maximum field width is eight and the data item is
  18210. ten characters long, then the first two characters of the data item
  18211. are dropped. This behavior deviates from the printf function in C
  18212. where truncation is done from the end.
  18213. </para>
  18214. <para>
  18215. Below are various format modifier examples for the logger
  18216. conversion specifier.
  18217. </para>
  18218. <div class="tablediv">
  18219. <table class="dtTABLE" cellspacing="0">
  18220. <tr>
  18221. <th>Format modifier</th>
  18222. <th>left justify</th>
  18223. <th>minimum width</th>
  18224. <th>maximum width</th>
  18225. <th>comment</th>
  18226. </tr>
  18227. <tr>
  18228. <td align="center">%20logger</td>
  18229. <td align="center">false</td>
  18230. <td align="center">20</td>
  18231. <td align="center">none</td>
  18232. <td>
  18233. <para>
  18234. Left pad with spaces if the logger name is less than 20
  18235. characters long.
  18236. </para>
  18237. </td>
  18238. </tr>
  18239. <tr>
  18240. <td align="center">%-20logger</td>
  18241. <td align="center">true</td>
  18242. <td align="center">20</td>
  18243. <td align="center">none</td>
  18244. <td>
  18245. <para>
  18246. Right pad with spaces if the logger
  18247. name is less than 20 characters long.
  18248. </para>
  18249. </td>
  18250. </tr>
  18251. <tr>
  18252. <td align="center">%.30logger</td>
  18253. <td align="center">NA</td>
  18254. <td align="center">none</td>
  18255. <td align="center">30</td>
  18256. <td>
  18257. <para>
  18258. Truncate from the beginning if the logger
  18259. name is longer than 30 characters.
  18260. </para>
  18261. </td>
  18262. </tr>
  18263. <tr>
  18264. <td align="center"><nobr>%20.30logger</nobr></td>
  18265. <td align="center">false</td>
  18266. <td align="center">20</td>
  18267. <td align="center">30</td>
  18268. <td>
  18269. <para>
  18270. Left pad with spaces if the logger name is shorter than 20
  18271. characters. However, if logger name is longer than 30 characters,
  18272. then truncate from the beginning.
  18273. </para>
  18274. </td>
  18275. </tr>
  18276. <tr>
  18277. <td align="center">%-20.30logger</td>
  18278. <td align="center">true</td>
  18279. <td align="center">20</td>
  18280. <td align="center">30</td>
  18281. <td>
  18282. <para>
  18283. Right pad with spaces if the logger name is shorter than 20
  18284. characters. However, if logger name is longer than 30 characters,
  18285. then truncate from the beginning.
  18286. </para>
  18287. </td>
  18288. </tr>
  18289. </table>
  18290. </div>
  18291. <para>
  18292. <b>Note about caller location information.</b><br />
  18293. The following patterns <c>%type %file %line %method %location %class %C %F %L %l %M</c>
  18294. all generate caller location information.
  18295. Location information uses the <c>System.Diagnostics.StackTrace</c> class to generate
  18296. a call stack. The caller's information is then extracted from this stack.
  18297. </para>
  18298. <note type="caution">
  18299. <para>
  18300. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  18301. .NET Compact Framework 1.0 therefore caller location information is not
  18302. available on that framework.
  18303. </para>
  18304. </note>
  18305. <note type="caution">
  18306. <para>
  18307. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  18308. </para>
  18309. <para>
  18310. "StackTrace information will be most informative with Debug build configurations.
  18311. By default, Debug builds include debug symbols, while Release builds do not. The
  18312. debug symbols contain most of the file, method name, line number, and column
  18313. information used in constructing StackFrame and StackTrace objects. StackTrace
  18314. might not report as many method calls as expected, due to code transformations
  18315. that occur during optimization."
  18316. </para>
  18317. <para>
  18318. This means that in a Release build the caller information may be incomplete or may
  18319. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  18320. </para>
  18321. </note>
  18322. <para>
  18323. Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/>
  18324. instance using the <see cref="M:AddConverter(string, Type)"/> method.
  18325. </para>
  18326. </remarks>
  18327. <example>
  18328. This is a more detailed pattern.
  18329. <code><b>%timestamp [%thread] %level %logger %ndc - %message%newline</b></code>
  18330. </example>
  18331. <example>
  18332. A similar pattern except that the relative time is
  18333. right padded if less than 6 digits, thread name is right padded if
  18334. less than 15 characters and truncated if longer and the logger
  18335. name is left padded if shorter than 30 characters and truncated if
  18336. longer.
  18337. <code><b>%-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline</b></code>
  18338. </example>
  18339. <author>Nicko Cadell</author>
  18340. <author>Gert Driesen</author>
  18341. <author>Douglas de la Torre</author>
  18342. <author>Daniel Cazzulino</author>
  18343. </member>
  18344. <member name="F:log4net.Layout.PatternLayout.DefaultConversionPattern">
  18345. <summary>
  18346. Default pattern string for log output.
  18347. </summary>
  18348. <remarks>
  18349. <para>
  18350. Default pattern string for log output.
  18351. Currently set to the string <b>"%message%newline"</b>
  18352. which just prints the application supplied message.
  18353. </para>
  18354. </remarks>
  18355. </member>
  18356. <member name="F:log4net.Layout.PatternLayout.DetailConversionPattern">
  18357. <summary>
  18358. A detailed conversion pattern
  18359. </summary>
  18360. <remarks>
  18361. <para>
  18362. A conversion pattern which includes Time, Thread, Logger, and Nested Context.
  18363. Current value is <b>%timestamp [%thread] %level %logger %ndc - %message%newline</b>.
  18364. </para>
  18365. </remarks>
  18366. </member>
  18367. <member name="F:log4net.Layout.PatternLayout.s_globalRulesRegistry">
  18368. <summary>
  18369. Internal map of converter identifiers to converter types.
  18370. </summary>
  18371. <remarks>
  18372. <para>
  18373. This static map is overridden by the m_converterRegistry instance map
  18374. </para>
  18375. </remarks>
  18376. </member>
  18377. <member name="F:log4net.Layout.PatternLayout.m_pattern">
  18378. <summary>
  18379. the pattern
  18380. </summary>
  18381. </member>
  18382. <member name="F:log4net.Layout.PatternLayout.m_head">
  18383. <summary>
  18384. the head of the pattern converter chain
  18385. </summary>
  18386. </member>
  18387. <member name="F:log4net.Layout.PatternLayout.m_instanceRulesRegistry">
  18388. <summary>
  18389. patterns defined on this PatternLayout only
  18390. </summary>
  18391. </member>
  18392. <member name="M:log4net.Layout.PatternLayout.#cctor">
  18393. <summary>
  18394. Initialize the global registry
  18395. </summary>
  18396. <remarks>
  18397. <para>
  18398. Defines the builtin global rules.
  18399. </para>
  18400. </remarks>
  18401. </member>
  18402. <member name="M:log4net.Layout.PatternLayout.#ctor">
  18403. <summary>
  18404. Constructs a PatternLayout using the DefaultConversionPattern
  18405. </summary>
  18406. <remarks>
  18407. <para>
  18408. The default pattern just produces the application supplied message.
  18409. </para>
  18410. <para>
  18411. Note to Inheritors: This constructor calls the virtual method
  18412. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  18413. aware that it will be called before your is called constructor.
  18414. </para>
  18415. <para>
  18416. As per the <see cref="T:log4net.Core.IOptionHandler"/> contract the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>
  18417. method must be called after the properties on this object have been
  18418. configured.
  18419. </para>
  18420. </remarks>
  18421. </member>
  18422. <member name="M:log4net.Layout.PatternLayout.#ctor(System.String)">
  18423. <summary>
  18424. Constructs a PatternLayout using the supplied conversion pattern
  18425. </summary>
  18426. <param name="pattern">the pattern to use</param>
  18427. <remarks>
  18428. <para>
  18429. Note to Inheritors: This constructor calls the virtual method
  18430. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  18431. aware that it will be called before your is called constructor.
  18432. </para>
  18433. <para>
  18434. When using this constructor the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method
  18435. need not be called. This may not be the case when using a subclass.
  18436. </para>
  18437. </remarks>
  18438. </member>
  18439. <member name="P:log4net.Layout.PatternLayout.ConversionPattern">
  18440. <summary>
  18441. The pattern formatting string
  18442. </summary>
  18443. <remarks>
  18444. <para>
  18445. The <b>ConversionPattern</b> option. This is the string which
  18446. controls formatting and consists of a mix of literal content and
  18447. conversion specifiers.
  18448. </para>
  18449. </remarks>
  18450. </member>
  18451. <member name="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)">
  18452. <summary>
  18453. Create the pattern parser instance
  18454. </summary>
  18455. <param name="pattern">the pattern to parse</param>
  18456. <returns>The <see cref="T:log4net.Util.PatternParser"/> that will format the event</returns>
  18457. <remarks>
  18458. <para>
  18459. Creates the <see cref="T:log4net.Util.PatternParser"/> used to parse the conversion string. Sets the
  18460. global and instance rules on the <see cref="T:log4net.Util.PatternParser"/>.
  18461. </para>
  18462. </remarks>
  18463. </member>
  18464. <member name="M:log4net.Layout.PatternLayout.ActivateOptions">
  18465. <summary>
  18466. Initialize layout options
  18467. </summary>
  18468. <remarks>
  18469. <para>
  18470. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  18471. activation scheme. The <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method must
  18472. be called on this object after the configuration properties have
  18473. been set. Until <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> is called this
  18474. object is in an undefined state and must not be used.
  18475. </para>
  18476. <para>
  18477. If any of the configuration properties are modified then
  18478. <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> must be called again.
  18479. </para>
  18480. </remarks>
  18481. </member>
  18482. <member name="M:log4net.Layout.PatternLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18483. <summary>
  18484. Produces a formatted string as specified by the conversion pattern.
  18485. </summary>
  18486. <param name="loggingEvent">the event being logged</param>
  18487. <param name="writer">The TextWriter to write the formatted event to</param>
  18488. <remarks>
  18489. <para>
  18490. Parse the <see cref="T:log4net.Core.LoggingEvent"/> using the patter format
  18491. specified in the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> property.
  18492. </para>
  18493. </remarks>
  18494. </member>
  18495. <member name="M:log4net.Layout.PatternLayout.AddConverter(log4net.Util.ConverterInfo)">
  18496. <summary>
  18497. Add a converter to this PatternLayout
  18498. </summary>
  18499. <param name="converterInfo">the converter info</param>
  18500. <remarks>
  18501. <para>
  18502. This version of the method is used by the configurator.
  18503. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  18504. </para>
  18505. </remarks>
  18506. </member>
  18507. <member name="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)">
  18508. <summary>
  18509. Add a converter to this PatternLayout
  18510. </summary>
  18511. <param name="name">the name of the conversion pattern for this converter</param>
  18512. <param name="type">the type of the converter</param>
  18513. <remarks>
  18514. <para>
  18515. Add a named pattern converter to this instance. This
  18516. converter will be used in the formatting of the event.
  18517. This method must be called before <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>.
  18518. </para>
  18519. <para>
  18520. The <paramref name="type"/> specified must extend the
  18521. <see cref="T:log4net.Util.PatternConverter"/> type.
  18522. </para>
  18523. </remarks>
  18524. </member>
  18525. <member name="T:log4net.Layout.Pattern.AppDomainPatternConverter">
  18526. <summary>
  18527. Write the event appdomain name to the output
  18528. </summary>
  18529. <remarks>
  18530. <para>
  18531. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output writer.
  18532. </para>
  18533. </remarks>
  18534. <author>Daniel Cazzulino</author>
  18535. <author>Nicko Cadell</author>
  18536. </member>
  18537. <member name="M:log4net.Layout.Pattern.AppDomainPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18538. <summary>
  18539. Write the event appdomain name to the output
  18540. </summary>
  18541. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18542. <param name="loggingEvent">the event being logged</param>
  18543. <remarks>
  18544. <para>
  18545. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output <paramref name="writer"/>.
  18546. </para>
  18547. </remarks>
  18548. </member>
  18549. <member name="T:log4net.Layout.Pattern.DatePatternConverter">
  18550. <summary>
  18551. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  18552. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  18553. </summary>
  18554. <remarks>
  18555. <para>
  18556. Render the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the writer as a string.
  18557. </para>
  18558. <para>
  18559. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  18560. the formatting of the date. The following values are allowed:
  18561. <list type="definition">
  18562. <listheader>
  18563. <term>Option value</term>
  18564. <description>Output</description>
  18565. </listheader>
  18566. <item>
  18567. <term>ISO8601</term>
  18568. <description>
  18569. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  18570. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  18571. </description>
  18572. </item>
  18573. <item>
  18574. <term>DATE</term>
  18575. <description>
  18576. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  18577. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  18578. </description>
  18579. </item>
  18580. <item>
  18581. <term>ABSOLUTE</term>
  18582. <description>
  18583. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  18584. Formats using the <c>"HH:mm:ss,yyyy"</c> for example, <c>"15:49:37,459"</c>.
  18585. </description>
  18586. </item>
  18587. <item>
  18588. <term>other</term>
  18589. <description>
  18590. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  18591. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  18592. <see cref="M:DateTime.ToString(string)"/> method.
  18593. For details on valid patterns see
  18594. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  18595. </description>
  18596. </item>
  18597. </list>
  18598. </para>
  18599. <para>
  18600. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> is in the local time zone and is rendered in that zone.
  18601. To output the time in Universal time see <see cref="T:log4net.Layout.Pattern.UtcDatePatternConverter"/>.
  18602. </para>
  18603. </remarks>
  18604. <author>Nicko Cadell</author>
  18605. </member>
  18606. <member name="F:log4net.Layout.Pattern.DatePatternConverter.m_dateFormatter">
  18607. <summary>
  18608. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  18609. </summary>
  18610. <remarks>
  18611. <para>
  18612. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  18613. </para>
  18614. </remarks>
  18615. </member>
  18616. <member name="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions">
  18617. <summary>
  18618. Initialize the converter pattern based on the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  18619. </summary>
  18620. <remarks>
  18621. <para>
  18622. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  18623. activation scheme. The <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> method must
  18624. be called on this object after the configuration properties have
  18625. been set. Until <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> is called this
  18626. object is in an undefined state and must not be used.
  18627. </para>
  18628. <para>
  18629. If any of the configuration properties are modified then
  18630. <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> must be called again.
  18631. </para>
  18632. </remarks>
  18633. </member>
  18634. <member name="M:log4net.Layout.Pattern.DatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18635. <summary>
  18636. Convert the pattern into the rendered message
  18637. </summary>
  18638. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18639. <param name="loggingEvent">the event being logged</param>
  18640. <remarks>
  18641. <para>
  18642. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  18643. for it to render it to the writer.
  18644. </para>
  18645. <para>
  18646. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone.
  18647. </para>
  18648. </remarks>
  18649. </member>
  18650. <member name="F:log4net.Layout.Pattern.DatePatternConverter.declaringType">
  18651. <summary>
  18652. The fully qualified type of the DatePatternConverter class.
  18653. </summary>
  18654. <remarks>
  18655. Used by the internal logger to record the Type of the
  18656. log message.
  18657. </remarks>
  18658. </member>
  18659. <member name="T:log4net.Layout.Pattern.ExceptionPatternConverter">
  18660. <summary>
  18661. Write the exception text to the output
  18662. </summary>
  18663. <remarks>
  18664. <para>
  18665. If an exception object is stored in the logging event
  18666. it will be rendered into the pattern output with a
  18667. trailing newline.
  18668. </para>
  18669. <para>
  18670. If there is no exception then nothing will be output
  18671. and no trailing newline will be appended.
  18672. It is typical to put a newline before the exception
  18673. and to have the exception as the last data in the pattern.
  18674. </para>
  18675. </remarks>
  18676. <author>Nicko Cadell</author>
  18677. </member>
  18678. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.#ctor">
  18679. <summary>
  18680. Default constructor
  18681. </summary>
  18682. </member>
  18683. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18684. <summary>
  18685. Write the exception text to the output
  18686. </summary>
  18687. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18688. <param name="loggingEvent">the event being logged</param>
  18689. <remarks>
  18690. <para>
  18691. If an exception object is stored in the logging event
  18692. it will be rendered into the pattern output with a
  18693. trailing newline.
  18694. </para>
  18695. <para>
  18696. If there is no exception or the exception property specified
  18697. by the Option value does not exist then nothing will be output
  18698. and no trailing newline will be appended.
  18699. It is typical to put a newline before the exception
  18700. and to have the exception as the last data in the pattern.
  18701. </para>
  18702. <para>
  18703. Recognized values for the Option parameter are:
  18704. </para>
  18705. <list type="bullet">
  18706. <item>
  18707. <description>Message</description>
  18708. </item>
  18709. <item>
  18710. <description>Source</description>
  18711. </item>
  18712. <item>
  18713. <description>StackTrace</description>
  18714. </item>
  18715. <item>
  18716. <description>TargetSite</description>
  18717. </item>
  18718. <item>
  18719. <description>HelpLink</description>
  18720. </item>
  18721. </list>
  18722. </remarks>
  18723. </member>
  18724. <member name="T:log4net.Layout.Pattern.FileLocationPatternConverter">
  18725. <summary>
  18726. Writes the caller location file name to the output
  18727. </summary>
  18728. <remarks>
  18729. <para>
  18730. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  18731. the event to the output writer.
  18732. </para>
  18733. </remarks>
  18734. <author>Nicko Cadell</author>
  18735. </member>
  18736. <member name="M:log4net.Layout.Pattern.FileLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18737. <summary>
  18738. Write the caller location file name to the output
  18739. </summary>
  18740. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18741. <param name="loggingEvent">the event being logged</param>
  18742. <remarks>
  18743. <para>
  18744. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  18745. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  18746. </para>
  18747. </remarks>
  18748. </member>
  18749. <member name="T:log4net.Layout.Pattern.FullLocationPatternConverter">
  18750. <summary>
  18751. Write the caller location info to the output
  18752. </summary>
  18753. <remarks>
  18754. <para>
  18755. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  18756. </para>
  18757. </remarks>
  18758. <author>Nicko Cadell</author>
  18759. </member>
  18760. <member name="M:log4net.Layout.Pattern.FullLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18761. <summary>
  18762. Write the caller location info to the output
  18763. </summary>
  18764. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18765. <param name="loggingEvent">the event being logged</param>
  18766. <remarks>
  18767. <para>
  18768. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  18769. </para>
  18770. </remarks>
  18771. </member>
  18772. <member name="T:log4net.Layout.Pattern.IdentityPatternConverter">
  18773. <summary>
  18774. Writes the event identity to the output
  18775. </summary>
  18776. <remarks>
  18777. <para>
  18778. Writes the value of the <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  18779. the output writer.
  18780. </para>
  18781. </remarks>
  18782. <author>Daniel Cazzulino</author>
  18783. <author>Nicko Cadell</author>
  18784. </member>
  18785. <member name="M:log4net.Layout.Pattern.IdentityPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18786. <summary>
  18787. Writes the event identity to the output
  18788. </summary>
  18789. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18790. <param name="loggingEvent">the event being logged</param>
  18791. <remarks>
  18792. <para>
  18793. Writes the value of the <paramref name="loggingEvent"/>
  18794. <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  18795. the output <paramref name="writer"/>.
  18796. </para>
  18797. </remarks>
  18798. </member>
  18799. <member name="T:log4net.Layout.Pattern.LevelPatternConverter">
  18800. <summary>
  18801. Write the event level to the output
  18802. </summary>
  18803. <remarks>
  18804. <para>
  18805. Writes the display name of the event <see cref="P:log4net.Core.LoggingEvent.Level"/>
  18806. to the writer.
  18807. </para>
  18808. </remarks>
  18809. <author>Nicko Cadell</author>
  18810. </member>
  18811. <member name="M:log4net.Layout.Pattern.LevelPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18812. <summary>
  18813. Write the event level to the output
  18814. </summary>
  18815. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18816. <param name="loggingEvent">the event being logged</param>
  18817. <remarks>
  18818. <para>
  18819. Writes the <see cref="P:log4net.Core.Level.DisplayName"/> of the <paramref name="loggingEvent"/> <see cref="P:log4net.Core.LoggingEvent.Level"/>
  18820. to the <paramref name="writer"/>.
  18821. </para>
  18822. </remarks>
  18823. </member>
  18824. <member name="T:log4net.Layout.Pattern.LineLocationPatternConverter">
  18825. <summary>
  18826. Write the caller location line number to the output
  18827. </summary>
  18828. <remarks>
  18829. <para>
  18830. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  18831. the event to the output writer.
  18832. </para>
  18833. </remarks>
  18834. <author>Nicko Cadell</author>
  18835. </member>
  18836. <member name="M:log4net.Layout.Pattern.LineLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18837. <summary>
  18838. Write the caller location line number to the output
  18839. </summary>
  18840. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18841. <param name="loggingEvent">the event being logged</param>
  18842. <remarks>
  18843. <para>
  18844. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  18845. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  18846. </para>
  18847. </remarks>
  18848. </member>
  18849. <member name="T:log4net.Layout.Pattern.LoggerPatternConverter">
  18850. <summary>
  18851. Converter for logger name
  18852. </summary>
  18853. <remarks>
  18854. <para>
  18855. Outputs the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the event.
  18856. </para>
  18857. </remarks>
  18858. <author>Nicko Cadell</author>
  18859. </member>
  18860. <member name="M:log4net.Layout.Pattern.LoggerPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  18861. <summary>
  18862. Gets the fully qualified name of the logger
  18863. </summary>
  18864. <param name="loggingEvent">the event being logged</param>
  18865. <returns>The fully qualified logger name</returns>
  18866. <remarks>
  18867. <para>
  18868. Returns the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <paramref name="loggingEvent"/>.
  18869. </para>
  18870. </remarks>
  18871. </member>
  18872. <member name="T:log4net.Layout.Pattern.MessagePatternConverter">
  18873. <summary>
  18874. Writes the event message to the output
  18875. </summary>
  18876. <remarks>
  18877. <para>
  18878. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  18879. to write out the event message.
  18880. </para>
  18881. </remarks>
  18882. <author>Nicko Cadell</author>
  18883. </member>
  18884. <member name="M:log4net.Layout.Pattern.MessagePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18885. <summary>
  18886. Writes the event message to the output
  18887. </summary>
  18888. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18889. <param name="loggingEvent">the event being logged</param>
  18890. <remarks>
  18891. <para>
  18892. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  18893. to write out the event message.
  18894. </para>
  18895. </remarks>
  18896. </member>
  18897. <member name="T:log4net.Layout.Pattern.MethodLocationPatternConverter">
  18898. <summary>
  18899. Write the method name to the output
  18900. </summary>
  18901. <remarks>
  18902. <para>
  18903. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  18904. the output.
  18905. </para>
  18906. </remarks>
  18907. <author>Nicko Cadell</author>
  18908. </member>
  18909. <member name="M:log4net.Layout.Pattern.MethodLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18910. <summary>
  18911. Write the method name to the output
  18912. </summary>
  18913. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18914. <param name="loggingEvent">the event being logged</param>
  18915. <remarks>
  18916. <para>
  18917. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  18918. the output.
  18919. </para>
  18920. </remarks>
  18921. </member>
  18922. <member name="T:log4net.Layout.Pattern.NamedPatternConverter">
  18923. <summary>
  18924. Converter to output and truncate <c>'.'</c> separated strings
  18925. </summary>
  18926. <remarks>
  18927. <para>
  18928. This abstract class supports truncating a <c>'.'</c> separated string
  18929. to show a specified number of elements from the right hand side.
  18930. This is used to truncate class names that are fully qualified.
  18931. </para>
  18932. <para>
  18933. Subclasses should override the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> method to
  18934. return the fully qualified string.
  18935. </para>
  18936. </remarks>
  18937. <author>Nicko Cadell</author>
  18938. </member>
  18939. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions">
  18940. <summary>
  18941. Initialize the converter
  18942. </summary>
  18943. <remarks>
  18944. <para>
  18945. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  18946. activation scheme. The <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> method must
  18947. be called on this object after the configuration properties have
  18948. been set. Until <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> is called this
  18949. object is in an undefined state and must not be used.
  18950. </para>
  18951. <para>
  18952. If any of the configuration properties are modified then
  18953. <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> must be called again.
  18954. </para>
  18955. </remarks>
  18956. </member>
  18957. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  18958. <summary>
  18959. Get the fully qualified string data
  18960. </summary>
  18961. <param name="loggingEvent">the event being logged</param>
  18962. <returns>the fully qualified name</returns>
  18963. <remarks>
  18964. <para>
  18965. Overridden by subclasses to get the fully qualified name before the
  18966. precision is applied to it.
  18967. </para>
  18968. <para>
  18969. Return the fully qualified <c>'.'</c> (dot/period) separated string.
  18970. </para>
  18971. </remarks>
  18972. </member>
  18973. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18974. <summary>
  18975. Convert the pattern to the rendered message
  18976. </summary>
  18977. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18978. <param name="loggingEvent">the event being logged</param>
  18979. <remarks>
  18980. Render the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> to the precision
  18981. specified by the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  18982. </remarks>
  18983. </member>
  18984. <member name="F:log4net.Layout.Pattern.NamedPatternConverter.declaringType">
  18985. <summary>
  18986. The fully qualified type of the NamedPatternConverter class.
  18987. </summary>
  18988. <remarks>
  18989. Used by the internal logger to record the Type of the
  18990. log message.
  18991. </remarks>
  18992. </member>
  18993. <member name="T:log4net.Layout.Pattern.NdcPatternConverter">
  18994. <summary>
  18995. Converter to include event NDC
  18996. </summary>
  18997. <remarks>
  18998. <para>
  18999. Outputs the value of the event property named <c>NDC</c>.
  19000. </para>
  19001. <para>
  19002. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  19003. </para>
  19004. </remarks>
  19005. <author>Nicko Cadell</author>
  19006. </member>
  19007. <member name="M:log4net.Layout.Pattern.NdcPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19008. <summary>
  19009. Write the event NDC to the output
  19010. </summary>
  19011. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19012. <param name="loggingEvent">the event being logged</param>
  19013. <remarks>
  19014. <para>
  19015. As the thread context stacks are now stored in named event properties
  19016. this converter simply looks up the value of the <c>NDC</c> property.
  19017. </para>
  19018. <para>
  19019. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  19020. </para>
  19021. </remarks>
  19022. </member>
  19023. <member name="T:log4net.Layout.Pattern.PatternLayoutConverter">
  19024. <summary>
  19025. Abstract class that provides the formatting functionality that
  19026. derived classes need.
  19027. </summary>
  19028. <remarks>
  19029. Conversion specifiers in a conversion patterns are parsed to
  19030. individual PatternConverters. Each of which is responsible for
  19031. converting a logging event in a converter specific manner.
  19032. </remarks>
  19033. <author>Nicko Cadell</author>
  19034. </member>
  19035. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.#ctor">
  19036. <summary>
  19037. Initializes a new instance of the <see cref="T:log4net.Layout.Pattern.PatternLayoutConverter" /> class.
  19038. </summary>
  19039. </member>
  19040. <member name="P:log4net.Layout.Pattern.PatternLayoutConverter.IgnoresException">
  19041. <summary>
  19042. Flag indicating if this converter handles the logging event exception
  19043. </summary>
  19044. <value><c>false</c> if this converter handles the logging event exception</value>
  19045. <remarks>
  19046. <para>
  19047. If this converter handles the exception object contained within
  19048. <see cref="T:log4net.Core.LoggingEvent"/>, then this property should be set to
  19049. <c>false</c>. Otherwise, if the layout ignores the exception
  19050. object, then the property should be set to <c>true</c>.
  19051. </para>
  19052. <para>
  19053. Set this value to override a this default setting. The default
  19054. value is <c>true</c>, this converter does not handle the exception.
  19055. </para>
  19056. </remarks>
  19057. </member>
  19058. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19059. <summary>
  19060. Derived pattern converters must override this method in order to
  19061. convert conversion specifiers in the correct way.
  19062. </summary>
  19063. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19064. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent" /> on which the pattern converter should be executed.</param>
  19065. </member>
  19066. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,System.Object)">
  19067. <summary>
  19068. Derived pattern converters must override this method in order to
  19069. convert conversion specifiers in the correct way.
  19070. </summary>
  19071. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19072. <param name="state">The state object on which the pattern converter should be executed.</param>
  19073. </member>
  19074. <member name="F:log4net.Layout.Pattern.PatternLayoutConverter.m_ignoresException">
  19075. <summary>
  19076. Flag indicating if this converter handles exceptions
  19077. </summary>
  19078. <remarks>
  19079. <c>false</c> if this converter handles exceptions
  19080. </remarks>
  19081. </member>
  19082. <member name="T:log4net.Layout.Pattern.PropertyPatternConverter">
  19083. <summary>
  19084. Property pattern converter
  19085. </summary>
  19086. <remarks>
  19087. <para>
  19088. Writes out the value of a named property. The property name
  19089. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  19090. property.
  19091. </para>
  19092. <para>
  19093. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  19094. then all the properties are written as key value pairs.
  19095. </para>
  19096. </remarks>
  19097. <author>Nicko Cadell</author>
  19098. </member>
  19099. <member name="M:log4net.Layout.Pattern.PropertyPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19100. <summary>
  19101. Write the property value to the output
  19102. </summary>
  19103. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19104. <param name="loggingEvent">the event being logged</param>
  19105. <remarks>
  19106. <para>
  19107. Writes out the value of a named property. The property name
  19108. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  19109. property.
  19110. </para>
  19111. <para>
  19112. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  19113. then all the properties are written as key value pairs.
  19114. </para>
  19115. </remarks>
  19116. </member>
  19117. <member name="T:log4net.Layout.Pattern.RelativeTimePatternConverter">
  19118. <summary>
  19119. Converter to output the relative time of the event
  19120. </summary>
  19121. <remarks>
  19122. <para>
  19123. Converter to output the time of the event relative to the start of the program.
  19124. </para>
  19125. </remarks>
  19126. <author>Nicko Cadell</author>
  19127. </member>
  19128. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19129. <summary>
  19130. Write the relative time to the output
  19131. </summary>
  19132. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19133. <param name="loggingEvent">the event being logged</param>
  19134. <remarks>
  19135. <para>
  19136. Writes out the relative time of the event in milliseconds.
  19137. That is the number of milliseconds between the event <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  19138. and the <see cref="P:log4net.Core.LoggingEvent.StartTime"/>.
  19139. </para>
  19140. </remarks>
  19141. </member>
  19142. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.TimeDifferenceInMillis(System.DateTime,System.DateTime)">
  19143. <summary>
  19144. Helper method to get the time difference between two DateTime objects
  19145. </summary>
  19146. <param name="start">start time (in the current local time zone)</param>
  19147. <param name="end">end time (in the current local time zone)</param>
  19148. <returns>the time difference in milliseconds</returns>
  19149. </member>
  19150. <member name="T:log4net.Layout.Pattern.StackTraceDetailPatternConverter">
  19151. <summary>
  19152. Write the caller stack frames to the output
  19153. </summary>
  19154. <remarks>
  19155. <para>
  19156. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
  19157. type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...)
  19158. </para>
  19159. </remarks>
  19160. <author>Adam Davies</author>
  19161. </member>
  19162. <member name="F:log4net.Layout.Pattern.StackTraceDetailPatternConverter.declaringType">
  19163. <summary>
  19164. The fully qualified type of the StackTraceDetailPatternConverter class.
  19165. </summary>
  19166. <remarks>
  19167. Used by the internal logger to record the Type of the
  19168. log message.
  19169. </remarks>
  19170. </member>
  19171. <member name="T:log4net.Layout.Pattern.StackTracePatternConverter">
  19172. <summary>
  19173. Write the caller stack frames to the output
  19174. </summary>
  19175. <remarks>
  19176. <para>
  19177. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
  19178. type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1
  19179. </para>
  19180. </remarks>
  19181. <author>Michael Cromwell</author>
  19182. </member>
  19183. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions">
  19184. <summary>
  19185. Initialize the converter
  19186. </summary>
  19187. <remarks>
  19188. <para>
  19189. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19190. activation scheme. The <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> method must
  19191. be called on this object after the configuration properties have
  19192. been set. Until <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> is called this
  19193. object is in an undefined state and must not be used.
  19194. </para>
  19195. <para>
  19196. If any of the configuration properties are modified then
  19197. <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> must be called again.
  19198. </para>
  19199. </remarks>
  19200. </member>
  19201. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19202. <summary>
  19203. Write the strack frames to the output
  19204. </summary>
  19205. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19206. <param name="loggingEvent">the event being logged</param>
  19207. <remarks>
  19208. <para>
  19209. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer.
  19210. </para>
  19211. </remarks>
  19212. </member>
  19213. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.GetMethodInformation(log4net.Core.MethodItem)">
  19214. <summary>
  19215. Returns the Name of the method
  19216. </summary>
  19217. <param name="method"></param>
  19218. <remarks>This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter</remarks>
  19219. <returns>string</returns>
  19220. </member>
  19221. <member name="F:log4net.Layout.Pattern.StackTracePatternConverter.declaringType">
  19222. <summary>
  19223. The fully qualified type of the StackTracePatternConverter class.
  19224. </summary>
  19225. <remarks>
  19226. Used by the internal logger to record the Type of the
  19227. log message.
  19228. </remarks>
  19229. </member>
  19230. <member name="T:log4net.Layout.Pattern.ThreadPatternConverter">
  19231. <summary>
  19232. Converter to include event thread name
  19233. </summary>
  19234. <remarks>
  19235. <para>
  19236. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the output.
  19237. </para>
  19238. </remarks>
  19239. <author>Nicko Cadell</author>
  19240. </member>
  19241. <member name="M:log4net.Layout.Pattern.ThreadPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19242. <summary>
  19243. Write the ThreadName to the output
  19244. </summary>
  19245. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19246. <param name="loggingEvent">the event being logged</param>
  19247. <remarks>
  19248. <para>
  19249. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the <paramref name="writer" />.
  19250. </para>
  19251. </remarks>
  19252. </member>
  19253. <member name="T:log4net.Layout.Pattern.TypeNamePatternConverter">
  19254. <summary>
  19255. Pattern converter for the class name
  19256. </summary>
  19257. <remarks>
  19258. <para>
  19259. Outputs the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the event.
  19260. </para>
  19261. </remarks>
  19262. <author>Nicko Cadell</author>
  19263. </member>
  19264. <member name="M:log4net.Layout.Pattern.TypeNamePatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  19265. <summary>
  19266. Gets the fully qualified name of the class
  19267. </summary>
  19268. <param name="loggingEvent">the event being logged</param>
  19269. <returns>The fully qualified type name for the caller location</returns>
  19270. <remarks>
  19271. <para>
  19272. Returns the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the <paramref name="loggingEvent"/>.
  19273. </para>
  19274. </remarks>
  19275. </member>
  19276. <member name="T:log4net.Layout.Pattern.UserNamePatternConverter">
  19277. <summary>
  19278. Converter to include event user name
  19279. </summary>
  19280. <author>Douglas de la Torre</author>
  19281. <author>Nicko Cadell</author>
  19282. </member>
  19283. <member name="M:log4net.Layout.Pattern.UserNamePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19284. <summary>
  19285. Convert the pattern to the rendered message
  19286. </summary>
  19287. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19288. <param name="loggingEvent">the event being logged</param>
  19289. </member>
  19290. <member name="T:log4net.Layout.Pattern.UtcDatePatternConverter">
  19291. <summary>
  19292. Write the TimeStamp to the output
  19293. </summary>
  19294. <remarks>
  19295. <para>
  19296. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  19297. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  19298. </para>
  19299. <para>
  19300. Uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  19301. in Universal time.
  19302. </para>
  19303. <para>
  19304. See the <see cref="T:log4net.Layout.Pattern.DatePatternConverter"/> for details on the date pattern syntax.
  19305. </para>
  19306. </remarks>
  19307. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  19308. <author>Nicko Cadell</author>
  19309. </member>
  19310. <member name="M:log4net.Layout.Pattern.UtcDatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19311. <summary>
  19312. Write the TimeStamp to the output
  19313. </summary>
  19314. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19315. <param name="loggingEvent">the event being logged</param>
  19316. <remarks>
  19317. <para>
  19318. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  19319. for it to render it to the writer.
  19320. </para>
  19321. <para>
  19322. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone, this is converted
  19323. to Universal time before it is rendered.
  19324. </para>
  19325. </remarks>
  19326. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  19327. </member>
  19328. <member name="F:log4net.Layout.Pattern.UtcDatePatternConverter.declaringType">
  19329. <summary>
  19330. The fully qualified type of the UtcDatePatternConverter class.
  19331. </summary>
  19332. <remarks>
  19333. Used by the internal logger to record the Type of the
  19334. log message.
  19335. </remarks>
  19336. </member>
  19337. <member name="T:log4net.Layout.RawLayoutConverter">
  19338. <summary>
  19339. Type converter for the <see cref="T:log4net.Layout.IRawLayout"/> interface
  19340. </summary>
  19341. <remarks>
  19342. <para>
  19343. Used to convert objects to the <see cref="T:log4net.Layout.IRawLayout"/> interface.
  19344. Supports converting from the <see cref="T:log4net.Layout.ILayout"/> interface to
  19345. the <see cref="T:log4net.Layout.IRawLayout"/> interface using the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>.
  19346. </para>
  19347. </remarks>
  19348. <author>Nicko Cadell</author>
  19349. <author>Gert Driesen</author>
  19350. </member>
  19351. <member name="M:log4net.Layout.RawLayoutConverter.CanConvertFrom(System.Type)">
  19352. <summary>
  19353. Can the sourceType be converted to an <see cref="T:log4net.Layout.IRawLayout"/>
  19354. </summary>
  19355. <param name="sourceType">the source to be to be converted</param>
  19356. <returns><c>true</c> if the source type can be converted to <see cref="T:log4net.Layout.IRawLayout"/></returns>
  19357. <remarks>
  19358. <para>
  19359. Test if the <paramref name="sourceType"/> can be converted to a
  19360. <see cref="T:log4net.Layout.IRawLayout"/>. Only <see cref="T:log4net.Layout.ILayout"/> is supported
  19361. as the <paramref name="sourceType"/>.
  19362. </para>
  19363. </remarks>
  19364. </member>
  19365. <member name="M:log4net.Layout.RawLayoutConverter.ConvertFrom(System.Object)">
  19366. <summary>
  19367. Convert the value to a <see cref="T:log4net.Layout.IRawLayout"/> object
  19368. </summary>
  19369. <param name="source">the value to convert</param>
  19370. <returns>the <see cref="T:log4net.Layout.IRawLayout"/> object</returns>
  19371. <remarks>
  19372. <para>
  19373. Convert the <paramref name="source"/> object to a
  19374. <see cref="T:log4net.Layout.IRawLayout"/> object. If the <paramref name="source"/> object
  19375. is a <see cref="T:log4net.Layout.ILayout"/> then the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>
  19376. is used to adapt between the two interfaces, otherwise an
  19377. exception is thrown.
  19378. </para>
  19379. </remarks>
  19380. </member>
  19381. <member name="T:log4net.Layout.RawPropertyLayout">
  19382. <summary>
  19383. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  19384. </summary>
  19385. <remarks>
  19386. <para>
  19387. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  19388. </para>
  19389. </remarks>
  19390. <author>Nicko Cadell</author>
  19391. </member>
  19392. <member name="M:log4net.Layout.RawPropertyLayout.#ctor">
  19393. <summary>
  19394. Constructs a RawPropertyLayout
  19395. </summary>
  19396. </member>
  19397. <member name="P:log4net.Layout.RawPropertyLayout.Key">
  19398. <summary>
  19399. The name of the value to lookup in the LoggingEvent Properties collection.
  19400. </summary>
  19401. <value>
  19402. Value to lookup in the LoggingEvent Properties collection
  19403. </value>
  19404. <remarks>
  19405. <para>
  19406. String name of the property to lookup in the <see cref="T:log4net.Core.LoggingEvent"/>.
  19407. </para>
  19408. </remarks>
  19409. </member>
  19410. <member name="M:log4net.Layout.RawPropertyLayout.Format(log4net.Core.LoggingEvent)">
  19411. <summary>
  19412. Lookup the property for <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>
  19413. </summary>
  19414. <param name="loggingEvent">The event to format</param>
  19415. <returns>returns property value</returns>
  19416. <remarks>
  19417. <para>
  19418. Looks up and returns the object value of the property
  19419. named <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>. If there is no property defined
  19420. with than name then <c>null</c> will be returned.
  19421. </para>
  19422. </remarks>
  19423. </member>
  19424. <member name="T:log4net.Layout.RawTimeStampLayout">
  19425. <summary>
  19426. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19427. </summary>
  19428. <remarks>
  19429. <para>
  19430. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19431. </para>
  19432. </remarks>
  19433. <author>Nicko Cadell</author>
  19434. <author>Gert Driesen</author>
  19435. </member>
  19436. <member name="M:log4net.Layout.RawTimeStampLayout.#ctor">
  19437. <summary>
  19438. Constructs a RawTimeStampLayout
  19439. </summary>
  19440. </member>
  19441. <member name="M:log4net.Layout.RawTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  19442. <summary>
  19443. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19444. </summary>
  19445. <param name="loggingEvent">The event to format</param>
  19446. <returns>returns the time stamp</returns>
  19447. <remarks>
  19448. <para>
  19449. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19450. </para>
  19451. <para>
  19452. The time stamp is in local time. To format the time stamp
  19453. in universal time use <see cref="T:log4net.Layout.RawUtcTimeStampLayout"/>.
  19454. </para>
  19455. </remarks>
  19456. </member>
  19457. <member name="T:log4net.Layout.RawUtcTimeStampLayout">
  19458. <summary>
  19459. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19460. </summary>
  19461. <remarks>
  19462. <para>
  19463. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19464. </para>
  19465. </remarks>
  19466. <author>Nicko Cadell</author>
  19467. <author>Gert Driesen</author>
  19468. </member>
  19469. <member name="M:log4net.Layout.RawUtcTimeStampLayout.#ctor">
  19470. <summary>
  19471. Constructs a RawUtcTimeStampLayout
  19472. </summary>
  19473. </member>
  19474. <member name="M:log4net.Layout.RawUtcTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  19475. <summary>
  19476. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19477. </summary>
  19478. <param name="loggingEvent">The event to format</param>
  19479. <returns>returns the time stamp</returns>
  19480. <remarks>
  19481. <para>
  19482. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19483. </para>
  19484. <para>
  19485. The time stamp is in universal time. To format the time stamp
  19486. in local time use <see cref="T:log4net.Layout.RawTimeStampLayout"/>.
  19487. </para>
  19488. </remarks>
  19489. </member>
  19490. <member name="T:log4net.Layout.SimpleLayout">
  19491. <summary>
  19492. A very simple layout
  19493. </summary>
  19494. <remarks>
  19495. <para>
  19496. SimpleLayout consists of the level of the log statement,
  19497. followed by " - " and then the log message itself. For example,
  19498. <code>
  19499. DEBUG - Hello world
  19500. </code>
  19501. </para>
  19502. </remarks>
  19503. <author>Nicko Cadell</author>
  19504. <author>Gert Driesen</author>
  19505. </member>
  19506. <member name="M:log4net.Layout.SimpleLayout.#ctor">
  19507. <summary>
  19508. Constructs a SimpleLayout
  19509. </summary>
  19510. </member>
  19511. <member name="M:log4net.Layout.SimpleLayout.ActivateOptions">
  19512. <summary>
  19513. Initialize layout options
  19514. </summary>
  19515. <remarks>
  19516. <para>
  19517. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19518. activation scheme. The <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> method must
  19519. be called on this object after the configuration properties have
  19520. been set. Until <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> is called this
  19521. object is in an undefined state and must not be used.
  19522. </para>
  19523. <para>
  19524. If any of the configuration properties are modified then
  19525. <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> must be called again.
  19526. </para>
  19527. </remarks>
  19528. </member>
  19529. <member name="M:log4net.Layout.SimpleLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19530. <summary>
  19531. Produces a simple formatted output.
  19532. </summary>
  19533. <param name="loggingEvent">the event being logged</param>
  19534. <param name="writer">The TextWriter to write the formatted event to</param>
  19535. <remarks>
  19536. <para>
  19537. Formats the event as the level of the even,
  19538. followed by " - " and then the log message itself. The
  19539. output is terminated by a newline.
  19540. </para>
  19541. </remarks>
  19542. </member>
  19543. <member name="T:log4net.Layout.XmlLayout">
  19544. <summary>
  19545. Layout that formats the log events as XML elements.
  19546. </summary>
  19547. <remarks>
  19548. <para>
  19549. The output of the <see cref="T:log4net.Layout.XmlLayout" /> consists of a series of
  19550. log4net:event elements. It does not output a complete well-formed XML
  19551. file. The output is designed to be included as an <em>external entity</em>
  19552. in a separate file to form a correct XML file.
  19553. </para>
  19554. <para>
  19555. For example, if <c>abc</c> is the name of the file where
  19556. the <see cref="T:log4net.Layout.XmlLayout" /> output goes, then a well-formed XML file would
  19557. be:
  19558. </para>
  19559. <code lang="XML">
  19560. &lt;?xml version="1.0" ?&gt;
  19561. &lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
  19562. &lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
  19563. &amp;data;
  19564. &lt;/log4net:events&gt;
  19565. </code>
  19566. <para>
  19567. This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout" />
  19568. and the appender where it is embedded.
  19569. </para>
  19570. <para>
  19571. The <c>version</c> attribute helps components to correctly
  19572. interpret output generated by <see cref="T:log4net.Layout.XmlLayout" />. The value of
  19573. this attribute should be "1.2" for release 1.2 and later.
  19574. </para>
  19575. <para>
  19576. Alternatively the <c>Header</c> and <c>Footer</c> properties can be
  19577. configured to output the correct XML header, open tag and close tag.
  19578. When setting the <c>Header</c> and <c>Footer</c> properties it is essential
  19579. that the underlying data store not be appendable otherwise the data
  19580. will become invalid XML.
  19581. </para>
  19582. </remarks>
  19583. <author>Nicko Cadell</author>
  19584. <author>Gert Driesen</author>
  19585. </member>
  19586. <member name="M:log4net.Layout.XmlLayout.#ctor">
  19587. <summary>
  19588. Constructs an XmlLayout
  19589. </summary>
  19590. </member>
  19591. <member name="M:log4net.Layout.XmlLayout.#ctor(System.Boolean)">
  19592. <summary>
  19593. Constructs an XmlLayout.
  19594. </summary>
  19595. <remarks>
  19596. <para>
  19597. The <b>LocationInfo</b> option takes a boolean value. By
  19598. default, it is set to false which means there will be no location
  19599. information output by this layout. If the the option is set to
  19600. true, then the file name and line number of the statement
  19601. at the origin of the log statement will be output.
  19602. </para>
  19603. <para>
  19604. If you are embedding this layout within an SmtpAppender
  19605. then make sure to set the <b>LocationInfo</b> option of that
  19606. appender as well.
  19607. </para>
  19608. </remarks>
  19609. </member>
  19610. <member name="P:log4net.Layout.XmlLayout.Prefix">
  19611. <summary>
  19612. The prefix to use for all element names
  19613. </summary>
  19614. <remarks>
  19615. <para>
  19616. The default prefix is <b>log4net</b>. Set this property
  19617. to change the prefix. If the prefix is set to an empty string
  19618. then no prefix will be written.
  19619. </para>
  19620. </remarks>
  19621. </member>
  19622. <member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage">
  19623. <summary>
  19624. Set whether or not to base64 encode the message.
  19625. </summary>
  19626. <remarks>
  19627. <para>
  19628. By default the log message will be written as text to the xml
  19629. output. This can cause problems when the message contains binary
  19630. data. By setting this to true the contents of the message will be
  19631. base64 encoded. If this is set then invalid character replacement
  19632. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  19633. on the log message.
  19634. </para>
  19635. </remarks>
  19636. </member>
  19637. <member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties">
  19638. <summary>
  19639. Set whether or not to base64 encode the property values.
  19640. </summary>
  19641. <remarks>
  19642. <para>
  19643. By default the properties will be written as text to the xml
  19644. output. This can cause problems when one or more properties contain
  19645. binary data. By setting this to true the values of the properties
  19646. will be base64 encoded. If this is set then invalid character replacement
  19647. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  19648. on the property values.
  19649. </para>
  19650. </remarks>
  19651. </member>
  19652. <member name="M:log4net.Layout.XmlLayout.ActivateOptions">
  19653. <summary>
  19654. Initialize layout options
  19655. </summary>
  19656. <remarks>
  19657. <para>
  19658. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19659. activation scheme. The <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> method must
  19660. be called on this object after the configuration properties have
  19661. been set. Until <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> is called this
  19662. object is in an undefined state and must not be used.
  19663. </para>
  19664. <para>
  19665. If any of the configuration properties are modified then
  19666. <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> must be called again.
  19667. </para>
  19668. <para>
  19669. Builds a cache of the element names
  19670. </para>
  19671. </remarks>
  19672. </member>
  19673. <member name="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  19674. <summary>
  19675. Does the actual writing of the XML.
  19676. </summary>
  19677. <param name="writer">The writer to use to output the event to.</param>
  19678. <param name="loggingEvent">The event to write.</param>
  19679. <remarks>
  19680. <para>
  19681. Override the base class <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method
  19682. to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>.
  19683. </para>
  19684. </remarks>
  19685. </member>
  19686. <member name="F:log4net.Layout.XmlLayout.m_prefix">
  19687. <summary>
  19688. The prefix to use for all generated element names
  19689. </summary>
  19690. </member>
  19691. <member name="T:log4net.Layout.XmlLayoutBase">
  19692. <summary>
  19693. Layout that formats the log events as XML elements.
  19694. </summary>
  19695. <remarks>
  19696. <para>
  19697. This is an abstract class that must be subclassed by an implementation
  19698. to conform to a specific schema.
  19699. </para>
  19700. <para>
  19701. Deriving classes must implement the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method.
  19702. </para>
  19703. </remarks>
  19704. <author>Nicko Cadell</author>
  19705. <author>Gert Driesen</author>
  19706. </member>
  19707. <member name="M:log4net.Layout.XmlLayoutBase.#ctor">
  19708. <summary>
  19709. Protected constructor to support subclasses
  19710. </summary>
  19711. <remarks>
  19712. <para>
  19713. Initializes a new instance of the <see cref="T:log4net.Layout.XmlLayoutBase" /> class
  19714. with no location info.
  19715. </para>
  19716. </remarks>
  19717. </member>
  19718. <member name="M:log4net.Layout.XmlLayoutBase.#ctor(System.Boolean)">
  19719. <summary>
  19720. Protected constructor to support subclasses
  19721. </summary>
  19722. <remarks>
  19723. <para>
  19724. The <paramref name="locationInfo" /> parameter determines whether
  19725. location information will be output by the layout. If
  19726. <paramref name="locationInfo" /> is set to <c>true</c>, then the
  19727. file name and line number of the statement at the origin of the log
  19728. statement will be output.
  19729. </para>
  19730. <para>
  19731. If you are embedding this layout within an SMTPAppender
  19732. then make sure to set the <b>LocationInfo</b> option of that
  19733. appender as well.
  19734. </para>
  19735. </remarks>
  19736. </member>
  19737. <member name="P:log4net.Layout.XmlLayoutBase.LocationInfo">
  19738. <summary>
  19739. Gets a value indicating whether to include location information in
  19740. the XML events.
  19741. </summary>
  19742. <value>
  19743. <c>true</c> if location information should be included in the XML
  19744. events; otherwise, <c>false</c>.
  19745. </value>
  19746. <remarks>
  19747. <para>
  19748. If <see cref="P:log4net.Layout.XmlLayoutBase.LocationInfo" /> is set to <c>true</c>, then the file
  19749. name and line number of the statement at the origin of the log
  19750. statement will be output.
  19751. </para>
  19752. <para>
  19753. If you are embedding this layout within an <c>SMTPAppender</c>
  19754. then make sure to set the <b>LocationInfo</b> option of that
  19755. appender as well.
  19756. </para>
  19757. </remarks>
  19758. </member>
  19759. <member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement">
  19760. <summary>
  19761. The string to replace characters that can not be expressed in XML with.
  19762. <remarks>
  19763. <para>
  19764. Not all characters may be expressed in XML. This property contains the
  19765. string to replace those that can not with. This defaults to a ?. Set it
  19766. to the empty string to simply remove offending characters. For more
  19767. details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
  19768. Character replacement will occur in the log message, the property names
  19769. and the property values.
  19770. </para>
  19771. </remarks>
  19772. </summary>
  19773. </member>
  19774. <member name="M:log4net.Layout.XmlLayoutBase.ActivateOptions">
  19775. <summary>
  19776. Initialize layout options
  19777. </summary>
  19778. <remarks>
  19779. <para>
  19780. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19781. activation scheme. The <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> method must
  19782. be called on this object after the configuration properties have
  19783. been set. Until <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> is called this
  19784. object is in an undefined state and must not be used.
  19785. </para>
  19786. <para>
  19787. If any of the configuration properties are modified then
  19788. <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> must be called again.
  19789. </para>
  19790. </remarks>
  19791. </member>
  19792. <member name="P:log4net.Layout.XmlLayoutBase.ContentType">
  19793. <summary>
  19794. Gets the content type output by this layout.
  19795. </summary>
  19796. <value>
  19797. As this is the XML layout, the value is always <c>"text/xml"</c>.
  19798. </value>
  19799. <remarks>
  19800. <para>
  19801. As this is the XML layout, the value is always <c>"text/xml"</c>.
  19802. </para>
  19803. </remarks>
  19804. </member>
  19805. <member name="M:log4net.Layout.XmlLayoutBase.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19806. <summary>
  19807. Produces a formatted string.
  19808. </summary>
  19809. <param name="loggingEvent">The event being logged.</param>
  19810. <param name="writer">The TextWriter to write the formatted event to</param>
  19811. <remarks>
  19812. <para>
  19813. Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>.
  19814. </para>
  19815. <para>
  19816. This method creates an <see cref="T:System.Xml.XmlTextWriter"/> that writes to the
  19817. <paramref name="writer"/>. The <see cref="T:System.Xml.XmlTextWriter"/> is passed
  19818. to the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the
  19819. <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method.
  19820. </para>
  19821. </remarks>
  19822. </member>
  19823. <member name="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  19824. <summary>
  19825. Does the actual writing of the XML.
  19826. </summary>
  19827. <param name="writer">The writer to use to output the event to.</param>
  19828. <param name="loggingEvent">The event to write.</param>
  19829. <remarks>
  19830. <para>
  19831. Subclasses should override this method to format
  19832. the <see cref="T:log4net.Core.LoggingEvent"/> as XML.
  19833. </para>
  19834. </remarks>
  19835. </member>
  19836. <member name="F:log4net.Layout.XmlLayoutBase.m_locationInfo">
  19837. <summary>
  19838. Flag to indicate if location information should be included in
  19839. the XML events.
  19840. </summary>
  19841. </member>
  19842. <member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement">
  19843. <summary>
  19844. The string to replace invalid chars with
  19845. </summary>
  19846. </member>
  19847. <member name="T:log4net.Layout.XmlLayoutSchemaLog4j">
  19848. <summary>
  19849. Layout that formats the log events as XML elements compatible with the log4j schema
  19850. </summary>
  19851. <remarks>
  19852. <para>
  19853. Formats the log events according to the http://logging.apache.org/log4j schema.
  19854. </para>
  19855. </remarks>
  19856. <author>Nicko Cadell</author>
  19857. </member>
  19858. <member name="F:log4net.Layout.XmlLayoutSchemaLog4j.s_date1970">
  19859. <summary>
  19860. The 1st of January 1970 in UTC
  19861. </summary>
  19862. </member>
  19863. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor">
  19864. <summary>
  19865. Constructs an XMLLayoutSchemaLog4j
  19866. </summary>
  19867. </member>
  19868. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor(System.Boolean)">
  19869. <summary>
  19870. Constructs an XMLLayoutSchemaLog4j.
  19871. </summary>
  19872. <remarks>
  19873. <para>
  19874. The <b>LocationInfo</b> option takes a boolean value. By
  19875. default, it is set to false which means there will be no location
  19876. information output by this layout. If the the option is set to
  19877. true, then the file name and line number of the statement
  19878. at the origin of the log statement will be output.
  19879. </para>
  19880. <para>
  19881. If you are embedding this layout within an SMTPAppender
  19882. then make sure to set the <b>LocationInfo</b> option of that
  19883. appender as well.
  19884. </para>
  19885. </remarks>
  19886. </member>
  19887. <member name="P:log4net.Layout.XmlLayoutSchemaLog4j.Version">
  19888. <summary>
  19889. The version of the log4j schema to use.
  19890. </summary>
  19891. <remarks>
  19892. <para>
  19893. Only version 1.2 of the log4j schema is supported.
  19894. </para>
  19895. </remarks>
  19896. </member>
  19897. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  19898. <summary>
  19899. Actually do the writing of the xml
  19900. </summary>
  19901. <param name="writer">the writer to use</param>
  19902. <param name="loggingEvent">the event to write</param>
  19903. <remarks>
  19904. <para>
  19905. Generate XML that is compatible with the log4j schema.
  19906. </para>
  19907. </remarks>
  19908. </member>
  19909. <member name="T:log4net.LogicalThreadContext">
  19910. <summary>
  19911. The log4net Logical Thread Context.
  19912. </summary>
  19913. <remarks>
  19914. <para>
  19915. The <c>LogicalThreadContext</c> provides a location for <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> specific debugging
  19916. information to be stored.
  19917. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> or <see cref="T:log4net.GlobalContext"/>
  19918. properties with the same name.
  19919. </para>
  19920. <para>
  19921. For .NET Standard 1.3 this class uses
  19922. System.Threading.AsyncLocal rather than <see
  19923. cref="T:System.Runtime.Remoting.Messaging.CallContext"/>.
  19924. </para>
  19925. <para>
  19926. The Logical Thread Context has a properties map and a stack.
  19927. The properties and stack can
  19928. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  19929. supports selecting and outputting these properties.
  19930. </para>
  19931. <para>
  19932. The Logical Thread Context provides a diagnostic context for the current call context.
  19933. This is an instrument for distinguishing interleaved log
  19934. output from different sources. Log output is typically interleaved
  19935. when a server handles multiple clients near-simultaneously.
  19936. </para>
  19937. <para>
  19938. The Logical Thread Context is managed on a per <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> basis.
  19939. </para>
  19940. <para>
  19941. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  19942. <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
  19943. <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  19944. If the calling code does not have this permission then this context will be disabled.
  19945. It will not store any property values set on it.
  19946. </para>
  19947. </remarks>
  19948. <example>Example of using the thread context properties to store a username.
  19949. <code lang="C#">
  19950. LogicalThreadContext.Properties["user"] = userName;
  19951. log.Info("This log message has a LogicalThreadContext Property called 'user'");
  19952. </code>
  19953. </example>
  19954. <example>Example of how to push a message into the context stack
  19955. <code lang="C#">
  19956. using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
  19957. {
  19958. log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
  19959. } // at the end of the using block the message is automatically popped
  19960. </code>
  19961. </example>
  19962. <threadsafety static="true" instance="true" />
  19963. <author>Nicko Cadell</author>
  19964. </member>
  19965. <member name="M:log4net.LogicalThreadContext.#ctor">
  19966. <summary>
  19967. Private Constructor.
  19968. </summary>
  19969. <remarks>
  19970. <para>
  19971. Uses a private access modifier to prevent instantiation of this class.
  19972. </para>
  19973. </remarks>
  19974. </member>
  19975. <member name="P:log4net.LogicalThreadContext.Properties">
  19976. <summary>
  19977. The thread properties map
  19978. </summary>
  19979. <value>
  19980. The thread properties map
  19981. </value>
  19982. <remarks>
  19983. <para>
  19984. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/>
  19985. or <see cref="T:log4net.GlobalContext"/> properties with the same name.
  19986. </para>
  19987. </remarks>
  19988. </member>
  19989. <member name="P:log4net.LogicalThreadContext.Stacks">
  19990. <summary>
  19991. The thread stacks
  19992. </summary>
  19993. <value>
  19994. stack map
  19995. </value>
  19996. <remarks>
  19997. <para>
  19998. The logical thread stacks.
  19999. </para>
  20000. </remarks>
  20001. </member>
  20002. <member name="F:log4net.LogicalThreadContext.s_properties">
  20003. <summary>
  20004. The thread context properties instance
  20005. </summary>
  20006. </member>
  20007. <member name="F:log4net.LogicalThreadContext.s_stacks">
  20008. <summary>
  20009. The thread context stacks instance
  20010. </summary>
  20011. </member>
  20012. <member name="T:log4net.LogManager">
  20013. <summary>
  20014. This class is used by client applications to request logger instances.
  20015. </summary>
  20016. <remarks>
  20017. <para>
  20018. This class has static methods that are used by a client to request
  20019. a logger instance. The <see cref="M:GetLogger(string)"/> method is
  20020. used to retrieve a logger.
  20021. </para>
  20022. <para>
  20023. See the <see cref="T:log4net.ILog"/> interface for more details.
  20024. </para>
  20025. </remarks>
  20026. <example>Simple example of logging messages
  20027. <code lang="C#">
  20028. ILog log = LogManager.GetLogger("application-log");
  20029. log.Info("Application Start");
  20030. log.Debug("This is a debug message");
  20031. if (log.IsDebugEnabled)
  20032. {
  20033. log.Debug("This is another debug message");
  20034. }
  20035. </code>
  20036. </example>
  20037. <threadsafety static="true" instance="true" />
  20038. <seealso cref="T:log4net.ILog"/>
  20039. <author>Nicko Cadell</author>
  20040. <author>Gert Driesen</author>
  20041. </member>
  20042. <member name="M:log4net.LogManager.#ctor">
  20043. <summary>
  20044. Initializes a new instance of the <see cref="T:log4net.LogManager" /> class.
  20045. </summary>
  20046. <remarks>
  20047. Uses a private access modifier to prevent instantiation of this class.
  20048. </remarks>
  20049. </member>
  20050. <member name="M:log4net.LogManager.Exists(System.String)">
  20051. <overloads>Returns the named logger if it exists.</overloads>
  20052. <summary>
  20053. Returns the named logger if it exists.
  20054. </summary>
  20055. <remarks>
  20056. <para>
  20057. If the named logger exists (in the default repository) then it
  20058. returns a reference to the logger, otherwise it returns <c>null</c>.
  20059. </para>
  20060. </remarks>
  20061. <param name="name">The fully qualified logger name to look for.</param>
  20062. <returns>The logger found, or <c>null</c> if no logger could be found.</returns>
  20063. </member>
  20064. <member name="M:log4net.LogManager.GetCurrentLoggers">
  20065. <overloads>Get the currently defined loggers.</overloads>
  20066. <summary>
  20067. Returns all the currently defined loggers in the default repository.
  20068. </summary>
  20069. <remarks>
  20070. <para>The root logger is <b>not</b> included in the returned array.</para>
  20071. </remarks>
  20072. <returns>All the defined loggers.</returns>
  20073. </member>
  20074. <member name="M:log4net.LogManager.GetLogger(System.String)">
  20075. <overloads>Get or create a logger.</overloads>
  20076. <summary>
  20077. Retrieves or creates a named logger.
  20078. </summary>
  20079. <remarks>
  20080. <para>
  20081. Retrieves a logger named as the <paramref name="name"/>
  20082. parameter. If the named logger already exists, then the
  20083. existing instance will be returned. Otherwise, a new instance is
  20084. created.
  20085. </para>
  20086. <para>By default, loggers do not have a set level but inherit
  20087. it from the hierarchy. This is one of the central features of
  20088. log4net.
  20089. </para>
  20090. </remarks>
  20091. <param name="name">The name of the logger to retrieve.</param>
  20092. <returns>The logger with the name specified.</returns>
  20093. </member>
  20094. <member name="M:log4net.LogManager.Exists(System.String,System.String)">
  20095. <summary>
  20096. Returns the named logger if it exists.
  20097. </summary>
  20098. <remarks>
  20099. <para>
  20100. If the named logger exists (in the specified repository) then it
  20101. returns a reference to the logger, otherwise it returns
  20102. <c>null</c>.
  20103. </para>
  20104. </remarks>
  20105. <param name="repository">The repository to lookup in.</param>
  20106. <param name="name">The fully qualified logger name to look for.</param>
  20107. <returns>
  20108. The logger found, or <c>null</c> if the logger doesn't exist in the specified
  20109. repository.
  20110. </returns>
  20111. </member>
  20112. <member name="M:log4net.LogManager.Exists(System.Reflection.Assembly,System.String)">
  20113. <summary>
  20114. Returns the named logger if it exists.
  20115. </summary>
  20116. <remarks>
  20117. <para>
  20118. If the named logger exists (in the repository for the specified assembly) then it
  20119. returns a reference to the logger, otherwise it returns
  20120. <c>null</c>.
  20121. </para>
  20122. </remarks>
  20123. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20124. <param name="name">The fully qualified logger name to look for.</param>
  20125. <returns>
  20126. The logger, or <c>null</c> if the logger doesn't exist in the specified
  20127. assembly's repository.
  20128. </returns>
  20129. </member>
  20130. <member name="M:log4net.LogManager.GetCurrentLoggers(System.String)">
  20131. <summary>
  20132. Returns all the currently defined loggers in the specified repository.
  20133. </summary>
  20134. <param name="repository">The repository to lookup in.</param>
  20135. <remarks>
  20136. The root logger is <b>not</b> included in the returned array.
  20137. </remarks>
  20138. <returns>All the defined loggers.</returns>
  20139. </member>
  20140. <member name="M:log4net.LogManager.GetCurrentLoggers(System.Reflection.Assembly)">
  20141. <summary>
  20142. Returns all the currently defined loggers in the specified assembly's repository.
  20143. </summary>
  20144. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20145. <remarks>
  20146. The root logger is <b>not</b> included in the returned array.
  20147. </remarks>
  20148. <returns>All the defined loggers.</returns>
  20149. </member>
  20150. <member name="M:log4net.LogManager.GetLogger(System.String,System.String)">
  20151. <summary>
  20152. Retrieves or creates a named logger.
  20153. </summary>
  20154. <remarks>
  20155. <para>
  20156. Retrieve a logger named as the <paramref name="name"/>
  20157. parameter. If the named logger already exists, then the
  20158. existing instance will be returned. Otherwise, a new instance is
  20159. created.
  20160. </para>
  20161. <para>
  20162. By default, loggers do not have a set level but inherit
  20163. it from the hierarchy. This is one of the central features of
  20164. log4net.
  20165. </para>
  20166. </remarks>
  20167. <param name="repository">The repository to lookup in.</param>
  20168. <param name="name">The name of the logger to retrieve.</param>
  20169. <returns>The logger with the name specified.</returns>
  20170. </member>
  20171. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.String)">
  20172. <summary>
  20173. Retrieves or creates a named logger.
  20174. </summary>
  20175. <remarks>
  20176. <para>
  20177. Retrieve a logger named as the <paramref name="name"/>
  20178. parameter. If the named logger already exists, then the
  20179. existing instance will be returned. Otherwise, a new instance is
  20180. created.
  20181. </para>
  20182. <para>
  20183. By default, loggers do not have a set level but inherit
  20184. it from the hierarchy. This is one of the central features of
  20185. log4net.
  20186. </para>
  20187. </remarks>
  20188. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20189. <param name="name">The name of the logger to retrieve.</param>
  20190. <returns>The logger with the name specified.</returns>
  20191. </member>
  20192. <member name="M:log4net.LogManager.GetLogger(System.Type)">
  20193. <summary>
  20194. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  20195. </summary>
  20196. <remarks>
  20197. Get the logger for the fully qualified name of the type specified.
  20198. </remarks>
  20199. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  20200. <returns>The logger with the name specified.</returns>
  20201. </member>
  20202. <member name="M:log4net.LogManager.GetLogger(System.String,System.Type)">
  20203. <summary>
  20204. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  20205. </summary>
  20206. <remarks>
  20207. Gets the logger for the fully qualified name of the type specified.
  20208. </remarks>
  20209. <param name="repository">The repository to lookup in.</param>
  20210. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  20211. <returns>The logger with the name specified.</returns>
  20212. </member>
  20213. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)">
  20214. <summary>
  20215. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  20216. </summary>
  20217. <remarks>
  20218. Gets the logger for the fully qualified name of the type specified.
  20219. </remarks>
  20220. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20221. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  20222. <returns>The logger with the name specified.</returns>
  20223. </member>
  20224. <member name="M:log4net.LogManager.Shutdown">
  20225. <summary>
  20226. Shuts down the log4net system.
  20227. </summary>
  20228. <remarks>
  20229. <para>
  20230. Calling this method will <b>safely</b> close and remove all
  20231. appenders in all the loggers including root contained in all the
  20232. default repositories.
  20233. </para>
  20234. <para>
  20235. Some appenders need to be closed before the application exists.
  20236. Otherwise, pending logging events might be lost.
  20237. </para>
  20238. <para>The <c>shutdown</c> method is careful to close nested
  20239. appenders before closing regular appenders. This is allows
  20240. configurations where a regular appender is attached to a logger
  20241. and again to a nested appender.
  20242. </para>
  20243. </remarks>
  20244. </member>
  20245. <member name="M:log4net.LogManager.ShutdownRepository">
  20246. <overloads>Shutdown a logger repository.</overloads>
  20247. <summary>
  20248. Shuts down the default repository.
  20249. </summary>
  20250. <remarks>
  20251. <para>
  20252. Calling this method will <b>safely</b> close and remove all
  20253. appenders in all the loggers including root contained in the
  20254. default repository.
  20255. </para>
  20256. <para>Some appenders need to be closed before the application exists.
  20257. Otherwise, pending logging events might be lost.
  20258. </para>
  20259. <para>The <c>shutdown</c> method is careful to close nested
  20260. appenders before closing regular appenders. This is allows
  20261. configurations where a regular appender is attached to a logger
  20262. and again to a nested appender.
  20263. </para>
  20264. </remarks>
  20265. </member>
  20266. <member name="M:log4net.LogManager.ShutdownRepository(System.String)">
  20267. <summary>
  20268. Shuts down the repository for the repository specified.
  20269. </summary>
  20270. <remarks>
  20271. <para>
  20272. Calling this method will <b>safely</b> close and remove all
  20273. appenders in all the loggers including root contained in the
  20274. <paramref name="repository"/> specified.
  20275. </para>
  20276. <para>
  20277. Some appenders need to be closed before the application exists.
  20278. Otherwise, pending logging events might be lost.
  20279. </para>
  20280. <para>The <c>shutdown</c> method is careful to close nested
  20281. appenders before closing regular appenders. This is allows
  20282. configurations where a regular appender is attached to a logger
  20283. and again to a nested appender.
  20284. </para>
  20285. </remarks>
  20286. <param name="repository">The repository to shutdown.</param>
  20287. </member>
  20288. <member name="M:log4net.LogManager.ShutdownRepository(System.Reflection.Assembly)">
  20289. <summary>
  20290. Shuts down the repository specified.
  20291. </summary>
  20292. <remarks>
  20293. <para>
  20294. Calling this method will <b>safely</b> close and remove all
  20295. appenders in all the loggers including root contained in the
  20296. repository. The repository is looked up using
  20297. the <paramref name="repositoryAssembly"/> specified.
  20298. </para>
  20299. <para>
  20300. Some appenders need to be closed before the application exists.
  20301. Otherwise, pending logging events might be lost.
  20302. </para>
  20303. <para>
  20304. The <c>shutdown</c> method is careful to close nested
  20305. appenders before closing regular appenders. This is allows
  20306. configurations where a regular appender is attached to a logger
  20307. and again to a nested appender.
  20308. </para>
  20309. </remarks>
  20310. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20311. </member>
  20312. <member name="M:log4net.LogManager.ResetConfiguration">
  20313. <overloads>Reset the configuration of a repository</overloads>
  20314. <summary>
  20315. Resets all values contained in this repository instance to their defaults.
  20316. </summary>
  20317. <remarks>
  20318. <para>
  20319. Resets all values contained in the repository instance to their
  20320. defaults. This removes all appenders from all loggers, sets
  20321. the level of all non-root loggers to <c>null</c>,
  20322. sets their additivity flag to <c>true</c> and sets the level
  20323. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  20324. message disabling is set to its default "off" value.
  20325. </para>
  20326. </remarks>
  20327. </member>
  20328. <member name="M:log4net.LogManager.ResetConfiguration(System.String)">
  20329. <summary>
  20330. Resets all values contained in this repository instance to their defaults.
  20331. </summary>
  20332. <remarks>
  20333. <para>
  20334. Reset all values contained in the repository instance to their
  20335. defaults. This removes all appenders from all loggers, sets
  20336. the level of all non-root loggers to <c>null</c>,
  20337. sets their additivity flag to <c>true</c> and sets the level
  20338. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  20339. message disabling is set to its default "off" value.
  20340. </para>
  20341. </remarks>
  20342. <param name="repository">The repository to reset.</param>
  20343. </member>
  20344. <member name="M:log4net.LogManager.ResetConfiguration(System.Reflection.Assembly)">
  20345. <summary>
  20346. Resets all values contained in this repository instance to their defaults.
  20347. </summary>
  20348. <remarks>
  20349. <para>
  20350. Reset all values contained in the repository instance to their
  20351. defaults. This removes all appenders from all loggers, sets
  20352. the level of all non-root loggers to <c>null</c>,
  20353. sets their additivity flag to <c>true</c> and sets the level
  20354. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  20355. message disabling is set to its default "off" value.
  20356. </para>
  20357. </remarks>
  20358. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  20359. </member>
  20360. <member name="M:log4net.LogManager.GetLoggerRepository">
  20361. <overloads>Get the logger repository.</overloads>
  20362. <summary>
  20363. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20364. </summary>
  20365. <remarks>
  20366. <para>
  20367. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20368. by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
  20369. </para>
  20370. </remarks>
  20371. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
  20372. </member>
  20373. <member name="M:log4net.LogManager.GetLoggerRepository(System.String)">
  20374. <summary>
  20375. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20376. </summary>
  20377. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  20378. <remarks>
  20379. <para>
  20380. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20381. by the <paramref name="repository"/> argument.
  20382. </para>
  20383. </remarks>
  20384. <param name="repository">The repository to lookup in.</param>
  20385. </member>
  20386. <member name="M:log4net.LogManager.GetLoggerRepository(System.Reflection.Assembly)">
  20387. <summary>
  20388. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20389. </summary>
  20390. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  20391. <remarks>
  20392. <para>
  20393. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20394. by the <paramref name="repositoryAssembly"/> argument.
  20395. </para>
  20396. </remarks>
  20397. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20398. </member>
  20399. <member name="M:log4net.LogManager.GetRepository">
  20400. <overloads>Get a logger repository.</overloads>
  20401. <summary>
  20402. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20403. </summary>
  20404. <remarks>
  20405. <para>
  20406. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20407. by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
  20408. </para>
  20409. </remarks>
  20410. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
  20411. </member>
  20412. <member name="M:log4net.LogManager.GetRepository(System.String)">
  20413. <summary>
  20414. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20415. </summary>
  20416. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  20417. <remarks>
  20418. <para>
  20419. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20420. by the <paramref name="repository"/> argument.
  20421. </para>
  20422. </remarks>
  20423. <param name="repository">The repository to lookup in.</param>
  20424. </member>
  20425. <member name="M:log4net.LogManager.GetRepository(System.Reflection.Assembly)">
  20426. <summary>
  20427. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20428. </summary>
  20429. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  20430. <remarks>
  20431. <para>
  20432. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20433. by the <paramref name="repositoryAssembly"/> argument.
  20434. </para>
  20435. </remarks>
  20436. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20437. </member>
  20438. <member name="M:log4net.LogManager.CreateDomain(System.Type)">
  20439. <overloads>Create a domain</overloads>
  20440. <summary>
  20441. Creates a repository with the specified repository type.
  20442. </summary>
  20443. <remarks>
  20444. <para>
  20445. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  20446. </para>
  20447. <para>
  20448. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  20449. specified such that a call to <see cref="M:GetRepository()"/> will return
  20450. the same repository instance.
  20451. </para>
  20452. </remarks>
  20453. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20454. and has a no arg constructor. An instance of this type will be created to act
  20455. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20456. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20457. </member>
  20458. <member name="M:log4net.LogManager.CreateRepository(System.Type)">
  20459. <overloads>Create a logger repository.</overloads>
  20460. <summary>
  20461. Creates a repository with the specified repository type.
  20462. </summary>
  20463. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20464. and has a no arg constructor. An instance of this type will be created to act
  20465. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20466. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20467. <remarks>
  20468. <para>
  20469. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  20470. specified such that a call to <see cref="M:GetRepository()"/> will return
  20471. the same repository instance.
  20472. </para>
  20473. </remarks>
  20474. </member>
  20475. <member name="M:log4net.LogManager.CreateDomain(System.String)">
  20476. <summary>
  20477. Creates a repository with the specified name.
  20478. </summary>
  20479. <remarks>
  20480. <para>
  20481. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  20482. </para>
  20483. <para>
  20484. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  20485. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  20486. </para>
  20487. <para>
  20488. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  20489. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  20490. </para>
  20491. </remarks>
  20492. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  20493. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20494. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  20495. </member>
  20496. <member name="M:log4net.LogManager.CreateRepository(System.String)">
  20497. <summary>
  20498. Creates a repository with the specified name.
  20499. </summary>
  20500. <remarks>
  20501. <para>
  20502. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  20503. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  20504. </para>
  20505. <para>
  20506. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  20507. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  20508. </para>
  20509. </remarks>
  20510. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  20511. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20512. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  20513. </member>
  20514. <member name="M:log4net.LogManager.CreateDomain(System.String,System.Type)">
  20515. <summary>
  20516. Creates a repository with the specified name and repository type.
  20517. </summary>
  20518. <remarks>
  20519. <para>
  20520. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  20521. </para>
  20522. <para>
  20523. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  20524. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  20525. </para>
  20526. </remarks>
  20527. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  20528. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20529. and has a no arg constructor. An instance of this type will be created to act
  20530. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20531. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20532. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  20533. </member>
  20534. <member name="M:log4net.LogManager.CreateRepository(System.String,System.Type)">
  20535. <summary>
  20536. Creates a repository with the specified name and repository type.
  20537. </summary>
  20538. <remarks>
  20539. <para>
  20540. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  20541. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  20542. </para>
  20543. </remarks>
  20544. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  20545. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20546. and has a no arg constructor. An instance of this type will be created to act
  20547. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20548. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20549. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  20550. </member>
  20551. <member name="M:log4net.LogManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  20552. <summary>
  20553. Creates a repository for the specified assembly and repository type.
  20554. </summary>
  20555. <remarks>
  20556. <para>
  20557. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  20558. </para>
  20559. <para>
  20560. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  20561. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  20562. same assembly specified will return the same repository instance.
  20563. </para>
  20564. </remarks>
  20565. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  20566. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20567. and has a no arg constructor. An instance of this type will be created to act
  20568. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20569. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20570. </member>
  20571. <member name="M:log4net.LogManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  20572. <summary>
  20573. Creates a repository for the specified assembly and repository type.
  20574. </summary>
  20575. <remarks>
  20576. <para>
  20577. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  20578. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  20579. same assembly specified will return the same repository instance.
  20580. </para>
  20581. </remarks>
  20582. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  20583. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20584. and has a no arg constructor. An instance of this type will be created to act
  20585. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20586. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20587. </member>
  20588. <member name="M:log4net.LogManager.GetAllRepositories">
  20589. <summary>
  20590. Gets the list of currently defined repositories.
  20591. </summary>
  20592. <remarks>
  20593. <para>
  20594. Get an array of all the <see cref="T:log4net.Repository.ILoggerRepository"/> objects that have been created.
  20595. </para>
  20596. </remarks>
  20597. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  20598. </member>
  20599. <member name="M:log4net.LogManager.Flush(System.Int32)">
  20600. <summary>
  20601. Flushes logging events buffered in all configured appenders in the default repository.
  20602. </summary>
  20603. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed.</param>
  20604. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  20605. </member>
  20606. <member name="M:log4net.LogManager.WrapLogger(log4net.Core.ILogger)">
  20607. <summary>
  20608. Looks up the wrapper object for the logger specified.
  20609. </summary>
  20610. <param name="logger">The logger to get the wrapper for.</param>
  20611. <returns>The wrapper for the logger specified.</returns>
  20612. </member>
  20613. <member name="M:log4net.LogManager.WrapLoggers(log4net.Core.ILogger[])">
  20614. <summary>
  20615. Looks up the wrapper objects for the loggers specified.
  20616. </summary>
  20617. <param name="loggers">The loggers to get the wrappers for.</param>
  20618. <returns>The wrapper objects for the loggers specified.</returns>
  20619. </member>
  20620. <member name="M:log4net.LogManager.WrapperCreationHandler(log4net.Core.ILogger)">
  20621. <summary>
  20622. Create the <see cref="T:log4net.Core.ILoggerWrapper"/> objects used by
  20623. this manager.
  20624. </summary>
  20625. <param name="logger">The logger to wrap.</param>
  20626. <returns>The wrapper for the logger specified.</returns>
  20627. </member>
  20628. <member name="F:log4net.LogManager.s_wrapperMap">
  20629. <summary>
  20630. The wrapper map to use to hold the <see cref="T:log4net.Core.LogImpl"/> objects.
  20631. </summary>
  20632. </member>
  20633. <member name="T:log4net.MDC">
  20634. <summary>
  20635. Implementation of Mapped Diagnostic Contexts.
  20636. </summary>
  20637. <remarks>
  20638. <note>
  20639. <para>
  20640. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  20641. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  20642. </para>
  20643. </note>
  20644. <para>
  20645. The MDC class is similar to the <see cref="T:log4net.NDC"/> class except that it is
  20646. based on a map instead of a stack. It provides <i>mapped
  20647. diagnostic contexts</i>. A <i>Mapped Diagnostic Context</i>, or
  20648. MDC in short, is an instrument for distinguishing interleaved log
  20649. output from different sources. Log output is typically interleaved
  20650. when a server handles multiple clients near-simultaneously.
  20651. </para>
  20652. <para>
  20653. The MDC is managed on a per thread basis.
  20654. </para>
  20655. </remarks>
  20656. <threadsafety static="true" instance="true" />
  20657. <author>Nicko Cadell</author>
  20658. <author>Gert Driesen</author>
  20659. </member>
  20660. <member name="M:log4net.MDC.#ctor">
  20661. <summary>
  20662. Initializes a new instance of the <see cref="T:log4net.MDC" /> class.
  20663. </summary>
  20664. <remarks>
  20665. Uses a private access modifier to prevent instantiation of this class.
  20666. </remarks>
  20667. </member>
  20668. <member name="M:log4net.MDC.Get(System.String)">
  20669. <summary>
  20670. Gets the context value identified by the <paramref name="key" /> parameter.
  20671. </summary>
  20672. <param name="key">The key to lookup in the MDC.</param>
  20673. <returns>The string value held for the key, or a <c>null</c> reference if no corresponding value is found.</returns>
  20674. <remarks>
  20675. <note>
  20676. <para>
  20677. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  20678. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  20679. </para>
  20680. </note>
  20681. <para>
  20682. If the <paramref name="key" /> parameter does not look up to a
  20683. previously defined context then <c>null</c> will be returned.
  20684. </para>
  20685. </remarks>
  20686. </member>
  20687. <member name="M:log4net.MDC.Set(System.String,System.String)">
  20688. <summary>
  20689. Add an entry to the MDC
  20690. </summary>
  20691. <param name="key">The key to store the value under.</param>
  20692. <param name="value">The value to store.</param>
  20693. <remarks>
  20694. <note>
  20695. <para>
  20696. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  20697. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  20698. </para>
  20699. </note>
  20700. <para>
  20701. Puts a context value (the <paramref name="value" /> parameter) as identified
  20702. with the <paramref name="key" /> parameter into the current thread's
  20703. context map.
  20704. </para>
  20705. <para>
  20706. If a value is already defined for the <paramref name="key" />
  20707. specified then the value will be replaced. If the <paramref name="value" />
  20708. is specified as <c>null</c> then the key value mapping will be removed.
  20709. </para>
  20710. </remarks>
  20711. </member>
  20712. <member name="M:log4net.MDC.Remove(System.String)">
  20713. <summary>
  20714. Removes the key value mapping for the key specified.
  20715. </summary>
  20716. <param name="key">The key to remove.</param>
  20717. <remarks>
  20718. <note>
  20719. <para>
  20720. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  20721. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  20722. </para>
  20723. </note>
  20724. <para>
  20725. Remove the specified entry from this thread's MDC
  20726. </para>
  20727. </remarks>
  20728. </member>
  20729. <member name="M:log4net.MDC.Clear">
  20730. <summary>
  20731. Clear all entries in the MDC
  20732. </summary>
  20733. <remarks>
  20734. <note>
  20735. <para>
  20736. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  20737. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  20738. </para>
  20739. </note>
  20740. <para>
  20741. Remove all the entries from this thread's MDC
  20742. </para>
  20743. </remarks>
  20744. </member>
  20745. <member name="T:log4net.NDC">
  20746. <summary>
  20747. Implementation of Nested Diagnostic Contexts.
  20748. </summary>
  20749. <remarks>
  20750. <note>
  20751. <para>
  20752. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20753. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20754. </para>
  20755. </note>
  20756. <para>
  20757. A Nested Diagnostic Context, or NDC in short, is an instrument
  20758. to distinguish interleaved log output from different sources. Log
  20759. output is typically interleaved when a server handles multiple
  20760. clients near-simultaneously.
  20761. </para>
  20762. <para>
  20763. Interleaved log output can still be meaningful if each log entry
  20764. from different contexts had a distinctive stamp. This is where NDCs
  20765. come into play.
  20766. </para>
  20767. <para>
  20768. Note that NDCs are managed on a per thread basis. The NDC class
  20769. is made up of static methods that operate on the context of the
  20770. calling thread.
  20771. </para>
  20772. </remarks>
  20773. <example>How to push a message into the context
  20774. <code lang="C#">
  20775. using(NDC.Push("my context message"))
  20776. {
  20777. ... all log calls will have 'my context message' included ...
  20778. } // at the end of the using block the message is automatically removed
  20779. </code>
  20780. </example>
  20781. <threadsafety static="true" instance="true" />
  20782. <author>Nicko Cadell</author>
  20783. <author>Gert Driesen</author>
  20784. </member>
  20785. <member name="M:log4net.NDC.#ctor">
  20786. <summary>
  20787. Initializes a new instance of the <see cref="T:log4net.NDC" /> class.
  20788. </summary>
  20789. <remarks>
  20790. Uses a private access modifier to prevent instantiation of this class.
  20791. </remarks>
  20792. </member>
  20793. <member name="P:log4net.NDC.Depth">
  20794. <summary>
  20795. Gets the current context depth.
  20796. </summary>
  20797. <value>The current context depth.</value>
  20798. <remarks>
  20799. <note>
  20800. <para>
  20801. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20802. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20803. </para>
  20804. </note>
  20805. <para>
  20806. The number of context values pushed onto the context stack.
  20807. </para>
  20808. <para>
  20809. Used to record the current depth of the context. This can then
  20810. be restored using the <see cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> method.
  20811. </para>
  20812. </remarks>
  20813. <seealso cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/>
  20814. </member>
  20815. <member name="M:log4net.NDC.Clear">
  20816. <summary>
  20817. Clears all the contextual information held on the current thread.
  20818. </summary>
  20819. <remarks>
  20820. <note>
  20821. <para>
  20822. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20823. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20824. </para>
  20825. </note>
  20826. <para>
  20827. Clears the stack of NDC data held on the current thread.
  20828. </para>
  20829. </remarks>
  20830. </member>
  20831. <member name="M:log4net.NDC.CloneStack">
  20832. <summary>
  20833. Creates a clone of the stack of context information.
  20834. </summary>
  20835. <returns>A clone of the context info for this thread.</returns>
  20836. <remarks>
  20837. <note>
  20838. <para>
  20839. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20840. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20841. </para>
  20842. </note>
  20843. <para>
  20844. The results of this method can be passed to the <see cref="M:log4net.NDC.Inherit(System.Collections.Stack)"/>
  20845. method to allow child threads to inherit the context of their
  20846. parent thread.
  20847. </para>
  20848. </remarks>
  20849. </member>
  20850. <member name="M:log4net.NDC.Inherit(System.Collections.Stack)">
  20851. <summary>
  20852. Inherits the contextual information from another thread.
  20853. </summary>
  20854. <param name="stack">The context stack to inherit.</param>
  20855. <remarks>
  20856. <note>
  20857. <para>
  20858. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20859. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20860. </para>
  20861. </note>
  20862. <para>
  20863. This thread will use the context information from the stack
  20864. supplied. This can be used to initialize child threads with
  20865. the same contextual information as their parent threads. These
  20866. contexts will <b>NOT</b> be shared. Any further contexts that
  20867. are pushed onto the stack will not be visible to the other.
  20868. Call <see cref="M:log4net.NDC.CloneStack"/> to obtain a stack to pass to
  20869. this method.
  20870. </para>
  20871. </remarks>
  20872. </member>
  20873. <member name="M:log4net.NDC.Pop">
  20874. <summary>
  20875. Removes the top context from the stack.
  20876. </summary>
  20877. <returns>
  20878. The message in the context that was removed from the top
  20879. of the stack.
  20880. </returns>
  20881. <remarks>
  20882. <note>
  20883. <para>
  20884. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20885. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20886. </para>
  20887. </note>
  20888. <para>
  20889. Remove the top context from the stack, and return
  20890. it to the caller. If the stack is empty then an
  20891. empty string (not <c>null</c>) is returned.
  20892. </para>
  20893. </remarks>
  20894. </member>
  20895. <member name="M:log4net.NDC.Push(System.String)">
  20896. <summary>
  20897. Pushes a new context message.
  20898. </summary>
  20899. <param name="message">The new context message.</param>
  20900. <returns>
  20901. An <see cref="T:System.IDisposable"/> that can be used to clean up
  20902. the context stack.
  20903. </returns>
  20904. <remarks>
  20905. <note>
  20906. <para>
  20907. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20908. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20909. </para>
  20910. </note>
  20911. <para>
  20912. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  20913. is returned that can be used to clean up the context stack. This
  20914. can be easily combined with the <c>using</c> keyword to scope the
  20915. context.
  20916. </para>
  20917. </remarks>
  20918. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  20919. <code lang="C#">
  20920. using(log4net.NDC.Push("NDC_Message"))
  20921. {
  20922. log.Warn("This should have an NDC message");
  20923. }
  20924. </code>
  20925. </example>
  20926. </member>
  20927. <member name="M:log4net.NDC.PushFormat(System.String,System.Object[])">
  20928. <summary>
  20929. Pushes a new context message.
  20930. </summary>
  20931. <param name="messageFormat">The new context message string format.</param>
  20932. <param name="args">Arguments to be passed into messageFormat.</param>
  20933. <returns>
  20934. An <see cref="T:System.IDisposable"/> that can be used to clean up
  20935. the context stack.
  20936. </returns>
  20937. <remarks>
  20938. <note>
  20939. <para>
  20940. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20941. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20942. </para>
  20943. </note>
  20944. <para>
  20945. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  20946. is returned that can be used to clean up the context stack. This
  20947. can be easily combined with the <c>using</c> keyword to scope the
  20948. context.
  20949. </para>
  20950. </remarks>
  20951. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  20952. <code lang="C#">
  20953. var someValue = "ExampleContext"
  20954. using(log4net.NDC.PushFormat("NDC_Message {0}", someValue))
  20955. {
  20956. log.Warn("This should have an NDC message");
  20957. }
  20958. </code>
  20959. </example>
  20960. </member>
  20961. <member name="M:log4net.NDC.Remove">
  20962. <summary>
  20963. Removes the context information for this thread. It is
  20964. not required to call this method.
  20965. </summary>
  20966. <remarks>
  20967. <note>
  20968. <para>
  20969. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20970. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20971. </para>
  20972. </note>
  20973. <para>
  20974. This method is not implemented.
  20975. </para>
  20976. </remarks>
  20977. </member>
  20978. <member name="M:log4net.NDC.SetMaxDepth(System.Int32)">
  20979. <summary>
  20980. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  20981. </summary>
  20982. <param name="maxDepth">The maximum depth of the stack</param>
  20983. <remarks>
  20984. <note>
  20985. <para>
  20986. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20987. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20988. </para>
  20989. </note>
  20990. <para>
  20991. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  20992. This may truncate the head of the stack. This only affects the
  20993. stack in the current thread. Also it does not prevent it from
  20994. growing, it only sets the maximum depth at the time of the
  20995. call. This can be used to return to a known context depth.
  20996. </para>
  20997. </remarks>
  20998. </member>
  20999. <member name="T:log4net.ObjectRenderer.DefaultRenderer">
  21000. <summary>
  21001. The default object Renderer.
  21002. </summary>
  21003. <remarks>
  21004. <para>
  21005. The default renderer supports rendering objects and collections to strings.
  21006. </para>
  21007. <para>
  21008. See the <see cref="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"/> method for details of the output.
  21009. </para>
  21010. </remarks>
  21011. <author>Nicko Cadell</author>
  21012. <author>Gert Driesen</author>
  21013. </member>
  21014. <member name="M:log4net.ObjectRenderer.DefaultRenderer.#ctor">
  21015. <summary>
  21016. Default constructor
  21017. </summary>
  21018. <remarks>
  21019. <para>
  21020. Default constructor
  21021. </para>
  21022. </remarks>
  21023. </member>
  21024. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  21025. <summary>
  21026. Render the object <paramref name="obj"/> to a string
  21027. </summary>
  21028. <param name="rendererMap">The map used to lookup renderers</param>
  21029. <param name="obj">The object to render</param>
  21030. <param name="writer">The writer to render to</param>
  21031. <remarks>
  21032. <para>
  21033. Render the object <paramref name="obj"/> to a string.
  21034. </para>
  21035. <para>
  21036. The <paramref name="rendererMap"/> parameter is
  21037. provided to lookup and render other objects. This is
  21038. very useful where <paramref name="obj"/> contains
  21039. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object)"/>
  21040. method can be used to render these objects.
  21041. </para>
  21042. <para>
  21043. The default renderer supports rendering objects to strings as follows:
  21044. </para>
  21045. <list type="table">
  21046. <listheader>
  21047. <term>Value</term>
  21048. <description>Rendered String</description>
  21049. </listheader>
  21050. <item>
  21051. <term><c>null</c></term>
  21052. <description>
  21053. <para>"(null)"</para>
  21054. </description>
  21055. </item>
  21056. <item>
  21057. <term><see cref="T:System.Array"/></term>
  21058. <description>
  21059. <para>
  21060. For a one dimensional array this is the
  21061. array type name, an open brace, followed by a comma
  21062. separated list of the elements (using the appropriate
  21063. renderer), followed by a close brace.
  21064. </para>
  21065. <para>
  21066. For example: <c>int[] {1, 2, 3}</c>.
  21067. </para>
  21068. <para>
  21069. If the array is not one dimensional the
  21070. <c>Array.ToString()</c> is returned.
  21071. </para>
  21072. </description>
  21073. </item>
  21074. <item>
  21075. <term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> &amp; <see cref="T:System.Collections.IEnumerator"/></term>
  21076. <description>
  21077. <para>
  21078. Rendered as an open brace, followed by a comma
  21079. separated list of the elements (using the appropriate
  21080. renderer), followed by a close brace.
  21081. </para>
  21082. <para>
  21083. For example: <c>{a, b, c}</c>.
  21084. </para>
  21085. <para>
  21086. All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses,
  21087. or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface.
  21088. </para>
  21089. </description>
  21090. </item>
  21091. <item>
  21092. <term><see cref="T:System.Collections.DictionaryEntry"/></term>
  21093. <description>
  21094. <para>
  21095. Rendered as the key, an equals sign ('='), and the value (using the appropriate
  21096. renderer).
  21097. </para>
  21098. <para>
  21099. For example: <c>key=value</c>.
  21100. </para>
  21101. </description>
  21102. </item>
  21103. <item>
  21104. <term>other</term>
  21105. <description>
  21106. <para><c>Object.ToString()</c></para>
  21107. </description>
  21108. </item>
  21109. </list>
  21110. </remarks>
  21111. </member>
  21112. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderArray(log4net.ObjectRenderer.RendererMap,System.Array,System.IO.TextWriter)">
  21113. <summary>
  21114. Render the array argument into a string
  21115. </summary>
  21116. <param name="rendererMap">The map used to lookup renderers</param>
  21117. <param name="array">the array to render</param>
  21118. <param name="writer">The writer to render to</param>
  21119. <remarks>
  21120. <para>
  21121. For a one dimensional array this is the
  21122. array type name, an open brace, followed by a comma
  21123. separated list of the elements (using the appropriate
  21124. renderer), followed by a close brace. For example:
  21125. <c>int[] {1, 2, 3}</c>.
  21126. </para>
  21127. <para>
  21128. If the array is not one dimensional the
  21129. <c>Array.ToString()</c> is returned.
  21130. </para>
  21131. </remarks>
  21132. </member>
  21133. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)">
  21134. <summary>
  21135. Render the enumerator argument into a string
  21136. </summary>
  21137. <param name="rendererMap">The map used to lookup renderers</param>
  21138. <param name="enumerator">the enumerator to render</param>
  21139. <param name="writer">The writer to render to</param>
  21140. <remarks>
  21141. <para>
  21142. Rendered as an open brace, followed by a comma
  21143. separated list of the elements (using the appropriate
  21144. renderer), followed by a close brace. For example:
  21145. <c>{a, b, c}</c>.
  21146. </para>
  21147. </remarks>
  21148. </member>
  21149. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderDictionaryEntry(log4net.ObjectRenderer.RendererMap,System.Collections.DictionaryEntry,System.IO.TextWriter)">
  21150. <summary>
  21151. Render the DictionaryEntry argument into a string
  21152. </summary>
  21153. <param name="rendererMap">The map used to lookup renderers</param>
  21154. <param name="entry">the DictionaryEntry to render</param>
  21155. <param name="writer">The writer to render to</param>
  21156. <remarks>
  21157. <para>
  21158. Render the key, an equals sign ('='), and the value (using the appropriate
  21159. renderer). For example: <c>key=value</c>.
  21160. </para>
  21161. </remarks>
  21162. </member>
  21163. <member name="T:log4net.ObjectRenderer.IObjectRenderer">
  21164. <summary>
  21165. Implement this interface in order to render objects as strings
  21166. </summary>
  21167. <remarks>
  21168. <para>
  21169. Certain types require special case conversion to
  21170. string form. This conversion is done by an object renderer.
  21171. Object renderers implement the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>
  21172. interface.
  21173. </para>
  21174. </remarks>
  21175. <author>Nicko Cadell</author>
  21176. <author>Gert Driesen</author>
  21177. </member>
  21178. <member name="M:log4net.ObjectRenderer.IObjectRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  21179. <summary>
  21180. Render the object <paramref name="obj"/> to a string
  21181. </summary>
  21182. <param name="rendererMap">The map used to lookup renderers</param>
  21183. <param name="obj">The object to render</param>
  21184. <param name="writer">The writer to render to</param>
  21185. <remarks>
  21186. <para>
  21187. Render the object <paramref name="obj"/> to a
  21188. string.
  21189. </para>
  21190. <para>
  21191. The <paramref name="rendererMap"/> parameter is
  21192. provided to lookup and render other objects. This is
  21193. very useful where <paramref name="obj"/> contains
  21194. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object, TextWriter)"/>
  21195. method can be used to render these objects.
  21196. </para>
  21197. </remarks>
  21198. </member>
  21199. <member name="T:log4net.ObjectRenderer.RendererMap">
  21200. <summary>
  21201. Map class objects to an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  21202. </summary>
  21203. <remarks>
  21204. <para>
  21205. Maintains a mapping between types that require special
  21206. rendering and the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> that
  21207. is used to render them.
  21208. </para>
  21209. <para>
  21210. The <see cref="M:FindAndRender(object)"/> method is used to render an
  21211. <c>object</c> using the appropriate renderers defined in this map.
  21212. </para>
  21213. </remarks>
  21214. <author>Nicko Cadell</author>
  21215. <author>Gert Driesen</author>
  21216. </member>
  21217. <member name="M:log4net.ObjectRenderer.RendererMap.#ctor">
  21218. <summary>
  21219. Default Constructor
  21220. </summary>
  21221. <remarks>
  21222. <para>
  21223. Default constructor.
  21224. </para>
  21225. </remarks>
  21226. </member>
  21227. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)">
  21228. <summary>
  21229. Render <paramref name="obj"/> using the appropriate renderer.
  21230. </summary>
  21231. <param name="obj">the object to render to a string</param>
  21232. <returns>the object rendered as a string</returns>
  21233. <remarks>
  21234. <para>
  21235. This is a convenience method used to render an object to a string.
  21236. The alternative method <see cref="M:FindAndRender(object,TextWriter)"/>
  21237. should be used when streaming output to a <see cref="T:System.IO.TextWriter"/>.
  21238. </para>
  21239. </remarks>
  21240. </member>
  21241. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)">
  21242. <summary>
  21243. Render <paramref name="obj"/> using the appropriate renderer.
  21244. </summary>
  21245. <param name="obj">the object to render to a string</param>
  21246. <param name="writer">The writer to render to</param>
  21247. <remarks>
  21248. <para>
  21249. Find the appropriate renderer for the type of the
  21250. <paramref name="obj"/> parameter. This is accomplished by calling the
  21251. <see cref="M:Get(Type)"/> method. Once a renderer is found, it is
  21252. applied on the object <paramref name="obj"/> and the result is returned
  21253. as a <see cref="T:System.String"/>.
  21254. </para>
  21255. </remarks>
  21256. </member>
  21257. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)">
  21258. <summary>
  21259. Gets the renderer for the specified object type
  21260. </summary>
  21261. <param name="obj">the object to lookup the renderer for</param>
  21262. <returns>the renderer for <paramref name="obj"/></returns>
  21263. <remarks>
  21264. <param>
  21265. Gets the renderer for the specified object type.
  21266. </param>
  21267. <param>
  21268. Syntactic sugar method that calls <see cref="M:Get(Type)"/>
  21269. with the type of the object parameter.
  21270. </param>
  21271. </remarks>
  21272. </member>
  21273. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)">
  21274. <summary>
  21275. Gets the renderer for the specified type
  21276. </summary>
  21277. <param name="type">the type to lookup the renderer for</param>
  21278. <returns>the renderer for the specified type</returns>
  21279. <remarks>
  21280. <para>
  21281. Returns the renderer for the specified type.
  21282. If no specific renderer has been defined the
  21283. <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> will be returned.
  21284. </para>
  21285. </remarks>
  21286. </member>
  21287. <member name="M:log4net.ObjectRenderer.RendererMap.SearchTypeAndInterfaces(System.Type)">
  21288. <summary>
  21289. Internal function to recursively search interfaces
  21290. </summary>
  21291. <param name="type">the type to lookup the renderer for</param>
  21292. <returns>the renderer for the specified type</returns>
  21293. </member>
  21294. <member name="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer">
  21295. <summary>
  21296. Get the default renderer instance
  21297. </summary>
  21298. <value>the default renderer</value>
  21299. <remarks>
  21300. <para>
  21301. Get the default renderer
  21302. </para>
  21303. </remarks>
  21304. </member>
  21305. <member name="M:log4net.ObjectRenderer.RendererMap.Clear">
  21306. <summary>
  21307. Clear the map of renderers
  21308. </summary>
  21309. <remarks>
  21310. <para>
  21311. Clear the custom renderers defined by using
  21312. <see cref="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"/>. The <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/>
  21313. cannot be removed.
  21314. </para>
  21315. </remarks>
  21316. </member>
  21317. <member name="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  21318. <summary>
  21319. Register an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> for <paramref name="typeToRender"/>.
  21320. </summary>
  21321. <param name="typeToRender">the type that will be rendered by <paramref name="renderer"/></param>
  21322. <param name="renderer">the renderer for <paramref name="typeToRender"/></param>
  21323. <remarks>
  21324. <para>
  21325. Register an object renderer for a specific source type.
  21326. This renderer will be returned from a call to <see cref="M:Get(Type)"/>
  21327. specifying the same <paramref name="typeToRender"/> as an argument.
  21328. </para>
  21329. </remarks>
  21330. </member>
  21331. <member name="T:log4net.Plugin.IPlugin">
  21332. <summary>
  21333. Interface implemented by logger repository plugins.
  21334. </summary>
  21335. <remarks>
  21336. <para>
  21337. Plugins define additional behavior that can be associated
  21338. with a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21339. The <see cref="T:log4net.Plugin.PluginMap"/> held by the <see cref="P:log4net.Repository.ILoggerRepository.PluginMap"/>
  21340. property is used to store the plugins for a repository.
  21341. </para>
  21342. <para>
  21343. The <c>log4net.Config.PluginAttribute</c> can be used to
  21344. attach plugins to repositories created using configuration
  21345. attributes.
  21346. </para>
  21347. </remarks>
  21348. <author>Nicko Cadell</author>
  21349. <author>Gert Driesen</author>
  21350. </member>
  21351. <member name="P:log4net.Plugin.IPlugin.Name">
  21352. <summary>
  21353. Gets the name of the plugin.
  21354. </summary>
  21355. <value>
  21356. The name of the plugin.
  21357. </value>
  21358. <remarks>
  21359. <para>
  21360. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  21361. keyed by name. Each plugin instance attached to a
  21362. repository must be a unique name.
  21363. </para>
  21364. </remarks>
  21365. </member>
  21366. <member name="M:log4net.Plugin.IPlugin.Attach(log4net.Repository.ILoggerRepository)">
  21367. <summary>
  21368. Attaches the plugin to the specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21369. </summary>
  21370. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  21371. <remarks>
  21372. <para>
  21373. A plugin may only be attached to a single repository.
  21374. </para>
  21375. <para>
  21376. This method is called when the plugin is attached to the repository.
  21377. </para>
  21378. </remarks>
  21379. </member>
  21380. <member name="M:log4net.Plugin.IPlugin.Shutdown">
  21381. <summary>
  21382. Is called when the plugin is to shutdown.
  21383. </summary>
  21384. <remarks>
  21385. <para>
  21386. This method is called to notify the plugin that
  21387. it should stop operating and should detach from
  21388. the repository.
  21389. </para>
  21390. </remarks>
  21391. </member>
  21392. <member name="T:log4net.Plugin.IPluginFactory">
  21393. <summary>
  21394. Interface used to create plugins.
  21395. </summary>
  21396. <remarks>
  21397. <para>
  21398. Interface used to create a plugin.
  21399. </para>
  21400. </remarks>
  21401. <author>Nicko Cadell</author>
  21402. <author>Gert Driesen</author>
  21403. </member>
  21404. <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin">
  21405. <summary>
  21406. Creates the plugin object.
  21407. </summary>
  21408. <returns>the new plugin instance</returns>
  21409. <remarks>
  21410. <para>
  21411. Create and return a new plugin instance.
  21412. </para>
  21413. </remarks>
  21414. </member>
  21415. <member name="T:log4net.Plugin.PluginCollection">
  21416. <summary>
  21417. A strongly-typed collection of <see cref="T:log4net.Plugin.IPlugin"/> objects.
  21418. </summary>
  21419. <author>Nicko Cadell</author>
  21420. </member>
  21421. <member name="T:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator">
  21422. <summary>
  21423. Supports type-safe iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  21424. </summary>
  21425. <exclude/>
  21426. </member>
  21427. <member name="P:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Current">
  21428. <summary>
  21429. Gets the current element in the collection.
  21430. </summary>
  21431. </member>
  21432. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.MoveNext">
  21433. <summary>
  21434. Advances the enumerator to the next element in the collection.
  21435. </summary>
  21436. <returns>
  21437. <c>true</c> if the enumerator was successfully advanced to the next element;
  21438. <c>false</c> if the enumerator has passed the end of the collection.
  21439. </returns>
  21440. <exception cref="T:System.InvalidOperationException">
  21441. The collection was modified after the enumerator was created.
  21442. </exception>
  21443. </member>
  21444. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Reset">
  21445. <summary>
  21446. Sets the enumerator to its initial position, before the first element in the collection.
  21447. </summary>
  21448. </member>
  21449. <member name="M:log4net.Plugin.PluginCollection.ReadOnly(log4net.Plugin.PluginCollection)">
  21450. <summary>
  21451. Creates a read-only wrapper for a <c>PluginCollection</c> instance.
  21452. </summary>
  21453. <param name="list">list to create a readonly wrapper arround</param>
  21454. <returns>
  21455. A <c>PluginCollection</c> wrapper that is read-only.
  21456. </returns>
  21457. </member>
  21458. <member name="M:log4net.Plugin.PluginCollection.#ctor">
  21459. <summary>
  21460. Initializes a new instance of the <c>PluginCollection</c> class
  21461. that is empty and has the default initial capacity.
  21462. </summary>
  21463. </member>
  21464. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Int32)">
  21465. <summary>
  21466. Initializes a new instance of the <c>PluginCollection</c> class
  21467. that has the specified initial capacity.
  21468. </summary>
  21469. <param name="capacity">
  21470. The number of elements that the new <c>PluginCollection</c> is initially capable of storing.
  21471. </param>
  21472. </member>
  21473. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection)">
  21474. <summary>
  21475. Initializes a new instance of the <c>PluginCollection</c> class
  21476. that contains elements copied from the specified <c>PluginCollection</c>.
  21477. </summary>
  21478. <param name="c">The <c>PluginCollection</c> whose elements are copied to the new collection.</param>
  21479. </member>
  21480. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.IPlugin[])">
  21481. <summary>
  21482. Initializes a new instance of the <c>PluginCollection</c> class
  21483. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> array.
  21484. </summary>
  21485. <param name="a">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements are copied to the new list.</param>
  21486. </member>
  21487. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Collections.ICollection)">
  21488. <summary>
  21489. Initializes a new instance of the <c>PluginCollection</c> class
  21490. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> collection.
  21491. </summary>
  21492. <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements are copied to the new list.</param>
  21493. </member>
  21494. <member name="T:log4net.Plugin.PluginCollection.Tag">
  21495. <summary>
  21496. Type visible only to our subclasses
  21497. Used to access protected constructor
  21498. </summary>
  21499. <exclude/>
  21500. </member>
  21501. <member name="F:log4net.Plugin.PluginCollection.Tag.Default">
  21502. <summary>
  21503. A value
  21504. </summary>
  21505. </member>
  21506. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection.Tag)">
  21507. <summary>
  21508. Allow subclasses to avoid our default constructors
  21509. </summary>
  21510. <param name="tag"></param>
  21511. <exclude/>
  21512. </member>
  21513. <member name="P:log4net.Plugin.PluginCollection.Count">
  21514. <summary>
  21515. Gets the number of elements actually contained in the <c>PluginCollection</c>.
  21516. </summary>
  21517. </member>
  21518. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[])">
  21519. <summary>
  21520. Copies the entire <c>PluginCollection</c> to a one-dimensional
  21521. <see cref="T:log4net.Plugin.IPlugin"/> array.
  21522. </summary>
  21523. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  21524. </member>
  21525. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[],System.Int32)">
  21526. <summary>
  21527. Copies the entire <c>PluginCollection</c> to a one-dimensional
  21528. <see cref="T:log4net.Plugin.IPlugin"/> array, starting at the specified index of the target array.
  21529. </summary>
  21530. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  21531. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  21532. </member>
  21533. <member name="P:log4net.Plugin.PluginCollection.IsSynchronized">
  21534. <summary>
  21535. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  21536. </summary>
  21537. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  21538. </member>
  21539. <member name="P:log4net.Plugin.PluginCollection.SyncRoot">
  21540. <summary>
  21541. Gets an object that can be used to synchronize access to the collection.
  21542. </summary>
  21543. <value>
  21544. An object that can be used to synchronize access to the collection.
  21545. </value>
  21546. </member>
  21547. <member name="P:log4net.Plugin.PluginCollection.Item(System.Int32)">
  21548. <summary>
  21549. Gets or sets the <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  21550. </summary>
  21551. <value>
  21552. The <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  21553. </value>
  21554. <param name="index">The zero-based index of the element to get or set.</param>
  21555. <exception cref="T:System.ArgumentOutOfRangeException">
  21556. <para><paramref name="index"/> is less than zero.</para>
  21557. <para>-or-</para>
  21558. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  21559. </exception>
  21560. </member>
  21561. <member name="M:log4net.Plugin.PluginCollection.Add(log4net.Plugin.IPlugin)">
  21562. <summary>
  21563. Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the end of the <c>PluginCollection</c>.
  21564. </summary>
  21565. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to be added to the end of the <c>PluginCollection</c>.</param>
  21566. <returns>The index at which the value has been added.</returns>
  21567. </member>
  21568. <member name="M:log4net.Plugin.PluginCollection.Clear">
  21569. <summary>
  21570. Removes all elements from the <c>PluginCollection</c>.
  21571. </summary>
  21572. </member>
  21573. <member name="M:log4net.Plugin.PluginCollection.Clone">
  21574. <summary>
  21575. Creates a shallow copy of the <see cref="T:log4net.Plugin.PluginCollection"/>.
  21576. </summary>
  21577. <returns>A new <see cref="T:log4net.Plugin.PluginCollection"/> with a shallow copy of the collection data.</returns>
  21578. </member>
  21579. <member name="M:log4net.Plugin.PluginCollection.Contains(log4net.Plugin.IPlugin)">
  21580. <summary>
  21581. Determines whether a given <see cref="T:log4net.Plugin.IPlugin"/> is in the <c>PluginCollection</c>.
  21582. </summary>
  21583. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to check for.</param>
  21584. <returns><c>true</c> if <paramref name="item"/> is found in the <c>PluginCollection</c>; otherwise, <c>false</c>.</returns>
  21585. </member>
  21586. <member name="M:log4net.Plugin.PluginCollection.IndexOf(log4net.Plugin.IPlugin)">
  21587. <summary>
  21588. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Plugin.IPlugin"/>
  21589. in the <c>PluginCollection</c>.
  21590. </summary>
  21591. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to locate in the <c>PluginCollection</c>.</param>
  21592. <returns>
  21593. The zero-based index of the first occurrence of <paramref name="item"/>
  21594. in the entire <c>PluginCollection</c>, if found; otherwise, -1.
  21595. </returns>
  21596. </member>
  21597. <member name="M:log4net.Plugin.PluginCollection.Insert(System.Int32,log4net.Plugin.IPlugin)">
  21598. <summary>
  21599. Inserts an element into the <c>PluginCollection</c> at the specified index.
  21600. </summary>
  21601. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  21602. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to insert.</param>
  21603. <exception cref="T:System.ArgumentOutOfRangeException">
  21604. <para><paramref name="index"/> is less than zero</para>
  21605. <para>-or-</para>
  21606. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  21607. </exception>
  21608. </member>
  21609. <member name="M:log4net.Plugin.PluginCollection.Remove(log4net.Plugin.IPlugin)">
  21610. <summary>
  21611. Removes the first occurrence of a specific <see cref="T:log4net.Plugin.IPlugin"/> from the <c>PluginCollection</c>.
  21612. </summary>
  21613. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the <c>PluginCollection</c>.</param>
  21614. <exception cref="T:System.ArgumentException">
  21615. The specified <see cref="T:log4net.Plugin.IPlugin"/> was not found in the <c>PluginCollection</c>.
  21616. </exception>
  21617. </member>
  21618. <member name="M:log4net.Plugin.PluginCollection.RemoveAt(System.Int32)">
  21619. <summary>
  21620. Removes the element at the specified index of the <c>PluginCollection</c>.
  21621. </summary>
  21622. <param name="index">The zero-based index of the element to remove.</param>
  21623. <exception cref="T:System.ArgumentOutOfRangeException">
  21624. <para><paramref name="index"/> is less than zero.</para>
  21625. <para>-or-</para>
  21626. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  21627. </exception>
  21628. </member>
  21629. <member name="P:log4net.Plugin.PluginCollection.IsFixedSize">
  21630. <summary>
  21631. Gets a value indicating whether the collection has a fixed size.
  21632. </summary>
  21633. <value><c>true</c> if the collection has a fixed size; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  21634. </member>
  21635. <member name="P:log4net.Plugin.PluginCollection.IsReadOnly">
  21636. <summary>
  21637. Gets a value indicating whether the IList is read-only.
  21638. </summary>
  21639. <value><c>true</c> if the collection is read-only; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  21640. </member>
  21641. <member name="M:log4net.Plugin.PluginCollection.GetEnumerator">
  21642. <summary>
  21643. Returns an enumerator that can iterate through the <c>PluginCollection</c>.
  21644. </summary>
  21645. <returns>An <see cref="T:log4net.Plugin.PluginCollection.Enumerator"/> for the entire <c>PluginCollection</c>.</returns>
  21646. </member>
  21647. <member name="P:log4net.Plugin.PluginCollection.Capacity">
  21648. <summary>
  21649. Gets or sets the number of elements the <c>PluginCollection</c> can contain.
  21650. </summary>
  21651. <value>
  21652. The number of elements the <c>PluginCollection</c> can contain.
  21653. </value>
  21654. </member>
  21655. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.PluginCollection)">
  21656. <summary>
  21657. Adds the elements of another <c>PluginCollection</c> to the current <c>PluginCollection</c>.
  21658. </summary>
  21659. <param name="x">The <c>PluginCollection</c> whose elements should be added to the end of the current <c>PluginCollection</c>.</param>
  21660. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  21661. </member>
  21662. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.IPlugin[])">
  21663. <summary>
  21664. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> array to the current <c>PluginCollection</c>.
  21665. </summary>
  21666. <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>
  21667. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  21668. </member>
  21669. <member name="M:log4net.Plugin.PluginCollection.AddRange(System.Collections.ICollection)">
  21670. <summary>
  21671. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> collection to the current <c>PluginCollection</c>.
  21672. </summary>
  21673. <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>
  21674. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  21675. </member>
  21676. <member name="M:log4net.Plugin.PluginCollection.TrimToSize">
  21677. <summary>
  21678. Sets the capacity to the actual number of elements.
  21679. </summary>
  21680. </member>
  21681. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32)">
  21682. <exception cref="T:System.ArgumentOutOfRangeException">
  21683. <para><paramref name="i"/> is less than zero.</para>
  21684. <para>-or-</para>
  21685. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  21686. </exception>
  21687. </member>
  21688. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32,System.Boolean)">
  21689. <exception cref="T:System.ArgumentOutOfRangeException">
  21690. <para><paramref name="i"/> is less than zero.</para>
  21691. <para>-or-</para>
  21692. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  21693. </exception>
  21694. </member>
  21695. <member name="T:log4net.Plugin.PluginCollection.Enumerator">
  21696. <summary>
  21697. Supports simple iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  21698. </summary>
  21699. <exclude/>
  21700. </member>
  21701. <member name="M:log4net.Plugin.PluginCollection.Enumerator.#ctor(log4net.Plugin.PluginCollection)">
  21702. <summary>
  21703. Initializes a new instance of the <c>Enumerator</c> class.
  21704. </summary>
  21705. <param name="tc"></param>
  21706. </member>
  21707. <member name="P:log4net.Plugin.PluginCollection.Enumerator.Current">
  21708. <summary>
  21709. Gets the current element in the collection.
  21710. </summary>
  21711. <value>
  21712. The current element in the collection.
  21713. </value>
  21714. </member>
  21715. <member name="M:log4net.Plugin.PluginCollection.Enumerator.MoveNext">
  21716. <summary>
  21717. Advances the enumerator to the next element in the collection.
  21718. </summary>
  21719. <returns>
  21720. <c>true</c> if the enumerator was successfully advanced to the next element;
  21721. <c>false</c> if the enumerator has passed the end of the collection.
  21722. </returns>
  21723. <exception cref="T:System.InvalidOperationException">
  21724. The collection was modified after the enumerator was created.
  21725. </exception>
  21726. </member>
  21727. <member name="M:log4net.Plugin.PluginCollection.Enumerator.Reset">
  21728. <summary>
  21729. Sets the enumerator to its initial position, before the first element in the collection.
  21730. </summary>
  21731. </member>
  21732. <member name="T:log4net.Plugin.PluginCollection.ReadOnlyPluginCollection">
  21733. <exclude/>
  21734. </member>
  21735. <member name="T:log4net.Plugin.PluginMap">
  21736. <summary>
  21737. Map of repository plugins.
  21738. </summary>
  21739. <remarks>
  21740. <para>
  21741. This class is a name keyed map of the plugins that are
  21742. attached to a repository.
  21743. </para>
  21744. </remarks>
  21745. <author>Nicko Cadell</author>
  21746. <author>Gert Driesen</author>
  21747. </member>
  21748. <member name="M:log4net.Plugin.PluginMap.#ctor(log4net.Repository.ILoggerRepository)">
  21749. <summary>
  21750. Constructor
  21751. </summary>
  21752. <param name="repository">The repository that the plugins should be attached to.</param>
  21753. <remarks>
  21754. <para>
  21755. Initialize a new instance of the <see cref="T:log4net.Plugin.PluginMap" /> class with a
  21756. repository that the plugins should be attached to.
  21757. </para>
  21758. </remarks>
  21759. </member>
  21760. <member name="P:log4net.Plugin.PluginMap.Item(System.String)">
  21761. <summary>
  21762. Gets a <see cref="T:log4net.Plugin.IPlugin" /> by name.
  21763. </summary>
  21764. <param name="name">The name of the <see cref="T:log4net.Plugin.IPlugin" /> to lookup.</param>
  21765. <returns>
  21766. The <see cref="T:log4net.Plugin.IPlugin" /> from the map with the name specified, or
  21767. <c>null</c> if no plugin is found.
  21768. </returns>
  21769. <remarks>
  21770. <para>
  21771. Lookup a plugin by name. If the plugin is not found <c>null</c>
  21772. will be returned.
  21773. </para>
  21774. </remarks>
  21775. </member>
  21776. <member name="P:log4net.Plugin.PluginMap.AllPlugins">
  21777. <summary>
  21778. Gets all possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin" /> objects.
  21779. </summary>
  21780. <value>All possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin" /> objects.</value>
  21781. <remarks>
  21782. <para>
  21783. Get a collection of all the plugins defined in this map.
  21784. </para>
  21785. </remarks>
  21786. </member>
  21787. <member name="M:log4net.Plugin.PluginMap.Add(log4net.Plugin.IPlugin)">
  21788. <summary>
  21789. Adds a <see cref="T:log4net.Plugin.IPlugin" /> to the map.
  21790. </summary>
  21791. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin" /> to add to the map.</param>
  21792. <remarks>
  21793. <para>
  21794. The <see cref="T:log4net.Plugin.IPlugin" /> will be attached to the repository when added.
  21795. </para>
  21796. <para>
  21797. If there already exists a plugin with the same name
  21798. attached to the repository then the old plugin will
  21799. be <see cref="M:log4net.Plugin.IPlugin.Shutdown"/> and replaced with
  21800. the new plugin.
  21801. </para>
  21802. </remarks>
  21803. </member>
  21804. <member name="M:log4net.Plugin.PluginMap.Remove(log4net.Plugin.IPlugin)">
  21805. <summary>
  21806. Removes a <see cref="T:log4net.Plugin.IPlugin" /> from the map.
  21807. </summary>
  21808. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin" /> to remove from the map.</param>
  21809. <remarks>
  21810. <para>
  21811. Remove a specific plugin from this map.
  21812. </para>
  21813. </remarks>
  21814. </member>
  21815. <member name="T:log4net.Plugin.PluginSkeleton">
  21816. <summary>
  21817. Base implementation of <see cref="T:log4net.Plugin.IPlugin"/>
  21818. </summary>
  21819. <remarks>
  21820. <para>
  21821. Default abstract implementation of the <see cref="T:log4net.Plugin.IPlugin"/>
  21822. interface. This base class can be used by implementors
  21823. of the <see cref="T:log4net.Plugin.IPlugin"/> interface.
  21824. </para>
  21825. </remarks>
  21826. <author>Nicko Cadell</author>
  21827. <author>Gert Driesen</author>
  21828. </member>
  21829. <member name="M:log4net.Plugin.PluginSkeleton.#ctor(System.String)">
  21830. <summary>
  21831. Constructor
  21832. </summary>
  21833. <param name="name">the name of the plugin</param>
  21834. <remarks>
  21835. Initializes a new Plugin with the specified name.
  21836. </remarks>
  21837. </member>
  21838. <member name="P:log4net.Plugin.PluginSkeleton.Name">
  21839. <summary>
  21840. Gets or sets the name of the plugin.
  21841. </summary>
  21842. <value>
  21843. The name of the plugin.
  21844. </value>
  21845. <remarks>
  21846. <para>
  21847. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  21848. keyed by name. Each plugin instance attached to a
  21849. repository must be a unique name.
  21850. </para>
  21851. <para>
  21852. The name of the plugin must not change one the
  21853. plugin has been attached to a repository.
  21854. </para>
  21855. </remarks>
  21856. </member>
  21857. <member name="M:log4net.Plugin.PluginSkeleton.Attach(log4net.Repository.ILoggerRepository)">
  21858. <summary>
  21859. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21860. </summary>
  21861. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  21862. <remarks>
  21863. <para>
  21864. A plugin may only be attached to a single repository.
  21865. </para>
  21866. <para>
  21867. This method is called when the plugin is attached to the repository.
  21868. </para>
  21869. </remarks>
  21870. </member>
  21871. <member name="M:log4net.Plugin.PluginSkeleton.Shutdown">
  21872. <summary>
  21873. Is called when the plugin is to shutdown.
  21874. </summary>
  21875. <remarks>
  21876. <para>
  21877. This method is called to notify the plugin that
  21878. it should stop operating and should detach from
  21879. the repository.
  21880. </para>
  21881. </remarks>
  21882. </member>
  21883. <member name="P:log4net.Plugin.PluginSkeleton.LoggerRepository">
  21884. <summary>
  21885. The repository for this plugin
  21886. </summary>
  21887. <value>
  21888. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this plugin is attached to.
  21889. </value>
  21890. <remarks>
  21891. <para>
  21892. Gets or sets the <see cref="T:log4net.Repository.ILoggerRepository" /> that this plugin is
  21893. attached to.
  21894. </para>
  21895. </remarks>
  21896. </member>
  21897. <member name="F:log4net.Plugin.PluginSkeleton.m_name">
  21898. <summary>
  21899. The name of this plugin.
  21900. </summary>
  21901. </member>
  21902. <member name="F:log4net.Plugin.PluginSkeleton.m_repository">
  21903. <summary>
  21904. The repository this plugin is attached to.
  21905. </summary>
  21906. </member>
  21907. <member name="T:log4net.Plugin.RemoteLoggingServerPlugin">
  21908. <summary>
  21909. Plugin that listens for events from the <see cref="T:log4net.Appender.RemotingAppender"/>
  21910. </summary>
  21911. <remarks>
  21912. <para>
  21913. This plugin publishes an instance of <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  21914. on a specified <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/>. This listens for logging events delivered from
  21915. a remote <see cref="T:log4net.Appender.RemotingAppender"/>.
  21916. </para>
  21917. <para>
  21918. When an event is received it is relogged within the attached repository
  21919. as if it had been raised locally.
  21920. </para>
  21921. </remarks>
  21922. <author>Nicko Cadell</author>
  21923. <author>Gert Driesen</author>
  21924. </member>
  21925. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor">
  21926. <summary>
  21927. Default constructor
  21928. </summary>
  21929. <remarks>
  21930. <para>
  21931. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin" /> class.
  21932. </para>
  21933. <para>
  21934. The <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> property must be set.
  21935. </para>
  21936. </remarks>
  21937. </member>
  21938. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor(System.String)">
  21939. <summary>
  21940. Construct with sink Uri.
  21941. </summary>
  21942. <param name="sinkUri">The name to publish the sink under in the remoting infrastructure.
  21943. See <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> for more details.</param>
  21944. <remarks>
  21945. <para>
  21946. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin" /> class
  21947. with specified name.
  21948. </para>
  21949. </remarks>
  21950. </member>
  21951. <member name="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri">
  21952. <summary>
  21953. Gets or sets the URI of this sink.
  21954. </summary>
  21955. <value>
  21956. The URI of this sink.
  21957. </value>
  21958. <remarks>
  21959. <para>
  21960. This is the name under which the object is marshaled.
  21961. <see cref="M:RemotingServices.Marshal(MarshalByRefObject,String,Type)"/>
  21962. </para>
  21963. </remarks>
  21964. </member>
  21965. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Attach(log4net.Repository.ILoggerRepository)">
  21966. <summary>
  21967. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21968. </summary>
  21969. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  21970. <remarks>
  21971. <para>
  21972. A plugin may only be attached to a single repository.
  21973. </para>
  21974. <para>
  21975. This method is called when the plugin is attached to the repository.
  21976. </para>
  21977. </remarks>
  21978. </member>
  21979. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Shutdown">
  21980. <summary>
  21981. Is called when the plugin is to shutdown.
  21982. </summary>
  21983. <remarks>
  21984. <para>
  21985. When the plugin is shutdown the remote logging
  21986. sink is disconnected.
  21987. </para>
  21988. </remarks>
  21989. </member>
  21990. <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.declaringType">
  21991. <summary>
  21992. The fully qualified type of the RemoteLoggingServerPlugin class.
  21993. </summary>
  21994. <remarks>
  21995. Used by the internal logger to record the Type of the
  21996. log message.
  21997. </remarks>
  21998. </member>
  21999. <member name="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl">
  22000. <summary>
  22001. Delivers <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  22002. </summary>
  22003. <remarks>
  22004. <para>
  22005. Internal class used to listen for logging events
  22006. and deliver them to the local repository.
  22007. </para>
  22008. </remarks>
  22009. </member>
  22010. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.#ctor(log4net.Repository.ILoggerRepository)">
  22011. <summary>
  22012. Constructor
  22013. </summary>
  22014. <param name="repository">The repository to log to.</param>
  22015. <remarks>
  22016. <para>
  22017. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl"/> for the
  22018. specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  22019. </para>
  22020. </remarks>
  22021. </member>
  22022. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.LogEvents(log4net.Core.LoggingEvent[])">
  22023. <summary>
  22024. Logs the events to the repository.
  22025. </summary>
  22026. <param name="events">The events to log.</param>
  22027. <remarks>
  22028. <para>
  22029. The events passed are logged to the <see cref="T:log4net.Repository.ILoggerRepository"/>
  22030. </para>
  22031. </remarks>
  22032. </member>
  22033. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.InitializeLifetimeService">
  22034. <summary>
  22035. Obtains a lifetime service object to control the lifetime
  22036. policy for this instance.
  22037. </summary>
  22038. <returns><c>null</c> to indicate that this instance should live forever.</returns>
  22039. <remarks>
  22040. <para>
  22041. Obtains a lifetime service object to control the lifetime
  22042. policy for this instance. This object should live forever
  22043. therefore this implementation returns <c>null</c>.
  22044. </para>
  22045. </remarks>
  22046. </member>
  22047. <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.m_repository">
  22048. <summary>
  22049. The underlying <see cref="T:log4net.Repository.ILoggerRepository" /> that events should
  22050. be logged to.
  22051. </summary>
  22052. </member>
  22053. <member name="T:log4net.Repository.ConfigurationChangedEventArgs">
  22054. <summary>
  22055. </summary>
  22056. </member>
  22057. <member name="M:log4net.Repository.ConfigurationChangedEventArgs.#ctor(System.Collections.ICollection)">
  22058. <summary>
  22059. </summary>
  22060. <param name="configurationMessages"></param>
  22061. </member>
  22062. <member name="P:log4net.Repository.ConfigurationChangedEventArgs.ConfigurationMessages">
  22063. <summary>
  22064. </summary>
  22065. </member>
  22066. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory">
  22067. <summary>
  22068. Default implementation of <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  22069. </summary>
  22070. <remarks>
  22071. <para>
  22072. This default implementation of the <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  22073. interface is used to create the default subclass
  22074. of the <see cref="T:log4net.Repository.Hierarchy.Logger"/> object.
  22075. </para>
  22076. </remarks>
  22077. <author>Nicko Cadell</author>
  22078. <author>Gert Driesen</author>
  22079. </member>
  22080. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.#ctor">
  22081. <summary>
  22082. Default constructor
  22083. </summary>
  22084. <remarks>
  22085. <para>
  22086. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory" /> class.
  22087. </para>
  22088. </remarks>
  22089. </member>
  22090. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  22091. <summary>
  22092. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance
  22093. </summary>
  22094. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository" /> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  22095. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  22096. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance for the specified name.</returns>
  22097. <remarks>
  22098. <para>
  22099. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance with the
  22100. specified name.
  22101. </para>
  22102. <para>
  22103. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  22104. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  22105. </para>
  22106. <para>
  22107. If the <paramref name="name"/> is <c>null</c> then the root logger
  22108. must be returned.
  22109. </para>
  22110. </remarks>
  22111. </member>
  22112. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl">
  22113. <summary>
  22114. Default internal subclass of <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  22115. </summary>
  22116. <remarks>
  22117. <para>
  22118. This subclass has no additional behavior over the
  22119. <see cref="T:log4net.Repository.Hierarchy.Logger"/> class but does allow instances
  22120. to be created.
  22121. </para>
  22122. </remarks>
  22123. </member>
  22124. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl.#ctor(System.String)">
  22125. <summary>
  22126. Construct a new Logger
  22127. </summary>
  22128. <param name="name">the name of the logger</param>
  22129. <remarks>
  22130. <para>
  22131. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl" /> class
  22132. with the specified name.
  22133. </para>
  22134. </remarks>
  22135. </member>
  22136. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventHandler">
  22137. <summary>
  22138. Delegate used to handle logger creation event notifications.
  22139. </summary>
  22140. <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>
  22141. <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>
  22142. <remarks>
  22143. <para>
  22144. Delegate used to handle logger creation event notifications.
  22145. </para>
  22146. </remarks>
  22147. </member>
  22148. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs">
  22149. <summary>
  22150. Provides data for the <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event.
  22151. </summary>
  22152. <remarks>
  22153. <para>
  22154. A <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event is raised every time a
  22155. <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> is created.
  22156. </para>
  22157. </remarks>
  22158. </member>
  22159. <member name="F:log4net.Repository.Hierarchy.LoggerCreationEventArgs.m_log">
  22160. <summary>
  22161. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> created
  22162. </summary>
  22163. </member>
  22164. <member name="M:log4net.Repository.Hierarchy.LoggerCreationEventArgs.#ctor(log4net.Repository.Hierarchy.Logger)">
  22165. <summary>
  22166. Constructor
  22167. </summary>
  22168. <param name="log">The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.</param>
  22169. <remarks>
  22170. <para>
  22171. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs" /> event argument
  22172. class,with the specified <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/>.
  22173. </para>
  22174. </remarks>
  22175. </member>
  22176. <member name="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger">
  22177. <summary>
  22178. Gets the <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  22179. </summary>
  22180. <value>
  22181. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  22182. </value>
  22183. <remarks>
  22184. <para>
  22185. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  22186. </para>
  22187. </remarks>
  22188. </member>
  22189. <member name="T:log4net.Repository.Hierarchy.Hierarchy">
  22190. <summary>
  22191. Hierarchical organization of loggers
  22192. </summary>
  22193. <remarks>
  22194. <para>
  22195. <i>The casual user should not have to deal with this class
  22196. directly.</i>
  22197. </para>
  22198. <para>
  22199. This class is specialized in retrieving loggers by name and
  22200. also maintaining the logger hierarchy. Implements the
  22201. <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  22202. </para>
  22203. <para>
  22204. The structure of the logger hierarchy is maintained by the
  22205. <see cref="M:GetLogger(string)"/> method. The hierarchy is such that children
  22206. link to their parent but parents do not have any references to their
  22207. children. Moreover, loggers can be instantiated in any order, in
  22208. particular descendant before ancestor.
  22209. </para>
  22210. <para>
  22211. In case a descendant is created before a particular ancestor,
  22212. then it creates a provision node for the ancestor and adds itself
  22213. to the provision node. Other descendants of the same ancestor add
  22214. themselves to the previously created provision node.
  22215. </para>
  22216. </remarks>
  22217. <author>Nicko Cadell</author>
  22218. <author>Gert Driesen</author>
  22219. </member>
  22220. <member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent">
  22221. <summary>
  22222. Event used to notify that a logger has been created.
  22223. </summary>
  22224. <remarks>
  22225. <para>
  22226. Event raised when a logger is created.
  22227. </para>
  22228. </remarks>
  22229. </member>
  22230. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor">
  22231. <summary>
  22232. Default constructor
  22233. </summary>
  22234. <remarks>
  22235. <para>
  22236. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class.
  22237. </para>
  22238. </remarks>
  22239. </member>
  22240. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary)">
  22241. <summary>
  22242. Construct with properties
  22243. </summary>
  22244. <param name="properties">The properties to pass to this repository.</param>
  22245. <remarks>
  22246. <para>
  22247. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class.
  22248. </para>
  22249. </remarks>
  22250. </member>
  22251. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Repository.Hierarchy.ILoggerFactory)">
  22252. <summary>
  22253. Construct with a logger factory
  22254. </summary>
  22255. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  22256. <remarks>
  22257. <para>
  22258. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class with
  22259. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" />.
  22260. </para>
  22261. </remarks>
  22262. </member>
  22263. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary,log4net.Repository.Hierarchy.ILoggerFactory)">
  22264. <summary>
  22265. Construct with properties and a logger factory
  22266. </summary>
  22267. <param name="properties">The properties to pass to this repository.</param>
  22268. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  22269. <remarks>
  22270. <para>
  22271. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class with
  22272. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" />.
  22273. </para>
  22274. </remarks>
  22275. </member>
  22276. <member name="P:log4net.Repository.Hierarchy.Hierarchy.EmittedNoAppenderWarning">
  22277. <summary>
  22278. Has no appender warning been emitted
  22279. </summary>
  22280. <remarks>
  22281. <para>
  22282. Flag to indicate if we have already issued a warning
  22283. about not having an appender warning.
  22284. </para>
  22285. </remarks>
  22286. </member>
  22287. <member name="P:log4net.Repository.Hierarchy.Hierarchy.Root">
  22288. <summary>
  22289. Get the root of this hierarchy
  22290. </summary>
  22291. <remarks>
  22292. <para>
  22293. Get the root of this hierarchy.
  22294. </para>
  22295. </remarks>
  22296. </member>
  22297. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LoggerFactory">
  22298. <summary>
  22299. Gets or sets the default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" /> instance.
  22300. </summary>
  22301. <value>The default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" /></value>
  22302. <remarks>
  22303. <para>
  22304. The logger factory is used to create logger instances.
  22305. </para>
  22306. </remarks>
  22307. </member>
  22308. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Exists(System.String)">
  22309. <summary>
  22310. Test if a logger exists
  22311. </summary>
  22312. <param name="name">The name of the logger to lookup</param>
  22313. <returns>The Logger object with the name specified</returns>
  22314. <remarks>
  22315. <para>
  22316. Check if the named logger exists in the hierarchy. If so return
  22317. its reference, otherwise returns <c>null</c>.
  22318. </para>
  22319. </remarks>
  22320. </member>
  22321. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetCurrentLoggers">
  22322. <summary>
  22323. Returns all the currently defined loggers in the hierarchy as an Array
  22324. </summary>
  22325. <returns>All the defined loggers</returns>
  22326. <remarks>
  22327. <para>
  22328. Returns all the currently defined loggers in the hierarchy as an Array.
  22329. The root logger is <b>not</b> included in the returned
  22330. enumeration.
  22331. </para>
  22332. </remarks>
  22333. </member>
  22334. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String)">
  22335. <summary>
  22336. Return a new logger instance named as the first parameter using
  22337. the default factory.
  22338. </summary>
  22339. <remarks>
  22340. <para>
  22341. Return a new logger instance named as the first parameter using
  22342. the default factory.
  22343. </para>
  22344. <para>
  22345. If a logger of that name already exists, then it will be
  22346. returned. Otherwise, a new logger will be instantiated and
  22347. then linked with its existing ancestors as well as children.
  22348. </para>
  22349. </remarks>
  22350. <param name="name">The name of the logger to retrieve</param>
  22351. <returns>The logger object with the name specified</returns>
  22352. </member>
  22353. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Shutdown">
  22354. <summary>
  22355. Shutting down a hierarchy will <i>safely</i> close and remove
  22356. all appenders in all loggers including the root logger.
  22357. </summary>
  22358. <remarks>
  22359. <para>
  22360. Shutting down a hierarchy will <i>safely</i> close and remove
  22361. all appenders in all loggers including the root logger.
  22362. </para>
  22363. <para>
  22364. Some appenders need to be closed before the
  22365. application exists. Otherwise, pending logging events might be
  22366. lost.
  22367. </para>
  22368. <para>
  22369. The <c>Shutdown</c> method is careful to close nested
  22370. appenders before closing regular appenders. This is allows
  22371. configurations where a regular appender is attached to a logger
  22372. and again to a nested appender.
  22373. </para>
  22374. </remarks>
  22375. </member>
  22376. <member name="M:log4net.Repository.Hierarchy.Hierarchy.ResetConfiguration">
  22377. <summary>
  22378. Reset all values contained in this hierarchy instance to their default.
  22379. </summary>
  22380. <remarks>
  22381. <para>
  22382. Reset all values contained in this hierarchy instance to their
  22383. default. This removes all appenders from all loggers, sets
  22384. the level of all non-root loggers to <c>null</c>,
  22385. sets their additivity flag to <c>true</c> and sets the level
  22386. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  22387. message disabling is set its default "off" value.
  22388. </para>
  22389. <para>
  22390. Existing loggers are not removed. They are just reset.
  22391. </para>
  22392. <para>
  22393. This method should be used sparingly and with care as it will
  22394. block all logging until it is completed.
  22395. </para>
  22396. </remarks>
  22397. </member>
  22398. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Log(log4net.Core.LoggingEvent)">
  22399. <summary>
  22400. Log the logEvent through this hierarchy.
  22401. </summary>
  22402. <param name="logEvent">the event to log</param>
  22403. <remarks>
  22404. <para>
  22405. This method should not normally be used to log.
  22406. The <see cref="T:log4net.ILog"/> interface should be used
  22407. for routine logging. This interface can be obtained
  22408. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  22409. </para>
  22410. <para>
  22411. The <c>logEvent</c> is delivered to the appropriate logger and
  22412. that logger is then responsible for logging the event.
  22413. </para>
  22414. </remarks>
  22415. </member>
  22416. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetAppenders">
  22417. <summary>
  22418. Returns all the Appenders that are currently configured
  22419. </summary>
  22420. <returns>An array containing all the currently configured appenders</returns>
  22421. <remarks>
  22422. <para>
  22423. Returns all the <see cref="T:log4net.Appender.IAppender"/> instances that are currently configured.
  22424. All the loggers are searched for appenders. The appenders may also be containers
  22425. for appenders and these are also searched for additional loggers.
  22426. </para>
  22427. <para>
  22428. The list returned is unordered but does not contain duplicates.
  22429. </para>
  22430. </remarks>
  22431. </member>
  22432. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppender(System.Collections.ArrayList,log4net.Appender.IAppender)">
  22433. <summary>
  22434. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/>.
  22435. The appender may also be a container.
  22436. </summary>
  22437. <param name="appenderList"></param>
  22438. <param name="appender"></param>
  22439. </member>
  22440. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppenders(System.Collections.ArrayList,log4net.Core.IAppenderAttachable)">
  22441. <summary>
  22442. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/> container
  22443. </summary>
  22444. <param name="appenderList"></param>
  22445. <param name="container"></param>
  22446. </member>
  22447. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender)">
  22448. <summary>
  22449. Initialize the log4net system using the specified appender
  22450. </summary>
  22451. <param name="appender">the appender to use to log all logging events</param>
  22452. </member>
  22453. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender[])">
  22454. <summary>
  22455. Initialize the log4net system using the specified appenders
  22456. </summary>
  22457. <param name="appenders">the appenders to use to log all logging events</param>
  22458. </member>
  22459. <member name="M:log4net.Repository.Hierarchy.Hierarchy.BasicRepositoryConfigure(log4net.Appender.IAppender[])">
  22460. <summary>
  22461. Initialize the log4net system using the specified appenders
  22462. </summary>
  22463. <param name="appenders">the appenders to use to log all logging events</param>
  22464. <remarks>
  22465. <para>
  22466. This method provides the same functionality as the
  22467. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  22468. on this object, but it is protected and therefore can be called by subclasses.
  22469. </para>
  22470. </remarks>
  22471. </member>
  22472. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IXmlRepositoryConfigurator#Configure(System.Xml.XmlElement)">
  22473. <summary>
  22474. Initialize the log4net system using the specified config
  22475. </summary>
  22476. <param name="element">the element containing the root of the config</param>
  22477. </member>
  22478. <member name="M:log4net.Repository.Hierarchy.Hierarchy.XmlRepositoryConfigure(System.Xml.XmlElement)">
  22479. <summary>
  22480. Initialize the log4net system using the specified config
  22481. </summary>
  22482. <param name="element">the element containing the root of the config</param>
  22483. <remarks>
  22484. <para>
  22485. This method provides the same functionality as the
  22486. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  22487. on this object, but it is protected and therefore can be called by subclasses.
  22488. </para>
  22489. </remarks>
  22490. </member>
  22491. <member name="M:log4net.Repository.Hierarchy.Hierarchy.IsDisabled(log4net.Core.Level)">
  22492. <summary>
  22493. Test if this hierarchy is disabled for the specified <see cref="T:log4net.Core.Level"/>.
  22494. </summary>
  22495. <param name="level">The level to check against.</param>
  22496. <returns>
  22497. <c>true</c> if the repository is disabled for the level argument, <c>false</c> otherwise.
  22498. </returns>
  22499. <remarks>
  22500. <para>
  22501. If this hierarchy has not been configured then this method will
  22502. always return <c>true</c>.
  22503. </para>
  22504. <para>
  22505. This method will return <c>true</c> if this repository is
  22506. disabled for <c>level</c> object passed as parameter and
  22507. <c>false</c> otherwise.
  22508. </para>
  22509. <para>
  22510. See also the <see cref="P:log4net.Repository.ILoggerRepository.Threshold"/> property.
  22511. </para>
  22512. </remarks>
  22513. </member>
  22514. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Clear">
  22515. <summary>
  22516. Clear all logger definitions from the internal hashtable
  22517. </summary>
  22518. <remarks>
  22519. <para>
  22520. This call will clear all logger definitions from the internal
  22521. hashtable. Invoking this method will irrevocably mess up the
  22522. logger hierarchy.
  22523. </para>
  22524. <para>
  22525. You should <b>really</b> know what you are doing before
  22526. invoking this method.
  22527. </para>
  22528. </remarks>
  22529. </member>
  22530. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String,log4net.Repository.Hierarchy.ILoggerFactory)">
  22531. <summary>
  22532. Return a new logger instance named as the first parameter using
  22533. <paramref name="factory"/>.
  22534. </summary>
  22535. <param name="name">The name of the logger to retrieve</param>
  22536. <param name="factory">The factory that will make the new logger instance</param>
  22537. <returns>The logger object with the name specified</returns>
  22538. <remarks>
  22539. <para>
  22540. If a logger of that name already exists, then it will be
  22541. returned. Otherwise, a new logger will be instantiated by the
  22542. <paramref name="factory"/> parameter and linked with its existing
  22543. ancestors as well as children.
  22544. </para>
  22545. </remarks>
  22546. </member>
  22547. <member name="M:log4net.Repository.Hierarchy.Hierarchy.OnLoggerCreationEvent(log4net.Repository.Hierarchy.Logger)">
  22548. <summary>
  22549. Sends a logger creation event to all registered listeners
  22550. </summary>
  22551. <param name="logger">The newly created logger</param>
  22552. <remarks>
  22553. Raises the logger creation event.
  22554. </remarks>
  22555. </member>
  22556. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateParents(log4net.Repository.Hierarchy.Logger)">
  22557. <summary>
  22558. Updates all the parents of the specified logger
  22559. </summary>
  22560. <param name="log">The logger to update the parents for</param>
  22561. <remarks>
  22562. <para>
  22563. This method loops through all the <i>potential</i> parents of
  22564. <paramref name="log"/>. There 3 possible cases:
  22565. </para>
  22566. <list type="number">
  22567. <item>
  22568. <term>No entry for the potential parent of <paramref name="log"/> exists</term>
  22569. <description>
  22570. We create a ProvisionNode for this potential
  22571. parent and insert <paramref name="log"/> in that provision node.
  22572. </description>
  22573. </item>
  22574. <item>
  22575. <term>The entry is of type Logger for the potential parent.</term>
  22576. <description>
  22577. The entry is <paramref name="log"/>'s nearest existing parent. We
  22578. update <paramref name="log"/>'s parent field with this entry. We also break from
  22579. he loop because updating our parent's parent is our parent's
  22580. responsibility.
  22581. </description>
  22582. </item>
  22583. <item>
  22584. <term>The entry is of type ProvisionNode for this potential parent.</term>
  22585. <description>
  22586. We add <paramref name="log"/> to the list of children for this
  22587. potential parent.
  22588. </description>
  22589. </item>
  22590. </list>
  22591. </remarks>
  22592. </member>
  22593. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateChildren(log4net.Repository.Hierarchy.ProvisionNode,log4net.Repository.Hierarchy.Logger)">
  22594. <summary>
  22595. Replace a <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> with a <see cref="T:log4net.Repository.Hierarchy.Logger"/> in the hierarchy.
  22596. </summary>
  22597. <param name="pn"></param>
  22598. <param name="log"></param>
  22599. <remarks>
  22600. <para>
  22601. We update the links for all the children that placed themselves
  22602. in the provision node 'pn'. The second argument 'log' is a
  22603. reference for the newly created Logger, parent of all the
  22604. children in 'pn'.
  22605. </para>
  22606. <para>
  22607. We loop on all the children 'c' in 'pn'.
  22608. </para>
  22609. <para>
  22610. If the child 'c' has been already linked to a child of
  22611. 'log' then there is no need to update 'c'.
  22612. </para>
  22613. <para>
  22614. Otherwise, we set log's parent field to c's parent and set
  22615. c's parent field to log.
  22616. </para>
  22617. </remarks>
  22618. </member>
  22619. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddLevel(log4net.Repository.Hierarchy.Hierarchy.LevelEntry)">
  22620. <summary>
  22621. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22622. </summary>
  22623. <param name="levelEntry">the level values</param>
  22624. <remarks>
  22625. <para>
  22626. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22627. </para>
  22628. <para>
  22629. Supports setting levels via the configuration file.
  22630. </para>
  22631. </remarks>
  22632. </member>
  22633. <member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry">
  22634. <summary>
  22635. A class to hold the value, name and display name for a level
  22636. </summary>
  22637. <remarks>
  22638. <para>
  22639. A class to hold the value, name and display name for a level
  22640. </para>
  22641. </remarks>
  22642. </member>
  22643. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Value">
  22644. <summary>
  22645. Value of the level
  22646. </summary>
  22647. <remarks>
  22648. <para>
  22649. If the value is not set (defaults to -1) the value will be looked
  22650. up for the current level with the same name.
  22651. </para>
  22652. </remarks>
  22653. </member>
  22654. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Name">
  22655. <summary>
  22656. Name of the level
  22657. </summary>
  22658. <value>
  22659. The name of the level
  22660. </value>
  22661. <remarks>
  22662. <para>
  22663. The name of the level.
  22664. </para>
  22665. </remarks>
  22666. </member>
  22667. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.DisplayName">
  22668. <summary>
  22669. Display name for the level
  22670. </summary>
  22671. <value>
  22672. The display name of the level
  22673. </value>
  22674. <remarks>
  22675. <para>
  22676. The display name of the level.
  22677. </para>
  22678. </remarks>
  22679. </member>
  22680. <member name="M:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.ToString">
  22681. <summary>
  22682. Override <c>Object.ToString</c> to return sensible debug info
  22683. </summary>
  22684. <returns>string info about this object</returns>
  22685. </member>
  22686. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Util.PropertyEntry)">
  22687. <summary>
  22688. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22689. </summary>
  22690. <param name="propertyEntry">the property value</param>
  22691. <remarks>
  22692. <para>
  22693. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument.
  22694. </para>
  22695. <para>
  22696. Supports setting property values via the configuration file.
  22697. </para>
  22698. </remarks>
  22699. </member>
  22700. <member name="F:log4net.Repository.Hierarchy.Hierarchy.declaringType">
  22701. <summary>
  22702. The fully qualified type of the Hierarchy class.
  22703. </summary>
  22704. <remarks>
  22705. Used by the internal logger to record the Type of the
  22706. log message.
  22707. </remarks>
  22708. </member>
  22709. <member name="T:log4net.Repository.Hierarchy.ILoggerFactory">
  22710. <summary>
  22711. Interface abstracts creation of <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances
  22712. </summary>
  22713. <remarks>
  22714. <para>
  22715. This interface is used by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to
  22716. create new <see cref="T:log4net.Repository.Hierarchy.Logger"/> objects.
  22717. </para>
  22718. <para>
  22719. The <see cref="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"/> method is called
  22720. to create a named <see cref="T:log4net.Repository.Hierarchy.Logger" />.
  22721. </para>
  22722. <para>
  22723. Implement this interface to create new subclasses of <see cref="T:log4net.Repository.Hierarchy.Logger" />.
  22724. </para>
  22725. </remarks>
  22726. <author>Nicko Cadell</author>
  22727. <author>Gert Driesen</author>
  22728. </member>
  22729. <member name="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  22730. <summary>
  22731. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance
  22732. </summary>
  22733. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository" /> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  22734. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  22735. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance for the specified name.</returns>
  22736. <remarks>
  22737. <para>
  22738. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance with the
  22739. specified name.
  22740. </para>
  22741. <para>
  22742. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  22743. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  22744. </para>
  22745. <para>
  22746. If the <paramref name="name"/> is <c>null</c> then the root logger
  22747. must be returned.
  22748. </para>
  22749. </remarks>
  22750. </member>
  22751. <member name="T:log4net.Repository.Hierarchy.Logger">
  22752. <summary>
  22753. Implementation of <see cref="T:log4net.Core.ILogger"/> used by <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>
  22754. </summary>
  22755. <remarks>
  22756. <para>
  22757. Internal class used to provide implementation of <see cref="T:log4net.Core.ILogger"/>
  22758. interface. Applications should use <see cref="T:log4net.LogManager"/> to get
  22759. logger instances.
  22760. </para>
  22761. <para>
  22762. This is one of the central classes in the log4net implementation. One of the
  22763. distinctive features of log4net are hierarchical loggers and their
  22764. evaluation. The <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> organizes the <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  22765. instances into a rooted tree hierarchy.
  22766. </para>
  22767. <para>
  22768. The <see cref="T:log4net.Repository.Hierarchy.Logger"/> class is abstract. Only concrete subclasses of
  22769. <see cref="T:log4net.Repository.Hierarchy.Logger"/> can be created. The <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  22770. is used to create instances of this type for the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  22771. </para>
  22772. </remarks>
  22773. <author>Nicko Cadell</author>
  22774. <author>Gert Driesen</author>
  22775. <author>Aspi Havewala</author>
  22776. <author>Douglas de la Torre</author>
  22777. </member>
  22778. <member name="M:log4net.Repository.Hierarchy.Logger.#ctor(System.String)">
  22779. <summary>
  22780. This constructor created a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance and
  22781. sets its name.
  22782. </summary>
  22783. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  22784. <remarks>
  22785. <para>
  22786. This constructor is protected and designed to be used by
  22787. a subclass that is not abstract.
  22788. </para>
  22789. <para>
  22790. Loggers are constructed by <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  22791. objects. See <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> for the default
  22792. logger creator.
  22793. </para>
  22794. </remarks>
  22795. </member>
  22796. <member name="P:log4net.Repository.Hierarchy.Logger.Parent">
  22797. <summary>
  22798. Gets or sets the parent logger in the hierarchy.
  22799. </summary>
  22800. <value>
  22801. The parent logger in the hierarchy.
  22802. </value>
  22803. <remarks>
  22804. <para>
  22805. Part of the Composite pattern that makes the hierarchy.
  22806. The hierarchy is parent linked rather than child linked.
  22807. </para>
  22808. </remarks>
  22809. </member>
  22810. <member name="P:log4net.Repository.Hierarchy.Logger.Additivity">
  22811. <summary>
  22812. Gets or sets a value indicating if child loggers inherit their parent's appenders.
  22813. </summary>
  22814. <value>
  22815. <c>true</c> if child loggers inherit their parent's appenders.
  22816. </value>
  22817. <remarks>
  22818. <para>
  22819. Additivity is set to <c>true</c> by default, that is children inherit
  22820. the appenders of their ancestors by default. If this variable is
  22821. set to <c>false</c> then the appenders found in the
  22822. ancestors of this logger are not used. However, the children
  22823. of this logger will inherit its appenders, unless the children
  22824. have their additivity flag set to <c>false</c> too. See
  22825. the user manual for more details.
  22826. </para>
  22827. </remarks>
  22828. </member>
  22829. <member name="P:log4net.Repository.Hierarchy.Logger.EffectiveLevel">
  22830. <summary>
  22831. Gets the effective level for this logger.
  22832. </summary>
  22833. <returns>The nearest level in the logger hierarchy.</returns>
  22834. <remarks>
  22835. <para>
  22836. Starting from this logger, searches the logger hierarchy for a
  22837. non-null level and returns it. Otherwise, returns the level of the
  22838. root logger.
  22839. </para>
  22840. <para>The Logger class is designed so that this method executes as
  22841. quickly as possible.</para>
  22842. </remarks>
  22843. </member>
  22844. <member name="P:log4net.Repository.Hierarchy.Logger.Hierarchy">
  22845. <summary>
  22846. Gets or sets the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> where this
  22847. <c>Logger</c> instance is attached to.
  22848. </summary>
  22849. <value>The hierarchy that this logger belongs to.</value>
  22850. <remarks>
  22851. <para>
  22852. This logger must be attached to a single <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  22853. </para>
  22854. </remarks>
  22855. </member>
  22856. <member name="P:log4net.Repository.Hierarchy.Logger.Level">
  22857. <summary>
  22858. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>, if any, for this Logger.
  22859. </summary>
  22860. <value>
  22861. The <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> of this logger.
  22862. </value>
  22863. <remarks>
  22864. <para>
  22865. The assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> can be <c>null</c>.
  22866. </para>
  22867. </remarks>
  22868. </member>
  22869. <member name="M:log4net.Repository.Hierarchy.Logger.AddAppender(log4net.Appender.IAppender)">
  22870. <summary>
  22871. Add <paramref name="newAppender"/> to the list of appenders of this
  22872. Logger instance.
  22873. </summary>
  22874. <param name="newAppender">An appender to add to this logger</param>
  22875. <remarks>
  22876. <para>
  22877. Add <paramref name="newAppender"/> to the list of appenders of this
  22878. Logger instance.
  22879. </para>
  22880. <para>
  22881. If <paramref name="newAppender"/> is already in the list of
  22882. appenders, then it won't be added again.
  22883. </para>
  22884. </remarks>
  22885. </member>
  22886. <member name="P:log4net.Repository.Hierarchy.Logger.Appenders">
  22887. <summary>
  22888. Get the appenders contained in this logger as an
  22889. <see cref="T:System.Collections.ICollection"/>.
  22890. </summary>
  22891. <returns>A collection of the appenders in this logger</returns>
  22892. <remarks>
  22893. <para>
  22894. Get the appenders contained in this logger as an
  22895. <see cref="T:System.Collections.ICollection"/>. If no appenders
  22896. can be found, then a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  22897. </para>
  22898. </remarks>
  22899. </member>
  22900. <member name="M:log4net.Repository.Hierarchy.Logger.GetAppender(System.String)">
  22901. <summary>
  22902. Look for the appender named as <c>name</c>
  22903. </summary>
  22904. <param name="name">The name of the appender to lookup</param>
  22905. <returns>The appender with the name specified, or <c>null</c>.</returns>
  22906. <remarks>
  22907. <para>
  22908. Returns the named appender, or null if the appender is not found.
  22909. </para>
  22910. </remarks>
  22911. </member>
  22912. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAllAppenders">
  22913. <summary>
  22914. Remove all previously added appenders from this Logger instance.
  22915. </summary>
  22916. <remarks>
  22917. <para>
  22918. Remove all previously added appenders from this Logger instance.
  22919. </para>
  22920. <para>
  22921. This is useful when re-reading configuration information.
  22922. </para>
  22923. </remarks>
  22924. </member>
  22925. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(log4net.Appender.IAppender)">
  22926. <summary>
  22927. Remove the appender passed as parameter form the list of appenders.
  22928. </summary>
  22929. <param name="appender">The appender to remove</param>
  22930. <returns>The appender removed from the list</returns>
  22931. <remarks>
  22932. <para>
  22933. Remove the appender passed as parameter form the list of appenders.
  22934. The appender removed is not closed.
  22935. If you are discarding the appender you must call
  22936. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  22937. </para>
  22938. </remarks>
  22939. </member>
  22940. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(System.String)">
  22941. <summary>
  22942. Remove the appender passed as parameter form the list of appenders.
  22943. </summary>
  22944. <param name="name">The name of the appender to remove</param>
  22945. <returns>The appender removed from the list</returns>
  22946. <remarks>
  22947. <para>
  22948. Remove the named appender passed as parameter form the list of appenders.
  22949. The appender removed is not closed.
  22950. If you are discarding the appender you must call
  22951. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  22952. </para>
  22953. </remarks>
  22954. </member>
  22955. <member name="P:log4net.Repository.Hierarchy.Logger.Name">
  22956. <summary>
  22957. Gets the logger name.
  22958. </summary>
  22959. <value>
  22960. The name of the logger.
  22961. </value>
  22962. <remarks>
  22963. <para>
  22964. The name of this logger
  22965. </para>
  22966. </remarks>
  22967. </member>
  22968. <member name="M:log4net.Repository.Hierarchy.Logger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  22969. <summary>
  22970. This generic form is intended to be used by wrappers.
  22971. </summary>
  22972. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  22973. the stack boundary into the logging system for this call.</param>
  22974. <param name="level">The level of the message to be logged.</param>
  22975. <param name="message">The message object to log.</param>
  22976. <param name="exception">The exception to log, including its stack trace.</param>
  22977. <remarks>
  22978. <para>
  22979. Generate a logging event for the specified <paramref name="level"/> using
  22980. the <paramref name="message"/> and <paramref name="exception"/>.
  22981. </para>
  22982. <para>
  22983. This method must not throw any exception to the caller.
  22984. </para>
  22985. </remarks>
  22986. </member>
  22987. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)">
  22988. <summary>
  22989. This is the most generic printing method that is intended to be used
  22990. by wrappers.
  22991. </summary>
  22992. <param name="logEvent">The event being logged.</param>
  22993. <remarks>
  22994. <para>
  22995. Logs the specified logging event through this logger.
  22996. </para>
  22997. <para>
  22998. This method must not throw any exception to the caller.
  22999. </para>
  23000. </remarks>
  23001. </member>
  23002. <member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)">
  23003. <summary>
  23004. Checks if this logger is enabled for a given <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> passed as parameter.
  23005. </summary>
  23006. <param name="level">The level to check.</param>
  23007. <returns>
  23008. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  23009. </returns>
  23010. <remarks>
  23011. <para>
  23012. Test if this logger is going to log events of the specified <paramref name="level"/>.
  23013. </para>
  23014. <para>
  23015. This method must not throw any exception to the caller.
  23016. </para>
  23017. </remarks>
  23018. </member>
  23019. <member name="P:log4net.Repository.Hierarchy.Logger.Repository">
  23020. <summary>
  23021. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  23022. <c>Logger</c> instance is attached to.
  23023. </summary>
  23024. <value>
  23025. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this logger belongs to.
  23026. </value>
  23027. <remarks>
  23028. <para>
  23029. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  23030. <c>Logger</c> instance is attached to.
  23031. </para>
  23032. </remarks>
  23033. </member>
  23034. <member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)">
  23035. <summary>
  23036. Deliver the <see cref="T:log4net.Core.LoggingEvent"/> to the attached appenders.
  23037. </summary>
  23038. <param name="loggingEvent">The event to log.</param>
  23039. <remarks>
  23040. <para>
  23041. Call the appenders in the hierarchy starting at
  23042. <c>this</c>. If no appenders could be found, emit a
  23043. warning.
  23044. </para>
  23045. <para>
  23046. This method calls all the appenders inherited from the
  23047. hierarchy circumventing any evaluation of whether to log or not
  23048. to log the particular log request.
  23049. </para>
  23050. </remarks>
  23051. </member>
  23052. <member name="M:log4net.Repository.Hierarchy.Logger.CloseNestedAppenders">
  23053. <summary>
  23054. Closes all attached appenders implementing the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  23055. </summary>
  23056. <remarks>
  23057. <para>
  23058. Used to ensure that the appenders are correctly shutdown.
  23059. </para>
  23060. </remarks>
  23061. </member>
  23062. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.Level,System.Object,System.Exception)">
  23063. <summary>
  23064. This is the most generic printing method. This generic form is intended to be used by wrappers
  23065. </summary>
  23066. <param name="level">The level of the message to be logged.</param>
  23067. <param name="message">The message object to log.</param>
  23068. <param name="exception">The exception to log, including its stack trace.</param>
  23069. <remarks>
  23070. <para>
  23071. Generate a logging event for the specified <paramref name="level"/> using
  23072. the <paramref name="message"/>.
  23073. </para>
  23074. </remarks>
  23075. </member>
  23076. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  23077. <summary>
  23078. Creates a new logging event and logs the event without further checks.
  23079. </summary>
  23080. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  23081. the stack boundary into the logging system for this call.</param>
  23082. <param name="level">The level of the message to be logged.</param>
  23083. <param name="message">The message object to log.</param>
  23084. <param name="exception">The exception to log, including its stack trace.</param>
  23085. <remarks>
  23086. <para>
  23087. Generates a logging event and delivers it to the attached
  23088. appenders.
  23089. </para>
  23090. </remarks>
  23091. </member>
  23092. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(log4net.Core.LoggingEvent)">
  23093. <summary>
  23094. Creates a new logging event and logs the event without further checks.
  23095. </summary>
  23096. <param name="logEvent">The event being logged.</param>
  23097. <remarks>
  23098. <para>
  23099. Delivers the logging event to the attached appenders.
  23100. </para>
  23101. </remarks>
  23102. </member>
  23103. <member name="F:log4net.Repository.Hierarchy.Logger.declaringType">
  23104. <summary>
  23105. The fully qualified type of the Logger class.
  23106. </summary>
  23107. </member>
  23108. <member name="F:log4net.Repository.Hierarchy.Logger.m_name">
  23109. <summary>
  23110. The name of this logger.
  23111. </summary>
  23112. </member>
  23113. <member name="F:log4net.Repository.Hierarchy.Logger.m_level">
  23114. <summary>
  23115. The assigned level of this logger.
  23116. </summary>
  23117. <remarks>
  23118. <para>
  23119. The <c>level</c> variable need not be
  23120. assigned a value in which case it is inherited
  23121. form the hierarchy.
  23122. </para>
  23123. </remarks>
  23124. </member>
  23125. <member name="F:log4net.Repository.Hierarchy.Logger.m_parent">
  23126. <summary>
  23127. The parent of this logger.
  23128. </summary>
  23129. <remarks>
  23130. <para>
  23131. The parent of this logger.
  23132. All loggers have at least one ancestor which is the root logger.
  23133. </para>
  23134. </remarks>
  23135. </member>
  23136. <member name="F:log4net.Repository.Hierarchy.Logger.m_hierarchy">
  23137. <summary>
  23138. Loggers need to know what Hierarchy they are in.
  23139. </summary>
  23140. <remarks>
  23141. <para>
  23142. Loggers need to know what Hierarchy they are in.
  23143. The hierarchy that this logger is a member of is stored
  23144. here.
  23145. </para>
  23146. </remarks>
  23147. </member>
  23148. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderAttachedImpl">
  23149. <summary>
  23150. Helper implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  23151. </summary>
  23152. </member>
  23153. <member name="F:log4net.Repository.Hierarchy.Logger.m_additive">
  23154. <summary>
  23155. Flag indicating if child loggers inherit their parents appenders
  23156. </summary>
  23157. <remarks>
  23158. <para>
  23159. Additivity is set to true by default, that is children inherit
  23160. the appenders of their ancestors by default. If this variable is
  23161. set to <c>false</c> then the appenders found in the
  23162. ancestors of this logger are not used. However, the children
  23163. of this logger will inherit its appenders, unless the children
  23164. have their additivity flag set to <c>false</c> too. See
  23165. the user manual for more details.
  23166. </para>
  23167. </remarks>
  23168. </member>
  23169. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderLock">
  23170. <summary>
  23171. Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl
  23172. </summary>
  23173. </member>
  23174. <member name="T:log4net.Repository.Hierarchy.LoggerKey">
  23175. <summary>
  23176. Used internally to accelerate hash table searches.
  23177. </summary>
  23178. <remarks>
  23179. <para>
  23180. Internal class used to improve performance of
  23181. string keyed hashtables.
  23182. </para>
  23183. <para>
  23184. The hashcode of the string is cached for reuse.
  23185. The string is stored as an interned value.
  23186. When comparing two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> objects for equality
  23187. the reference equality of the interned strings is compared.
  23188. </para>
  23189. </remarks>
  23190. <author>Nicko Cadell</author>
  23191. <author>Gert Driesen</author>
  23192. </member>
  23193. <member name="M:log4net.Repository.Hierarchy.LoggerKey.#ctor(System.String)">
  23194. <summary>
  23195. Construct key with string name
  23196. </summary>
  23197. <remarks>
  23198. <para>
  23199. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerKey" /> class
  23200. with the specified name.
  23201. </para>
  23202. <para>
  23203. Stores the hashcode of the string and interns
  23204. the string key to optimize comparisons.
  23205. </para>
  23206. <note>
  23207. The Compact Framework 1.0 the <see cref="M:System.String.Intern(System.String)"/>
  23208. method does not work. On the Compact Framework
  23209. the string keys are not interned nor are they
  23210. compared by reference.
  23211. </note>
  23212. </remarks>
  23213. <param name="name">The name of the logger.</param>
  23214. </member>
  23215. <member name="M:log4net.Repository.Hierarchy.LoggerKey.GetHashCode">
  23216. <summary>
  23217. Returns a hash code for the current instance.
  23218. </summary>
  23219. <returns>A hash code for the current instance.</returns>
  23220. <remarks>
  23221. <para>
  23222. Returns the cached hashcode.
  23223. </para>
  23224. </remarks>
  23225. </member>
  23226. <member name="M:log4net.Repository.Hierarchy.LoggerKey.Equals(System.Object)">
  23227. <summary>
  23228. Determines whether two <see cref="T:log4net.Repository.Hierarchy.LoggerKey" /> instances
  23229. are equal.
  23230. </summary>
  23231. <param name="obj">The <see cref="T:System.Object" /> to compare with the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey" />.</param>
  23232. <returns>
  23233. <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>.
  23234. </returns>
  23235. <remarks>
  23236. <para>
  23237. Compares the references of the interned strings.
  23238. </para>
  23239. </remarks>
  23240. </member>
  23241. <member name="T:log4net.Repository.Hierarchy.ProvisionNode">
  23242. <summary>
  23243. Provision nodes are used where no logger instance has been specified
  23244. </summary>
  23245. <remarks>
  23246. <para>
  23247. <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> instances are used in the
  23248. <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> when there is no specified
  23249. <see cref="T:log4net.Repository.Hierarchy.Logger" /> for that node.
  23250. </para>
  23251. <para>
  23252. A provision node holds a list of child loggers on behalf of
  23253. a logger that does not exist.
  23254. </para>
  23255. </remarks>
  23256. <author>Nicko Cadell</author>
  23257. <author>Gert Driesen</author>
  23258. </member>
  23259. <member name="M:log4net.Repository.Hierarchy.ProvisionNode.#ctor(log4net.Repository.Hierarchy.Logger)">
  23260. <summary>
  23261. Create a new provision node with child node
  23262. </summary>
  23263. <param name="log">A child logger to add to this node.</param>
  23264. <remarks>
  23265. <para>
  23266. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.ProvisionNode" /> class
  23267. with the specified child logger.
  23268. </para>
  23269. </remarks>
  23270. </member>
  23271. <member name="T:log4net.Repository.Hierarchy.RootLogger">
  23272. <summary>
  23273. The <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> sits at the root of the logger hierarchy tree.
  23274. </summary>
  23275. <remarks>
  23276. <para>
  23277. The <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> is a regular <see cref="T:log4net.Repository.Hierarchy.Logger" /> except
  23278. that it provides several guarantees.
  23279. </para>
  23280. <para>
  23281. First, it cannot be assigned a <c>null</c>
  23282. level. Second, since the root logger cannot have a parent, the
  23283. <see cref="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"/> property always returns the value of the
  23284. level field without walking the hierarchy.
  23285. </para>
  23286. </remarks>
  23287. <author>Nicko Cadell</author>
  23288. <author>Gert Driesen</author>
  23289. </member>
  23290. <member name="M:log4net.Repository.Hierarchy.RootLogger.#ctor(log4net.Core.Level)">
  23291. <summary>
  23292. Construct a <see cref="T:log4net.Repository.Hierarchy.RootLogger"/>
  23293. </summary>
  23294. <param name="level">The level to assign to the root logger.</param>
  23295. <remarks>
  23296. <para>
  23297. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> class with
  23298. the specified logging level.
  23299. </para>
  23300. <para>
  23301. The root logger names itself as "root". However, the root
  23302. logger cannot be retrieved by name.
  23303. </para>
  23304. </remarks>
  23305. </member>
  23306. <member name="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel">
  23307. <summary>
  23308. Gets the assigned level value without walking the logger hierarchy.
  23309. </summary>
  23310. <value>The assigned level value without walking the logger hierarchy.</value>
  23311. <remarks>
  23312. <para>
  23313. Because the root logger cannot have a parent and its level
  23314. must not be <c>null</c> this property just returns the
  23315. value of <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>.
  23316. </para>
  23317. </remarks>
  23318. </member>
  23319. <member name="P:log4net.Repository.Hierarchy.RootLogger.Level">
  23320. <summary>
  23321. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> for the root logger.
  23322. </summary>
  23323. <value>
  23324. The <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> of the root logger.
  23325. </value>
  23326. <remarks>
  23327. <para>
  23328. Setting the level of the root logger to a <c>null</c> reference
  23329. may have catastrophic results. We prevent this here.
  23330. </para>
  23331. </remarks>
  23332. </member>
  23333. <member name="F:log4net.Repository.Hierarchy.RootLogger.declaringType">
  23334. <summary>
  23335. The fully qualified type of the RootLogger class.
  23336. </summary>
  23337. <remarks>
  23338. Used by the internal logger to record the Type of the
  23339. log message.
  23340. </remarks>
  23341. </member>
  23342. <member name="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator">
  23343. <summary>
  23344. Initializes the log4net environment using an XML DOM.
  23345. </summary>
  23346. <remarks>
  23347. <para>
  23348. Configures a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> using an XML DOM.
  23349. </para>
  23350. </remarks>
  23351. <author>Nicko Cadell</author>
  23352. <author>Gert Driesen</author>
  23353. </member>
  23354. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.#ctor(log4net.Repository.Hierarchy.Hierarchy)">
  23355. <summary>
  23356. Construct the configurator for a hierarchy
  23357. </summary>
  23358. <param name="hierarchy">The hierarchy to build.</param>
  23359. <remarks>
  23360. <para>
  23361. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator" /> class
  23362. with the specified <see cref="T:log4net.Repository.Hierarchy.Hierarchy" />.
  23363. </para>
  23364. </remarks>
  23365. </member>
  23366. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.Configure(System.Xml.XmlElement)">
  23367. <summary>
  23368. Configure the hierarchy by parsing a DOM tree of XML elements.
  23369. </summary>
  23370. <param name="element">The root element to parse.</param>
  23371. <remarks>
  23372. <para>
  23373. Configure the hierarchy by parsing a DOM tree of XML elements.
  23374. </para>
  23375. </remarks>
  23376. </member>
  23377. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindAppenderByReference(System.Xml.XmlElement)">
  23378. <summary>
  23379. Parse appenders by IDREF.
  23380. </summary>
  23381. <param name="appenderRef">The appender ref element.</param>
  23382. <returns>The instance of the appender that the ref refers to.</returns>
  23383. <remarks>
  23384. <para>
  23385. Parse an XML element that represents an appender and return
  23386. the appender.
  23387. </para>
  23388. </remarks>
  23389. </member>
  23390. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseAppender(System.Xml.XmlElement)">
  23391. <summary>
  23392. Parses an appender element.
  23393. </summary>
  23394. <param name="appenderElement">The appender element.</param>
  23395. <returns>The appender instance or <c>null</c> when parsing failed.</returns>
  23396. <remarks>
  23397. <para>
  23398. Parse an XML element that represents an appender and return
  23399. the appender instance.
  23400. </para>
  23401. </remarks>
  23402. </member>
  23403. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLogger(System.Xml.XmlElement)">
  23404. <summary>
  23405. Parses a logger element.
  23406. </summary>
  23407. <param name="loggerElement">The logger element.</param>
  23408. <remarks>
  23409. <para>
  23410. Parse an XML element that represents a logger.
  23411. </para>
  23412. </remarks>
  23413. </member>
  23414. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRoot(System.Xml.XmlElement)">
  23415. <summary>
  23416. Parses the root logger element.
  23417. </summary>
  23418. <param name="rootElement">The root element.</param>
  23419. <remarks>
  23420. <para>
  23421. Parse an XML element that represents the root logger.
  23422. </para>
  23423. </remarks>
  23424. </member>
  23425. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseChildrenOfLoggerElement(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  23426. <summary>
  23427. Parses the children of a logger element.
  23428. </summary>
  23429. <param name="catElement">The category element.</param>
  23430. <param name="log">The logger instance.</param>
  23431. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  23432. <remarks>
  23433. <para>
  23434. Parse the child elements of a &lt;logger&gt; element.
  23435. </para>
  23436. </remarks>
  23437. </member>
  23438. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRenderer(System.Xml.XmlElement)">
  23439. <summary>
  23440. Parses an object renderer.
  23441. </summary>
  23442. <param name="element">The renderer element.</param>
  23443. <remarks>
  23444. <para>
  23445. Parse an XML element that represents a renderer.
  23446. </para>
  23447. </remarks>
  23448. </member>
  23449. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLevel(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  23450. <summary>
  23451. Parses a level element.
  23452. </summary>
  23453. <param name="element">The level element.</param>
  23454. <param name="log">The logger object to set the level on.</param>
  23455. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  23456. <remarks>
  23457. <para>
  23458. Parse an XML element that represents a level.
  23459. </para>
  23460. </remarks>
  23461. </member>
  23462. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.SetParameter(System.Xml.XmlElement,System.Object)">
  23463. <summary>
  23464. Sets a parameter on an object.
  23465. </summary>
  23466. <param name="element">The parameter element.</param>
  23467. <param name="target">The object to set the parameter on.</param>
  23468. <remarks>
  23469. The parameter name must correspond to a writable property
  23470. on the object. The value of the parameter is a string,
  23471. therefore this function will attempt to set a string
  23472. property first. If unable to set a string property it
  23473. will inspect the property and its argument type. It will
  23474. attempt to call a static method called <c>Parse</c> on the
  23475. type of the property. This method will take a single
  23476. string argument and return a value that can be used to
  23477. set the property.
  23478. </remarks>
  23479. </member>
  23480. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)">
  23481. <summary>
  23482. Test if an element has no attributes or child elements
  23483. </summary>
  23484. <param name="element">the element to inspect</param>
  23485. <returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns>
  23486. </member>
  23487. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)">
  23488. <summary>
  23489. Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>.
  23490. </summary>
  23491. <param name="type">the type to inspect</param>
  23492. <returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns>
  23493. </member>
  23494. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)">
  23495. <summary>
  23496. Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied
  23497. </summary>
  23498. <param name="targetType">the type that has the method</param>
  23499. <param name="name">the name of the method</param>
  23500. <returns>the method info found</returns>
  23501. <remarks>
  23502. <para>
  23503. The method must be a public instance method on the <paramref name="targetType"/>.
  23504. The method must be named <paramref name="name"/> or "Add" followed by <paramref name="name"/>.
  23505. The method must take a single parameter.
  23506. </para>
  23507. </remarks>
  23508. </member>
  23509. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ConvertStringTo(System.Type,System.String)">
  23510. <summary>
  23511. Converts a string value to a target type.
  23512. </summary>
  23513. <param name="type">The type of object to convert the string to.</param>
  23514. <param name="value">The string value to use as the value of the object.</param>
  23515. <returns>
  23516. <para>
  23517. An object of type <paramref name="type"/> with value <paramref name="value"/> or
  23518. <c>null</c> when the conversion could not be performed.
  23519. </para>
  23520. </returns>
  23521. </member>
  23522. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.CreateObjectFromXml(System.Xml.XmlElement,System.Type,System.Type)">
  23523. <summary>
  23524. Creates an object as specified in XML.
  23525. </summary>
  23526. <param name="element">The XML element that contains the definition of the object.</param>
  23527. <param name="defaultTargetType">The object type to use if not explicitly specified.</param>
  23528. <param name="typeConstraint">The type that the returned object must be or must inherit from.</param>
  23529. <returns>The object or <c>null</c></returns>
  23530. <remarks>
  23531. <para>
  23532. Parse an XML element and create an object instance based on the configuration
  23533. data.
  23534. </para>
  23535. <para>
  23536. The type of the instance may be specified in the XML. If not
  23537. specified then the <paramref name="defaultTargetType"/> is used
  23538. as the type. However the type is specified it must support the
  23539. <paramref name="typeConstraint"/> type.
  23540. </para>
  23541. </remarks>
  23542. </member>
  23543. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_appenderBag">
  23544. <summary>
  23545. key: appenderName, value: appender.
  23546. </summary>
  23547. </member>
  23548. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_hierarchy">
  23549. <summary>
  23550. The Hierarchy being configured.
  23551. </summary>
  23552. </member>
  23553. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.declaringType">
  23554. <summary>
  23555. The fully qualified type of the XmlHierarchyConfigurator class.
  23556. </summary>
  23557. <remarks>
  23558. Used by the internal logger to record the Type of the
  23559. log message.
  23560. </remarks>
  23561. </member>
  23562. <member name="T:log4net.Repository.IBasicRepositoryConfigurator">
  23563. <summary>
  23564. Basic Configurator interface for repositories
  23565. </summary>
  23566. <remarks>
  23567. <para>
  23568. Interface used by basic configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>
  23569. with a default <see cref="T:log4net.Appender.IAppender"/>.
  23570. </para>
  23571. <para>
  23572. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  23573. configuration by the <see cref="T:log4net.Config.BasicConfigurator"/>.
  23574. </para>
  23575. </remarks>
  23576. <author>Nicko Cadell</author>
  23577. <author>Gert Driesen</author>
  23578. </member>
  23579. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender)">
  23580. <summary>
  23581. Initialize the repository using the specified appender
  23582. </summary>
  23583. <param name="appender">the appender to use to log all logging events</param>
  23584. <remarks>
  23585. <para>
  23586. Configure the repository to route all logging events to the
  23587. specified appender.
  23588. </para>
  23589. </remarks>
  23590. </member>
  23591. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender[])">
  23592. <summary>
  23593. Initialize the repository using the specified appenders
  23594. </summary>
  23595. <param name="appenders">the appenders to use to log all logging events</param>
  23596. <remarks>
  23597. <para>
  23598. Configure the repository to route all logging events to the
  23599. specified appenders.
  23600. </para>
  23601. </remarks>
  23602. </member>
  23603. <member name="T:log4net.Repository.LoggerRepositoryShutdownEventHandler">
  23604. <summary>
  23605. Delegate used to handle logger repository shutdown event notifications
  23606. </summary>
  23607. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down.</param>
  23608. <param name="e">Empty event args</param>
  23609. <remarks>
  23610. <para>
  23611. Delegate used to handle logger repository shutdown event notifications.
  23612. </para>
  23613. </remarks>
  23614. </member>
  23615. <member name="T:log4net.Repository.LoggerRepositoryConfigurationResetEventHandler">
  23616. <summary>
  23617. Delegate used to handle logger repository configuration reset event notifications
  23618. </summary>
  23619. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration reset.</param>
  23620. <param name="e">Empty event args</param>
  23621. <remarks>
  23622. <para>
  23623. Delegate used to handle logger repository configuration reset event notifications.
  23624. </para>
  23625. </remarks>
  23626. </member>
  23627. <member name="T:log4net.Repository.LoggerRepositoryConfigurationChangedEventHandler">
  23628. <summary>
  23629. Delegate used to handle event notifications for logger repository configuration changes.
  23630. </summary>
  23631. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration changed.</param>
  23632. <param name="e">Empty event arguments.</param>
  23633. <remarks>
  23634. <para>
  23635. Delegate used to handle event notifications for logger repository configuration changes.
  23636. </para>
  23637. </remarks>
  23638. </member>
  23639. <member name="T:log4net.Repository.ILoggerRepository">
  23640. <summary>
  23641. Interface implemented by logger repositories.
  23642. </summary>
  23643. <remarks>
  23644. <para>
  23645. This interface is implemented by logger repositories. e.g.
  23646. <see cref="N:log4net.Repository.Hierarchy"/>.
  23647. </para>
  23648. <para>
  23649. This interface is used by the <see cref="T:log4net.LogManager"/>
  23650. to obtain <see cref="T:log4net.ILog"/> interfaces.
  23651. </para>
  23652. </remarks>
  23653. <author>Nicko Cadell</author>
  23654. <author>Gert Driesen</author>
  23655. </member>
  23656. <member name="P:log4net.Repository.ILoggerRepository.Name">
  23657. <summary>
  23658. The name of the repository
  23659. </summary>
  23660. <value>
  23661. The name of the repository
  23662. </value>
  23663. <remarks>
  23664. <para>
  23665. The name of the repository.
  23666. </para>
  23667. </remarks>
  23668. </member>
  23669. <member name="P:log4net.Repository.ILoggerRepository.RendererMap">
  23670. <summary>
  23671. RendererMap accesses the object renderer map for this repository.
  23672. </summary>
  23673. <value>
  23674. RendererMap accesses the object renderer map for this repository.
  23675. </value>
  23676. <remarks>
  23677. <para>
  23678. RendererMap accesses the object renderer map for this repository.
  23679. </para>
  23680. <para>
  23681. The RendererMap holds a mapping between types and
  23682. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  23683. </para>
  23684. </remarks>
  23685. </member>
  23686. <member name="P:log4net.Repository.ILoggerRepository.PluginMap">
  23687. <summary>
  23688. The plugin map for this repository.
  23689. </summary>
  23690. <value>
  23691. The plugin map for this repository.
  23692. </value>
  23693. <remarks>
  23694. <para>
  23695. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  23696. that have been attached to this repository.
  23697. </para>
  23698. </remarks>
  23699. </member>
  23700. <member name="P:log4net.Repository.ILoggerRepository.LevelMap">
  23701. <summary>
  23702. Get the level map for the Repository.
  23703. </summary>
  23704. <remarks>
  23705. <para>
  23706. Get the level map for the Repository.
  23707. </para>
  23708. <para>
  23709. The level map defines the mappings between
  23710. level names and <see cref="T:log4net.Core.Level"/> objects in
  23711. this repository.
  23712. </para>
  23713. </remarks>
  23714. </member>
  23715. <member name="P:log4net.Repository.ILoggerRepository.Threshold">
  23716. <summary>
  23717. The threshold for all events in this repository
  23718. </summary>
  23719. <value>
  23720. The threshold for all events in this repository
  23721. </value>
  23722. <remarks>
  23723. <para>
  23724. The threshold for all events in this repository.
  23725. </para>
  23726. </remarks>
  23727. </member>
  23728. <member name="M:log4net.Repository.ILoggerRepository.Exists(System.String)">
  23729. <summary>
  23730. Check if the named logger exists in the repository. If so return
  23731. its reference, otherwise returns <c>null</c>.
  23732. </summary>
  23733. <param name="name">The name of the logger to lookup</param>
  23734. <returns>The Logger object with the name specified</returns>
  23735. <remarks>
  23736. <para>
  23737. If the names logger exists it is returned, otherwise
  23738. <c>null</c> is returned.
  23739. </para>
  23740. </remarks>
  23741. </member>
  23742. <member name="M:log4net.Repository.ILoggerRepository.GetCurrentLoggers">
  23743. <summary>
  23744. Returns all the currently defined loggers as an Array.
  23745. </summary>
  23746. <returns>All the defined loggers</returns>
  23747. <remarks>
  23748. <para>
  23749. Returns all the currently defined loggers as an Array.
  23750. </para>
  23751. </remarks>
  23752. </member>
  23753. <member name="M:log4net.Repository.ILoggerRepository.GetLogger(System.String)">
  23754. <summary>
  23755. Returns a named logger instance
  23756. </summary>
  23757. <param name="name">The name of the logger to retrieve</param>
  23758. <returns>The logger object with the name specified</returns>
  23759. <remarks>
  23760. <para>
  23761. Returns a named logger instance.
  23762. </para>
  23763. <para>
  23764. If a logger of that name already exists, then it will be
  23765. returned. Otherwise, a new logger will be instantiated and
  23766. then linked with its existing ancestors as well as children.
  23767. </para>
  23768. </remarks>
  23769. </member>
  23770. <member name="M:log4net.Repository.ILoggerRepository.Shutdown">
  23771. <summary>Shutdown the repository</summary>
  23772. <remarks>
  23773. <para>
  23774. Shutting down a repository will <i>safely</i> close and remove
  23775. all appenders in all loggers including the root logger.
  23776. </para>
  23777. <para>
  23778. Some appenders need to be closed before the
  23779. application exists. Otherwise, pending logging events might be
  23780. lost.
  23781. </para>
  23782. <para>
  23783. The <see cref="M:Shutdown()"/> method is careful to close nested
  23784. appenders before closing regular appenders. This is allows
  23785. configurations where a regular appender is attached to a logger
  23786. and again to a nested appender.
  23787. </para>
  23788. </remarks>
  23789. </member>
  23790. <member name="M:log4net.Repository.ILoggerRepository.ResetConfiguration">
  23791. <summary>
  23792. Reset the repositories configuration to a default state
  23793. </summary>
  23794. <remarks>
  23795. <para>
  23796. Reset all values contained in this instance to their
  23797. default state.
  23798. </para>
  23799. <para>
  23800. Existing loggers are not removed. They are just reset.
  23801. </para>
  23802. <para>
  23803. This method should be used sparingly and with care as it will
  23804. block all logging until it is completed.
  23805. </para>
  23806. </remarks>
  23807. </member>
  23808. <member name="M:log4net.Repository.ILoggerRepository.Log(log4net.Core.LoggingEvent)">
  23809. <summary>
  23810. Log the <see cref="T:log4net.Core.LoggingEvent"/> through this repository.
  23811. </summary>
  23812. <param name="logEvent">the event to log</param>
  23813. <remarks>
  23814. <para>
  23815. This method should not normally be used to log.
  23816. The <see cref="T:log4net.ILog"/> interface should be used
  23817. for routine logging. This interface can be obtained
  23818. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  23819. </para>
  23820. <para>
  23821. The <c>logEvent</c> is delivered to the appropriate logger and
  23822. that logger is then responsible for logging the event.
  23823. </para>
  23824. </remarks>
  23825. </member>
  23826. <member name="P:log4net.Repository.ILoggerRepository.Configured">
  23827. <summary>
  23828. Flag indicates if this repository has been configured.
  23829. </summary>
  23830. <value>
  23831. Flag indicates if this repository has been configured.
  23832. </value>
  23833. <remarks>
  23834. <para>
  23835. Flag indicates if this repository has been configured.
  23836. </para>
  23837. </remarks>
  23838. </member>
  23839. <member name="P:log4net.Repository.ILoggerRepository.ConfigurationMessages">
  23840. <summary>
  23841. Collection of internal messages captured during the most
  23842. recent configuration process.
  23843. </summary>
  23844. </member>
  23845. <member name="E:log4net.Repository.ILoggerRepository.ShutdownEvent">
  23846. <summary>
  23847. Event to notify that the repository has been shutdown.
  23848. </summary>
  23849. <value>
  23850. Event to notify that the repository has been shutdown.
  23851. </value>
  23852. <remarks>
  23853. <para>
  23854. Event raised when the repository has been shutdown.
  23855. </para>
  23856. </remarks>
  23857. </member>
  23858. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationReset">
  23859. <summary>
  23860. Event to notify that the repository has had its configuration reset.
  23861. </summary>
  23862. <value>
  23863. Event to notify that the repository has had its configuration reset.
  23864. </value>
  23865. <remarks>
  23866. <para>
  23867. Event raised when the repository's configuration has been
  23868. reset to default.
  23869. </para>
  23870. </remarks>
  23871. </member>
  23872. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationChanged">
  23873. <summary>
  23874. Event to notify that the repository has had its configuration changed.
  23875. </summary>
  23876. <value>
  23877. Event to notify that the repository has had its configuration changed.
  23878. </value>
  23879. <remarks>
  23880. <para>
  23881. Event raised when the repository's configuration has been changed.
  23882. </para>
  23883. </remarks>
  23884. </member>
  23885. <member name="P:log4net.Repository.ILoggerRepository.Properties">
  23886. <summary>
  23887. Repository specific properties
  23888. </summary>
  23889. <value>
  23890. Repository specific properties
  23891. </value>
  23892. <remarks>
  23893. <para>
  23894. These properties can be specified on a repository specific basis.
  23895. </para>
  23896. </remarks>
  23897. </member>
  23898. <member name="M:log4net.Repository.ILoggerRepository.GetAppenders">
  23899. <summary>
  23900. Returns all the Appenders that are configured as an Array.
  23901. </summary>
  23902. <returns>All the Appenders</returns>
  23903. <remarks>
  23904. <para>
  23905. Returns all the Appenders that are configured as an Array.
  23906. </para>
  23907. </remarks>
  23908. </member>
  23909. <member name="T:log4net.Repository.IXmlRepositoryConfigurator">
  23910. <summary>
  23911. Configure repository using XML
  23912. </summary>
  23913. <remarks>
  23914. <para>
  23915. Interface used by Xml configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  23916. </para>
  23917. <para>
  23918. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  23919. configuration by the <see cref="T:log4net.Config.XmlConfigurator"/>.
  23920. </para>
  23921. </remarks>
  23922. <author>Nicko Cadell</author>
  23923. <author>Gert Driesen</author>
  23924. </member>
  23925. <member name="M:log4net.Repository.IXmlRepositoryConfigurator.Configure(System.Xml.XmlElement)">
  23926. <summary>
  23927. Initialize the repository using the specified config
  23928. </summary>
  23929. <param name="element">the element containing the root of the config</param>
  23930. <remarks>
  23931. <para>
  23932. The schema for the XML configuration data is defined by
  23933. the implementation.
  23934. </para>
  23935. </remarks>
  23936. </member>
  23937. <member name="T:log4net.Repository.LoggerRepositorySkeleton">
  23938. <summary>
  23939. Base implementation of <see cref="T:log4net.Repository.ILoggerRepository"/>
  23940. </summary>
  23941. <remarks>
  23942. <para>
  23943. Default abstract implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  23944. </para>
  23945. <para>
  23946. Skeleton implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  23947. All <see cref="T:log4net.Repository.ILoggerRepository"/> types can extend this type.
  23948. </para>
  23949. </remarks>
  23950. <author>Nicko Cadell</author>
  23951. <author>Gert Driesen</author>
  23952. </member>
  23953. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor">
  23954. <summary>
  23955. Default Constructor
  23956. </summary>
  23957. <remarks>
  23958. <para>
  23959. Initializes the repository with default (empty) properties.
  23960. </para>
  23961. </remarks>
  23962. </member>
  23963. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor(log4net.Util.PropertiesDictionary)">
  23964. <summary>
  23965. Construct the repository using specific properties
  23966. </summary>
  23967. <param name="properties">the properties to set for this repository</param>
  23968. <remarks>
  23969. <para>
  23970. Initializes the repository with specified properties.
  23971. </para>
  23972. </remarks>
  23973. </member>
  23974. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Name">
  23975. <summary>
  23976. The name of the repository
  23977. </summary>
  23978. <value>
  23979. The string name of the repository
  23980. </value>
  23981. <remarks>
  23982. <para>
  23983. The name of this repository. The name is
  23984. used to store and lookup the repositories
  23985. stored by the <see cref="T:log4net.Core.IRepositorySelector"/>.
  23986. </para>
  23987. </remarks>
  23988. </member>
  23989. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Threshold">
  23990. <summary>
  23991. The threshold for all events in this repository
  23992. </summary>
  23993. <value>
  23994. The threshold for all events in this repository
  23995. </value>
  23996. <remarks>
  23997. <para>
  23998. The threshold for all events in this repository
  23999. </para>
  24000. </remarks>
  24001. </member>
  24002. <member name="P:log4net.Repository.LoggerRepositorySkeleton.RendererMap">
  24003. <summary>
  24004. RendererMap accesses the object renderer map for this repository.
  24005. </summary>
  24006. <value>
  24007. RendererMap accesses the object renderer map for this repository.
  24008. </value>
  24009. <remarks>
  24010. <para>
  24011. RendererMap accesses the object renderer map for this repository.
  24012. </para>
  24013. <para>
  24014. The RendererMap holds a mapping between types and
  24015. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  24016. </para>
  24017. </remarks>
  24018. </member>
  24019. <member name="P:log4net.Repository.LoggerRepositorySkeleton.PluginMap">
  24020. <summary>
  24021. The plugin map for this repository.
  24022. </summary>
  24023. <value>
  24024. The plugin map for this repository.
  24025. </value>
  24026. <remarks>
  24027. <para>
  24028. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  24029. that have been attached to this repository.
  24030. </para>
  24031. </remarks>
  24032. </member>
  24033. <member name="P:log4net.Repository.LoggerRepositorySkeleton.LevelMap">
  24034. <summary>
  24035. Get the level map for the Repository.
  24036. </summary>
  24037. <remarks>
  24038. <para>
  24039. Get the level map for the Repository.
  24040. </para>
  24041. <para>
  24042. The level map defines the mappings between
  24043. level names and <see cref="T:log4net.Core.Level"/> objects in
  24044. this repository.
  24045. </para>
  24046. </remarks>
  24047. </member>
  24048. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Exists(System.String)">
  24049. <summary>
  24050. Test if logger exists
  24051. </summary>
  24052. <param name="name">The name of the logger to lookup</param>
  24053. <returns>The Logger object with the name specified</returns>
  24054. <remarks>
  24055. <para>
  24056. Check if the named logger exists in the repository. If so return
  24057. its reference, otherwise returns <c>null</c>.
  24058. </para>
  24059. </remarks>
  24060. </member>
  24061. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetCurrentLoggers">
  24062. <summary>
  24063. Returns all the currently defined loggers in the repository
  24064. </summary>
  24065. <returns>All the defined loggers</returns>
  24066. <remarks>
  24067. <para>
  24068. Returns all the currently defined loggers in the repository as an Array.
  24069. </para>
  24070. </remarks>
  24071. </member>
  24072. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetLogger(System.String)">
  24073. <summary>
  24074. Return a new logger instance
  24075. </summary>
  24076. <param name="name">The name of the logger to retrieve</param>
  24077. <returns>The logger object with the name specified</returns>
  24078. <remarks>
  24079. <para>
  24080. Return a new logger instance.
  24081. </para>
  24082. <para>
  24083. If a logger of that name already exists, then it will be
  24084. returned. Otherwise, a new logger will be instantiated and
  24085. then linked with its existing ancestors as well as children.
  24086. </para>
  24087. </remarks>
  24088. </member>
  24089. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Shutdown">
  24090. <summary>
  24091. Shutdown the repository
  24092. </summary>
  24093. <remarks>
  24094. <para>
  24095. Shutdown the repository. Can be overridden in a subclass.
  24096. This base class implementation notifies the <see cref="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"/>
  24097. listeners and all attached plugins of the shutdown event.
  24098. </para>
  24099. </remarks>
  24100. </member>
  24101. <member name="M:log4net.Repository.LoggerRepositorySkeleton.ResetConfiguration">
  24102. <summary>
  24103. Reset the repositories configuration to a default state
  24104. </summary>
  24105. <remarks>
  24106. <para>
  24107. Reset all values contained in this instance to their
  24108. default state.
  24109. </para>
  24110. <para>
  24111. Existing loggers are not removed. They are just reset.
  24112. </para>
  24113. <para>
  24114. This method should be used sparingly and with care as it will
  24115. block all logging until it is completed.
  24116. </para>
  24117. </remarks>
  24118. </member>
  24119. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Log(log4net.Core.LoggingEvent)">
  24120. <summary>
  24121. Log the logEvent through this repository.
  24122. </summary>
  24123. <param name="logEvent">the event to log</param>
  24124. <remarks>
  24125. <para>
  24126. This method should not normally be used to log.
  24127. The <see cref="T:log4net.ILog"/> interface should be used
  24128. for routine logging. This interface can be obtained
  24129. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  24130. </para>
  24131. <para>
  24132. The <c>logEvent</c> is delivered to the appropriate logger and
  24133. that logger is then responsible for logging the event.
  24134. </para>
  24135. </remarks>
  24136. </member>
  24137. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Configured">
  24138. <summary>
  24139. Flag indicates if this repository has been configured.
  24140. </summary>
  24141. <value>
  24142. Flag indicates if this repository has been configured.
  24143. </value>
  24144. <remarks>
  24145. <para>
  24146. Flag indicates if this repository has been configured.
  24147. </para>
  24148. </remarks>
  24149. </member>
  24150. <member name="P:log4net.Repository.LoggerRepositorySkeleton.ConfigurationMessages">
  24151. <summary>
  24152. Contains a list of internal messages captures during the
  24153. last configuration.
  24154. </summary>
  24155. </member>
  24156. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent">
  24157. <summary>
  24158. Event to notify that the repository has been shutdown.
  24159. </summary>
  24160. <value>
  24161. Event to notify that the repository has been shutdown.
  24162. </value>
  24163. <remarks>
  24164. <para>
  24165. Event raised when the repository has been shutdown.
  24166. </para>
  24167. </remarks>
  24168. </member>
  24169. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationReset">
  24170. <summary>
  24171. Event to notify that the repository has had its configuration reset.
  24172. </summary>
  24173. <value>
  24174. Event to notify that the repository has had its configuration reset.
  24175. </value>
  24176. <remarks>
  24177. <para>
  24178. Event raised when the repository's configuration has been
  24179. reset to default.
  24180. </para>
  24181. </remarks>
  24182. </member>
  24183. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationChanged">
  24184. <summary>
  24185. Event to notify that the repository has had its configuration changed.
  24186. </summary>
  24187. <value>
  24188. Event to notify that the repository has had its configuration changed.
  24189. </value>
  24190. <remarks>
  24191. <para>
  24192. Event raised when the repository's configuration has been changed.
  24193. </para>
  24194. </remarks>
  24195. </member>
  24196. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Properties">
  24197. <summary>
  24198. Repository specific properties
  24199. </summary>
  24200. <value>
  24201. Repository specific properties
  24202. </value>
  24203. <remarks>
  24204. These properties can be specified on a repository specific basis
  24205. </remarks>
  24206. </member>
  24207. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetAppenders">
  24208. <summary>
  24209. Returns all the Appenders that are configured as an Array.
  24210. </summary>
  24211. <returns>All the Appenders</returns>
  24212. <remarks>
  24213. <para>
  24214. Returns all the Appenders that are configured as an Array.
  24215. </para>
  24216. </remarks>
  24217. </member>
  24218. <member name="F:log4net.Repository.LoggerRepositorySkeleton.declaringType">
  24219. <summary>
  24220. The fully qualified type of the LoggerRepositorySkeleton class.
  24221. </summary>
  24222. <remarks>
  24223. Used by the internal logger to record the Type of the
  24224. log message.
  24225. </remarks>
  24226. </member>
  24227. <member name="M:log4net.Repository.LoggerRepositorySkeleton.AddRenderer(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  24228. <summary>
  24229. Adds an object renderer for a specific class.
  24230. </summary>
  24231. <param name="typeToRender">The type that will be rendered by the renderer supplied.</param>
  24232. <param name="rendererInstance">The object renderer used to render the object.</param>
  24233. <remarks>
  24234. <para>
  24235. Adds an object renderer for a specific class.
  24236. </para>
  24237. </remarks>
  24238. </member>
  24239. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnShutdown(System.EventArgs)">
  24240. <summary>
  24241. Notify the registered listeners that the repository is shutting down
  24242. </summary>
  24243. <param name="e">Empty EventArgs</param>
  24244. <remarks>
  24245. <para>
  24246. Notify any listeners that this repository is shutting down.
  24247. </para>
  24248. </remarks>
  24249. </member>
  24250. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationReset(System.EventArgs)">
  24251. <summary>
  24252. Notify the registered listeners that the repository has had its configuration reset
  24253. </summary>
  24254. <param name="e">Empty EventArgs</param>
  24255. <remarks>
  24256. <para>
  24257. Notify any listeners that this repository's configuration has been reset.
  24258. </para>
  24259. </remarks>
  24260. </member>
  24261. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationChanged(System.EventArgs)">
  24262. <summary>
  24263. Notify the registered listeners that the repository has had its configuration changed
  24264. </summary>
  24265. <param name="e">Empty EventArgs</param>
  24266. <remarks>
  24267. <para>
  24268. Notify any listeners that this repository's configuration has changed.
  24269. </para>
  24270. </remarks>
  24271. </member>
  24272. <member name="M:log4net.Repository.LoggerRepositorySkeleton.RaiseConfigurationChanged(System.EventArgs)">
  24273. <summary>
  24274. Raise a configuration changed event on this repository
  24275. </summary>
  24276. <param name="e">EventArgs.Empty</param>
  24277. <remarks>
  24278. <para>
  24279. Applications that programmatically change the configuration of the repository should
  24280. raise this event notification to notify listeners.
  24281. </para>
  24282. </remarks>
  24283. </member>
  24284. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Flush(System.Int32)">
  24285. <summary>
  24286. Flushes all configured Appenders that implement <see cref="T:log4net.Appender.IFlushable"/>.
  24287. </summary>
  24288. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed,
  24289. or <see cref="F:System.Threading.Timeout.Infinite"/> to wait indefinitely.</param>
  24290. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  24291. </member>
  24292. <member name="T:log4net.ThreadContext">
  24293. <summary>
  24294. The log4net Thread Context.
  24295. </summary>
  24296. <remarks>
  24297. <para>
  24298. The <c>ThreadContext</c> provides a location for thread specific debugging
  24299. information to be stored.
  24300. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  24301. properties with the same name.
  24302. </para>
  24303. <para>
  24304. The thread context has a properties map and a stack.
  24305. The properties and stack can
  24306. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  24307. supports selecting and outputting these properties.
  24308. </para>
  24309. <para>
  24310. The Thread Context provides a diagnostic context for the current thread.
  24311. This is an instrument for distinguishing interleaved log
  24312. output from different sources. Log output is typically interleaved
  24313. when a server handles multiple clients near-simultaneously.
  24314. </para>
  24315. <para>
  24316. The Thread Context is managed on a per thread basis.
  24317. </para>
  24318. </remarks>
  24319. <example>Example of using the thread context properties to store a username.
  24320. <code lang="C#">
  24321. ThreadContext.Properties["user"] = userName;
  24322. log.Info("This log message has a ThreadContext Property called 'user'");
  24323. </code>
  24324. </example>
  24325. <example>Example of how to push a message into the context stack
  24326. <code lang="C#">
  24327. using(ThreadContext.Stacks["NDC"].Push("my context message"))
  24328. {
  24329. log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
  24330. } // at the end of the using block the message is automatically popped
  24331. </code>
  24332. </example>
  24333. <threadsafety static="true" instance="true" />
  24334. <author>Nicko Cadell</author>
  24335. </member>
  24336. <member name="M:log4net.ThreadContext.#ctor">
  24337. <summary>
  24338. Private Constructor.
  24339. </summary>
  24340. <remarks>
  24341. <para>
  24342. Uses a private access modifier to prevent instantiation of this class.
  24343. </para>
  24344. </remarks>
  24345. </member>
  24346. <member name="P:log4net.ThreadContext.Properties">
  24347. <summary>
  24348. The thread properties map
  24349. </summary>
  24350. <value>
  24351. The thread properties map
  24352. </value>
  24353. <remarks>
  24354. <para>
  24355. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  24356. properties with the same name.
  24357. </para>
  24358. </remarks>
  24359. </member>
  24360. <member name="P:log4net.ThreadContext.Stacks">
  24361. <summary>
  24362. The thread stacks
  24363. </summary>
  24364. <value>
  24365. stack map
  24366. </value>
  24367. <remarks>
  24368. <para>
  24369. The thread local stacks.
  24370. </para>
  24371. </remarks>
  24372. </member>
  24373. <member name="F:log4net.ThreadContext.s_properties">
  24374. <summary>
  24375. The thread context properties instance
  24376. </summary>
  24377. </member>
  24378. <member name="F:log4net.ThreadContext.s_stacks">
  24379. <summary>
  24380. The thread context stacks instance
  24381. </summary>
  24382. </member>
  24383. <member name="T:log4net.Util.AppenderAttachedImpl">
  24384. <summary>
  24385. A straightforward implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  24386. </summary>
  24387. <remarks>
  24388. <para>
  24389. This is the default implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/>
  24390. interface. Implementors of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  24391. should aggregate an instance of this type.
  24392. </para>
  24393. </remarks>
  24394. <author>Nicko Cadell</author>
  24395. <author>Gert Driesen</author>
  24396. </member>
  24397. <member name="M:log4net.Util.AppenderAttachedImpl.#ctor">
  24398. <summary>
  24399. Constructor
  24400. </summary>
  24401. <remarks>
  24402. <para>
  24403. Initializes a new instance of the <see cref="T:log4net.Util.AppenderAttachedImpl"/> class.
  24404. </para>
  24405. </remarks>
  24406. </member>
  24407. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent)">
  24408. <summary>
  24409. Append on on all attached appenders.
  24410. </summary>
  24411. <param name="loggingEvent">The event being logged.</param>
  24412. <returns>The number of appenders called.</returns>
  24413. <remarks>
  24414. <para>
  24415. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)" /> method on all
  24416. attached appenders.
  24417. </para>
  24418. </remarks>
  24419. </member>
  24420. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])">
  24421. <summary>
  24422. Append on on all attached appenders.
  24423. </summary>
  24424. <param name="loggingEvents">The array of events being logged.</param>
  24425. <returns>The number of appenders called.</returns>
  24426. <remarks>
  24427. <para>
  24428. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)" /> method on all
  24429. attached appenders.
  24430. </para>
  24431. </remarks>
  24432. </member>
  24433. <member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])">
  24434. <summary>
  24435. Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with
  24436. the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied.
  24437. </summary>
  24438. <param name="appender">The appender</param>
  24439. <param name="loggingEvents">The events</param>
  24440. <remarks>
  24441. <para>
  24442. If the <paramref name="appender" /> supports the <see cref="T:log4net.Appender.IBulkAppender"/>
  24443. interface then the <paramref name="loggingEvents" /> will be passed
  24444. through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/>
  24445. objects in the array will be passed one at a time.
  24446. </para>
  24447. </remarks>
  24448. </member>
  24449. <member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)">
  24450. <summary>
  24451. Attaches an appender.
  24452. </summary>
  24453. <param name="newAppender">The appender to add.</param>
  24454. <remarks>
  24455. <para>
  24456. If the appender is already in the list it won't be added again.
  24457. </para>
  24458. </remarks>
  24459. </member>
  24460. <member name="P:log4net.Util.AppenderAttachedImpl.Appenders">
  24461. <summary>
  24462. Gets all attached appenders.
  24463. </summary>
  24464. <returns>
  24465. A collection of attached appenders, or <c>null</c> if there
  24466. are no attached appenders.
  24467. </returns>
  24468. <remarks>
  24469. <para>
  24470. The read only collection of all currently attached appenders.
  24471. </para>
  24472. </remarks>
  24473. </member>
  24474. <member name="M:log4net.Util.AppenderAttachedImpl.GetAppender(System.String)">
  24475. <summary>
  24476. Gets an attached appender with the specified name.
  24477. </summary>
  24478. <param name="name">The name of the appender to get.</param>
  24479. <returns>
  24480. The appender with the name specified, or <c>null</c> if no appender with the
  24481. specified name is found.
  24482. </returns>
  24483. <remarks>
  24484. <para>
  24485. Lookup an attached appender by name.
  24486. </para>
  24487. </remarks>
  24488. </member>
  24489. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAllAppenders">
  24490. <summary>
  24491. Removes all attached appenders.
  24492. </summary>
  24493. <remarks>
  24494. <para>
  24495. Removes and closes all attached appenders
  24496. </para>
  24497. </remarks>
  24498. </member>
  24499. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(log4net.Appender.IAppender)">
  24500. <summary>
  24501. Removes the specified appender from the list of attached appenders.
  24502. </summary>
  24503. <param name="appender">The appender to remove.</param>
  24504. <returns>The appender removed from the list</returns>
  24505. <remarks>
  24506. <para>
  24507. The appender removed is not closed.
  24508. If you are discarding the appender you must call
  24509. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  24510. </para>
  24511. </remarks>
  24512. </member>
  24513. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(System.String)">
  24514. <summary>
  24515. Removes the appender with the specified name from the list of appenders.
  24516. </summary>
  24517. <param name="name">The name of the appender to remove.</param>
  24518. <returns>The appender removed from the list</returns>
  24519. <remarks>
  24520. <para>
  24521. The appender removed is not closed.
  24522. If you are discarding the appender you must call
  24523. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  24524. </para>
  24525. </remarks>
  24526. </member>
  24527. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderList">
  24528. <summary>
  24529. List of appenders
  24530. </summary>
  24531. </member>
  24532. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderArray">
  24533. <summary>
  24534. Array of appenders, used to cache the m_appenderList
  24535. </summary>
  24536. </member>
  24537. <member name="F:log4net.Util.AppenderAttachedImpl.declaringType">
  24538. <summary>
  24539. The fully qualified type of the AppenderAttachedImpl class.
  24540. </summary>
  24541. <remarks>
  24542. Used by the internal logger to record the Type of the
  24543. log message.
  24544. </remarks>
  24545. </member>
  24546. <member name="T:log4net.Util.CompositeProperties">
  24547. <summary>
  24548. This class aggregates several PropertiesDictionary collections together.
  24549. </summary>
  24550. <remarks>
  24551. <para>
  24552. Provides a dictionary style lookup over an ordered list of
  24553. <see cref="T:log4net.Util.PropertiesDictionary"/> collections.
  24554. </para>
  24555. </remarks>
  24556. <author>Nicko Cadell</author>
  24557. </member>
  24558. <member name="M:log4net.Util.CompositeProperties.#ctor">
  24559. <summary>
  24560. Constructor
  24561. </summary>
  24562. <remarks>
  24563. <para>
  24564. Initializes a new instance of the <see cref="T:log4net.Util.CompositeProperties" /> class.
  24565. </para>
  24566. </remarks>
  24567. </member>
  24568. <member name="P:log4net.Util.CompositeProperties.Item(System.String)">
  24569. <summary>
  24570. Gets the value of a property
  24571. </summary>
  24572. <value>
  24573. The value for the property with the specified key
  24574. </value>
  24575. <remarks>
  24576. <para>
  24577. Looks up the value for the <paramref name="key" /> specified.
  24578. The <see cref="T:log4net.Util.PropertiesDictionary"/> collections are searched
  24579. in the order in which they were added to this collection. The value
  24580. returned is the value held by the first collection that contains
  24581. the specified key.
  24582. </para>
  24583. <para>
  24584. If none of the collections contain the specified key then
  24585. <c>null</c> is returned.
  24586. </para>
  24587. </remarks>
  24588. </member>
  24589. <member name="M:log4net.Util.CompositeProperties.Add(log4net.Util.ReadOnlyPropertiesDictionary)">
  24590. <summary>
  24591. Add a Properties Dictionary to this composite collection
  24592. </summary>
  24593. <param name="properties">the properties to add</param>
  24594. <remarks>
  24595. <para>
  24596. Properties dictionaries added first take precedence over dictionaries added
  24597. later.
  24598. </para>
  24599. </remarks>
  24600. </member>
  24601. <member name="M:log4net.Util.CompositeProperties.Flatten">
  24602. <summary>
  24603. Flatten this composite collection into a single properties dictionary
  24604. </summary>
  24605. <returns>the flattened dictionary</returns>
  24606. <remarks>
  24607. <para>
  24608. Reduces the collection of ordered dictionaries to a single dictionary
  24609. containing the resultant values for the keys.
  24610. </para>
  24611. </remarks>
  24612. </member>
  24613. <member name="T:log4net.Util.ContextPropertiesBase">
  24614. <summary>
  24615. Base class for Context Properties implementations
  24616. </summary>
  24617. <remarks>
  24618. <para>
  24619. This class defines a basic property get set accessor
  24620. </para>
  24621. </remarks>
  24622. <author>Nicko Cadell</author>
  24623. </member>
  24624. <member name="P:log4net.Util.ContextPropertiesBase.Item(System.String)">
  24625. <summary>
  24626. Gets or sets the value of a property
  24627. </summary>
  24628. <value>
  24629. The value for the property with the specified key
  24630. </value>
  24631. <remarks>
  24632. <para>
  24633. Gets or sets the value of a property
  24634. </para>
  24635. </remarks>
  24636. </member>
  24637. <member name="T:log4net.Util.ConverterInfo">
  24638. <summary>
  24639. Wrapper class used to map converter names to converter types
  24640. </summary>
  24641. <remarks>
  24642. <para>
  24643. Pattern converter info class used during configuration by custom
  24644. PatternString and PatternLayer converters.
  24645. </para>
  24646. </remarks>
  24647. </member>
  24648. <member name="M:log4net.Util.ConverterInfo.#ctor">
  24649. <summary>
  24650. default constructor
  24651. </summary>
  24652. </member>
  24653. <member name="P:log4net.Util.ConverterInfo.Name">
  24654. <summary>
  24655. Gets or sets the name of the conversion pattern
  24656. </summary>
  24657. <remarks>
  24658. <para>
  24659. The name of the pattern in the format string
  24660. </para>
  24661. </remarks>
  24662. </member>
  24663. <member name="P:log4net.Util.ConverterInfo.Type">
  24664. <summary>
  24665. Gets or sets the type of the converter
  24666. </summary>
  24667. <remarks>
  24668. <para>
  24669. The value specified must extend the
  24670. <see cref="T:log4net.Util.PatternConverter"/> type.
  24671. </para>
  24672. </remarks>
  24673. </member>
  24674. <member name="M:log4net.Util.ConverterInfo.AddProperty(log4net.Util.PropertyEntry)">
  24675. <summary>
  24676. </summary>
  24677. <param name="entry"></param>
  24678. </member>
  24679. <member name="P:log4net.Util.ConverterInfo.Properties">
  24680. <summary>
  24681. </summary>
  24682. </member>
  24683. <member name="T:log4net.Util.CountingQuietTextWriter">
  24684. <summary>
  24685. Subclass of <see cref="T:log4net.Util.QuietTextWriter"/> that maintains a count of
  24686. the number of bytes written.
  24687. </summary>
  24688. <remarks>
  24689. <para>
  24690. This writer counts the number of bytes written.
  24691. </para>
  24692. </remarks>
  24693. <author>Nicko Cadell</author>
  24694. <author>Gert Driesen</author>
  24695. </member>
  24696. <member name="M:log4net.Util.CountingQuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  24697. <summary>
  24698. Constructor
  24699. </summary>
  24700. <param name="writer">The <see cref="T:System.IO.TextWriter" /> to actually write to.</param>
  24701. <param name="errorHandler">The <see cref="T:log4net.Core.IErrorHandler" /> to report errors to.</param>
  24702. <remarks>
  24703. <para>
  24704. Creates a new instance of the <see cref="T:log4net.Util.CountingQuietTextWriter" /> class
  24705. with the specified <see cref="T:System.IO.TextWriter" /> and <see cref="T:log4net.Core.IErrorHandler" />.
  24706. </para>
  24707. </remarks>
  24708. </member>
  24709. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)">
  24710. <summary>
  24711. Writes a character to the underlying writer and counts the number of bytes written.
  24712. </summary>
  24713. <param name="value">the char to write</param>
  24714. <remarks>
  24715. <para>
  24716. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  24717. the number of bytes written.
  24718. </para>
  24719. </remarks>
  24720. </member>
  24721. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  24722. <summary>
  24723. Writes a buffer to the underlying writer and counts the number of bytes written.
  24724. </summary>
  24725. <param name="buffer">the buffer to write</param>
  24726. <param name="index">the start index to write from</param>
  24727. <param name="count">the number of characters to write</param>
  24728. <remarks>
  24729. <para>
  24730. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  24731. the number of bytes written.
  24732. </para>
  24733. </remarks>
  24734. </member>
  24735. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)">
  24736. <summary>
  24737. Writes a string to the output and counts the number of bytes written.
  24738. </summary>
  24739. <param name="str">The string data to write to the output.</param>
  24740. <remarks>
  24741. <para>
  24742. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  24743. the number of bytes written.
  24744. </para>
  24745. </remarks>
  24746. </member>
  24747. <member name="P:log4net.Util.CountingQuietTextWriter.Count">
  24748. <summary>
  24749. Gets or sets the total number of bytes written.
  24750. </summary>
  24751. <value>
  24752. The total number of bytes written.
  24753. </value>
  24754. <remarks>
  24755. <para>
  24756. Gets or sets the total number of bytes written.
  24757. </para>
  24758. </remarks>
  24759. </member>
  24760. <member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes">
  24761. <summary>
  24762. Total number of bytes written.
  24763. </summary>
  24764. </member>
  24765. <member name="T:log4net.Util.CyclicBuffer">
  24766. <summary>
  24767. A fixed size rolling buffer of logging events.
  24768. </summary>
  24769. <remarks>
  24770. <para>
  24771. An array backed fixed size leaky bucket.
  24772. </para>
  24773. </remarks>
  24774. <author>Nicko Cadell</author>
  24775. <author>Gert Driesen</author>
  24776. </member>
  24777. <member name="M:log4net.Util.CyclicBuffer.#ctor(System.Int32)">
  24778. <summary>
  24779. Constructor
  24780. </summary>
  24781. <param name="maxSize">The maximum number of logging events in the buffer.</param>
  24782. <remarks>
  24783. <para>
  24784. Initializes a new instance of the <see cref="T:log4net.Util.CyclicBuffer" /> class with
  24785. the specified maximum number of buffered logging events.
  24786. </para>
  24787. </remarks>
  24788. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="maxSize"/> argument is not a positive integer.</exception>
  24789. </member>
  24790. <member name="M:log4net.Util.CyclicBuffer.Append(log4net.Core.LoggingEvent)">
  24791. <summary>
  24792. Appends a <paramref name="loggingEvent"/> to the buffer.
  24793. </summary>
  24794. <param name="loggingEvent">The event to append to the buffer.</param>
  24795. <returns>The event discarded from the buffer, if the buffer is full, otherwise <c>null</c>.</returns>
  24796. <remarks>
  24797. <para>
  24798. Append an event to the buffer. If the buffer still contains free space then
  24799. <c>null</c> is returned. If the buffer is full then an event will be dropped
  24800. to make space for the new event, the event dropped is returned.
  24801. </para>
  24802. </remarks>
  24803. </member>
  24804. <member name="M:log4net.Util.CyclicBuffer.PopOldest">
  24805. <summary>
  24806. Get and remove the oldest event in the buffer.
  24807. </summary>
  24808. <returns>The oldest logging event in the buffer</returns>
  24809. <remarks>
  24810. <para>
  24811. Gets the oldest (first) logging event in the buffer and removes it
  24812. from the buffer.
  24813. </para>
  24814. </remarks>
  24815. </member>
  24816. <member name="M:log4net.Util.CyclicBuffer.PopAll">
  24817. <summary>
  24818. Pops all the logging events from the buffer into an array.
  24819. </summary>
  24820. <returns>An array of all the logging events in the buffer.</returns>
  24821. <remarks>
  24822. <para>
  24823. Get all the events in the buffer and clear the buffer.
  24824. </para>
  24825. </remarks>
  24826. </member>
  24827. <member name="M:log4net.Util.CyclicBuffer.Clear">
  24828. <summary>
  24829. Clear the buffer
  24830. </summary>
  24831. <remarks>
  24832. <para>
  24833. Clear the buffer of all events. The events in the buffer are lost.
  24834. </para>
  24835. </remarks>
  24836. </member>
  24837. <member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)">
  24838. <summary>
  24839. Gets the <paramref name="i"/>th oldest event currently in the buffer.
  24840. </summary>
  24841. <value>The <paramref name="i"/>th oldest event currently in the buffer.</value>
  24842. <remarks>
  24843. <para>
  24844. If <paramref name="i"/> is outside the range 0 to the number of events
  24845. currently in the buffer, then <c>null</c> is returned.
  24846. </para>
  24847. </remarks>
  24848. </member>
  24849. <member name="P:log4net.Util.CyclicBuffer.MaxSize">
  24850. <summary>
  24851. Gets the maximum size of the buffer.
  24852. </summary>
  24853. <value>The maximum size of the buffer.</value>
  24854. <remarks>
  24855. <para>
  24856. Gets the maximum size of the buffer
  24857. </para>
  24858. </remarks>
  24859. </member>
  24860. <member name="P:log4net.Util.CyclicBuffer.Length">
  24861. <summary>
  24862. Gets the number of logging events in the buffer.
  24863. </summary>
  24864. <value>The number of logging events in the buffer.</value>
  24865. <remarks>
  24866. <para>
  24867. This number is guaranteed to be in the range 0 to <see cref="P:log4net.Util.CyclicBuffer.MaxSize"/>
  24868. (inclusive).
  24869. </para>
  24870. </remarks>
  24871. </member>
  24872. <member name="T:log4net.Util.EmptyCollection">
  24873. <summary>
  24874. An always empty <see cref="T:System.Collections.ICollection"/>.
  24875. </summary>
  24876. <remarks>
  24877. <para>
  24878. A singleton implementation of the <see cref="T:System.Collections.ICollection"/>
  24879. interface that always represents an empty collection.
  24880. </para>
  24881. </remarks>
  24882. <author>Nicko Cadell</author>
  24883. <author>Gert Driesen</author>
  24884. </member>
  24885. <member name="M:log4net.Util.EmptyCollection.#ctor">
  24886. <summary>
  24887. Initializes a new instance of the <see cref="T:log4net.Util.EmptyCollection" /> class.
  24888. </summary>
  24889. <remarks>
  24890. <para>
  24891. Uses a private access modifier to enforce the singleton pattern.
  24892. </para>
  24893. </remarks>
  24894. </member>
  24895. <member name="P:log4net.Util.EmptyCollection.Instance">
  24896. <summary>
  24897. Gets the singleton instance of the empty collection.
  24898. </summary>
  24899. <returns>The singleton instance of the empty collection.</returns>
  24900. <remarks>
  24901. <para>
  24902. Gets the singleton instance of the empty collection.
  24903. </para>
  24904. </remarks>
  24905. </member>
  24906. <member name="M:log4net.Util.EmptyCollection.CopyTo(System.Array,System.Int32)">
  24907. <summary>
  24908. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  24909. <see cref="T:System.Array"/>, starting at a particular Array index.
  24910. </summary>
  24911. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  24912. that is the destination of the elements copied from
  24913. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  24914. indexing.</param>
  24915. <param name="index">The zero-based index in array at which
  24916. copying begins.</param>
  24917. <remarks>
  24918. <para>
  24919. As the collection is empty no values are copied into the array.
  24920. </para>
  24921. </remarks>
  24922. </member>
  24923. <member name="P:log4net.Util.EmptyCollection.IsSynchronized">
  24924. <summary>
  24925. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  24926. </summary>
  24927. <value>
  24928. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  24929. </value>
  24930. <remarks>
  24931. <para>
  24932. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <c>true</c>.
  24933. </para>
  24934. </remarks>
  24935. </member>
  24936. <member name="P:log4net.Util.EmptyCollection.Count">
  24937. <summary>
  24938. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  24939. </summary>
  24940. <value>
  24941. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  24942. </value>
  24943. <remarks>
  24944. <para>
  24945. As the collection is empty the <see cref="P:log4net.Util.EmptyCollection.Count"/> is always <c>0</c>.
  24946. </para>
  24947. </remarks>
  24948. </member>
  24949. <member name="P:log4net.Util.EmptyCollection.SyncRoot">
  24950. <summary>
  24951. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  24952. </summary>
  24953. <value>
  24954. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  24955. </value>
  24956. <remarks>
  24957. <para>
  24958. As the collection is empty and thread safe and synchronized this instance is also
  24959. the <see cref="P:log4net.Util.EmptyCollection.SyncRoot"/> object.
  24960. </para>
  24961. </remarks>
  24962. </member>
  24963. <member name="M:log4net.Util.EmptyCollection.GetEnumerator">
  24964. <summary>
  24965. Returns an enumerator that can iterate through a collection.
  24966. </summary>
  24967. <returns>
  24968. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  24969. iterate through the collection.
  24970. </returns>
  24971. <remarks>
  24972. <para>
  24973. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  24974. </para>
  24975. </remarks>
  24976. </member>
  24977. <member name="F:log4net.Util.EmptyCollection.s_instance">
  24978. <summary>
  24979. The singleton instance of the empty collection.
  24980. </summary>
  24981. </member>
  24982. <member name="T:log4net.Util.EmptyDictionary">
  24983. <summary>
  24984. An always empty <see cref="T:System.Collections.IDictionary"/>.
  24985. </summary>
  24986. <remarks>
  24987. <para>
  24988. A singleton implementation of the <see cref="T:System.Collections.IDictionary"/>
  24989. interface that always represents an empty collection.
  24990. </para>
  24991. </remarks>
  24992. <author>Nicko Cadell</author>
  24993. <author>Gert Driesen</author>
  24994. </member>
  24995. <member name="M:log4net.Util.EmptyDictionary.#ctor">
  24996. <summary>
  24997. Initializes a new instance of the <see cref="T:log4net.Util.EmptyDictionary" /> class.
  24998. </summary>
  24999. <remarks>
  25000. <para>
  25001. Uses a private access modifier to enforce the singleton pattern.
  25002. </para>
  25003. </remarks>
  25004. </member>
  25005. <member name="P:log4net.Util.EmptyDictionary.Instance">
  25006. <summary>
  25007. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.
  25008. </summary>
  25009. <returns>The singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.</returns>
  25010. <remarks>
  25011. <para>
  25012. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.
  25013. </para>
  25014. </remarks>
  25015. </member>
  25016. <member name="M:log4net.Util.EmptyDictionary.CopyTo(System.Array,System.Int32)">
  25017. <summary>
  25018. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  25019. <see cref="T:System.Array"/>, starting at a particular Array index.
  25020. </summary>
  25021. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  25022. that is the destination of the elements copied from
  25023. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  25024. indexing.</param>
  25025. <param name="index">The zero-based index in array at which
  25026. copying begins.</param>
  25027. <remarks>
  25028. <para>
  25029. As the collection is empty no values are copied into the array.
  25030. </para>
  25031. </remarks>
  25032. </member>
  25033. <member name="P:log4net.Util.EmptyDictionary.IsSynchronized">
  25034. <summary>
  25035. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  25036. </summary>
  25037. <value>
  25038. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  25039. </value>
  25040. <remarks>
  25041. <para>
  25042. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <b>true</b>.
  25043. </para>
  25044. </remarks>
  25045. </member>
  25046. <member name="P:log4net.Util.EmptyDictionary.Count">
  25047. <summary>
  25048. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>
  25049. </summary>
  25050. <value>
  25051. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25052. </value>
  25053. <remarks>
  25054. <para>
  25055. As the collection is empty the <see cref="P:log4net.Util.EmptyDictionary.Count"/> is always <c>0</c>.
  25056. </para>
  25057. </remarks>
  25058. </member>
  25059. <member name="P:log4net.Util.EmptyDictionary.SyncRoot">
  25060. <summary>
  25061. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25062. </summary>
  25063. <value>
  25064. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25065. </value>
  25066. <remarks>
  25067. <para>
  25068. As the collection is empty and thread safe and synchronized this instance is also
  25069. the <see cref="P:log4net.Util.EmptyDictionary.SyncRoot"/> object.
  25070. </para>
  25071. </remarks>
  25072. </member>
  25073. <member name="M:log4net.Util.EmptyDictionary.System#Collections#IEnumerable#GetEnumerator">
  25074. <summary>
  25075. Returns an enumerator that can iterate through a collection.
  25076. </summary>
  25077. <returns>
  25078. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25079. iterate through the collection.
  25080. </returns>
  25081. <remarks>
  25082. <para>
  25083. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25084. </para>
  25085. </remarks>
  25086. </member>
  25087. <member name="M:log4net.Util.EmptyDictionary.Add(System.Object,System.Object)">
  25088. <summary>
  25089. Adds an element with the provided key and value to the
  25090. <see cref="T:log4net.Util.EmptyDictionary" />.
  25091. </summary>
  25092. <param name="key">The <see cref="T:System.Object" /> to use as the key of the element to add.</param>
  25093. <param name="value">The <see cref="T:System.Object" /> to use as the value of the element to add.</param>
  25094. <remarks>
  25095. <para>
  25096. As the collection is empty no new values can be added. A <see cref="T:System.InvalidOperationException"/>
  25097. is thrown if this method is called.
  25098. </para>
  25099. </remarks>
  25100. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25101. </member>
  25102. <member name="M:log4net.Util.EmptyDictionary.Clear">
  25103. <summary>
  25104. Removes all elements from the <see cref="T:log4net.Util.EmptyDictionary" />.
  25105. </summary>
  25106. <remarks>
  25107. <para>
  25108. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  25109. is thrown if this method is called.
  25110. </para>
  25111. </remarks>
  25112. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25113. </member>
  25114. <member name="M:log4net.Util.EmptyDictionary.Contains(System.Object)">
  25115. <summary>
  25116. Determines whether the <see cref="T:log4net.Util.EmptyDictionary" /> contains an element
  25117. with the specified key.
  25118. </summary>
  25119. <param name="key">The key to locate in the <see cref="T:log4net.Util.EmptyDictionary" />.</param>
  25120. <returns><c>false</c></returns>
  25121. <remarks>
  25122. <para>
  25123. As the collection is empty the <see cref="M:log4net.Util.EmptyDictionary.Contains(System.Object)"/> method always returns <c>false</c>.
  25124. </para>
  25125. </remarks>
  25126. </member>
  25127. <member name="M:log4net.Util.EmptyDictionary.GetEnumerator">
  25128. <summary>
  25129. Returns an enumerator that can iterate through a collection.
  25130. </summary>
  25131. <returns>
  25132. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25133. iterate through the collection.
  25134. </returns>
  25135. <remarks>
  25136. <para>
  25137. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25138. </para>
  25139. </remarks>
  25140. </member>
  25141. <member name="M:log4net.Util.EmptyDictionary.Remove(System.Object)">
  25142. <summary>
  25143. Removes the element with the specified key from the <see cref="T:log4net.Util.EmptyDictionary" />.
  25144. </summary>
  25145. <param name="key">The key of the element to remove.</param>
  25146. <remarks>
  25147. <para>
  25148. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  25149. is thrown if this method is called.
  25150. </para>
  25151. </remarks>
  25152. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25153. </member>
  25154. <member name="P:log4net.Util.EmptyDictionary.IsFixedSize">
  25155. <summary>
  25156. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary" /> has a fixed size.
  25157. </summary>
  25158. <value><c>true</c></value>
  25159. <remarks>
  25160. <para>
  25161. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsFixedSize"/> always returns <c>true</c>.
  25162. </para>
  25163. </remarks>
  25164. </member>
  25165. <member name="P:log4net.Util.EmptyDictionary.IsReadOnly">
  25166. <summary>
  25167. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary" /> is read-only.
  25168. </summary>
  25169. <value><c>true</c></value>
  25170. <remarks>
  25171. <para>
  25172. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsReadOnly"/> always returns <c>true</c>.
  25173. </para>
  25174. </remarks>
  25175. </member>
  25176. <member name="P:log4net.Util.EmptyDictionary.Keys">
  25177. <summary>
  25178. Gets an <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary" />.
  25179. </summary>
  25180. <value>An <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary" />.</value>
  25181. <remarks>
  25182. <para>
  25183. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  25184. </para>
  25185. </remarks>
  25186. </member>
  25187. <member name="P:log4net.Util.EmptyDictionary.Values">
  25188. <summary>
  25189. Gets an <see cref="T:System.Collections.ICollection" /> containing the values of the <see cref="T:log4net.Util.EmptyDictionary" />.
  25190. </summary>
  25191. <value>An <see cref="T:System.Collections.ICollection" /> containing the values of the <see cref="T:log4net.Util.EmptyDictionary" />.</value>
  25192. <remarks>
  25193. <para>
  25194. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  25195. </para>
  25196. </remarks>
  25197. </member>
  25198. <member name="P:log4net.Util.EmptyDictionary.Item(System.Object)">
  25199. <summary>
  25200. Gets or sets the element with the specified key.
  25201. </summary>
  25202. <param name="key">The key of the element to get or set.</param>
  25203. <value><c>null</c></value>
  25204. <remarks>
  25205. <para>
  25206. As the collection is empty no values can be looked up or stored.
  25207. If the index getter is called then <c>null</c> is returned.
  25208. A <see cref="T:System.InvalidOperationException"/> is thrown if the setter is called.
  25209. </para>
  25210. </remarks>
  25211. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25212. </member>
  25213. <member name="F:log4net.Util.EmptyDictionary.s_instance">
  25214. <summary>
  25215. The singleton instance of the empty dictionary.
  25216. </summary>
  25217. </member>
  25218. <member name="T:log4net.Util.FormattingInfo">
  25219. <summary>
  25220. Contain the information obtained when parsing formatting modifiers
  25221. in conversion modifiers.
  25222. </summary>
  25223. <remarks>
  25224. <para>
  25225. Holds the formatting information extracted from the format string by
  25226. the <see cref="T:log4net.Util.PatternParser"/>. This is used by the <see cref="T:log4net.Util.PatternConverter"/>
  25227. objects when rendering the output.
  25228. </para>
  25229. </remarks>
  25230. <author>Nicko Cadell</author>
  25231. <author>Gert Driesen</author>
  25232. </member>
  25233. <member name="M:log4net.Util.FormattingInfo.#ctor">
  25234. <summary>
  25235. Defaut Constructor
  25236. </summary>
  25237. <remarks>
  25238. <para>
  25239. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo" /> class.
  25240. </para>
  25241. </remarks>
  25242. </member>
  25243. <member name="M:log4net.Util.FormattingInfo.#ctor(System.Int32,System.Int32,System.Boolean)">
  25244. <summary>
  25245. Constructor
  25246. </summary>
  25247. <remarks>
  25248. <para>
  25249. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo" /> class
  25250. with the specified parameters.
  25251. </para>
  25252. </remarks>
  25253. </member>
  25254. <member name="P:log4net.Util.FormattingInfo.Min">
  25255. <summary>
  25256. Gets or sets the minimum value.
  25257. </summary>
  25258. <value>
  25259. The minimum value.
  25260. </value>
  25261. <remarks>
  25262. <para>
  25263. Gets or sets the minimum value.
  25264. </para>
  25265. </remarks>
  25266. </member>
  25267. <member name="P:log4net.Util.FormattingInfo.Max">
  25268. <summary>
  25269. Gets or sets the maximum value.
  25270. </summary>
  25271. <value>
  25272. The maximum value.
  25273. </value>
  25274. <remarks>
  25275. <para>
  25276. Gets or sets the maximum value.
  25277. </para>
  25278. </remarks>
  25279. </member>
  25280. <member name="P:log4net.Util.FormattingInfo.LeftAlign">
  25281. <summary>
  25282. Gets or sets a flag indicating whether left align is enabled
  25283. or not.
  25284. </summary>
  25285. <value>
  25286. A flag indicating whether left align is enabled or not.
  25287. </value>
  25288. <remarks>
  25289. <para>
  25290. Gets or sets a flag indicating whether left align is enabled or not.
  25291. </para>
  25292. </remarks>
  25293. </member>
  25294. <member name="T:log4net.Util.GlobalContextProperties">
  25295. <summary>
  25296. Implementation of Properties collection for the <see cref="T:log4net.GlobalContext"/>
  25297. </summary>
  25298. <remarks>
  25299. <para>
  25300. This class implements a properties collection that is thread safe and supports both
  25301. storing properties and capturing a read only copy of the current propertied.
  25302. </para>
  25303. <para>
  25304. This class is optimized to the scenario where the properties are read frequently
  25305. and are modified infrequently.
  25306. </para>
  25307. </remarks>
  25308. <author>Nicko Cadell</author>
  25309. </member>
  25310. <member name="F:log4net.Util.GlobalContextProperties.m_readOnlyProperties">
  25311. <summary>
  25312. The read only copy of the properties.
  25313. </summary>
  25314. <remarks>
  25315. <para>
  25316. This variable is declared <c>volatile</c> to prevent the compiler and JIT from
  25317. reordering reads and writes of this thread performed on different threads.
  25318. </para>
  25319. </remarks>
  25320. </member>
  25321. <member name="F:log4net.Util.GlobalContextProperties.m_syncRoot">
  25322. <summary>
  25323. Lock object used to synchronize updates within this instance
  25324. </summary>
  25325. </member>
  25326. <member name="M:log4net.Util.GlobalContextProperties.#ctor">
  25327. <summary>
  25328. Constructor
  25329. </summary>
  25330. <remarks>
  25331. <para>
  25332. Initializes a new instance of the <see cref="T:log4net.Util.GlobalContextProperties" /> class.
  25333. </para>
  25334. </remarks>
  25335. </member>
  25336. <member name="P:log4net.Util.GlobalContextProperties.Item(System.String)">
  25337. <summary>
  25338. Gets or sets the value of a property
  25339. </summary>
  25340. <value>
  25341. The value for the property with the specified key
  25342. </value>
  25343. <remarks>
  25344. <para>
  25345. Reading the value for a key is faster than setting the value.
  25346. When the value is written a new read only copy of
  25347. the properties is created.
  25348. </para>
  25349. </remarks>
  25350. </member>
  25351. <member name="M:log4net.Util.GlobalContextProperties.Remove(System.String)">
  25352. <summary>
  25353. Remove a property from the global context
  25354. </summary>
  25355. <param name="key">the key for the entry to remove</param>
  25356. <remarks>
  25357. <para>
  25358. Removing an entry from the global context properties is relatively expensive compared
  25359. with reading a value.
  25360. </para>
  25361. </remarks>
  25362. </member>
  25363. <member name="M:log4net.Util.GlobalContextProperties.Clear">
  25364. <summary>
  25365. Clear the global context properties
  25366. </summary>
  25367. </member>
  25368. <member name="M:log4net.Util.GlobalContextProperties.GetReadOnlyProperties">
  25369. <summary>
  25370. Get a readonly immutable copy of the properties
  25371. </summary>
  25372. <returns>the current global context properties</returns>
  25373. <remarks>
  25374. <para>
  25375. This implementation is fast because the GlobalContextProperties class
  25376. stores a readonly copy of the properties.
  25377. </para>
  25378. </remarks>
  25379. </member>
  25380. <member name="T:log4net.Util.ILogExtensions">
  25381. <summary>
  25382. The static class ILogExtensions contains a set of widely used
  25383. methods that ease the interaction with the ILog interface implementations.
  25384. </summary>
  25385. <remarks>
  25386. <para>
  25387. This class contains methods for logging at different levels and checks the
  25388. properties for determining if those logging levels are enabled in the current
  25389. configuration.
  25390. </para>
  25391. </remarks>
  25392. <example>Simple example of logging messages
  25393. <code lang="C#">
  25394. using log4net.Util;
  25395. ILog log = LogManager.GetLogger("application-log");
  25396. log.InfoExt("Application Start");
  25397. log.DebugExt("This is a debug message");
  25398. </code>
  25399. </example>
  25400. </member>
  25401. <member name="F:log4net.Util.ILogExtensions.declaringType">
  25402. <summary>
  25403. The fully qualified type of the Logger class.
  25404. </summary>
  25405. </member>
  25406. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object})">
  25407. <summary>
  25408. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25409. </summary>
  25410. <param name="logger">The logger on which the message is logged.</param>
  25411. <param name="callback">The lambda expression that gets the object to log.</param>
  25412. <remarks>
  25413. <para>
  25414. This method first checks if this logger is <c>INFO</c>
  25415. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  25416. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25417. implementation. If this logger is <c>INFO</c> enabled, then it converts
  25418. the message object (retrieved by invocation of the provided callback) to a
  25419. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  25420. It then proceeds to call all the registered appenders in this logger
  25421. and also higher in the hierarchy depending on the value of
  25422. the additivity flag.
  25423. </para>
  25424. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25425. to this method will print the name of the <see cref="T:System.Exception"/>
  25426. but no stack trace. To print a stack trace use the
  25427. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  25428. </para>
  25429. </remarks>
  25430. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25431. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25432. </member>
  25433. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  25434. <summary>
  25435. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  25436. the stack trace of the <see cref="T:System.Exception"/> passed
  25437. as a parameter.
  25438. </summary>
  25439. <param name="logger">The logger on which the message is logged.</param>
  25440. <param name="callback">The lambda expression that gets the object to log.</param>
  25441. <param name="exception">The exception to log, including its stack trace.</param>
  25442. <remarks>
  25443. <para>
  25444. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25445. </para>
  25446. </remarks>
  25447. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25448. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25449. </member>
  25450. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)">
  25451. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> //TODO
  25452. <summary>
  25453. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25454. </summary>
  25455. <param name="logger">The logger on which the message is logged.</param>
  25456. <param name="message">The message object to log.</param>
  25457. <remarks>
  25458. <para>
  25459. This method first checks if this logger is <c>INFO</c>
  25460. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  25461. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25462. implementation. If this logger is <c>INFO</c> enabled, then it converts
  25463. the message object (passed as parameter) to a string by invoking the appropriate
  25464. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  25465. proceeds to call all the registered appenders in this logger
  25466. and also higher in the hierarchy depending on the value of
  25467. the additivity flag.
  25468. </para>
  25469. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25470. to this method will print the name of the <see cref="T:System.Exception"/>
  25471. but no stack trace. To print a stack trace use the
  25472. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  25473. </para>
  25474. </remarks>
  25475. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25476. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25477. </member>
  25478. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)">
  25479. <summary>
  25480. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  25481. the stack trace of the <see cref="T:System.Exception"/> passed
  25482. as a parameter.
  25483. </summary>
  25484. <param name="logger">The logger on which the message is logged.</param>
  25485. <param name="message">The message object to log.</param>
  25486. <param name="exception">The exception to log, including its stack trace.</param>
  25487. <remarks>
  25488. <para>
  25489. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25490. </para>
  25491. </remarks>
  25492. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25493. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25494. </member>
  25495. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object)">
  25496. <summary>
  25497. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25498. </summary>
  25499. <param name="logger">The logger on which the message is logged.</param>
  25500. <param name="format">A String containing zero or more format items</param>
  25501. <param name="arg0">An Object to format</param>
  25502. <remarks>
  25503. <para>
  25504. The message is formatted using the <c>String.Format</c> method. See
  25505. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25506. of the formatting.
  25507. </para>
  25508. <para>
  25509. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25510. 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)"/>
  25511. methods instead.
  25512. </para>
  25513. </remarks>
  25514. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25515. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25516. </member>
  25517. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object[])">
  25518. <summary>
  25519. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25520. </summary>
  25521. <param name="logger">The logger on which the message is logged.</param>
  25522. <param name="format">A String containing zero or more format items</param>
  25523. <param name="args">An Object array containing zero or more objects to format</param>
  25524. <remarks>
  25525. <para>
  25526. The message is formatted using the <c>String.Format</c> method. See
  25527. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25528. of the formatting.
  25529. </para>
  25530. <para>
  25531. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25532. 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)"/>
  25533. methods instead.
  25534. </para>
  25535. </remarks>
  25536. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25537. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25538. </member>
  25539. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  25540. <summary>
  25541. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25542. </summary>
  25543. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  25544. <param name="logger">The logger on which the message is logged.</param>
  25545. <param name="format">A String containing zero or more format items</param>
  25546. <param name="args">An Object array containing zero or more objects to format</param>
  25547. <remarks>
  25548. <para>
  25549. The message is formatted using the <c>String.Format</c> method. See
  25550. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25551. of the formatting.
  25552. </para>
  25553. <para>
  25554. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25555. 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)"/>
  25556. methods instead.
  25557. </para>
  25558. </remarks>
  25559. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25560. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25561. </member>
  25562. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  25563. <summary>
  25564. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25565. </summary>
  25566. <param name="logger">The logger on which the message is logged.</param>
  25567. <param name="format">A String containing zero or more format items</param>
  25568. <param name="arg0">An Object to format</param>
  25569. <param name="arg1">An Object to format</param>
  25570. <remarks>
  25571. <para>
  25572. The message is formatted using the <c>String.Format</c> method. See
  25573. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25574. of the formatting.
  25575. </para>
  25576. <para>
  25577. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25578. 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)"/>
  25579. methods instead.
  25580. </para>
  25581. </remarks>
  25582. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25583. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25584. </member>
  25585. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  25586. <summary>
  25587. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25588. </summary>
  25589. <param name="logger">The logger on which the message is logged.</param>
  25590. <param name="format">A String containing zero or more format items</param>
  25591. <param name="arg0">An Object to format</param>
  25592. <param name="arg1">An Object to format</param>
  25593. <param name="arg2">An Object to format</param>
  25594. <remarks>
  25595. <para>
  25596. The message is formatted using the <c>String.Format</c> method. See
  25597. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25598. of the formatting.
  25599. </para>
  25600. <para>
  25601. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25602. 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)"/>
  25603. methods instead.
  25604. </para>
  25605. </remarks>
  25606. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25607. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25608. </member>
  25609. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object})">
  25610. <summary>
  25611. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  25612. </summary>
  25613. <param name="logger">The logger on which the message is logged.</param>
  25614. <param name="callback">The lambda expression that gets the object to log.</param>
  25615. <remarks>
  25616. <para>
  25617. This method first checks if this logger is <c>INFO</c>
  25618. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  25619. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25620. implementation. If this logger is <c>INFO</c> enabled, then it converts
  25621. the message object (retrieved by invocation of the provided callback) to a
  25622. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  25623. It then proceeds to call all the registered appenders in this logger
  25624. and also higher in the hierarchy depending on the value of
  25625. the additivity flag.
  25626. </para>
  25627. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25628. to this method will print the name of the <see cref="T:System.Exception"/>
  25629. but no stack trace. To print a stack trace use the
  25630. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  25631. </para>
  25632. </remarks>
  25633. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25634. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25635. </member>
  25636. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  25637. <summary>
  25638. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  25639. the stack trace of the <see cref="T:System.Exception"/> passed
  25640. as a parameter.
  25641. </summary>
  25642. <param name="logger">The logger on which the message is logged.</param>
  25643. <param name="callback">The lambda expression that gets the object to log.</param>
  25644. <param name="exception">The exception to log, including its stack trace.</param>
  25645. <remarks>
  25646. <para>
  25647. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25648. </para>
  25649. </remarks>
  25650. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25651. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25652. </member>
  25653. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)">
  25654. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> //TODO
  25655. <summary>
  25656. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  25657. </summary>
  25658. <param name="logger">The logger on which the message is logged.</param>
  25659. <param name="message">The message object to log.</param>
  25660. <remarks>
  25661. <para>
  25662. This method first checks if this logger is <c>INFO</c>
  25663. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  25664. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25665. implementation. If this logger is <c>INFO</c> enabled, then it converts
  25666. the message object (passed as parameter) to a string by invoking the appropriate
  25667. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  25668. proceeds to call all the registered appenders in this logger
  25669. and also higher in the hierarchy depending on the value of
  25670. the additivity flag.
  25671. </para>
  25672. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25673. to this method will print the name of the <see cref="T:System.Exception"/>
  25674. but no stack trace. To print a stack trace use the
  25675. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  25676. </para>
  25677. </remarks>
  25678. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25679. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25680. </member>
  25681. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)">
  25682. <summary>
  25683. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  25684. the stack trace of the <see cref="T:System.Exception"/> passed
  25685. as a parameter.
  25686. </summary>
  25687. <param name="logger">The logger on which the message is logged.</param>
  25688. <param name="message">The message object to log.</param>
  25689. <param name="exception">The exception to log, including its stack trace.</param>
  25690. <remarks>
  25691. <para>
  25692. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25693. </para>
  25694. </remarks>
  25695. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25696. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25697. </member>
  25698. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object)">
  25699. <summary>
  25700. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  25701. </summary>
  25702. <param name="logger">The logger on which the message is logged.</param>
  25703. <param name="format">A String containing zero or more format items</param>
  25704. <param name="arg0">An Object to format</param>
  25705. <remarks>
  25706. <para>
  25707. The message is formatted using the <c>String.Format</c> method. See
  25708. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25709. of the formatting.
  25710. </para>
  25711. <para>
  25712. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25713. 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)"/>
  25714. methods instead.
  25715. </para>
  25716. </remarks>
  25717. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25718. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25719. </member>
  25720. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object[])">
  25721. <summary>
  25722. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  25723. </summary>
  25724. <param name="logger">The logger on which the message is logged.</param>
  25725. <param name="format">A String containing zero or more format items</param>
  25726. <param name="args">An Object array containing zero or more objects to format</param>
  25727. <remarks>
  25728. <para>
  25729. The message is formatted using the <c>String.Format</c> method. See
  25730. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25731. of the formatting.
  25732. </para>
  25733. <para>
  25734. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25735. 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)"/>
  25736. methods instead.
  25737. </para>
  25738. </remarks>
  25739. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25740. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25741. </member>
  25742. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  25743. <summary>
  25744. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  25745. </summary>
  25746. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  25747. <param name="logger">The logger on which the message is logged.</param>
  25748. <param name="format">A String containing zero or more format items</param>
  25749. <param name="args">An Object array containing zero or more objects to format</param>
  25750. <remarks>
  25751. <para>
  25752. The message is formatted using the <c>String.Format</c> method. See
  25753. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25754. of the formatting.
  25755. </para>
  25756. <para>
  25757. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25758. 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)"/>
  25759. methods instead.
  25760. </para>
  25761. </remarks>
  25762. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25763. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25764. </member>
  25765. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  25766. <summary>
  25767. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  25768. </summary>
  25769. <param name="logger">The logger on which the message is logged.</param>
  25770. <param name="format">A String containing zero or more format items</param>
  25771. <param name="arg0">An Object to format</param>
  25772. <param name="arg1">An Object to format</param>
  25773. <remarks>
  25774. <para>
  25775. The message is formatted using the <c>String.Format</c> method. See
  25776. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25777. of the formatting.
  25778. </para>
  25779. <para>
  25780. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25781. 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)"/>
  25782. methods instead.
  25783. </para>
  25784. </remarks>
  25785. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25786. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25787. </member>
  25788. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  25789. <summary>
  25790. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  25791. </summary>
  25792. <param name="logger">The logger on which the message is logged.</param>
  25793. <param name="format">A String containing zero or more format items</param>
  25794. <param name="arg0">An Object to format</param>
  25795. <param name="arg1">An Object to format</param>
  25796. <param name="arg2">An Object to format</param>
  25797. <remarks>
  25798. <para>
  25799. The message is formatted using the <c>String.Format</c> method. See
  25800. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25801. of the formatting.
  25802. </para>
  25803. <para>
  25804. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25805. 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)"/>
  25806. methods instead.
  25807. </para>
  25808. </remarks>
  25809. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25810. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25811. </member>
  25812. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object})">
  25813. <summary>
  25814. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25815. </summary>
  25816. <param name="logger">The logger on which the message is logged.</param>
  25817. <param name="callback">The lambda expression that gets the object to log.</param>
  25818. <remarks>
  25819. <para>
  25820. This method first checks if this logger is <c>WARN</c>
  25821. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  25822. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25823. implementation. If this logger is <c>WARN</c> enabled, then it converts
  25824. the message object (retrieved by invocation of the provided callback) to a
  25825. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  25826. It then proceeds to call all the registered appenders in this logger
  25827. and also higher in the hierarchy depending on the value of
  25828. the additivity flag.
  25829. </para>
  25830. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25831. to this method will print the name of the <see cref="T:System.Exception"/>
  25832. but no stack trace. To print a stack trace use the
  25833. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  25834. </para>
  25835. </remarks>
  25836. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25837. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25838. </member>
  25839. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  25840. <summary>
  25841. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  25842. the stack trace of the <see cref="T:System.Exception"/> passed
  25843. as a parameter.
  25844. </summary>
  25845. <param name="logger">The logger on which the message is logged.</param>
  25846. <param name="callback">The lambda expression that gets the object to log.</param>
  25847. <param name="exception">The exception to log, including its stack trace.</param>
  25848. <remarks>
  25849. <para>
  25850. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25851. </para>
  25852. </remarks>
  25853. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25854. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25855. </member>
  25856. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)">
  25857. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> //TODO
  25858. <summary>
  25859. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25860. </summary>
  25861. <param name="logger">The logger on which the message is logged.</param>
  25862. <param name="message">The message object to log.</param>
  25863. <remarks>
  25864. <para>
  25865. This method first checks if this logger is <c>WARN</c>
  25866. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  25867. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25868. implementation. If this logger is <c>WARN</c> enabled, then it converts
  25869. the message object (passed as parameter) to a string by invoking the appropriate
  25870. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  25871. proceeds to call all the registered appenders in this logger
  25872. and also higher in the hierarchy depending on the value of
  25873. the additivity flag.
  25874. </para>
  25875. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25876. to this method will print the name of the <see cref="T:System.Exception"/>
  25877. but no stack trace. To print a stack trace use the
  25878. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  25879. </para>
  25880. </remarks>
  25881. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25882. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25883. </member>
  25884. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)">
  25885. <summary>
  25886. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  25887. the stack trace of the <see cref="T:System.Exception"/> passed
  25888. as a parameter.
  25889. </summary>
  25890. <param name="logger">The logger on which the message is logged.</param>
  25891. <param name="message">The message object to log.</param>
  25892. <param name="exception">The exception to log, including its stack trace.</param>
  25893. <remarks>
  25894. <para>
  25895. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25896. </para>
  25897. </remarks>
  25898. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25899. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25900. </member>
  25901. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object)">
  25902. <summary>
  25903. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25904. </summary>
  25905. <param name="logger">The logger on which the message is logged.</param>
  25906. <param name="format">A String containing zero or more format items</param>
  25907. <param name="arg0">An Object to format</param>
  25908. <remarks>
  25909. <para>
  25910. The message is formatted using the <c>String.Format</c> method. See
  25911. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25912. of the formatting.
  25913. </para>
  25914. <para>
  25915. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25916. 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)"/>
  25917. methods instead.
  25918. </para>
  25919. </remarks>
  25920. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25921. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25922. </member>
  25923. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object[])">
  25924. <summary>
  25925. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25926. </summary>
  25927. <param name="logger">The logger on which the message is logged.</param>
  25928. <param name="format">A String containing zero or more format items</param>
  25929. <param name="args">An Object array containing zero or more objects to format</param>
  25930. <remarks>
  25931. <para>
  25932. The message is formatted using the <c>String.Format</c> method. See
  25933. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25934. of the formatting.
  25935. </para>
  25936. <para>
  25937. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25938. 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)"/>
  25939. methods instead.
  25940. </para>
  25941. </remarks>
  25942. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25943. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25944. </member>
  25945. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  25946. <summary>
  25947. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25948. </summary>
  25949. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  25950. <param name="logger">The logger on which the message is logged.</param>
  25951. <param name="format">A String containing zero or more format items</param>
  25952. <param name="args">An Object array containing zero or more objects to format</param>
  25953. <remarks>
  25954. <para>
  25955. The message is formatted using the <c>String.Format</c> method. See
  25956. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25957. of the formatting.
  25958. </para>
  25959. <para>
  25960. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25961. 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)"/>
  25962. methods instead.
  25963. </para>
  25964. </remarks>
  25965. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25966. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25967. </member>
  25968. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  25969. <summary>
  25970. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25971. </summary>
  25972. <param name="logger">The logger on which the message is logged.</param>
  25973. <param name="format">A String containing zero or more format items</param>
  25974. <param name="arg0">An Object to format</param>
  25975. <param name="arg1">An Object to format</param>
  25976. <remarks>
  25977. <para>
  25978. The message is formatted using the <c>String.Format</c> method. See
  25979. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25980. of the formatting.
  25981. </para>
  25982. <para>
  25983. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25984. 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)"/>
  25985. methods instead.
  25986. </para>
  25987. </remarks>
  25988. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25989. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25990. </member>
  25991. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  25992. <summary>
  25993. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25994. </summary>
  25995. <param name="logger">The logger on which the message is logged.</param>
  25996. <param name="format">A String containing zero or more format items</param>
  25997. <param name="arg0">An Object to format</param>
  25998. <param name="arg1">An Object to format</param>
  25999. <param name="arg2">An Object to format</param>
  26000. <remarks>
  26001. <para>
  26002. The message is formatted using the <c>String.Format</c> method. See
  26003. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26004. of the formatting.
  26005. </para>
  26006. <para>
  26007. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26008. 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)"/>
  26009. methods instead.
  26010. </para>
  26011. </remarks>
  26012. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26013. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26014. </member>
  26015. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object})">
  26016. <summary>
  26017. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  26018. </summary>
  26019. <param name="logger">The logger on which the message is logged.</param>
  26020. <param name="callback">The lambda expression that gets the object to log.</param>
  26021. <remarks>
  26022. <para>
  26023. This method first checks if this logger is <c>ERROR</c>
  26024. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  26025. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26026. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  26027. the message object (retrieved by invocation of the provided callback) to a
  26028. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26029. It then proceeds to call all the registered appenders in this logger
  26030. and also higher in the hierarchy depending on the value of
  26031. the additivity flag.
  26032. </para>
  26033. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26034. to this method will print the name of the <see cref="T:System.Exception"/>
  26035. but no stack trace. To print a stack trace use the
  26036. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26037. </para>
  26038. </remarks>
  26039. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26040. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26041. </member>
  26042. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26043. <summary>
  26044. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  26045. the stack trace of the <see cref="T:System.Exception"/> passed
  26046. as a parameter.
  26047. </summary>
  26048. <param name="logger">The logger on which the message is logged.</param>
  26049. <param name="callback">The lambda expression that gets the object to log.</param>
  26050. <param name="exception">The exception to log, including its stack trace.</param>
  26051. <remarks>
  26052. <para>
  26053. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26054. </para>
  26055. </remarks>
  26056. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26057. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26058. </member>
  26059. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)">
  26060. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> //TODO
  26061. <summary>
  26062. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  26063. </summary>
  26064. <param name="logger">The logger on which the message is logged.</param>
  26065. <param name="message">The message object to log.</param>
  26066. <remarks>
  26067. <para>
  26068. This method first checks if this logger is <c>ERROR</c>
  26069. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  26070. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26071. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  26072. the message object (passed as parameter) to a string by invoking the appropriate
  26073. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26074. proceeds to call all the registered appenders in this logger
  26075. and also higher in the hierarchy depending on the value of
  26076. the additivity flag.
  26077. </para>
  26078. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26079. to this method will print the name of the <see cref="T:System.Exception"/>
  26080. but no stack trace. To print a stack trace use the
  26081. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26082. </para>
  26083. </remarks>
  26084. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26085. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26086. </member>
  26087. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)">
  26088. <summary>
  26089. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  26090. the stack trace of the <see cref="T:System.Exception"/> passed
  26091. as a parameter.
  26092. </summary>
  26093. <param name="logger">The logger on which the message is logged.</param>
  26094. <param name="message">The message object to log.</param>
  26095. <param name="exception">The exception to log, including its stack trace.</param>
  26096. <remarks>
  26097. <para>
  26098. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26099. </para>
  26100. </remarks>
  26101. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26102. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26103. </member>
  26104. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object)">
  26105. <summary>
  26106. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26107. </summary>
  26108. <param name="logger">The logger on which the message is logged.</param>
  26109. <param name="format">A String containing zero or more format items</param>
  26110. <param name="arg0">An Object to format</param>
  26111. <remarks>
  26112. <para>
  26113. The message is formatted using the <c>String.Format</c> method. See
  26114. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26115. of the formatting.
  26116. </para>
  26117. <para>
  26118. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26119. 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)"/>
  26120. methods instead.
  26121. </para>
  26122. </remarks>
  26123. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26124. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26125. </member>
  26126. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object[])">
  26127. <summary>
  26128. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26129. </summary>
  26130. <param name="logger">The logger on which the message is logged.</param>
  26131. <param name="format">A String containing zero or more format items</param>
  26132. <param name="args">An Object array containing zero or more objects to format</param>
  26133. <remarks>
  26134. <para>
  26135. The message is formatted using the <c>String.Format</c> method. See
  26136. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26137. of the formatting.
  26138. </para>
  26139. <para>
  26140. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26141. 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)"/>
  26142. methods instead.
  26143. </para>
  26144. </remarks>
  26145. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26146. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26147. </member>
  26148. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26149. <summary>
  26150. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26151. </summary>
  26152. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26153. <param name="logger">The logger on which the message is logged.</param>
  26154. <param name="format">A String containing zero or more format items</param>
  26155. <param name="args">An Object array containing zero or more objects to format</param>
  26156. <remarks>
  26157. <para>
  26158. The message is formatted using the <c>String.Format</c> method. See
  26159. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26160. of the formatting.
  26161. </para>
  26162. <para>
  26163. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26164. 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)"/>
  26165. methods instead.
  26166. </para>
  26167. </remarks>
  26168. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26169. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26170. </member>
  26171. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26172. <summary>
  26173. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26174. </summary>
  26175. <param name="logger">The logger on which the message is logged.</param>
  26176. <param name="format">A String containing zero or more format items</param>
  26177. <param name="arg0">An Object to format</param>
  26178. <param name="arg1">An Object to format</param>
  26179. <remarks>
  26180. <para>
  26181. The message is formatted using the <c>String.Format</c> method. See
  26182. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26183. of the formatting.
  26184. </para>
  26185. <para>
  26186. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26187. 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)"/>
  26188. methods instead.
  26189. </para>
  26190. </remarks>
  26191. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26192. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26193. </member>
  26194. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26195. <summary>
  26196. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26197. </summary>
  26198. <param name="logger">The logger on which the message is logged.</param>
  26199. <param name="format">A String containing zero or more format items</param>
  26200. <param name="arg0">An Object to format</param>
  26201. <param name="arg1">An Object to format</param>
  26202. <param name="arg2">An Object to format</param>
  26203. <remarks>
  26204. <para>
  26205. The message is formatted using the <c>String.Format</c> method. See
  26206. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26207. of the formatting.
  26208. </para>
  26209. <para>
  26210. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26211. 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)"/>
  26212. methods instead.
  26213. </para>
  26214. </remarks>
  26215. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26216. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26217. </member>
  26218. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object})">
  26219. <summary>
  26220. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26221. </summary>
  26222. <param name="logger">The logger on which the message is logged.</param>
  26223. <param name="callback">The lambda expression that gets the object to log.</param>
  26224. <remarks>
  26225. <para>
  26226. This method first checks if this logger is <c>FATAL</c>
  26227. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  26228. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26229. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  26230. the message object (retrieved by invocation of the provided callback) to a
  26231. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26232. It then proceeds to call all the registered appenders in this logger
  26233. and also higher in the hierarchy depending on the value of
  26234. the additivity flag.
  26235. </para>
  26236. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26237. to this method will print the name of the <see cref="T:System.Exception"/>
  26238. but no stack trace. To print a stack trace use the
  26239. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26240. </para>
  26241. </remarks>
  26242. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26243. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26244. </member>
  26245. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26246. <summary>
  26247. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  26248. the stack trace of the <see cref="T:System.Exception"/> passed
  26249. as a parameter.
  26250. </summary>
  26251. <param name="logger">The logger on which the message is logged.</param>
  26252. <param name="callback">The lambda expression that gets the object to log.</param>
  26253. <param name="exception">The exception to log, including its stack trace.</param>
  26254. <remarks>
  26255. <para>
  26256. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26257. </para>
  26258. </remarks>
  26259. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26260. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26261. </member>
  26262. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)">
  26263. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> //TODO
  26264. <summary>
  26265. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26266. </summary>
  26267. <param name="logger">The logger on which the message is logged.</param>
  26268. <param name="message">The message object to log.</param>
  26269. <remarks>
  26270. <para>
  26271. This method first checks if this logger is <c>FATAL</c>
  26272. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  26273. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26274. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  26275. the message object (passed as parameter) to a string by invoking the appropriate
  26276. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26277. proceeds to call all the registered appenders in this logger
  26278. and also higher in the hierarchy depending on the value of
  26279. the additivity flag.
  26280. </para>
  26281. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26282. to this method will print the name of the <see cref="T:System.Exception"/>
  26283. but no stack trace. To print a stack trace use the
  26284. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26285. </para>
  26286. </remarks>
  26287. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26288. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26289. </member>
  26290. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)">
  26291. <summary>
  26292. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  26293. the stack trace of the <see cref="T:System.Exception"/> passed
  26294. as a parameter.
  26295. </summary>
  26296. <param name="logger">The logger on which the message is logged.</param>
  26297. <param name="message">The message object to log.</param>
  26298. <param name="exception">The exception to log, including its stack trace.</param>
  26299. <remarks>
  26300. <para>
  26301. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26302. </para>
  26303. </remarks>
  26304. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26305. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26306. </member>
  26307. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object)">
  26308. <summary>
  26309. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26310. </summary>
  26311. <param name="logger">The logger on which the message is logged.</param>
  26312. <param name="format">A String containing zero or more format items</param>
  26313. <param name="arg0">An Object to format</param>
  26314. <remarks>
  26315. <para>
  26316. The message is formatted using the <c>String.Format</c> method. See
  26317. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26318. of the formatting.
  26319. </para>
  26320. <para>
  26321. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26322. 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)"/>
  26323. methods instead.
  26324. </para>
  26325. </remarks>
  26326. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26327. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26328. </member>
  26329. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object[])">
  26330. <summary>
  26331. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26332. </summary>
  26333. <param name="logger">The logger on which the message is logged.</param>
  26334. <param name="format">A String containing zero or more format items</param>
  26335. <param name="args">An Object array containing zero or more objects to format</param>
  26336. <remarks>
  26337. <para>
  26338. The message is formatted using the <c>String.Format</c> method. See
  26339. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26340. of the formatting.
  26341. </para>
  26342. <para>
  26343. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26344. 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)"/>
  26345. methods instead.
  26346. </para>
  26347. </remarks>
  26348. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26349. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26350. </member>
  26351. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26352. <summary>
  26353. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26354. </summary>
  26355. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26356. <param name="logger">The logger on which the message is logged.</param>
  26357. <param name="format">A String containing zero or more format items</param>
  26358. <param name="args">An Object array containing zero or more objects to format</param>
  26359. <remarks>
  26360. <para>
  26361. The message is formatted using the <c>String.Format</c> method. See
  26362. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26363. of the formatting.
  26364. </para>
  26365. <para>
  26366. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26367. 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)"/>
  26368. methods instead.
  26369. </para>
  26370. </remarks>
  26371. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26372. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26373. </member>
  26374. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26375. <summary>
  26376. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26377. </summary>
  26378. <param name="logger">The logger on which the message is logged.</param>
  26379. <param name="format">A String containing zero or more format items</param>
  26380. <param name="arg0">An Object to format</param>
  26381. <param name="arg1">An Object to format</param>
  26382. <remarks>
  26383. <para>
  26384. The message is formatted using the <c>String.Format</c> method. See
  26385. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26386. of the formatting.
  26387. </para>
  26388. <para>
  26389. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26390. 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)"/>
  26391. methods instead.
  26392. </para>
  26393. </remarks>
  26394. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26395. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26396. </member>
  26397. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26398. <summary>
  26399. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26400. </summary>
  26401. <param name="logger">The logger on which the message is logged.</param>
  26402. <param name="format">A String containing zero or more format items</param>
  26403. <param name="arg0">An Object to format</param>
  26404. <param name="arg1">An Object to format</param>
  26405. <param name="arg2">An Object to format</param>
  26406. <remarks>
  26407. <para>
  26408. The message is formatted using the <c>String.Format</c> method. See
  26409. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26410. of the formatting.
  26411. </para>
  26412. <para>
  26413. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26414. 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)"/>
  26415. methods instead.
  26416. </para>
  26417. </remarks>
  26418. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26419. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26420. </member>
  26421. <member name="T:log4net.Util.LevelMapping">
  26422. <summary>
  26423. Manages a mapping from levels to <see cref="T:log4net.Util.LevelMappingEntry"/>
  26424. </summary>
  26425. <remarks>
  26426. <para>
  26427. Manages an ordered mapping from <see cref="T:log4net.Core.Level"/> instances
  26428. to <see cref="T:log4net.Util.LevelMappingEntry"/> subclasses.
  26429. </para>
  26430. </remarks>
  26431. <author>Nicko Cadell</author>
  26432. </member>
  26433. <member name="M:log4net.Util.LevelMapping.#ctor">
  26434. <summary>
  26435. Default constructor
  26436. </summary>
  26437. <remarks>
  26438. <para>
  26439. Initialise a new instance of <see cref="T:log4net.Util.LevelMapping"/>.
  26440. </para>
  26441. </remarks>
  26442. </member>
  26443. <member name="M:log4net.Util.LevelMapping.Add(log4net.Util.LevelMappingEntry)">
  26444. <summary>
  26445. Add a <see cref="T:log4net.Util.LevelMappingEntry"/> to this mapping
  26446. </summary>
  26447. <param name="entry">the entry to add</param>
  26448. <remarks>
  26449. <para>
  26450. If a <see cref="T:log4net.Util.LevelMappingEntry"/> has previously been added
  26451. for the same <see cref="T:log4net.Core.Level"/> then that entry will be
  26452. overwritten.
  26453. </para>
  26454. </remarks>
  26455. </member>
  26456. <member name="M:log4net.Util.LevelMapping.Lookup(log4net.Core.Level)">
  26457. <summary>
  26458. Lookup the mapping for the specified level
  26459. </summary>
  26460. <param name="level">the level to lookup</param>
  26461. <returns>the <see cref="T:log4net.Util.LevelMappingEntry"/> for the level or <c>null</c> if no mapping found</returns>
  26462. <remarks>
  26463. <para>
  26464. Lookup the value for the specified level. Finds the nearest
  26465. mapping value for the level that is equal to or less than the
  26466. <paramref name="level"/> specified.
  26467. </para>
  26468. <para>
  26469. If no mapping could be found then <c>null</c> is returned.
  26470. </para>
  26471. </remarks>
  26472. </member>
  26473. <member name="M:log4net.Util.LevelMapping.ActivateOptions">
  26474. <summary>
  26475. Initialize options
  26476. </summary>
  26477. <remarks>
  26478. <para>
  26479. Caches the sorted list of <see cref="T:log4net.Util.LevelMappingEntry"/> in an array
  26480. </para>
  26481. </remarks>
  26482. </member>
  26483. <member name="T:log4net.Util.LevelMappingEntry">
  26484. <summary>
  26485. An entry in the <see cref="T:log4net.Util.LevelMapping"/>
  26486. </summary>
  26487. <remarks>
  26488. <para>
  26489. This is an abstract base class for types that are stored in the
  26490. <see cref="T:log4net.Util.LevelMapping"/> object.
  26491. </para>
  26492. </remarks>
  26493. <author>Nicko Cadell</author>
  26494. </member>
  26495. <member name="M:log4net.Util.LevelMappingEntry.#ctor">
  26496. <summary>
  26497. Default protected constructor
  26498. </summary>
  26499. <remarks>
  26500. <para>
  26501. Default protected constructor
  26502. </para>
  26503. </remarks>
  26504. </member>
  26505. <member name="P:log4net.Util.LevelMappingEntry.Level">
  26506. <summary>
  26507. The level that is the key for this mapping
  26508. </summary>
  26509. <value>
  26510. The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping
  26511. </value>
  26512. <remarks>
  26513. <para>
  26514. Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this
  26515. mapping subclass.
  26516. </para>
  26517. </remarks>
  26518. </member>
  26519. <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions">
  26520. <summary>
  26521. Initialize any options defined on this entry
  26522. </summary>
  26523. <remarks>
  26524. <para>
  26525. Should be overridden by any classes that need to initialise based on their options
  26526. </para>
  26527. </remarks>
  26528. </member>
  26529. <member name="T:log4net.Util.LogicalThreadContextProperties">
  26530. <summary>
  26531. Implementation of Properties collection for the <see cref="T:log4net.LogicalThreadContext"/>
  26532. </summary>
  26533. <remarks>
  26534. <para>
  26535. Class implements a collection of properties that is specific to each thread.
  26536. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  26537. </para>
  26538. <para>
  26539. This class stores its properties in a slot on the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> named
  26540. <c>log4net.Util.LogicalThreadContextProperties</c>.
  26541. </para>
  26542. <para>
  26543. For .NET Standard 1.3 this class uses
  26544. System.Threading.AsyncLocal rather than <see
  26545. cref="T:System.Runtime.Remoting.Messaging.CallContext"/>.
  26546. </para>
  26547. <para>
  26548. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  26549. <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
  26550. <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  26551. If the calling code does not have this permission then this context will be disabled.
  26552. It will not store any property values set on it.
  26553. </para>
  26554. </remarks>
  26555. <author>Nicko Cadell</author>
  26556. </member>
  26557. <member name="F:log4net.Util.LogicalThreadContextProperties.m_disabled">
  26558. <summary>
  26559. Flag used to disable this context if we don't have permission to access the CallContext.
  26560. </summary>
  26561. </member>
  26562. <member name="M:log4net.Util.LogicalThreadContextProperties.#ctor">
  26563. <summary>
  26564. Constructor
  26565. </summary>
  26566. <remarks>
  26567. <para>
  26568. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextProperties" /> class.
  26569. </para>
  26570. </remarks>
  26571. </member>
  26572. <member name="P:log4net.Util.LogicalThreadContextProperties.Item(System.String)">
  26573. <summary>
  26574. Gets or sets the value of a property
  26575. </summary>
  26576. <value>
  26577. The value for the property with the specified key
  26578. </value>
  26579. <remarks>
  26580. <para>
  26581. Get or set the property value for the <paramref name="key"/> specified.
  26582. </para>
  26583. </remarks>
  26584. </member>
  26585. <member name="M:log4net.Util.LogicalThreadContextProperties.Remove(System.String)">
  26586. <summary>
  26587. Remove a property
  26588. </summary>
  26589. <param name="key">the key for the entry to remove</param>
  26590. <remarks>
  26591. <para>
  26592. Remove the value for the specified <paramref name="key"/> from the context.
  26593. </para>
  26594. </remarks>
  26595. </member>
  26596. <member name="M:log4net.Util.LogicalThreadContextProperties.Clear">
  26597. <summary>
  26598. Clear all the context properties
  26599. </summary>
  26600. <remarks>
  26601. <para>
  26602. Clear all the context properties
  26603. </para>
  26604. </remarks>
  26605. </member>
  26606. <member name="M:log4net.Util.LogicalThreadContextProperties.GetProperties(System.Boolean)">
  26607. <summary>
  26608. Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread.
  26609. </summary>
  26610. <param name="create">create the dictionary if it does not exist, otherwise return null if is does not exist</param>
  26611. <returns>the properties for this thread</returns>
  26612. <remarks>
  26613. <para>
  26614. The collection returned is only to be used on the calling thread. If the
  26615. caller needs to share the collection between different threads then the
  26616. caller must clone the collection before doings so.
  26617. </para>
  26618. </remarks>
  26619. </member>
  26620. <member name="M:log4net.Util.LogicalThreadContextProperties.GetLogicalProperties">
  26621. <summary>
  26622. Gets the call context get data.
  26623. </summary>
  26624. <returns>The peroperties dictionary stored in the call context</returns>
  26625. <remarks>
  26626. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.GetData(System.String)"/> has a
  26627. security link demand, therfore we must put the method call in a seperate method
  26628. that we can wrap in an exception handler.
  26629. </remarks>
  26630. </member>
  26631. <member name="M:log4net.Util.LogicalThreadContextProperties.SetLogicalProperties(log4net.Util.PropertiesDictionary)">
  26632. <summary>
  26633. Sets the call context data.
  26634. </summary>
  26635. <param name="properties">The properties.</param>
  26636. <remarks>
  26637. 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
  26638. security link demand, therfore we must put the method call in a seperate method
  26639. that we can wrap in an exception handler.
  26640. </remarks>
  26641. </member>
  26642. <member name="F:log4net.Util.LogicalThreadContextProperties.declaringType">
  26643. <summary>
  26644. The fully qualified type of the LogicalThreadContextProperties class.
  26645. </summary>
  26646. <remarks>
  26647. Used by the internal logger to record the Type of the
  26648. log message.
  26649. </remarks>
  26650. </member>
  26651. <member name="T:log4net.Util.TwoArgAction`2">
  26652. <summary>
  26653. Delegate type used for LogicalThreadContextStack's callbacks.
  26654. </summary>
  26655. </member>
  26656. <member name="T:log4net.Util.LogicalThreadContextStack">
  26657. <summary>
  26658. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  26659. </summary>
  26660. <remarks>
  26661. <para>
  26662. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  26663. </para>
  26664. </remarks>
  26665. <author>Nicko Cadell</author>
  26666. </member>
  26667. <member name="F:log4net.Util.LogicalThreadContextStack.m_stack">
  26668. <summary>
  26669. The stack store.
  26670. </summary>
  26671. </member>
  26672. <member name="F:log4net.Util.LogicalThreadContextStack.m_propertyKey">
  26673. <summary>
  26674. The name of this <see cref="T:log4net.Util.LogicalThreadContextStack"/> within the
  26675. <see cref="T:log4net.Util.LogicalThreadContextProperties"/>.
  26676. </summary>
  26677. </member>
  26678. <member name="F:log4net.Util.LogicalThreadContextStack.m_registerNew">
  26679. <summary>
  26680. The callback used to let the <see cref="T:log4net.Util.LogicalThreadContextStacks"/> register a
  26681. new instance of a <see cref="T:log4net.Util.LogicalThreadContextStack"/>.
  26682. </summary>
  26683. </member>
  26684. <member name="M:log4net.Util.LogicalThreadContextStack.#ctor(System.String,log4net.Util.TwoArgAction{System.String,log4net.Util.LogicalThreadContextStack})">
  26685. <summary>
  26686. Internal constructor
  26687. </summary>
  26688. <remarks>
  26689. <para>
  26690. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack" /> class.
  26691. </para>
  26692. </remarks>
  26693. </member>
  26694. <member name="P:log4net.Util.LogicalThreadContextStack.Count">
  26695. <summary>
  26696. The number of messages in the stack
  26697. </summary>
  26698. <value>
  26699. The current number of messages in the stack
  26700. </value>
  26701. <remarks>
  26702. <para>
  26703. The current number of messages in the stack. That is
  26704. the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> has been called
  26705. minus the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Pop"/> has been called.
  26706. </para>
  26707. </remarks>
  26708. </member>
  26709. <member name="M:log4net.Util.LogicalThreadContextStack.Clear">
  26710. <summary>
  26711. Clears all the contextual information held in this stack.
  26712. </summary>
  26713. <remarks>
  26714. <para>
  26715. Clears all the contextual information held in this stack.
  26716. Only call this if you think that this thread is being reused after
  26717. a previous call execution which may not have completed correctly.
  26718. You do not need to use this method if you always guarantee to call
  26719. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  26720. returned from <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  26721. for example by using the <c>using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  26722. syntax.
  26723. </para>
  26724. </remarks>
  26725. </member>
  26726. <member name="M:log4net.Util.LogicalThreadContextStack.Pop">
  26727. <summary>
  26728. Removes the top context from this stack.
  26729. </summary>
  26730. <returns>The message in the context that was removed from the top of this stack.</returns>
  26731. <remarks>
  26732. <para>
  26733. Remove the top context from this stack, and return
  26734. it to the caller. If this stack is empty then an
  26735. empty string (not <see langword="null"/>) is returned.
  26736. </para>
  26737. </remarks>
  26738. </member>
  26739. <member name="M:log4net.Util.LogicalThreadContextStack.Push(System.String)">
  26740. <summary>
  26741. Pushes a new context message into this stack.
  26742. </summary>
  26743. <param name="message">The new context message.</param>
  26744. <returns>
  26745. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  26746. </returns>
  26747. <remarks>
  26748. <para>
  26749. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  26750. is returned that can be used to clean up this stack. This
  26751. can be easily combined with the <c>using</c> keyword to scope the
  26752. context.
  26753. </para>
  26754. </remarks>
  26755. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  26756. <code lang="C#">
  26757. using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))
  26758. {
  26759. log.Warn("This should have an ThreadContext Stack message");
  26760. }
  26761. </code>
  26762. </example>
  26763. </member>
  26764. <member name="M:log4net.Util.LogicalThreadContextStack.GetFullMessage">
  26765. <summary>
  26766. Gets the current context information for this stack.
  26767. </summary>
  26768. <returns>The current context information.</returns>
  26769. </member>
  26770. <member name="P:log4net.Util.LogicalThreadContextStack.InternalStack">
  26771. <summary>
  26772. Gets and sets the internal stack used by this <see cref="T:log4net.Util.LogicalThreadContextStack"/>
  26773. </summary>
  26774. <value>The internal storage stack</value>
  26775. <remarks>
  26776. <para>
  26777. This property is provided only to support backward compatability
  26778. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  26779. be modified.
  26780. </para>
  26781. </remarks>
  26782. </member>
  26783. <member name="M:log4net.Util.LogicalThreadContextStack.ToString">
  26784. <summary>
  26785. Gets the current context information for this stack.
  26786. </summary>
  26787. <returns>Gets the current context information</returns>
  26788. <remarks>
  26789. <para>
  26790. Gets the current context information for this stack.
  26791. </para>
  26792. </remarks>
  26793. </member>
  26794. <member name="M:log4net.Util.LogicalThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  26795. <summary>
  26796. Get a portable version of this object
  26797. </summary>
  26798. <returns>the portable instance of this object</returns>
  26799. <remarks>
  26800. <para>
  26801. Get a cross thread portable version of this object
  26802. </para>
  26803. </remarks>
  26804. </member>
  26805. <member name="T:log4net.Util.LogicalThreadContextStack.StackFrame">
  26806. <summary>
  26807. Inner class used to represent a single context frame in the stack.
  26808. </summary>
  26809. <remarks>
  26810. <para>
  26811. Inner class used to represent a single context frame in the stack.
  26812. </para>
  26813. </remarks>
  26814. </member>
  26815. <member name="M:log4net.Util.LogicalThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.LogicalThreadContextStack.StackFrame)">
  26816. <summary>
  26817. Constructor
  26818. </summary>
  26819. <param name="message">The message for this context.</param>
  26820. <param name="parent">The parent context in the chain.</param>
  26821. <remarks>
  26822. <para>
  26823. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.StackFrame" /> class
  26824. with the specified message and parent context.
  26825. </para>
  26826. </remarks>
  26827. </member>
  26828. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.Message">
  26829. <summary>
  26830. Get the message.
  26831. </summary>
  26832. <value>The message.</value>
  26833. <remarks>
  26834. <para>
  26835. Get the message.
  26836. </para>
  26837. </remarks>
  26838. </member>
  26839. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.FullMessage">
  26840. <summary>
  26841. Gets the full text of the context down to the root level.
  26842. </summary>
  26843. <value>
  26844. The full text of the context down to the root level.
  26845. </value>
  26846. <remarks>
  26847. <para>
  26848. Gets the full text of the context down to the root level.
  26849. </para>
  26850. </remarks>
  26851. </member>
  26852. <member name="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame">
  26853. <summary>
  26854. Struct returned from the <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> method.
  26855. </summary>
  26856. <remarks>
  26857. <para>
  26858. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  26859. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  26860. </para>
  26861. </remarks>
  26862. </member>
  26863. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_frameDepth">
  26864. <summary>
  26865. The depth to trim the stack to when this instance is disposed
  26866. </summary>
  26867. </member>
  26868. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_logicalThreadContextStack">
  26869. <summary>
  26870. The outer LogicalThreadContextStack.
  26871. </summary>
  26872. </member>
  26873. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.#ctor(log4net.Util.LogicalThreadContextStack,System.Int32)">
  26874. <summary>
  26875. Constructor
  26876. </summary>
  26877. <param name="logicalThreadContextStack">The internal stack used by the ThreadContextStack.</param>
  26878. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  26879. <remarks>
  26880. <para>
  26881. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame" /> class with
  26882. the specified stack and return depth.
  26883. </para>
  26884. </remarks>
  26885. </member>
  26886. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.Dispose">
  26887. <summary>
  26888. Returns the stack to the correct depth.
  26889. </summary>
  26890. <remarks>
  26891. <para>
  26892. Returns the stack to the correct depth.
  26893. </para>
  26894. </remarks>
  26895. </member>
  26896. <member name="T:log4net.Util.LogicalThreadContextStacks">
  26897. <summary>
  26898. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  26899. </summary>
  26900. <remarks>
  26901. <para>
  26902. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  26903. </para>
  26904. </remarks>
  26905. <author>Nicko Cadell</author>
  26906. </member>
  26907. <member name="M:log4net.Util.LogicalThreadContextStacks.#ctor(log4net.Util.LogicalThreadContextProperties)">
  26908. <summary>
  26909. Internal constructor
  26910. </summary>
  26911. <remarks>
  26912. <para>
  26913. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks" /> class.
  26914. </para>
  26915. </remarks>
  26916. </member>
  26917. <member name="P:log4net.Util.LogicalThreadContextStacks.Item(System.String)">
  26918. <summary>
  26919. Gets the named thread context stack
  26920. </summary>
  26921. <value>
  26922. The named stack
  26923. </value>
  26924. <remarks>
  26925. <para>
  26926. Gets the named thread context stack
  26927. </para>
  26928. </remarks>
  26929. </member>
  26930. <member name="F:log4net.Util.LogicalThreadContextStacks.declaringType">
  26931. <summary>
  26932. The fully qualified type of the ThreadContextStacks class.
  26933. </summary>
  26934. <remarks>
  26935. Used by the internal logger to record the Type of the
  26936. log message.
  26937. </remarks>
  26938. </member>
  26939. <member name="T:log4net.Util.LogReceivedEventHandler">
  26940. <summary>
  26941. </summary>
  26942. <param name="source"></param>
  26943. <param name="e"></param>
  26944. </member>
  26945. <member name="T:log4net.Util.LogLog">
  26946. <summary>
  26947. Outputs log statements from within the log4net assembly.
  26948. </summary>
  26949. <remarks>
  26950. <para>
  26951. Log4net components cannot make log4net logging calls. However, it is
  26952. sometimes useful for the user to learn about what log4net is
  26953. doing.
  26954. </para>
  26955. <para>
  26956. All log4net internal debug calls go to the standard output stream
  26957. whereas internal error messages are sent to the standard error output
  26958. stream.
  26959. </para>
  26960. </remarks>
  26961. <author>Nicko Cadell</author>
  26962. <author>Gert Driesen</author>
  26963. </member>
  26964. <member name="E:log4net.Util.LogLog.LogReceived">
  26965. <summary>
  26966. The event raised when an internal message has been received.
  26967. </summary>
  26968. </member>
  26969. <member name="P:log4net.Util.LogLog.Source">
  26970. <summary>
  26971. The Type that generated the internal message.
  26972. </summary>
  26973. </member>
  26974. <member name="P:log4net.Util.LogLog.TimeStamp">
  26975. <summary>
  26976. The DateTime stamp of when the internal message was received.
  26977. </summary>
  26978. </member>
  26979. <member name="P:log4net.Util.LogLog.TimeStampUtc">
  26980. <summary>
  26981. The UTC DateTime stamp of when the internal message was received.
  26982. </summary>
  26983. </member>
  26984. <member name="P:log4net.Util.LogLog.Prefix">
  26985. <summary>
  26986. A string indicating the severity of the internal message.
  26987. </summary>
  26988. <remarks>
  26989. "log4net: ",
  26990. "log4net:ERROR ",
  26991. "log4net:WARN "
  26992. </remarks>
  26993. </member>
  26994. <member name="P:log4net.Util.LogLog.Message">
  26995. <summary>
  26996. The internal log message.
  26997. </summary>
  26998. </member>
  26999. <member name="P:log4net.Util.LogLog.Exception">
  27000. <summary>
  27001. The Exception related to the message.
  27002. </summary>
  27003. <remarks>
  27004. Optional. Will be null if no Exception was passed.
  27005. </remarks>
  27006. </member>
  27007. <member name="M:log4net.Util.LogLog.ToString">
  27008. <summary>
  27009. Formats Prefix, Source, and Message in the same format as the value
  27010. sent to Console.Out and Trace.Write.
  27011. </summary>
  27012. <returns></returns>
  27013. </member>
  27014. <member name="M:log4net.Util.LogLog.#ctor(System.Type,System.String,System.String,System.Exception)">
  27015. <summary>
  27016. Initializes a new instance of the <see cref="T:log4net.Util.LogLog" /> class.
  27017. </summary>
  27018. <param name="source"></param>
  27019. <param name="prefix"></param>
  27020. <param name="message"></param>
  27021. <param name="exception"></param>
  27022. </member>
  27023. <member name="M:log4net.Util.LogLog.#cctor">
  27024. <summary>
  27025. Static constructor that initializes logging by reading
  27026. settings from the application configuration file.
  27027. </summary>
  27028. <remarks>
  27029. <para>
  27030. The <c>log4net.Internal.Debug</c> application setting
  27031. controls internal debugging. This setting should be set
  27032. to <c>true</c> to enable debugging.
  27033. </para>
  27034. <para>
  27035. The <c>log4net.Internal.Quiet</c> application setting
  27036. suppresses all internal logging including error messages.
  27037. This setting should be set to <c>true</c> to enable message
  27038. suppression.
  27039. </para>
  27040. </remarks>
  27041. </member>
  27042. <member name="P:log4net.Util.LogLog.InternalDebugging">
  27043. <summary>
  27044. Gets or sets a value indicating whether log4net internal logging
  27045. is enabled or disabled.
  27046. </summary>
  27047. <value>
  27048. <c>true</c> if log4net internal logging is enabled, otherwise
  27049. <c>false</c>.
  27050. </value>
  27051. <remarks>
  27052. <para>
  27053. When set to <c>true</c>, internal debug level logging will be
  27054. displayed.
  27055. </para>
  27056. <para>
  27057. This value can be set by setting the application setting
  27058. <c>log4net.Internal.Debug</c> in the application configuration
  27059. file.
  27060. </para>
  27061. <para>
  27062. The default value is <c>false</c>, i.e. debugging is
  27063. disabled.
  27064. </para>
  27065. </remarks>
  27066. <example>
  27067. <para>
  27068. The following example enables internal debugging using the
  27069. application configuration file :
  27070. </para>
  27071. <code lang="XML" escaped="true">
  27072. <configuration>
  27073. <appSettings>
  27074. <add key="log4net.Internal.Debug" value="true" />
  27075. </appSettings>
  27076. </configuration>
  27077. </code>
  27078. </example>
  27079. </member>
  27080. <member name="P:log4net.Util.LogLog.QuietMode">
  27081. <summary>
  27082. Gets or sets a value indicating whether log4net should generate no output
  27083. from internal logging, not even for errors.
  27084. </summary>
  27085. <value>
  27086. <c>true</c> if log4net should generate no output at all from internal
  27087. logging, otherwise <c>false</c>.
  27088. </value>
  27089. <remarks>
  27090. <para>
  27091. When set to <c>true</c> will cause internal logging at all levels to be
  27092. suppressed. This means that no warning or error reports will be logged.
  27093. This option overrides the <see cref="P:log4net.Util.LogLog.InternalDebugging"/> setting and
  27094. disables all debug also.
  27095. </para>
  27096. <para>This value can be set by setting the application setting
  27097. <c>log4net.Internal.Quiet</c> in the application configuration file.
  27098. </para>
  27099. <para>
  27100. The default value is <c>false</c>, i.e. internal logging is not
  27101. disabled.
  27102. </para>
  27103. </remarks>
  27104. <example>
  27105. The following example disables internal logging using the
  27106. application configuration file :
  27107. <code lang="XML" escaped="true">
  27108. <configuration>
  27109. <appSettings>
  27110. <add key="log4net.Internal.Quiet" value="true" />
  27111. </appSettings>
  27112. </configuration>
  27113. </code>
  27114. </example>
  27115. </member>
  27116. <member name="P:log4net.Util.LogLog.EmitInternalMessages">
  27117. <summary>
  27118. </summary>
  27119. </member>
  27120. <member name="M:log4net.Util.LogLog.OnLogReceived(System.Type,System.String,System.String,System.Exception)">
  27121. <summary>
  27122. Raises the LogReceived event when an internal messages is received.
  27123. </summary>
  27124. <param name="source"></param>
  27125. <param name="prefix"></param>
  27126. <param name="message"></param>
  27127. <param name="exception"></param>
  27128. </member>
  27129. <member name="P:log4net.Util.LogLog.IsDebugEnabled">
  27130. <summary>
  27131. Test if LogLog.Debug is enabled for output.
  27132. </summary>
  27133. <value>
  27134. <c>true</c> if Debug is enabled
  27135. </value>
  27136. <remarks>
  27137. <para>
  27138. Test if LogLog.Debug is enabled for output.
  27139. </para>
  27140. </remarks>
  27141. </member>
  27142. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String)">
  27143. <summary>
  27144. Writes log4net internal debug messages to the
  27145. standard output stream.
  27146. </summary>
  27147. <param name="source"></param>
  27148. <param name="message">The message to log.</param>
  27149. <remarks>
  27150. <para>
  27151. All internal debug messages are prepended with
  27152. the string "log4net: ".
  27153. </para>
  27154. </remarks>
  27155. </member>
  27156. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String,System.Exception)">
  27157. <summary>
  27158. Writes log4net internal debug messages to the
  27159. standard output stream.
  27160. </summary>
  27161. <param name="source">The Type that generated this message.</param>
  27162. <param name="message">The message to log.</param>
  27163. <param name="exception">An exception to log.</param>
  27164. <remarks>
  27165. <para>
  27166. All internal debug messages are prepended with
  27167. the string "log4net: ".
  27168. </para>
  27169. </remarks>
  27170. </member>
  27171. <member name="P:log4net.Util.LogLog.IsWarnEnabled">
  27172. <summary>
  27173. Test if LogLog.Warn is enabled for output.
  27174. </summary>
  27175. <value>
  27176. <c>true</c> if Warn is enabled
  27177. </value>
  27178. <remarks>
  27179. <para>
  27180. Test if LogLog.Warn is enabled for output.
  27181. </para>
  27182. </remarks>
  27183. </member>
  27184. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String)">
  27185. <summary>
  27186. Writes log4net internal warning messages to the
  27187. standard error stream.
  27188. </summary>
  27189. <param name="source">The Type that generated this message.</param>
  27190. <param name="message">The message to log.</param>
  27191. <remarks>
  27192. <para>
  27193. All internal warning messages are prepended with
  27194. the string "log4net:WARN ".
  27195. </para>
  27196. </remarks>
  27197. </member>
  27198. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String,System.Exception)">
  27199. <summary>
  27200. Writes log4net internal warning messages to the
  27201. standard error stream.
  27202. </summary>
  27203. <param name="source">The Type that generated this message.</param>
  27204. <param name="message">The message to log.</param>
  27205. <param name="exception">An exception to log.</param>
  27206. <remarks>
  27207. <para>
  27208. All internal warning messages are prepended with
  27209. the string "log4net:WARN ".
  27210. </para>
  27211. </remarks>
  27212. </member>
  27213. <member name="P:log4net.Util.LogLog.IsErrorEnabled">
  27214. <summary>
  27215. Test if LogLog.Error is enabled for output.
  27216. </summary>
  27217. <value>
  27218. <c>true</c> if Error is enabled
  27219. </value>
  27220. <remarks>
  27221. <para>
  27222. Test if LogLog.Error is enabled for output.
  27223. </para>
  27224. </remarks>
  27225. </member>
  27226. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String)">
  27227. <summary>
  27228. Writes log4net internal error messages to the
  27229. standard error stream.
  27230. </summary>
  27231. <param name="source">The Type that generated this message.</param>
  27232. <param name="message">The message to log.</param>
  27233. <remarks>
  27234. <para>
  27235. All internal error messages are prepended with
  27236. the string "log4net:ERROR ".
  27237. </para>
  27238. </remarks>
  27239. </member>
  27240. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String,System.Exception)">
  27241. <summary>
  27242. Writes log4net internal error messages to the
  27243. standard error stream.
  27244. </summary>
  27245. <param name="source">The Type that generated this message.</param>
  27246. <param name="message">The message to log.</param>
  27247. <param name="exception">An exception to log.</param>
  27248. <remarks>
  27249. <para>
  27250. All internal debug messages are prepended with
  27251. the string "log4net:ERROR ".
  27252. </para>
  27253. </remarks>
  27254. </member>
  27255. <member name="M:log4net.Util.LogLog.EmitOutLine(System.String)">
  27256. <summary>
  27257. Writes output to the standard output stream.
  27258. </summary>
  27259. <param name="message">The message to log.</param>
  27260. <remarks>
  27261. <para>
  27262. Writes to both Console.Out and System.Diagnostics.Trace.
  27263. Note that the System.Diagnostics.Trace is not supported
  27264. on the Compact Framework.
  27265. </para>
  27266. <para>
  27267. If the AppDomain is not configured with a config file then
  27268. the call to System.Diagnostics.Trace may fail. This is only
  27269. an issue if you are programmatically creating your own AppDomains.
  27270. </para>
  27271. </remarks>
  27272. </member>
  27273. <member name="M:log4net.Util.LogLog.EmitErrorLine(System.String)">
  27274. <summary>
  27275. Writes output to the standard error stream.
  27276. </summary>
  27277. <param name="message">The message to log.</param>
  27278. <remarks>
  27279. <para>
  27280. Writes to both Console.Error and System.Diagnostics.Trace.
  27281. Note that the System.Diagnostics.Trace is not supported
  27282. on the Compact Framework.
  27283. </para>
  27284. <para>
  27285. If the AppDomain is not configured with a config file then
  27286. the call to System.Diagnostics.Trace may fail. This is only
  27287. an issue if you are programmatically creating your own AppDomains.
  27288. </para>
  27289. </remarks>
  27290. </member>
  27291. <member name="F:log4net.Util.LogLog.s_debugEnabled">
  27292. <summary>
  27293. Default debug level
  27294. </summary>
  27295. </member>
  27296. <member name="F:log4net.Util.LogLog.s_quietMode">
  27297. <summary>
  27298. In quietMode not even errors generate any output.
  27299. </summary>
  27300. </member>
  27301. <member name="T:log4net.Util.LogLog.LogReceivedAdapter">
  27302. <summary>
  27303. Subscribes to the LogLog.LogReceived event and stores messages
  27304. to the supplied IList instance.
  27305. </summary>
  27306. </member>
  27307. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.#ctor(System.Collections.IList)">
  27308. <summary>
  27309. </summary>
  27310. <param name="items"></param>
  27311. </member>
  27312. <member name="P:log4net.Util.LogLog.LogReceivedAdapter.Items">
  27313. <summary>
  27314. </summary>
  27315. </member>
  27316. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.Dispose">
  27317. <summary>
  27318. </summary>
  27319. </member>
  27320. <member name="T:log4net.Util.LogReceivedEventArgs">
  27321. <summary>
  27322. </summary>
  27323. </member>
  27324. <member name="M:log4net.Util.LogReceivedEventArgs.#ctor(log4net.Util.LogLog)">
  27325. <summary>
  27326. </summary>
  27327. <param name="loglog"></param>
  27328. </member>
  27329. <member name="P:log4net.Util.LogReceivedEventArgs.LogLog">
  27330. <summary>
  27331. </summary>
  27332. </member>
  27333. <member name="T:log4net.Util.NativeError">
  27334. <summary>
  27335. Represents a native error code and message.
  27336. </summary>
  27337. <remarks>
  27338. <para>
  27339. Represents a Win32 platform native error.
  27340. </para>
  27341. </remarks>
  27342. <author>Nicko Cadell</author>
  27343. <author>Gert Driesen</author>
  27344. </member>
  27345. <member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)">
  27346. <summary>
  27347. Create an instance of the <see cref="T:log4net.Util.NativeError" /> class with the specified
  27348. error number and message.
  27349. </summary>
  27350. <param name="number">The number of the native error.</param>
  27351. <param name="message">The message of the native error.</param>
  27352. <remarks>
  27353. <para>
  27354. Create an instance of the <see cref="T:log4net.Util.NativeError" /> class with the specified
  27355. error number and message.
  27356. </para>
  27357. </remarks>
  27358. </member>
  27359. <member name="P:log4net.Util.NativeError.Number">
  27360. <summary>
  27361. Gets the number of the native error.
  27362. </summary>
  27363. <value>
  27364. The number of the native error.
  27365. </value>
  27366. <remarks>
  27367. <para>
  27368. Gets the number of the native error.
  27369. </para>
  27370. </remarks>
  27371. </member>
  27372. <member name="P:log4net.Util.NativeError.Message">
  27373. <summary>
  27374. Gets the message of the native error.
  27375. </summary>
  27376. <value>
  27377. The message of the native error.
  27378. </value>
  27379. <remarks>
  27380. <para>
  27381. </para>
  27382. Gets the message of the native error.
  27383. </remarks>
  27384. </member>
  27385. <member name="M:log4net.Util.NativeError.GetLastError">
  27386. <summary>
  27387. Create a new instance of the <see cref="T:log4net.Util.NativeError" /> class for the last Windows error.
  27388. </summary>
  27389. <returns>
  27390. An instance of the <see cref="T:log4net.Util.NativeError" /> class for the last windows error.
  27391. </returns>
  27392. <remarks>
  27393. <para>
  27394. The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the
  27395. native Win32 <c>FormatMessage</c> function.
  27396. </para>
  27397. </remarks>
  27398. </member>
  27399. <member name="M:log4net.Util.NativeError.GetError(System.Int32)">
  27400. <summary>
  27401. Create a new instance of the <see cref="T:log4net.Util.NativeError" /> class.
  27402. </summary>
  27403. <param name="number">the error number for the native error</param>
  27404. <returns>
  27405. An instance of the <see cref="T:log4net.Util.NativeError" /> class for the specified
  27406. error number.
  27407. </returns>
  27408. <remarks>
  27409. <para>
  27410. The message for the specified error number is lookup up using the
  27411. native Win32 <c>FormatMessage</c> function.
  27412. </para>
  27413. </remarks>
  27414. </member>
  27415. <member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)">
  27416. <summary>
  27417. Retrieves the message corresponding with a Win32 message identifier.
  27418. </summary>
  27419. <param name="messageId">Message identifier for the requested message.</param>
  27420. <returns>
  27421. The message corresponding with the specified message identifier.
  27422. </returns>
  27423. <remarks>
  27424. <para>
  27425. The message will be searched for in system message-table resource(s)
  27426. using the native <c>FormatMessage</c> function.
  27427. </para>
  27428. </remarks>
  27429. </member>
  27430. <member name="M:log4net.Util.NativeError.ToString">
  27431. <summary>
  27432. Return error information string
  27433. </summary>
  27434. <returns>error information string</returns>
  27435. <remarks>
  27436. <para>
  27437. Return error information string
  27438. </para>
  27439. </remarks>
  27440. </member>
  27441. <member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)">
  27442. <summary>
  27443. Formats a message string.
  27444. </summary>
  27445. <param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource" /> parameter.</param>
  27446. <param name="lpSource">Location of the message definition.</param>
  27447. <param name="dwMessageId">Message identifier for the requested message.</param>
  27448. <param name="dwLanguageId">Language identifier for the requested message.</param>
  27449. <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>
  27450. <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>
  27451. <param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param>
  27452. <remarks>
  27453. <para>
  27454. The function requires a message definition as input. The message definition can come from a
  27455. buffer passed into the function. It can come from a message table resource in an
  27456. already-loaded module. Or the caller can ask the function to search the system's message
  27457. table resource(s) for the message definition. The function finds the message definition
  27458. in a message table resource based on a message identifier and a language identifier.
  27459. The function copies the formatted message text to an output buffer, processing any embedded
  27460. insert sequences if requested.
  27461. </para>
  27462. <para>
  27463. To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message.
  27464. </para>
  27465. </remarks>
  27466. <returns>
  27467. <para>
  27468. If the function succeeds, the return value is the number of TCHARs stored in the output
  27469. buffer, excluding the terminating null character.
  27470. </para>
  27471. <para>
  27472. If the function fails, the return value is zero. To get extended error information,
  27473. call <see cref="M:Marshal.GetLastWin32Error()" />.
  27474. </para>
  27475. </returns>
  27476. </member>
  27477. <member name="T:log4net.Util.NullDictionaryEnumerator">
  27478. <summary>
  27479. An always empty <see cref="T:System.Collections.IDictionaryEnumerator"/>.
  27480. </summary>
  27481. <remarks>
  27482. <para>
  27483. A singleton implementation of the <see cref="T:System.Collections.IDictionaryEnumerator"/> over a collection
  27484. that is empty and not modifiable.
  27485. </para>
  27486. </remarks>
  27487. <author>Nicko Cadell</author>
  27488. <author>Gert Driesen</author>
  27489. </member>
  27490. <member name="M:log4net.Util.NullDictionaryEnumerator.#ctor">
  27491. <summary>
  27492. Initializes a new instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" /> class.
  27493. </summary>
  27494. <remarks>
  27495. <para>
  27496. Uses a private access modifier to enforce the singleton pattern.
  27497. </para>
  27498. </remarks>
  27499. </member>
  27500. <member name="P:log4net.Util.NullDictionaryEnumerator.Instance">
  27501. <summary>
  27502. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  27503. </summary>
  27504. <returns>The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.</returns>
  27505. <remarks>
  27506. <para>
  27507. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  27508. </para>
  27509. </remarks>
  27510. </member>
  27511. <member name="P:log4net.Util.NullDictionaryEnumerator.Current">
  27512. <summary>
  27513. Gets the current object from the enumerator.
  27514. </summary>
  27515. <remarks>
  27516. Throws an <see cref="T:System.InvalidOperationException" /> because the
  27517. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  27518. </remarks>
  27519. <remarks>
  27520. <para>
  27521. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27522. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27523. will throw an <see cref="T:System.InvalidOperationException"/>.
  27524. </para>
  27525. </remarks>
  27526. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27527. cannot be positioned over a valid location.</exception>
  27528. </member>
  27529. <member name="M:log4net.Util.NullDictionaryEnumerator.MoveNext">
  27530. <summary>
  27531. Test if the enumerator can advance, if so advance.
  27532. </summary>
  27533. <returns><c>false</c> as the <see cref="T:log4net.Util.NullDictionaryEnumerator" /> cannot advance.</returns>
  27534. <remarks>
  27535. <para>
  27536. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27537. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullDictionaryEnumerator.MoveNext"/>
  27538. will always return <c>false</c>.
  27539. </para>
  27540. </remarks>
  27541. </member>
  27542. <member name="M:log4net.Util.NullDictionaryEnumerator.Reset">
  27543. <summary>
  27544. Resets the enumerator back to the start.
  27545. </summary>
  27546. <remarks>
  27547. <para>
  27548. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullDictionaryEnumerator.Reset"/> does nothing.
  27549. </para>
  27550. </remarks>
  27551. </member>
  27552. <member name="P:log4net.Util.NullDictionaryEnumerator.Key">
  27553. <summary>
  27554. Gets the current key from the enumerator.
  27555. </summary>
  27556. <remarks>
  27557. Throws an exception because the <see cref="T:log4net.Util.NullDictionaryEnumerator" />
  27558. never has a current value.
  27559. </remarks>
  27560. <remarks>
  27561. <para>
  27562. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27563. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Key"/>
  27564. will throw an <see cref="T:System.InvalidOperationException"/>.
  27565. </para>
  27566. </remarks>
  27567. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27568. cannot be positioned over a valid location.</exception>
  27569. </member>
  27570. <member name="P:log4net.Util.NullDictionaryEnumerator.Value">
  27571. <summary>
  27572. Gets the current value from the enumerator.
  27573. </summary>
  27574. <value>The current value from the enumerator.</value>
  27575. <remarks>
  27576. Throws an <see cref="T:System.InvalidOperationException" /> because the
  27577. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  27578. </remarks>
  27579. <remarks>
  27580. <para>
  27581. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27582. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Value"/>
  27583. will throw an <see cref="T:System.InvalidOperationException"/>.
  27584. </para>
  27585. </remarks>
  27586. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27587. cannot be positioned over a valid location.</exception>
  27588. </member>
  27589. <member name="P:log4net.Util.NullDictionaryEnumerator.Entry">
  27590. <summary>
  27591. Gets the current entry from the enumerator.
  27592. </summary>
  27593. <remarks>
  27594. Throws an <see cref="T:System.InvalidOperationException" /> because the
  27595. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current entry.
  27596. </remarks>
  27597. <remarks>
  27598. <para>
  27599. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27600. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Entry"/>
  27601. will throw an <see cref="T:System.InvalidOperationException"/>.
  27602. </para>
  27603. </remarks>
  27604. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27605. cannot be positioned over a valid location.</exception>
  27606. </member>
  27607. <member name="F:log4net.Util.NullDictionaryEnumerator.s_instance">
  27608. <summary>
  27609. The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  27610. </summary>
  27611. </member>
  27612. <member name="T:log4net.Util.NullEnumerator">
  27613. <summary>
  27614. An always empty <see cref="T:System.Collections.IEnumerator"/>.
  27615. </summary>
  27616. <remarks>
  27617. <para>
  27618. A singleton implementation of the <see cref="T:System.Collections.IEnumerator"/> over a collection
  27619. that is empty and not modifiable.
  27620. </para>
  27621. </remarks>
  27622. <author>Nicko Cadell</author>
  27623. <author>Gert Driesen</author>
  27624. </member>
  27625. <member name="M:log4net.Util.NullEnumerator.#ctor">
  27626. <summary>
  27627. Initializes a new instance of the <see cref="T:log4net.Util.NullEnumerator" /> class.
  27628. </summary>
  27629. <remarks>
  27630. <para>
  27631. Uses a private access modifier to enforce the singleton pattern.
  27632. </para>
  27633. </remarks>
  27634. </member>
  27635. <member name="P:log4net.Util.NullEnumerator.Instance">
  27636. <summary>
  27637. Get the singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  27638. </summary>
  27639. <returns>The singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.</returns>
  27640. <remarks>
  27641. <para>
  27642. Gets the singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  27643. </para>
  27644. </remarks>
  27645. </member>
  27646. <member name="P:log4net.Util.NullEnumerator.Current">
  27647. <summary>
  27648. Gets the current object from the enumerator.
  27649. </summary>
  27650. <remarks>
  27651. Throws an <see cref="T:System.InvalidOperationException" /> because the
  27652. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  27653. </remarks>
  27654. <remarks>
  27655. <para>
  27656. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  27657. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullEnumerator.Current"/>
  27658. will throw an <see cref="T:System.InvalidOperationException"/>.
  27659. </para>
  27660. </remarks>
  27661. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullEnumerator.Current"/>
  27662. cannot be positioned over a valid location.</exception>
  27663. </member>
  27664. <member name="M:log4net.Util.NullEnumerator.MoveNext">
  27665. <summary>
  27666. Test if the enumerator can advance, if so advance
  27667. </summary>
  27668. <returns><c>false</c> as the <see cref="T:log4net.Util.NullEnumerator" /> cannot advance.</returns>
  27669. <remarks>
  27670. <para>
  27671. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  27672. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullEnumerator.MoveNext"/>
  27673. will always return <c>false</c>.
  27674. </para>
  27675. </remarks>
  27676. </member>
  27677. <member name="M:log4net.Util.NullEnumerator.Reset">
  27678. <summary>
  27679. Resets the enumerator back to the start.
  27680. </summary>
  27681. <remarks>
  27682. <para>
  27683. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullEnumerator.Reset"/> does nothing.
  27684. </para>
  27685. </remarks>
  27686. </member>
  27687. <member name="F:log4net.Util.NullEnumerator.s_instance">
  27688. <summary>
  27689. The singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  27690. </summary>
  27691. </member>
  27692. <member name="T:log4net.Util.NullSecurityContext">
  27693. <summary>
  27694. A SecurityContext used when a SecurityContext is not required
  27695. </summary>
  27696. <remarks>
  27697. <para>
  27698. The <see cref="T:log4net.Util.NullSecurityContext"/> is a no-op implementation of the
  27699. <see cref="T:log4net.Core.SecurityContext"/> base class. It is used where a <see cref="T:log4net.Core.SecurityContext"/>
  27700. is required but one has not been provided.
  27701. </para>
  27702. </remarks>
  27703. <author>Nicko Cadell</author>
  27704. </member>
  27705. <member name="F:log4net.Util.NullSecurityContext.Instance">
  27706. <summary>
  27707. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  27708. </summary>
  27709. <remarks>
  27710. <para>
  27711. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  27712. </para>
  27713. </remarks>
  27714. </member>
  27715. <member name="M:log4net.Util.NullSecurityContext.#ctor">
  27716. <summary>
  27717. Private constructor
  27718. </summary>
  27719. <remarks>
  27720. <para>
  27721. Private constructor for singleton pattern.
  27722. </para>
  27723. </remarks>
  27724. </member>
  27725. <member name="M:log4net.Util.NullSecurityContext.Impersonate(System.Object)">
  27726. <summary>
  27727. Impersonate this SecurityContext
  27728. </summary>
  27729. <param name="state">State supplied by the caller</param>
  27730. <returns><c>null</c></returns>
  27731. <remarks>
  27732. <para>
  27733. No impersonation is done and <c>null</c> is always returned.
  27734. </para>
  27735. </remarks>
  27736. </member>
  27737. <member name="T:log4net.Util.OnlyOnceErrorHandler">
  27738. <summary>
  27739. Implements log4net's default error handling policy which consists
  27740. of emitting a message for the first error in an appender and
  27741. ignoring all subsequent errors.
  27742. </summary>
  27743. <remarks>
  27744. <para>
  27745. The error message is processed using the LogLog sub-system by default.
  27746. </para>
  27747. <para>
  27748. This policy aims at protecting an otherwise working application
  27749. from being flooded with error messages when logging fails.
  27750. </para>
  27751. </remarks>
  27752. <author>Nicko Cadell</author>
  27753. <author>Gert Driesen</author>
  27754. <author>Ron Grabowski</author>
  27755. </member>
  27756. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor">
  27757. <summary>
  27758. Default Constructor
  27759. </summary>
  27760. <remarks>
  27761. <para>
  27762. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler" /> class.
  27763. </para>
  27764. </remarks>
  27765. </member>
  27766. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor(System.String)">
  27767. <summary>
  27768. Constructor
  27769. </summary>
  27770. <param name="prefix">The prefix to use for each message.</param>
  27771. <remarks>
  27772. <para>
  27773. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler" /> class
  27774. with the specified prefix.
  27775. </para>
  27776. </remarks>
  27777. </member>
  27778. <member name="M:log4net.Util.OnlyOnceErrorHandler.Reset">
  27779. <summary>
  27780. Reset the error handler back to its initial disabled state.
  27781. </summary>
  27782. </member>
  27783. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  27784. <summary>
  27785. Log an Error
  27786. </summary>
  27787. <param name="message">The error message.</param>
  27788. <param name="e">The exception.</param>
  27789. <param name="errorCode">The internal error code.</param>
  27790. <remarks>
  27791. <para>
  27792. 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.
  27793. </para>
  27794. </remarks>
  27795. </member>
  27796. <member name="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)">
  27797. <summary>
  27798. Log the very first error
  27799. </summary>
  27800. <param name="message">The error message.</param>
  27801. <param name="e">The exception.</param>
  27802. <param name="errorCode">The internal error code.</param>
  27803. <remarks>
  27804. <para>
  27805. Sends the error information to <see cref="T:log4net.Util.LogLog"/>'s Error method.
  27806. </para>
  27807. </remarks>
  27808. </member>
  27809. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception)">
  27810. <summary>
  27811. Log an Error
  27812. </summary>
  27813. <param name="message">The error message.</param>
  27814. <param name="e">The exception.</param>
  27815. <remarks>
  27816. <para>
  27817. 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.
  27818. </para>
  27819. </remarks>
  27820. </member>
  27821. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String)">
  27822. <summary>
  27823. Log an error
  27824. </summary>
  27825. <param name="message">The error message.</param>
  27826. <remarks>
  27827. <para>
  27828. 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.
  27829. </para>
  27830. </remarks>
  27831. </member>
  27832. <member name="P:log4net.Util.OnlyOnceErrorHandler.IsEnabled">
  27833. <summary>
  27834. Is error logging enabled
  27835. </summary>
  27836. <remarks>
  27837. <para>
  27838. Is error logging enabled. Logging is only enabled for the
  27839. first error delivered to the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/>.
  27840. </para>
  27841. </remarks>
  27842. </member>
  27843. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDate">
  27844. <summary>
  27845. The date the first error that trigged this error handler occurred, or <see cref="F:System.DateTime.MinValue"/> if it has not been triggered.
  27846. </summary>
  27847. </member>
  27848. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDateUtc">
  27849. <summary>
  27850. 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.
  27851. </summary>
  27852. </member>
  27853. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorMessage">
  27854. <summary>
  27855. The message from the first error that trigged this error handler.
  27856. </summary>
  27857. </member>
  27858. <member name="P:log4net.Util.OnlyOnceErrorHandler.Exception">
  27859. <summary>
  27860. The exception from the first error that trigged this error handler.
  27861. </summary>
  27862. <remarks>
  27863. May be <see langword="null" />.
  27864. </remarks>
  27865. </member>
  27866. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorCode">
  27867. <summary>
  27868. The error code from the first error that trigged this error handler.
  27869. </summary>
  27870. <remarks>
  27871. Defaults to <see cref="F:log4net.Core.ErrorCode.GenericFailure"/>
  27872. </remarks>
  27873. </member>
  27874. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_enabledDateUtc">
  27875. <summary>
  27876. The UTC date the error was recorded.
  27877. </summary>
  27878. </member>
  27879. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_firstTime">
  27880. <summary>
  27881. Flag to indicate if it is the first error
  27882. </summary>
  27883. </member>
  27884. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_message">
  27885. <summary>
  27886. The message recorded during the first error.
  27887. </summary>
  27888. </member>
  27889. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_exception">
  27890. <summary>
  27891. The exception recorded during the first error.
  27892. </summary>
  27893. </member>
  27894. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_errorCode">
  27895. <summary>
  27896. The error code recorded during the first error.
  27897. </summary>
  27898. </member>
  27899. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_prefix">
  27900. <summary>
  27901. String to prefix each message with
  27902. </summary>
  27903. </member>
  27904. <member name="F:log4net.Util.OnlyOnceErrorHandler.declaringType">
  27905. <summary>
  27906. The fully qualified type of the OnlyOnceErrorHandler class.
  27907. </summary>
  27908. <remarks>
  27909. Used by the internal logger to record the Type of the
  27910. log message.
  27911. </remarks>
  27912. </member>
  27913. <member name="T:log4net.Util.OptionConverter">
  27914. <summary>
  27915. A convenience class to convert property values to specific types.
  27916. </summary>
  27917. <remarks>
  27918. <para>
  27919. Utility functions for converting types and parsing values.
  27920. </para>
  27921. </remarks>
  27922. <author>Nicko Cadell</author>
  27923. <author>Gert Driesen</author>
  27924. </member>
  27925. <member name="M:log4net.Util.OptionConverter.#ctor">
  27926. <summary>
  27927. Initializes a new instance of the <see cref="T:log4net.Util.OptionConverter" /> class.
  27928. </summary>
  27929. <remarks>
  27930. <para>
  27931. Uses a private access modifier to prevent instantiation of this class.
  27932. </para>
  27933. </remarks>
  27934. </member>
  27935. <member name="M:log4net.Util.OptionConverter.ToBoolean(System.String,System.Boolean)">
  27936. <summary>
  27937. Converts a string to a <see cref="T:System.Boolean" /> value.
  27938. </summary>
  27939. <param name="argValue">String to convert.</param>
  27940. <param name="defaultValue">The default value.</param>
  27941. <returns>The <see cref="T:System.Boolean" /> value of <paramref name="argValue" />.</returns>
  27942. <remarks>
  27943. <para>
  27944. If <paramref name="argValue"/> is "true", then <c>true</c> is returned.
  27945. If <paramref name="argValue"/> is "false", then <c>false</c> is returned.
  27946. Otherwise, <paramref name="defaultValue"/> is returned.
  27947. </para>
  27948. </remarks>
  27949. </member>
  27950. <member name="M:log4net.Util.OptionConverter.ToFileSize(System.String,System.Int64)">
  27951. <summary>
  27952. Parses a file size into a number.
  27953. </summary>
  27954. <param name="argValue">String to parse.</param>
  27955. <param name="defaultValue">The default value.</param>
  27956. <returns>The <see cref="T:System.Int64" /> value of <paramref name="argValue" />.</returns>
  27957. <remarks>
  27958. <para>
  27959. Parses a file size of the form: number[KB|MB|GB] into a
  27960. long value. It is scaled with the appropriate multiplier.
  27961. </para>
  27962. <para>
  27963. <paramref name="defaultValue"/> is returned when <paramref name="argValue"/>
  27964. cannot be converted to a <see cref="T:System.Int64" /> value.
  27965. </para>
  27966. </remarks>
  27967. </member>
  27968. <member name="M:log4net.Util.OptionConverter.ConvertStringTo(System.Type,System.String)">
  27969. <summary>
  27970. Converts a string to an object.
  27971. </summary>
  27972. <param name="target">The target type to convert to.</param>
  27973. <param name="txt">The string to convert to an object.</param>
  27974. <returns>
  27975. The object converted from a string or <c>null</c> when the
  27976. conversion failed.
  27977. </returns>
  27978. <remarks>
  27979. <para>
  27980. Converts a string to an object. Uses the converter registry to try
  27981. to convert the string value into the specified target type.
  27982. </para>
  27983. </remarks>
  27984. </member>
  27985. <member name="M:log4net.Util.OptionConverter.CanConvertTypeTo(System.Type,System.Type)">
  27986. <summary>
  27987. Checks if there is an appropriate type conversion from the source type to the target type.
  27988. </summary>
  27989. <param name="sourceType">The type to convert from.</param>
  27990. <param name="targetType">The type to convert to.</param>
  27991. <returns><c>true</c> if there is a conversion from the source type to the target type.</returns>
  27992. <remarks>
  27993. Checks if there is an appropriate type conversion from the source type to the target type.
  27994. <para>
  27995. </para>
  27996. </remarks>
  27997. </member>
  27998. <member name="M:log4net.Util.OptionConverter.ConvertTypeTo(System.Object,System.Type)">
  27999. <summary>
  28000. Converts an object to the target type.
  28001. </summary>
  28002. <param name="sourceInstance">The object to convert to the target type.</param>
  28003. <param name="targetType">The type to convert to.</param>
  28004. <returns>The converted object.</returns>
  28005. <remarks>
  28006. <para>
  28007. Converts an object to the target type.
  28008. </para>
  28009. </remarks>
  28010. </member>
  28011. <member name="M:log4net.Util.OptionConverter.InstantiateByClassName(System.String,System.Type,System.Object)">
  28012. <summary>
  28013. Instantiates an object given a class name.
  28014. </summary>
  28015. <param name="className">The fully qualified class name of the object to instantiate.</param>
  28016. <param name="superClass">The class to which the new object should belong.</param>
  28017. <param name="defaultValue">The object to return in case of non-fulfillment.</param>
  28018. <returns>
  28019. An instance of the <paramref name="className"/> or <paramref name="defaultValue"/>
  28020. if the object could not be instantiated.
  28021. </returns>
  28022. <remarks>
  28023. <para>
  28024. Checks that the <paramref name="className"/> is a subclass of
  28025. <paramref name="superClass"/>. If that test fails or the object could
  28026. not be instantiated, then <paramref name="defaultValue"/> is returned.
  28027. </para>
  28028. </remarks>
  28029. </member>
  28030. <member name="M:log4net.Util.OptionConverter.SubstituteVariables(System.String,System.Collections.IDictionary)">
  28031. <summary>
  28032. Performs variable substitution in string <paramref name="value"/> from the
  28033. values of keys found in <paramref name="props"/>.
  28034. </summary>
  28035. <param name="value">The string on which variable substitution is performed.</param>
  28036. <param name="props">The dictionary to use to lookup variables.</param>
  28037. <returns>The result of the substitutions.</returns>
  28038. <remarks>
  28039. <para>
  28040. The variable substitution delimiters are <b>${</b> and <b>}</b>.
  28041. </para>
  28042. <para>
  28043. For example, if props contains <c>key=value</c>, then the call
  28044. </para>
  28045. <para>
  28046. <code lang="C#">
  28047. string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
  28048. </code>
  28049. </para>
  28050. <para>
  28051. will set the variable <c>s</c> to "Value of key is value.".
  28052. </para>
  28053. <para>
  28054. If no value could be found for the specified key, then substitution
  28055. defaults to an empty string.
  28056. </para>
  28057. <para>
  28058. For example, if system properties contains no value for the key
  28059. "nonExistentKey", then the call
  28060. </para>
  28061. <para>
  28062. <code lang="C#">
  28063. string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
  28064. </code>
  28065. </para>
  28066. <para>
  28067. will set <s>s</s> to "Value of nonExistentKey is []".
  28068. </para>
  28069. <para>
  28070. An Exception is thrown if <paramref name="value"/> contains a start
  28071. delimiter "${" which is not balanced by a stop delimiter "}".
  28072. </para>
  28073. </remarks>
  28074. </member>
  28075. <member name="M:log4net.Util.OptionConverter.ParseEnum(System.Type,System.String,System.Boolean)">
  28076. <summary>
  28077. Converts the string representation of the name or numeric value of one or
  28078. more enumerated constants to an equivalent enumerated object.
  28079. </summary>
  28080. <param name="enumType">The type to convert to.</param>
  28081. <param name="value">The enum string value.</param>
  28082. <param name="ignoreCase">If <c>true</c>, ignore case; otherwise, regard case.</param>
  28083. <returns>An object of type <paramref name="enumType" /> whose value is represented by <paramref name="value" />.</returns>
  28084. </member>
  28085. <member name="F:log4net.Util.OptionConverter.declaringType">
  28086. <summary>
  28087. The fully qualified type of the OptionConverter class.
  28088. </summary>
  28089. <remarks>
  28090. Used by the internal logger to record the Type of the
  28091. log message.
  28092. </remarks>
  28093. </member>
  28094. <member name="T:log4net.Util.PatternConverter">
  28095. <summary>
  28096. Abstract class that provides the formatting functionality that
  28097. derived classes need.
  28098. </summary>
  28099. <remarks>
  28100. <para>
  28101. Conversion specifiers in a conversion patterns are parsed to
  28102. individual PatternConverters. Each of which is responsible for
  28103. converting a logging event in a converter specific manner.
  28104. </para>
  28105. </remarks>
  28106. <author>Nicko Cadell</author>
  28107. <author>Gert Driesen</author>
  28108. </member>
  28109. <member name="M:log4net.Util.PatternConverter.#ctor">
  28110. <summary>
  28111. Protected constructor
  28112. </summary>
  28113. <remarks>
  28114. <para>
  28115. Initializes a new instance of the <see cref="T:log4net.Util.PatternConverter" /> class.
  28116. </para>
  28117. </remarks>
  28118. </member>
  28119. <member name="P:log4net.Util.PatternConverter.Next">
  28120. <summary>
  28121. Get the next pattern converter in the chain
  28122. </summary>
  28123. <value>
  28124. the next pattern converter in the chain
  28125. </value>
  28126. <remarks>
  28127. <para>
  28128. Get the next pattern converter in the chain
  28129. </para>
  28130. </remarks>
  28131. </member>
  28132. <member name="P:log4net.Util.PatternConverter.FormattingInfo">
  28133. <summary>
  28134. Gets or sets the formatting info for this converter
  28135. </summary>
  28136. <value>
  28137. The formatting info for this converter
  28138. </value>
  28139. <remarks>
  28140. <para>
  28141. Gets or sets the formatting info for this converter
  28142. </para>
  28143. </remarks>
  28144. </member>
  28145. <member name="P:log4net.Util.PatternConverter.Option">
  28146. <summary>
  28147. Gets or sets the option value for this converter
  28148. </summary>
  28149. <summary>
  28150. The option for this converter
  28151. </summary>
  28152. <remarks>
  28153. <para>
  28154. Gets or sets the option value for this converter
  28155. </para>
  28156. </remarks>
  28157. </member>
  28158. <member name="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)">
  28159. <summary>
  28160. Evaluate this pattern converter and write the output to a writer.
  28161. </summary>
  28162. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  28163. <param name="state">The state object on which the pattern converter should be executed.</param>
  28164. <remarks>
  28165. <para>
  28166. Derived pattern converters must override this method in order to
  28167. convert conversion specifiers in the appropriate way.
  28168. </para>
  28169. </remarks>
  28170. </member>
  28171. <member name="M:log4net.Util.PatternConverter.SetNext(log4net.Util.PatternConverter)">
  28172. <summary>
  28173. Set the next pattern converter in the chains
  28174. </summary>
  28175. <param name="patternConverter">the pattern converter that should follow this converter in the chain</param>
  28176. <returns>the next converter</returns>
  28177. <remarks>
  28178. <para>
  28179. The PatternConverter can merge with its neighbor during this method (or a sub class).
  28180. Therefore the return value may or may not be the value of the argument passed in.
  28181. </para>
  28182. </remarks>
  28183. </member>
  28184. <member name="M:log4net.Util.PatternConverter.Format(System.IO.TextWriter,System.Object)">
  28185. <summary>
  28186. Write the pattern converter to the writer with appropriate formatting
  28187. </summary>
  28188. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  28189. <param name="state">The state object on which the pattern converter should be executed.</param>
  28190. <remarks>
  28191. <para>
  28192. This method calls <see cref="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"/> to allow the subclass to perform
  28193. appropriate conversion of the pattern converter. If formatting options have
  28194. been specified via the <see cref="P:log4net.Util.PatternConverter.FormattingInfo"/> then this method will
  28195. apply those formattings before writing the output.
  28196. </para>
  28197. </remarks>
  28198. </member>
  28199. <member name="M:log4net.Util.PatternConverter.SpacePad(System.IO.TextWriter,System.Int32)">
  28200. <summary>
  28201. Fast space padding method.
  28202. </summary>
  28203. <param name="writer"><see cref="T:System.IO.TextWriter" /> to which the spaces will be appended.</param>
  28204. <param name="length">The number of spaces to be padded.</param>
  28205. <remarks>
  28206. <para>
  28207. Fast space padding method.
  28208. </para>
  28209. </remarks>
  28210. </member>
  28211. <member name="F:log4net.Util.PatternConverter.m_option">
  28212. <summary>
  28213. The option string to the converter
  28214. </summary>
  28215. </member>
  28216. <member name="F:log4net.Util.PatternConverter.c_renderBufferSize">
  28217. <summary>
  28218. Initial buffer size
  28219. </summary>
  28220. </member>
  28221. <member name="F:log4net.Util.PatternConverter.c_renderBufferMaxCapacity">
  28222. <summary>
  28223. Maximum buffer size before it is recycled
  28224. </summary>
  28225. </member>
  28226. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionary)">
  28227. <summary>
  28228. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  28229. </summary>
  28230. <param name="writer">the writer to write to</param>
  28231. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  28232. <param name="value">the value to write to the writer</param>
  28233. <remarks>
  28234. <para>
  28235. Writes the <see cref="T:System.Collections.IDictionary"/> to a writer in the form:
  28236. </para>
  28237. <code>
  28238. {key1=value1, key2=value2, key3=value3}
  28239. </code>
  28240. <para>
  28241. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  28242. is not null then it is used to render the key and value to text, otherwise
  28243. the object's ToString method is called.
  28244. </para>
  28245. </remarks>
  28246. </member>
  28247. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionaryEnumerator)">
  28248. <summary>
  28249. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  28250. </summary>
  28251. <param name="writer">the writer to write to</param>
  28252. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  28253. <param name="value">the value to write to the writer</param>
  28254. <remarks>
  28255. <para>
  28256. Writes the <see cref="T:System.Collections.IDictionaryEnumerator"/> to a writer in the form:
  28257. </para>
  28258. <code>
  28259. {key1=value1, key2=value2, key3=value3}
  28260. </code>
  28261. <para>
  28262. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  28263. is not null then it is used to render the key and value to text, otherwise
  28264. the object's ToString method is called.
  28265. </para>
  28266. </remarks>
  28267. </member>
  28268. <member name="M:log4net.Util.PatternConverter.WriteObject(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Object)">
  28269. <summary>
  28270. Write an object to a <see cref="T:System.IO.TextWriter"/>
  28271. </summary>
  28272. <param name="writer">the writer to write to</param>
  28273. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  28274. <param name="value">the value to write to the writer</param>
  28275. <remarks>
  28276. <para>
  28277. Writes the Object to a writer. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  28278. is not null then it is used to render the object to text, otherwise
  28279. the object's ToString method is called.
  28280. </para>
  28281. </remarks>
  28282. </member>
  28283. <member name="P:log4net.Util.PatternConverter.Properties">
  28284. <summary>
  28285. </summary>
  28286. </member>
  28287. <member name="T:log4net.Util.PatternParser">
  28288. <summary>
  28289. Most of the work of the <see cref="T:log4net.Layout.PatternLayout"/> class
  28290. is delegated to the PatternParser class.
  28291. </summary>
  28292. <remarks>
  28293. <para>
  28294. The <c>PatternParser</c> processes a pattern string and
  28295. returns a chain of <see cref="T:log4net.Util.PatternConverter"/> objects.
  28296. </para>
  28297. </remarks>
  28298. <author>Nicko Cadell</author>
  28299. <author>Gert Driesen</author>
  28300. </member>
  28301. <member name="M:log4net.Util.PatternParser.#ctor(System.String)">
  28302. <summary>
  28303. Constructor
  28304. </summary>
  28305. <param name="pattern">The pattern to parse.</param>
  28306. <remarks>
  28307. <para>
  28308. Initializes a new instance of the <see cref="T:log4net.Util.PatternParser" /> class
  28309. with the specified pattern string.
  28310. </para>
  28311. </remarks>
  28312. </member>
  28313. <member name="M:log4net.Util.PatternParser.Parse">
  28314. <summary>
  28315. Parses the pattern into a chain of pattern converters.
  28316. </summary>
  28317. <returns>The head of a chain of pattern converters.</returns>
  28318. <remarks>
  28319. <para>
  28320. Parses the pattern into a chain of pattern converters.
  28321. </para>
  28322. </remarks>
  28323. </member>
  28324. <member name="P:log4net.Util.PatternParser.PatternConverters">
  28325. <summary>
  28326. Get the converter registry used by this parser
  28327. </summary>
  28328. <value>
  28329. The converter registry used by this parser
  28330. </value>
  28331. <remarks>
  28332. <para>
  28333. Get the converter registry used by this parser
  28334. </para>
  28335. </remarks>
  28336. </member>
  28337. <member name="M:log4net.Util.PatternParser.BuildCache">
  28338. <summary>
  28339. Build the unified cache of converters from the static and instance maps
  28340. </summary>
  28341. <returns>the list of all the converter names</returns>
  28342. <remarks>
  28343. <para>
  28344. Build the unified cache of converters from the static and instance maps
  28345. </para>
  28346. </remarks>
  28347. </member>
  28348. <member name="T:log4net.Util.PatternParser.StringLengthComparer">
  28349. <summary>
  28350. Sort strings by length
  28351. </summary>
  28352. <remarks>
  28353. <para>
  28354. <see cref="T:System.Collections.IComparer" /> that orders strings by string length.
  28355. The longest strings are placed first
  28356. </para>
  28357. </remarks>
  28358. </member>
  28359. <member name="M:log4net.Util.PatternParser.ParseInternal(System.String,System.String[])">
  28360. <summary>
  28361. Internal method to parse the specified pattern to find specified matches
  28362. </summary>
  28363. <param name="pattern">the pattern to parse</param>
  28364. <param name="matches">the converter names to match in the pattern</param>
  28365. <remarks>
  28366. <para>
  28367. The matches param must be sorted such that longer strings come before shorter ones.
  28368. </para>
  28369. </remarks>
  28370. </member>
  28371. <member name="M:log4net.Util.PatternParser.ProcessLiteral(System.String)">
  28372. <summary>
  28373. Process a parsed literal
  28374. </summary>
  28375. <param name="text">the literal text</param>
  28376. </member>
  28377. <member name="M:log4net.Util.PatternParser.ProcessConverter(System.String,System.String,log4net.Util.FormattingInfo)">
  28378. <summary>
  28379. Process a parsed converter pattern
  28380. </summary>
  28381. <param name="converterName">the name of the converter</param>
  28382. <param name="option">the optional option for the converter</param>
  28383. <param name="formattingInfo">the formatting info for the converter</param>
  28384. </member>
  28385. <member name="M:log4net.Util.PatternParser.AddConverter(log4net.Util.PatternConverter)">
  28386. <summary>
  28387. Resets the internal state of the parser and adds the specified pattern converter
  28388. to the chain.
  28389. </summary>
  28390. <param name="pc">The pattern converter to add.</param>
  28391. </member>
  28392. <member name="F:log4net.Util.PatternParser.m_head">
  28393. <summary>
  28394. The first pattern converter in the chain
  28395. </summary>
  28396. </member>
  28397. <member name="F:log4net.Util.PatternParser.m_tail">
  28398. <summary>
  28399. the last pattern converter in the chain
  28400. </summary>
  28401. </member>
  28402. <member name="F:log4net.Util.PatternParser.m_pattern">
  28403. <summary>
  28404. The pattern
  28405. </summary>
  28406. </member>
  28407. <member name="F:log4net.Util.PatternParser.m_patternConverters">
  28408. <summary>
  28409. Internal map of converter identifiers to converter types
  28410. </summary>
  28411. <remarks>
  28412. <para>
  28413. This map overrides the static s_globalRulesRegistry map.
  28414. </para>
  28415. </remarks>
  28416. </member>
  28417. <member name="F:log4net.Util.PatternParser.declaringType">
  28418. <summary>
  28419. The fully qualified type of the PatternParser class.
  28420. </summary>
  28421. <remarks>
  28422. Used by the internal logger to record the Type of the
  28423. log message.
  28424. </remarks>
  28425. </member>
  28426. <member name="T:log4net.Util.PatternString">
  28427. <summary>
  28428. This class implements a patterned string.
  28429. </summary>
  28430. <remarks>
  28431. <para>
  28432. This string has embedded patterns that are resolved and expanded
  28433. when the string is formatted.
  28434. </para>
  28435. <para>
  28436. This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/>
  28437. in that it accepts a pattern and renders it to a string. Unlike the
  28438. <see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c>
  28439. does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
  28440. of the process in general.
  28441. </para>
  28442. <para>
  28443. The recognized conversion pattern names are:
  28444. </para>
  28445. <list type="table">
  28446. <listheader>
  28447. <term>Conversion Pattern Name</term>
  28448. <description>Effect</description>
  28449. </listheader>
  28450. <item>
  28451. <term>appdomain</term>
  28452. <description>
  28453. <para>
  28454. Used to output the friendly name of the current AppDomain.
  28455. </para>
  28456. </description>
  28457. </item>
  28458. <item>
  28459. <term>appsetting</term>
  28460. <description>
  28461. <para>
  28462. Used to output the value of a specific appSetting key in the application
  28463. configuration file.
  28464. </para>
  28465. </description>
  28466. </item>
  28467. <item>
  28468. <term>date</term>
  28469. <description>
  28470. <para>
  28471. Used to output the current date and time in the local time zone.
  28472. To output the date in universal time use the <c>%utcdate</c> pattern.
  28473. The date conversion
  28474. specifier may be followed by a <i>date format specifier</i> enclosed
  28475. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  28476. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  28477. given then ISO8601 format is
  28478. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  28479. </para>
  28480. <para>
  28481. The date format specifier admits the same syntax as the
  28482. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  28483. </para>
  28484. <para>
  28485. For better results it is recommended to use the log4net date
  28486. formatters. These can be specified using one of the strings
  28487. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  28488. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  28489. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  28490. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  28491. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  28492. </para>
  28493. <para>
  28494. These dedicated date formatters perform significantly
  28495. better than <see cref="M:DateTime.ToString(string)"/>.
  28496. </para>
  28497. </description>
  28498. </item>
  28499. <item>
  28500. <term>env</term>
  28501. <description>
  28502. <para>
  28503. Used to output the a specific environment variable. The key to
  28504. lookup must be specified within braces and directly following the
  28505. pattern specifier, e.g. <b>%env{COMPUTERNAME}</b> would include the value
  28506. of the <c>COMPUTERNAME</c> environment variable.
  28507. </para>
  28508. <para>
  28509. The <c>env</c> pattern is not supported on the .NET Compact Framework.
  28510. </para>
  28511. </description>
  28512. </item>
  28513. <item>
  28514. <term>identity</term>
  28515. <description>
  28516. <para>
  28517. Used to output the user name for the currently active user
  28518. (Principal.Identity.Name).
  28519. </para>
  28520. </description>
  28521. </item>
  28522. <item>
  28523. <term>newline</term>
  28524. <description>
  28525. <para>
  28526. Outputs the platform dependent line separator character or
  28527. characters.
  28528. </para>
  28529. <para>
  28530. This conversion pattern name offers the same performance as using
  28531. non-portable line separator strings such as "\n", or "\r\n".
  28532. Thus, it is the preferred way of specifying a line separator.
  28533. </para>
  28534. </description>
  28535. </item>
  28536. <item>
  28537. <term>processid</term>
  28538. <description>
  28539. <para>
  28540. Used to output the system process ID for the current process.
  28541. </para>
  28542. </description>
  28543. </item>
  28544. <item>
  28545. <term>property</term>
  28546. <description>
  28547. <para>
  28548. Used to output a specific context property. The key to
  28549. lookup must be specified within braces and directly following the
  28550. pattern specifier, e.g. <b>%property{user}</b> would include the value
  28551. from the property that is keyed by the string 'user'. Each property value
  28552. that is to be included in the log must be specified separately.
  28553. Properties are stored in logging contexts. By default
  28554. the <c>log4net:HostName</c> property is set to the name of machine on
  28555. which the event was originally logged.
  28556. </para>
  28557. <para>
  28558. If no key is specified, e.g. <b>%property</b> then all the keys and their
  28559. values are printed in a comma separated list.
  28560. </para>
  28561. <para>
  28562. The properties of an event are combined from a number of different
  28563. contexts. These are listed below in the order in which they are searched.
  28564. </para>
  28565. <list type="definition">
  28566. <item>
  28567. <term>the thread properties</term>
  28568. <description>
  28569. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  28570. thread. These properties are shared by all events logged on this thread.
  28571. </description>
  28572. </item>
  28573. <item>
  28574. <term>the global properties</term>
  28575. <description>
  28576. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  28577. properties are shared by all the threads in the AppDomain.
  28578. </description>
  28579. </item>
  28580. </list>
  28581. </description>
  28582. </item>
  28583. <item>
  28584. <term>random</term>
  28585. <description>
  28586. <para>
  28587. Used to output a random string of characters. The string is made up of
  28588. uppercase letters and numbers. By default the string is 4 characters long.
  28589. The length of the string can be specified within braces directly following the
  28590. pattern specifier, e.g. <b>%random{8}</b> would output an 8 character string.
  28591. </para>
  28592. </description>
  28593. </item>
  28594. <item>
  28595. <term>username</term>
  28596. <description>
  28597. <para>
  28598. Used to output the WindowsIdentity for the currently
  28599. active user.
  28600. </para>
  28601. </description>
  28602. </item>
  28603. <item>
  28604. <term>utcdate</term>
  28605. <description>
  28606. <para>
  28607. Used to output the date of the logging event in universal time.
  28608. The date conversion
  28609. specifier may be followed by a <i>date format specifier</i> enclosed
  28610. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  28611. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  28612. given then ISO8601 format is
  28613. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  28614. </para>
  28615. <para>
  28616. The date format specifier admits the same syntax as the
  28617. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  28618. </para>
  28619. <para>
  28620. For better results it is recommended to use the log4net date
  28621. formatters. These can be specified using one of the strings
  28622. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  28623. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  28624. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  28625. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  28626. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  28627. </para>
  28628. <para>
  28629. These dedicated date formatters perform significantly
  28630. better than <see cref="M:DateTime.ToString(string)"/>.
  28631. </para>
  28632. </description>
  28633. </item>
  28634. <item>
  28635. <term>%</term>
  28636. <description>
  28637. <para>
  28638. The sequence %% outputs a single percent sign.
  28639. </para>
  28640. </description>
  28641. </item>
  28642. </list>
  28643. <para>
  28644. Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/>
  28645. instance using <see cref="M:AddConverter(ConverterInfo)"/> or
  28646. <see cref="M:AddConverter(string, Type)" />.
  28647. </para>
  28648. <para>
  28649. See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the
  28650. <i>format modifiers</i> supported by the patterns.
  28651. </para>
  28652. </remarks>
  28653. <author>Nicko Cadell</author>
  28654. </member>
  28655. <member name="F:log4net.Util.PatternString.s_globalRulesRegistry">
  28656. <summary>
  28657. Internal map of converter identifiers to converter types.
  28658. </summary>
  28659. </member>
  28660. <member name="F:log4net.Util.PatternString.m_pattern">
  28661. <summary>
  28662. the pattern
  28663. </summary>
  28664. </member>
  28665. <member name="F:log4net.Util.PatternString.m_head">
  28666. <summary>
  28667. the head of the pattern converter chain
  28668. </summary>
  28669. </member>
  28670. <member name="F:log4net.Util.PatternString.m_instanceRulesRegistry">
  28671. <summary>
  28672. patterns defined on this PatternString only
  28673. </summary>
  28674. </member>
  28675. <member name="M:log4net.Util.PatternString.#cctor">
  28676. <summary>
  28677. Initialize the global registry
  28678. </summary>
  28679. </member>
  28680. <member name="M:log4net.Util.PatternString.#ctor">
  28681. <summary>
  28682. Default constructor
  28683. </summary>
  28684. <remarks>
  28685. <para>
  28686. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/>
  28687. </para>
  28688. </remarks>
  28689. </member>
  28690. <member name="M:log4net.Util.PatternString.#ctor(System.String)">
  28691. <summary>
  28692. Constructs a PatternString
  28693. </summary>
  28694. <param name="pattern">The pattern to use with this PatternString</param>
  28695. <remarks>
  28696. <para>
  28697. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> with the pattern specified.
  28698. </para>
  28699. </remarks>
  28700. </member>
  28701. <member name="P:log4net.Util.PatternString.ConversionPattern">
  28702. <summary>
  28703. Gets or sets the pattern formatting string
  28704. </summary>
  28705. <value>
  28706. The pattern formatting string
  28707. </value>
  28708. <remarks>
  28709. <para>
  28710. The <b>ConversionPattern</b> option. This is the string which
  28711. controls formatting and consists of a mix of literal content and
  28712. conversion specifiers.
  28713. </para>
  28714. </remarks>
  28715. </member>
  28716. <member name="M:log4net.Util.PatternString.ActivateOptions">
  28717. <summary>
  28718. Initialize object options
  28719. </summary>
  28720. <remarks>
  28721. <para>
  28722. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  28723. activation scheme. The <see cref="M:log4net.Util.PatternString.ActivateOptions"/> method must
  28724. be called on this object after the configuration properties have
  28725. been set. Until <see cref="M:log4net.Util.PatternString.ActivateOptions"/> is called this
  28726. object is in an undefined state and must not be used.
  28727. </para>
  28728. <para>
  28729. If any of the configuration properties are modified then
  28730. <see cref="M:log4net.Util.PatternString.ActivateOptions"/> must be called again.
  28731. </para>
  28732. </remarks>
  28733. </member>
  28734. <member name="M:log4net.Util.PatternString.CreatePatternParser(System.String)">
  28735. <summary>
  28736. Create the <see cref="T:log4net.Util.PatternParser"/> used to parse the pattern
  28737. </summary>
  28738. <param name="pattern">the pattern to parse</param>
  28739. <returns>The <see cref="T:log4net.Util.PatternParser"/></returns>
  28740. <remarks>
  28741. <para>
  28742. Returns PatternParser used to parse the conversion string. Subclasses
  28743. may override this to return a subclass of PatternParser which recognize
  28744. custom conversion pattern name.
  28745. </para>
  28746. </remarks>
  28747. </member>
  28748. <member name="M:log4net.Util.PatternString.Format(System.IO.TextWriter)">
  28749. <summary>
  28750. Produces a formatted string as specified by the conversion pattern.
  28751. </summary>
  28752. <param name="writer">The TextWriter to write the formatted event to</param>
  28753. <remarks>
  28754. <para>
  28755. Format the pattern to the <paramref name="writer"/>.
  28756. </para>
  28757. </remarks>
  28758. </member>
  28759. <member name="M:log4net.Util.PatternString.Format">
  28760. <summary>
  28761. Format the pattern as a string
  28762. </summary>
  28763. <returns>the pattern formatted as a string</returns>
  28764. <remarks>
  28765. <para>
  28766. Format the pattern to a string.
  28767. </para>
  28768. </remarks>
  28769. </member>
  28770. <member name="M:log4net.Util.PatternString.AddConverter(log4net.Util.ConverterInfo)">
  28771. <summary>
  28772. Add a converter to this PatternString
  28773. </summary>
  28774. <param name="converterInfo">the converter info</param>
  28775. <remarks>
  28776. <para>
  28777. This version of the method is used by the configurator.
  28778. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  28779. </para>
  28780. </remarks>
  28781. </member>
  28782. <member name="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)">
  28783. <summary>
  28784. Add a converter to this PatternString
  28785. </summary>
  28786. <param name="name">the name of the conversion pattern for this converter</param>
  28787. <param name="type">the type of the converter</param>
  28788. <remarks>
  28789. <para>
  28790. Add a converter to this PatternString
  28791. </para>
  28792. </remarks>
  28793. </member>
  28794. <member name="T:log4net.Util.PatternStringConverters.AppDomainPatternConverter">
  28795. <summary>
  28796. Write the name of the current AppDomain to the output
  28797. </summary>
  28798. <remarks>
  28799. <para>
  28800. Write the name of the current AppDomain to the output writer
  28801. </para>
  28802. </remarks>
  28803. <author>Nicko Cadell</author>
  28804. </member>
  28805. <member name="M:log4net.Util.PatternStringConverters.AppDomainPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  28806. <summary>
  28807. Write the name of the current AppDomain to the output
  28808. </summary>
  28809. <param name="writer">the writer to write to</param>
  28810. <param name="state">null, state is not set</param>
  28811. <remarks>
  28812. <para>
  28813. Writes name of the current AppDomain to the output <paramref name="writer"/>.
  28814. </para>
  28815. </remarks>
  28816. </member>
  28817. <member name="T:log4net.Util.PatternStringConverters.AppSettingPatternConverter">
  28818. <summary>
  28819. AppSetting pattern converter
  28820. </summary>
  28821. <remarks>
  28822. <para>
  28823. This pattern converter reads appSettings from the application configuration file.
  28824. </para>
  28825. <para>
  28826. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  28827. lookup a single appSettings value. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  28828. then all appSettings will be dumped as a list of key value pairs.
  28829. </para>
  28830. <para>
  28831. A typical use is to specify a base directory for log files, e.g.
  28832. <example>
  28833. <![CDATA[
  28834. <log4net>
  28835. <appender name="MyAppender" type="log4net.Appender.RollingFileAppender">
  28836. <file type="log4net.Util.PatternString" value="appsetting{LogDirectory}MyApp.log"/>
  28837. ...
  28838. </appender>
  28839. </log4net>
  28840. ]]>
  28841. </example>
  28842. </para>
  28843. </remarks>
  28844. </member>
  28845. <member name="M:log4net.Util.PatternStringConverters.AppSettingPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  28846. <summary>
  28847. Write the property value to the output
  28848. </summary>
  28849. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  28850. <param name="state">null, state is not set</param>
  28851. <remarks>
  28852. <para>
  28853. Writes out the value of a named property. The property name
  28854. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  28855. property.
  28856. </para>
  28857. <para>
  28858. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  28859. then all the properties are written as key value pairs.
  28860. </para>
  28861. </remarks>
  28862. </member>
  28863. <member name="T:log4net.Util.PatternStringConverters.DatePatternConverter">
  28864. <summary>
  28865. Write the current date to the output
  28866. </summary>
  28867. <remarks>
  28868. <para>
  28869. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  28870. the current date and time to the writer as a string.
  28871. </para>
  28872. <para>
  28873. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  28874. the formatting of the date. The following values are allowed:
  28875. <list type="definition">
  28876. <listheader>
  28877. <term>Option value</term>
  28878. <description>Output</description>
  28879. </listheader>
  28880. <item>
  28881. <term>ISO8601</term>
  28882. <description>
  28883. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  28884. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  28885. </description>
  28886. </item>
  28887. <item>
  28888. <term>DATE</term>
  28889. <description>
  28890. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  28891. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  28892. </description>
  28893. </item>
  28894. <item>
  28895. <term>ABSOLUTE</term>
  28896. <description>
  28897. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  28898. Formats using the <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  28899. </description>
  28900. </item>
  28901. <item>
  28902. <term>other</term>
  28903. <description>
  28904. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  28905. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  28906. <see cref="M:DateTime.ToString(string)"/> method.
  28907. For details on valid patterns see
  28908. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  28909. </description>
  28910. </item>
  28911. </list>
  28912. </para>
  28913. <para>
  28914. The date and time is in the local time zone and is rendered in that zone.
  28915. To output the time in Universal time see <see cref="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"/>.
  28916. </para>
  28917. </remarks>
  28918. <author>Nicko Cadell</author>
  28919. </member>
  28920. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.m_dateFormatter">
  28921. <summary>
  28922. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  28923. </summary>
  28924. <remarks>
  28925. <para>
  28926. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  28927. </para>
  28928. </remarks>
  28929. </member>
  28930. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions">
  28931. <summary>
  28932. Initialize the converter options
  28933. </summary>
  28934. <remarks>
  28935. <para>
  28936. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  28937. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> method must
  28938. be called on this object after the configuration properties have
  28939. been set. Until <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> is called this
  28940. object is in an undefined state and must not be used.
  28941. </para>
  28942. <para>
  28943. If any of the configuration properties are modified then
  28944. <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> must be called again.
  28945. </para>
  28946. </remarks>
  28947. </member>
  28948. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  28949. <summary>
  28950. Write the current date to the output
  28951. </summary>
  28952. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  28953. <param name="state">null, state is not set</param>
  28954. <remarks>
  28955. <para>
  28956. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  28957. for it to render it to the writer.
  28958. </para>
  28959. <para>
  28960. The date and time passed is in the local time zone.
  28961. </para>
  28962. </remarks>
  28963. </member>
  28964. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.declaringType">
  28965. <summary>
  28966. The fully qualified type of the DatePatternConverter class.
  28967. </summary>
  28968. <remarks>
  28969. Used by the internal logger to record the Type of the
  28970. log message.
  28971. </remarks>
  28972. </member>
  28973. <member name="T:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter">
  28974. <summary>
  28975. Write an <see cref="T:System.Environment.SpecialFolder" /> folder path to the output
  28976. </summary>
  28977. <remarks>
  28978. <para>
  28979. Write an special path environment folder path to the output writer.
  28980. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  28981. the name of the variable to output. <see cref="P:log4net.Util.PatternConverter.Option"/>
  28982. should be a value in the <see cref="T:System.Environment.SpecialFolder" /> enumeration.
  28983. </para>
  28984. </remarks>
  28985. <author>Ron Grabowski</author>
  28986. </member>
  28987. <member name="M:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  28988. <summary>
  28989. Write an special path environment folder path to the output
  28990. </summary>
  28991. <param name="writer">the writer to write to</param>
  28992. <param name="state">null, state is not set</param>
  28993. <remarks>
  28994. <para>
  28995. Writes the special path environment folder path to the output <paramref name="writer"/>.
  28996. The name of the special path environment folder path to output must be set
  28997. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  28998. property.
  28999. </para>
  29000. </remarks>
  29001. </member>
  29002. <member name="F:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.declaringType">
  29003. <summary>
  29004. The fully qualified type of the EnvironmentFolderPathPatternConverter class.
  29005. </summary>
  29006. <remarks>
  29007. Used by the internal logger to record the Type of the
  29008. log message.
  29009. </remarks>
  29010. </member>
  29011. <member name="T:log4net.Util.PatternStringConverters.EnvironmentPatternConverter">
  29012. <summary>
  29013. Write an environment variable to the output
  29014. </summary>
  29015. <remarks>
  29016. <para>
  29017. Write an environment variable to the output writer.
  29018. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  29019. the name of the variable to output.
  29020. </para>
  29021. </remarks>
  29022. <author>Nicko Cadell</author>
  29023. </member>
  29024. <member name="M:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29025. <summary>
  29026. Write an environment variable to the output
  29027. </summary>
  29028. <param name="writer">the writer to write to</param>
  29029. <param name="state">null, state is not set</param>
  29030. <remarks>
  29031. <para>
  29032. Writes the environment variable to the output <paramref name="writer"/>.
  29033. The name of the environment variable to output must be set
  29034. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  29035. property.
  29036. </para>
  29037. </remarks>
  29038. </member>
  29039. <member name="F:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.declaringType">
  29040. <summary>
  29041. The fully qualified type of the EnvironmentPatternConverter class.
  29042. </summary>
  29043. <remarks>
  29044. Used by the internal logger to record the Type of the
  29045. log message.
  29046. </remarks>
  29047. </member>
  29048. <member name="T:log4net.Util.PatternStringConverters.IdentityPatternConverter">
  29049. <summary>
  29050. Write the current thread identity to the output
  29051. </summary>
  29052. <remarks>
  29053. <para>
  29054. Write the current thread identity to the output writer
  29055. </para>
  29056. </remarks>
  29057. <author>Nicko Cadell</author>
  29058. </member>
  29059. <member name="M:log4net.Util.PatternStringConverters.IdentityPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29060. <summary>
  29061. Write the current thread identity to the output
  29062. </summary>
  29063. <param name="writer">the writer to write to</param>
  29064. <param name="state">null, state is not set</param>
  29065. <remarks>
  29066. <para>
  29067. Writes the current thread identity to the output <paramref name="writer"/>.
  29068. </para>
  29069. </remarks>
  29070. </member>
  29071. <member name="F:log4net.Util.PatternStringConverters.IdentityPatternConverter.declaringType">
  29072. <summary>
  29073. The fully qualified type of the IdentityPatternConverter class.
  29074. </summary>
  29075. <remarks>
  29076. Used by the internal logger to record the Type of the
  29077. log message.
  29078. </remarks>
  29079. </member>
  29080. <member name="T:log4net.Util.PatternStringConverters.LiteralPatternConverter">
  29081. <summary>
  29082. Pattern converter for literal string instances in the pattern
  29083. </summary>
  29084. <remarks>
  29085. <para>
  29086. Writes the literal string value specified in the
  29087. <see cref="P:log4net.Util.PatternConverter.Option"/> property to
  29088. the output.
  29089. </para>
  29090. </remarks>
  29091. <author>Nicko Cadell</author>
  29092. </member>
  29093. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.SetNext(log4net.Util.PatternConverter)">
  29094. <summary>
  29095. Set the next converter in the chain
  29096. </summary>
  29097. <param name="pc">The next pattern converter in the chain</param>
  29098. <returns>The next pattern converter</returns>
  29099. <remarks>
  29100. <para>
  29101. Special case the building of the pattern converter chain
  29102. for <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> instances. Two adjacent
  29103. literals in the pattern can be represented by a single combined
  29104. pattern converter. This implementation detects when a
  29105. <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> is added to the chain
  29106. after this converter and combines its value with this converter's
  29107. literal value.
  29108. </para>
  29109. </remarks>
  29110. </member>
  29111. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Format(System.IO.TextWriter,System.Object)">
  29112. <summary>
  29113. Write the literal to the output
  29114. </summary>
  29115. <param name="writer">the writer to write to</param>
  29116. <param name="state">null, not set</param>
  29117. <remarks>
  29118. <para>
  29119. Override the formatting behavior to ignore the FormattingInfo
  29120. because we have a literal instead.
  29121. </para>
  29122. <para>
  29123. Writes the value of <see cref="P:log4net.Util.PatternConverter.Option"/>
  29124. to the output <paramref name="writer"/>.
  29125. </para>
  29126. </remarks>
  29127. </member>
  29128. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29129. <summary>
  29130. Convert this pattern into the rendered message
  29131. </summary>
  29132. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  29133. <param name="state">null, not set</param>
  29134. <remarks>
  29135. <para>
  29136. This method is not used.
  29137. </para>
  29138. </remarks>
  29139. </member>
  29140. <member name="T:log4net.Util.PatternStringConverters.NewLinePatternConverter">
  29141. <summary>
  29142. Writes a newline to the output
  29143. </summary>
  29144. <remarks>
  29145. <para>
  29146. Writes the system dependent line terminator to the output.
  29147. This behavior can be overridden by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>:
  29148. </para>
  29149. <list type="definition">
  29150. <listheader>
  29151. <term>Option Value</term>
  29152. <description>Output</description>
  29153. </listheader>
  29154. <item>
  29155. <term>DOS</term>
  29156. <description>DOS or Windows line terminator <c>"\r\n"</c></description>
  29157. </item>
  29158. <item>
  29159. <term>UNIX</term>
  29160. <description>UNIX line terminator <c>"\n"</c></description>
  29161. </item>
  29162. </list>
  29163. </remarks>
  29164. <author>Nicko Cadell</author>
  29165. </member>
  29166. <member name="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions">
  29167. <summary>
  29168. Initialize the converter
  29169. </summary>
  29170. <remarks>
  29171. <para>
  29172. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  29173. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> method must
  29174. be called on this object after the configuration properties have
  29175. been set. Until <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> is called this
  29176. object is in an undefined state and must not be used.
  29177. </para>
  29178. <para>
  29179. If any of the configuration properties are modified then
  29180. <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> must be called again.
  29181. </para>
  29182. </remarks>
  29183. </member>
  29184. <member name="T:log4net.Util.PatternStringConverters.ProcessIdPatternConverter">
  29185. <summary>
  29186. Write the current process ID to the output
  29187. </summary>
  29188. <remarks>
  29189. <para>
  29190. Write the current process ID to the output writer
  29191. </para>
  29192. </remarks>
  29193. <author>Nicko Cadell</author>
  29194. </member>
  29195. <member name="M:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29196. <summary>
  29197. Write the current process ID to the output
  29198. </summary>
  29199. <param name="writer">the writer to write to</param>
  29200. <param name="state">null, state is not set</param>
  29201. <remarks>
  29202. <para>
  29203. Write the current process ID to the output <paramref name="writer"/>.
  29204. </para>
  29205. </remarks>
  29206. </member>
  29207. <member name="F:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.declaringType">
  29208. <summary>
  29209. The fully qualified type of the ProcessIdPatternConverter class.
  29210. </summary>
  29211. <remarks>
  29212. Used by the internal logger to record the Type of the
  29213. log message.
  29214. </remarks>
  29215. </member>
  29216. <member name="T:log4net.Util.PatternStringConverters.PropertyPatternConverter">
  29217. <summary>
  29218. Property pattern converter
  29219. </summary>
  29220. <remarks>
  29221. <para>
  29222. This pattern converter reads the thread and global properties.
  29223. The thread properties take priority over global properties.
  29224. See <see cref="P:log4net.ThreadContext.Properties"/> for details of the
  29225. thread properties. See <see cref="P:log4net.GlobalContext.Properties"/> for
  29226. details of the global properties.
  29227. </para>
  29228. <para>
  29229. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  29230. lookup a single property. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  29231. then all properties will be dumped as a list of key value pairs.
  29232. </para>
  29233. </remarks>
  29234. <author>Nicko Cadell</author>
  29235. </member>
  29236. <member name="M:log4net.Util.PatternStringConverters.PropertyPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29237. <summary>
  29238. Write the property value to the output
  29239. </summary>
  29240. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  29241. <param name="state">null, state is not set</param>
  29242. <remarks>
  29243. <para>
  29244. Writes out the value of a named property. The property name
  29245. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  29246. property.
  29247. </para>
  29248. <para>
  29249. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  29250. then all the properties are written as key value pairs.
  29251. </para>
  29252. </remarks>
  29253. </member>
  29254. <member name="T:log4net.Util.PatternStringConverters.RandomStringPatternConverter">
  29255. <summary>
  29256. A Pattern converter that generates a string of random characters
  29257. </summary>
  29258. <remarks>
  29259. <para>
  29260. The converter generates a string of random characters. By default
  29261. the string is length 4. This can be changed by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>
  29262. to the string value of the length required.
  29263. </para>
  29264. <para>
  29265. The random characters in the string are limited to uppercase letters
  29266. and numbers only.
  29267. </para>
  29268. <para>
  29269. The random number generator used by this class is not cryptographically secure.
  29270. </para>
  29271. </remarks>
  29272. <author>Nicko Cadell</author>
  29273. </member>
  29274. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.s_random">
  29275. <summary>
  29276. Shared random number generator
  29277. </summary>
  29278. </member>
  29279. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.m_length">
  29280. <summary>
  29281. Length of random string to generate. Default length 4.
  29282. </summary>
  29283. </member>
  29284. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions">
  29285. <summary>
  29286. Initialize the converter options
  29287. </summary>
  29288. <remarks>
  29289. <para>
  29290. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  29291. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> method must
  29292. be called on this object after the configuration properties have
  29293. been set. Until <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> is called this
  29294. object is in an undefined state and must not be used.
  29295. </para>
  29296. <para>
  29297. If any of the configuration properties are modified then
  29298. <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> must be called again.
  29299. </para>
  29300. </remarks>
  29301. </member>
  29302. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29303. <summary>
  29304. Write a randoim string to the output
  29305. </summary>
  29306. <param name="writer">the writer to write to</param>
  29307. <param name="state">null, state is not set</param>
  29308. <remarks>
  29309. <para>
  29310. Write a randoim string to the output <paramref name="writer"/>.
  29311. </para>
  29312. </remarks>
  29313. </member>
  29314. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.declaringType">
  29315. <summary>
  29316. The fully qualified type of the RandomStringPatternConverter class.
  29317. </summary>
  29318. <remarks>
  29319. Used by the internal logger to record the Type of the
  29320. log message.
  29321. </remarks>
  29322. </member>
  29323. <member name="T:log4net.Util.PatternStringConverters.UserNamePatternConverter">
  29324. <summary>
  29325. Write the current threads username to the output
  29326. </summary>
  29327. <remarks>
  29328. <para>
  29329. Write the current threads username to the output writer
  29330. </para>
  29331. </remarks>
  29332. <author>Nicko Cadell</author>
  29333. </member>
  29334. <member name="M:log4net.Util.PatternStringConverters.UserNamePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29335. <summary>
  29336. Write the current threads username to the output
  29337. </summary>
  29338. <param name="writer">the writer to write to</param>
  29339. <param name="state">null, state is not set</param>
  29340. <remarks>
  29341. <para>
  29342. Write the current threads username to the output <paramref name="writer"/>.
  29343. </para>
  29344. </remarks>
  29345. </member>
  29346. <member name="F:log4net.Util.PatternStringConverters.UserNamePatternConverter.declaringType">
  29347. <summary>
  29348. The fully qualified type of the UserNamePatternConverter class.
  29349. </summary>
  29350. <remarks>
  29351. Used by the internal logger to record the Type of the
  29352. log message.
  29353. </remarks>
  29354. </member>
  29355. <member name="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter">
  29356. <summary>
  29357. Write the UTC date time to the output
  29358. </summary>
  29359. <remarks>
  29360. <para>
  29361. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  29362. the current date and time in Universal time.
  29363. </para>
  29364. <para>
  29365. See the <see cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> for details on the date pattern syntax.
  29366. </para>
  29367. </remarks>
  29368. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  29369. <author>Nicko Cadell</author>
  29370. </member>
  29371. <member name="M:log4net.Util.PatternStringConverters.UtcDatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29372. <summary>
  29373. Write the current date and time to the output
  29374. </summary>
  29375. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  29376. <param name="state">null, state is not set</param>
  29377. <remarks>
  29378. <para>
  29379. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  29380. for it to render it to the writer.
  29381. </para>
  29382. <para>
  29383. The date is in Universal time when it is rendered.
  29384. </para>
  29385. </remarks>
  29386. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  29387. </member>
  29388. <member name="F:log4net.Util.PatternStringConverters.UtcDatePatternConverter.declaringType">
  29389. <summary>
  29390. The fully qualified type of the UtcDatePatternConverter class.
  29391. </summary>
  29392. <remarks>
  29393. Used by the internal logger to record the Type of the
  29394. log message.
  29395. </remarks>
  29396. </member>
  29397. <member name="T:log4net.Util.PropertiesDictionary">
  29398. <summary>
  29399. String keyed object map.
  29400. </summary>
  29401. <remarks>
  29402. <para>
  29403. While this collection is serializable only member
  29404. objects that are serializable will
  29405. be serialized along with this collection.
  29406. </para>
  29407. </remarks>
  29408. <author>Nicko Cadell</author>
  29409. <author>Gert Driesen</author>
  29410. </member>
  29411. <member name="M:log4net.Util.PropertiesDictionary.#ctor">
  29412. <summary>
  29413. Constructor
  29414. </summary>
  29415. <remarks>
  29416. <para>
  29417. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class.
  29418. </para>
  29419. </remarks>
  29420. </member>
  29421. <member name="M:log4net.Util.PropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  29422. <summary>
  29423. Constructor
  29424. </summary>
  29425. <param name="propertiesDictionary">properties to copy</param>
  29426. <remarks>
  29427. <para>
  29428. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class.
  29429. </para>
  29430. </remarks>
  29431. </member>
  29432. <member name="M:log4net.Util.PropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29433. <summary>
  29434. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class
  29435. with serialized data.
  29436. </summary>
  29437. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  29438. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  29439. <remarks>
  29440. <para>
  29441. Because this class is sealed the serialization constructor is private.
  29442. </para>
  29443. </remarks>
  29444. </member>
  29445. <member name="P:log4net.Util.PropertiesDictionary.Item(System.String)">
  29446. <summary>
  29447. Gets or sets the value of the property with the specified key.
  29448. </summary>
  29449. <value>
  29450. The value of the property with the specified key.
  29451. </value>
  29452. <param name="key">The key of the property to get or set.</param>
  29453. <remarks>
  29454. <para>
  29455. The property value will only be serialized if it is serializable.
  29456. If it cannot be serialized it will be silently ignored if
  29457. a serialization operation is performed.
  29458. </para>
  29459. </remarks>
  29460. </member>
  29461. <member name="M:log4net.Util.PropertiesDictionary.Remove(System.String)">
  29462. <summary>
  29463. Remove the entry with the specified key from this dictionary
  29464. </summary>
  29465. <param name="key">the key for the entry to remove</param>
  29466. <remarks>
  29467. <para>
  29468. Remove the entry with the specified key from this dictionary
  29469. </para>
  29470. </remarks>
  29471. </member>
  29472. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  29473. <summary>
  29474. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  29475. </summary>
  29476. <returns>an enumerator</returns>
  29477. <remarks>
  29478. <para>
  29479. Returns a <see cref="T:System.Collections.IDictionaryEnumerator"/> over the contest of this collection.
  29480. </para>
  29481. </remarks>
  29482. </member>
  29483. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  29484. <summary>
  29485. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  29486. </summary>
  29487. <param name="key">the key to remove</param>
  29488. <remarks>
  29489. <para>
  29490. Remove the entry with the specified key from this dictionary
  29491. </para>
  29492. </remarks>
  29493. </member>
  29494. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  29495. <summary>
  29496. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  29497. </summary>
  29498. <param name="key">the key to lookup in the collection</param>
  29499. <returns><c>true</c> if the collection contains the specified key</returns>
  29500. <remarks>
  29501. <para>
  29502. Test if this collection contains a specified key.
  29503. </para>
  29504. </remarks>
  29505. </member>
  29506. <member name="M:log4net.Util.PropertiesDictionary.Clear">
  29507. <summary>
  29508. Remove all properties from the properties collection
  29509. </summary>
  29510. <remarks>
  29511. <para>
  29512. Remove all properties from the properties collection
  29513. </para>
  29514. </remarks>
  29515. </member>
  29516. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  29517. <summary>
  29518. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  29519. </summary>
  29520. <param name="key">the key</param>
  29521. <param name="value">the value to store for the key</param>
  29522. <remarks>
  29523. <para>
  29524. Store a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  29525. </para>
  29526. </remarks>
  29527. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  29528. </member>
  29529. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  29530. <summary>
  29531. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  29532. </summary>
  29533. <value>
  29534. <c>false</c>
  29535. </value>
  29536. <remarks>
  29537. <para>
  29538. This collection is modifiable. This property always
  29539. returns <c>false</c>.
  29540. </para>
  29541. </remarks>
  29542. </member>
  29543. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  29544. <summary>
  29545. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  29546. </summary>
  29547. <value>
  29548. The value for the key specified.
  29549. </value>
  29550. <remarks>
  29551. <para>
  29552. Get or set a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  29553. </para>
  29554. </remarks>
  29555. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  29556. </member>
  29557. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Values">
  29558. <summary>
  29559. See <see cref="P:System.Collections.IDictionary.Values"/>
  29560. </summary>
  29561. </member>
  29562. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Keys">
  29563. <summary>
  29564. See <see cref="P:System.Collections.IDictionary.Keys"/>
  29565. </summary>
  29566. </member>
  29567. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  29568. <summary>
  29569. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  29570. </summary>
  29571. </member>
  29572. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  29573. <summary>
  29574. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  29575. </summary>
  29576. <param name="array"></param>
  29577. <param name="index"></param>
  29578. </member>
  29579. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  29580. <summary>
  29581. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  29582. </summary>
  29583. </member>
  29584. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#SyncRoot">
  29585. <summary>
  29586. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  29587. </summary>
  29588. </member>
  29589. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  29590. <summary>
  29591. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  29592. </summary>
  29593. </member>
  29594. <member name="T:log4net.Util.PropertyEntry">
  29595. <summary>
  29596. A class to hold the key and data for a property set in the config file
  29597. </summary>
  29598. <remarks>
  29599. <para>
  29600. A class to hold the key and data for a property set in the config file
  29601. </para>
  29602. </remarks>
  29603. </member>
  29604. <member name="P:log4net.Util.PropertyEntry.Key">
  29605. <summary>
  29606. Property Key
  29607. </summary>
  29608. <value>
  29609. Property Key
  29610. </value>
  29611. <remarks>
  29612. <para>
  29613. Property Key.
  29614. </para>
  29615. </remarks>
  29616. </member>
  29617. <member name="P:log4net.Util.PropertyEntry.Value">
  29618. <summary>
  29619. Property Value
  29620. </summary>
  29621. <value>
  29622. Property Value
  29623. </value>
  29624. <remarks>
  29625. <para>
  29626. Property Value.
  29627. </para>
  29628. </remarks>
  29629. </member>
  29630. <member name="M:log4net.Util.PropertyEntry.ToString">
  29631. <summary>
  29632. Override <c>Object.ToString</c> to return sensible debug info
  29633. </summary>
  29634. <returns>string info about this object</returns>
  29635. </member>
  29636. <member name="T:log4net.Util.ProtectCloseTextWriter">
  29637. <summary>
  29638. A <see cref="T:System.IO.TextWriter"/> that ignores the <see cref="M:log4net.Util.ProtectCloseTextWriter.Close"/> message
  29639. </summary>
  29640. <remarks>
  29641. <para>
  29642. This writer is used in special cases where it is necessary
  29643. to protect a writer from being closed by a client.
  29644. </para>
  29645. </remarks>
  29646. <author>Nicko Cadell</author>
  29647. </member>
  29648. <member name="M:log4net.Util.ProtectCloseTextWriter.#ctor(System.IO.TextWriter)">
  29649. <summary>
  29650. Constructor
  29651. </summary>
  29652. <param name="writer">the writer to actually write to</param>
  29653. <remarks>
  29654. <para>
  29655. Create a new ProtectCloseTextWriter using a writer
  29656. </para>
  29657. </remarks>
  29658. </member>
  29659. <member name="M:log4net.Util.ProtectCloseTextWriter.Attach(System.IO.TextWriter)">
  29660. <summary>
  29661. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  29662. </summary>
  29663. <param name="writer">the writer to attach to</param>
  29664. <remarks>
  29665. <para>
  29666. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  29667. </para>
  29668. </remarks>
  29669. </member>
  29670. <member name="M:log4net.Util.ProtectCloseTextWriter.Close">
  29671. <summary>
  29672. Does not close the underlying output writer.
  29673. </summary>
  29674. <remarks>
  29675. <para>
  29676. Does not close the underlying output writer.
  29677. This method does nothing.
  29678. </para>
  29679. </remarks>
  29680. </member>
  29681. <member name="T:log4net.Util.QuietTextWriter">
  29682. <summary>
  29683. <see cref="T:System.IO.TextWriter"/> that does not leak exceptions
  29684. </summary>
  29685. <remarks>
  29686. <para>
  29687. <see cref="T:log4net.Util.QuietTextWriter"/> does not throw exceptions when things go wrong.
  29688. Instead, it delegates error handling to its <see cref="T:log4net.Core.IErrorHandler"/>.
  29689. </para>
  29690. </remarks>
  29691. <author>Nicko Cadell</author>
  29692. <author>Gert Driesen</author>
  29693. </member>
  29694. <member name="M:log4net.Util.QuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  29695. <summary>
  29696. Constructor
  29697. </summary>
  29698. <param name="writer">the writer to actually write to</param>
  29699. <param name="errorHandler">the error handler to report error to</param>
  29700. <remarks>
  29701. <para>
  29702. Create a new QuietTextWriter using a writer and error handler
  29703. </para>
  29704. </remarks>
  29705. </member>
  29706. <member name="P:log4net.Util.QuietTextWriter.ErrorHandler">
  29707. <summary>
  29708. Gets or sets the error handler that all errors are passed to.
  29709. </summary>
  29710. <value>
  29711. The error handler that all errors are passed to.
  29712. </value>
  29713. <remarks>
  29714. <para>
  29715. Gets or sets the error handler that all errors are passed to.
  29716. </para>
  29717. </remarks>
  29718. </member>
  29719. <member name="P:log4net.Util.QuietTextWriter.Closed">
  29720. <summary>
  29721. Gets a value indicating whether this writer is closed.
  29722. </summary>
  29723. <value>
  29724. <c>true</c> if this writer is closed, otherwise <c>false</c>.
  29725. </value>
  29726. <remarks>
  29727. <para>
  29728. Gets a value indicating whether this writer is closed.
  29729. </para>
  29730. </remarks>
  29731. </member>
  29732. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char)">
  29733. <summary>
  29734. Writes a character to the underlying writer
  29735. </summary>
  29736. <param name="value">the char to write</param>
  29737. <remarks>
  29738. <para>
  29739. Writes a character to the underlying writer
  29740. </para>
  29741. </remarks>
  29742. </member>
  29743. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  29744. <summary>
  29745. Writes a buffer to the underlying writer
  29746. </summary>
  29747. <param name="buffer">the buffer to write</param>
  29748. <param name="index">the start index to write from</param>
  29749. <param name="count">the number of characters to write</param>
  29750. <remarks>
  29751. <para>
  29752. Writes a buffer to the underlying writer
  29753. </para>
  29754. </remarks>
  29755. </member>
  29756. <member name="M:log4net.Util.QuietTextWriter.Write(System.String)">
  29757. <summary>
  29758. Writes a string to the output.
  29759. </summary>
  29760. <param name="value">The string data to write to the output.</param>
  29761. <remarks>
  29762. <para>
  29763. Writes a string to the output.
  29764. </para>
  29765. </remarks>
  29766. </member>
  29767. <member name="M:log4net.Util.QuietTextWriter.Close">
  29768. <summary>
  29769. Closes the underlying output writer.
  29770. </summary>
  29771. <remarks>
  29772. <para>
  29773. Closes the underlying output writer.
  29774. </para>
  29775. </remarks>
  29776. </member>
  29777. <member name="F:log4net.Util.QuietTextWriter.m_errorHandler">
  29778. <summary>
  29779. The error handler instance to pass all errors to
  29780. </summary>
  29781. </member>
  29782. <member name="F:log4net.Util.QuietTextWriter.m_closed">
  29783. <summary>
  29784. Flag to indicate if this writer is closed
  29785. </summary>
  29786. </member>
  29787. <member name="T:log4net.Util.ReaderWriterLock">
  29788. <summary>
  29789. Defines a lock that supports single writers and multiple readers
  29790. </summary>
  29791. <remarks>
  29792. <para>
  29793. <c>ReaderWriterLock</c> is used to synchronize access to a resource.
  29794. At any given time, it allows either concurrent read access for
  29795. multiple threads, or write access for a single thread. In a
  29796. situation where a resource is changed infrequently, a
  29797. <c>ReaderWriterLock</c> provides better throughput than a simple
  29798. one-at-a-time lock, such as <see cref="T:System.Threading.Monitor"/>.
  29799. </para>
  29800. <para>
  29801. If a platform does not support a <c>System.Threading.ReaderWriterLock</c>
  29802. implementation then all readers and writers are serialized. Therefore
  29803. the caller must not rely on multiple simultaneous readers.
  29804. </para>
  29805. </remarks>
  29806. <author>Nicko Cadell</author>
  29807. </member>
  29808. <member name="M:log4net.Util.ReaderWriterLock.#ctor">
  29809. <summary>
  29810. Constructor
  29811. </summary>
  29812. <remarks>
  29813. <para>
  29814. Initializes a new instance of the <see cref="T:log4net.Util.ReaderWriterLock" /> class.
  29815. </para>
  29816. </remarks>
  29817. </member>
  29818. <member name="M:log4net.Util.ReaderWriterLock.AcquireReaderLock">
  29819. <summary>
  29820. Acquires a reader lock
  29821. </summary>
  29822. <remarks>
  29823. <para>
  29824. <see cref="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"/> blocks if a different thread has the writer
  29825. lock, or if at least one thread is waiting for the writer lock.
  29826. </para>
  29827. </remarks>
  29828. </member>
  29829. <member name="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock">
  29830. <summary>
  29831. Decrements the lock count
  29832. </summary>
  29833. <remarks>
  29834. <para>
  29835. <see cref="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"/> decrements the lock count. When the count
  29836. reaches zero, the lock is released.
  29837. </para>
  29838. </remarks>
  29839. </member>
  29840. <member name="M:log4net.Util.ReaderWriterLock.AcquireWriterLock">
  29841. <summary>
  29842. Acquires the writer lock
  29843. </summary>
  29844. <remarks>
  29845. <para>
  29846. This method blocks if another thread has a reader lock or writer lock.
  29847. </para>
  29848. </remarks>
  29849. </member>
  29850. <member name="M:log4net.Util.ReaderWriterLock.ReleaseWriterLock">
  29851. <summary>
  29852. Decrements the lock count on the writer lock
  29853. </summary>
  29854. <remarks>
  29855. <para>
  29856. ReleaseWriterLock decrements the writer lock count.
  29857. When the count reaches zero, the writer lock is released.
  29858. </para>
  29859. </remarks>
  29860. </member>
  29861. <member name="T:log4net.Util.ReadOnlyPropertiesDictionary">
  29862. <summary>
  29863. String keyed object map that is read only.
  29864. </summary>
  29865. <remarks>
  29866. <para>
  29867. This collection is readonly and cannot be modified.
  29868. </para>
  29869. <para>
  29870. While this collection is serializable only member
  29871. objects that are serializable will
  29872. be serialized along with this collection.
  29873. </para>
  29874. </remarks>
  29875. <author>Nicko Cadell</author>
  29876. <author>Gert Driesen</author>
  29877. </member>
  29878. <member name="F:log4net.Util.ReadOnlyPropertiesDictionary.m_hashtable">
  29879. <summary>
  29880. The Hashtable used to store the properties data
  29881. </summary>
  29882. </member>
  29883. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor">
  29884. <summary>
  29885. Constructor
  29886. </summary>
  29887. <remarks>
  29888. <para>
  29889. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class.
  29890. </para>
  29891. </remarks>
  29892. </member>
  29893. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  29894. <summary>
  29895. Copy Constructor
  29896. </summary>
  29897. <param name="propertiesDictionary">properties to copy</param>
  29898. <remarks>
  29899. <para>
  29900. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class.
  29901. </para>
  29902. </remarks>
  29903. </member>
  29904. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29905. <summary>
  29906. Deserialization constructor
  29907. </summary>
  29908. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  29909. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  29910. <remarks>
  29911. <para>
  29912. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class
  29913. with serialized data.
  29914. </para>
  29915. </remarks>
  29916. </member>
  29917. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetKeys">
  29918. <summary>
  29919. Gets the key names.
  29920. </summary>
  29921. <returns>An array of all the keys.</returns>
  29922. <remarks>
  29923. <para>
  29924. Gets the key names.
  29925. </para>
  29926. </remarks>
  29927. </member>
  29928. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Item(System.String)">
  29929. <summary>
  29930. Gets or sets the value of the property with the specified key.
  29931. </summary>
  29932. <value>
  29933. The value of the property with the specified key.
  29934. </value>
  29935. <param name="key">The key of the property to get or set.</param>
  29936. <remarks>
  29937. <para>
  29938. The property value will only be serialized if it is serializable.
  29939. If it cannot be serialized it will be silently ignored if
  29940. a serialization operation is performed.
  29941. </para>
  29942. </remarks>
  29943. </member>
  29944. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Contains(System.String)">
  29945. <summary>
  29946. Test if the dictionary contains a specified key
  29947. </summary>
  29948. <param name="key">the key to look for</param>
  29949. <returns>true if the dictionary contains the specified key</returns>
  29950. <remarks>
  29951. <para>
  29952. Test if the dictionary contains a specified key
  29953. </para>
  29954. </remarks>
  29955. </member>
  29956. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.InnerHashtable">
  29957. <summary>
  29958. The hashtable used to store the properties
  29959. </summary>
  29960. <value>
  29961. The internal collection used to store the properties
  29962. </value>
  29963. <remarks>
  29964. <para>
  29965. The hashtable used to store the properties
  29966. </para>
  29967. </remarks>
  29968. </member>
  29969. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29970. <summary>
  29971. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  29972. </summary>
  29973. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
  29974. <param name="context">The destination for this serialization.</param>
  29975. <remarks>
  29976. <para>
  29977. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  29978. </para>
  29979. </remarks>
  29980. </member>
  29981. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  29982. <summary>
  29983. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  29984. </summary>
  29985. </member>
  29986. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  29987. <summary>
  29988. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  29989. </summary>
  29990. <param name="key"></param>
  29991. </member>
  29992. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  29993. <summary>
  29994. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  29995. </summary>
  29996. <param name="key"></param>
  29997. <returns></returns>
  29998. </member>
  29999. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Clear">
  30000. <summary>
  30001. Remove all properties from the properties collection
  30002. </summary>
  30003. </member>
  30004. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  30005. <summary>
  30006. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  30007. </summary>
  30008. <param name="key"></param>
  30009. <param name="value"></param>
  30010. </member>
  30011. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  30012. <summary>
  30013. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  30014. </summary>
  30015. </member>
  30016. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  30017. <summary>
  30018. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  30019. </summary>
  30020. </member>
  30021. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Values">
  30022. <summary>
  30023. See <see cref="P:System.Collections.IDictionary.Values"/>
  30024. </summary>
  30025. </member>
  30026. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Keys">
  30027. <summary>
  30028. See <see cref="P:System.Collections.IDictionary.Keys"/>
  30029. </summary>
  30030. </member>
  30031. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  30032. <summary>
  30033. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  30034. </summary>
  30035. </member>
  30036. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  30037. <summary>
  30038. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  30039. </summary>
  30040. <param name="array"></param>
  30041. <param name="index"></param>
  30042. </member>
  30043. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  30044. <summary>
  30045. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  30046. </summary>
  30047. </member>
  30048. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Count">
  30049. <summary>
  30050. The number of properties in this collection
  30051. </summary>
  30052. </member>
  30053. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#SyncRoot">
  30054. <summary>
  30055. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  30056. </summary>
  30057. </member>
  30058. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  30059. <summary>
  30060. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  30061. </summary>
  30062. </member>
  30063. <member name="T:log4net.Util.ReusableStringWriter">
  30064. <summary>
  30065. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused
  30066. </summary>
  30067. <remarks>
  30068. <para>
  30069. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused.
  30070. This uses a single buffer for string operations.
  30071. </para>
  30072. </remarks>
  30073. <author>Nicko Cadell</author>
  30074. </member>
  30075. <member name="M:log4net.Util.ReusableStringWriter.#ctor(System.IFormatProvider)">
  30076. <summary>
  30077. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  30078. </summary>
  30079. <param name="formatProvider">the format provider to use</param>
  30080. <remarks>
  30081. <para>
  30082. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  30083. </para>
  30084. </remarks>
  30085. </member>
  30086. <member name="M:log4net.Util.ReusableStringWriter.Dispose(System.Boolean)">
  30087. <summary>
  30088. Override Dispose to prevent closing of writer
  30089. </summary>
  30090. <param name="disposing">flag</param>
  30091. <remarks>
  30092. <para>
  30093. Override Dispose to prevent closing of writer
  30094. </para>
  30095. </remarks>
  30096. </member>
  30097. <member name="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)">
  30098. <summary>
  30099. Reset this string writer so that it can be reused.
  30100. </summary>
  30101. <param name="maxCapacity">the maximum buffer capacity before it is trimmed</param>
  30102. <param name="defaultSize">the default size to make the buffer</param>
  30103. <remarks>
  30104. <para>
  30105. Reset this string writer so that it can be reused.
  30106. The internal buffers are cleared and reset.
  30107. </para>
  30108. </remarks>
  30109. </member>
  30110. <member name="T:log4net.Util.SystemInfo">
  30111. <summary>
  30112. Utility class for system specific information.
  30113. </summary>
  30114. <remarks>
  30115. <para>
  30116. Utility class of static methods for system specific information.
  30117. </para>
  30118. </remarks>
  30119. <author>Nicko Cadell</author>
  30120. <author>Gert Driesen</author>
  30121. <author>Alexey Solofnenko</author>
  30122. </member>
  30123. <member name="M:log4net.Util.SystemInfo.#ctor">
  30124. <summary>
  30125. Private constructor to prevent instances.
  30126. </summary>
  30127. <remarks>
  30128. <para>
  30129. Only static methods are exposed from this type.
  30130. </para>
  30131. </remarks>
  30132. </member>
  30133. <member name="M:log4net.Util.SystemInfo.#cctor">
  30134. <summary>
  30135. Initialize default values for private static fields.
  30136. </summary>
  30137. <remarks>
  30138. <para>
  30139. Only static methods are exposed from this type.
  30140. </para>
  30141. </remarks>
  30142. </member>
  30143. <member name="P:log4net.Util.SystemInfo.NewLine">
  30144. <summary>
  30145. Gets the system dependent line terminator.
  30146. </summary>
  30147. <value>
  30148. The system dependent line terminator.
  30149. </value>
  30150. <remarks>
  30151. <para>
  30152. Gets the system dependent line terminator.
  30153. </para>
  30154. </remarks>
  30155. </member>
  30156. <member name="P:log4net.Util.SystemInfo.ApplicationBaseDirectory">
  30157. <summary>
  30158. Gets the base directory for this <see cref="T:System.AppDomain"/>.
  30159. </summary>
  30160. <value>The base directory path for the current <see cref="T:System.AppDomain"/>.</value>
  30161. <remarks>
  30162. <para>
  30163. Gets the base directory for this <see cref="T:System.AppDomain"/>.
  30164. </para>
  30165. <para>
  30166. The value returned may be either a local file path or a URI.
  30167. </para>
  30168. </remarks>
  30169. </member>
  30170. <member name="P:log4net.Util.SystemInfo.ConfigurationFileLocation">
  30171. <summary>
  30172. Gets the path to the configuration file for the current <see cref="T:System.AppDomain"/>.
  30173. </summary>
  30174. <value>The path to the configuration file for the current <see cref="T:System.AppDomain"/>.</value>
  30175. <remarks>
  30176. <para>
  30177. The .NET Compact Framework 1.0 does not have a concept of a configuration
  30178. file. For this runtime, we use the entry assembly location as the root for
  30179. the configuration file name.
  30180. </para>
  30181. <para>
  30182. The value returned may be either a local file path or a URI.
  30183. </para>
  30184. </remarks>
  30185. </member>
  30186. <member name="P:log4net.Util.SystemInfo.EntryAssemblyLocation">
  30187. <summary>
  30188. Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
  30189. </summary>
  30190. <value>The path to the entry assembly.</value>
  30191. <remarks>
  30192. <para>
  30193. Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
  30194. </para>
  30195. </remarks>
  30196. </member>
  30197. <member name="P:log4net.Util.SystemInfo.CurrentThreadId">
  30198. <summary>
  30199. Gets the ID of the current thread.
  30200. </summary>
  30201. <value>The ID of the current thread.</value>
  30202. <remarks>
  30203. <para>
  30204. On the .NET framework, the <c>AppDomain.GetCurrentThreadId</c> method
  30205. is used to obtain the thread ID for the current thread. This is the
  30206. operating system ID for the thread.
  30207. </para>
  30208. <para>
  30209. On the .NET Compact Framework 1.0 it is not possible to get the
  30210. operating system thread ID for the current thread. The native method
  30211. <c>GetCurrentThreadId</c> is implemented inline in a header file
  30212. and cannot be called.
  30213. </para>
  30214. <para>
  30215. On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this
  30216. gives a stable id unrelated to the operating system thread ID which may
  30217. change if the runtime is using fibers.
  30218. </para>
  30219. </remarks>
  30220. </member>
  30221. <member name="P:log4net.Util.SystemInfo.HostName">
  30222. <summary>
  30223. Get the host name or machine name for the current machine
  30224. </summary>
  30225. <value>
  30226. The hostname or machine name
  30227. </value>
  30228. <remarks>
  30229. <para>
  30230. Get the host name or machine name for the current machine
  30231. </para>
  30232. <para>
  30233. The host name (<see cref="M:System.Net.Dns.GetHostName"/>) or
  30234. the machine name (<c>Environment.MachineName</c>) for
  30235. the current machine, or if neither of these are available
  30236. then <c>NOT AVAILABLE</c> is returned.
  30237. </para>
  30238. </remarks>
  30239. </member>
  30240. <member name="P:log4net.Util.SystemInfo.ApplicationFriendlyName">
  30241. <summary>
  30242. Get this application's friendly name
  30243. </summary>
  30244. <value>
  30245. The friendly name of this application as a string
  30246. </value>
  30247. <remarks>
  30248. <para>
  30249. If available the name of the application is retrieved from
  30250. the <c>AppDomain</c> using <c>AppDomain.CurrentDomain.FriendlyName</c>.
  30251. </para>
  30252. <para>
  30253. Otherwise the file name of the entry assembly is used.
  30254. </para>
  30255. </remarks>
  30256. </member>
  30257. <member name="P:log4net.Util.SystemInfo.ProcessStartTime">
  30258. <summary>
  30259. Get the start time for the current process.
  30260. </summary>
  30261. <remarks>
  30262. <para>
  30263. This is the time at which the log4net library was loaded into the
  30264. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  30265. this is not the start time for the current process.
  30266. </para>
  30267. <para>
  30268. The log4net library should be loaded by an application early during its
  30269. startup, therefore this start time should be a good approximation for
  30270. the actual start time.
  30271. </para>
  30272. <para>
  30273. Note that AppDomains may be loaded and unloaded within the
  30274. same process without the process terminating, however this start time
  30275. will be set per AppDomain.
  30276. </para>
  30277. </remarks>
  30278. </member>
  30279. <member name="P:log4net.Util.SystemInfo.ProcessStartTimeUtc">
  30280. <summary>
  30281. Get the UTC start time for the current process.
  30282. </summary>
  30283. <remarks>
  30284. <para>
  30285. This is the UTC time at which the log4net library was loaded into the
  30286. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  30287. this is not the start time for the current process.
  30288. </para>
  30289. <para>
  30290. The log4net library should be loaded by an application early during its
  30291. startup, therefore this start time should be a good approximation for
  30292. the actual start time.
  30293. </para>
  30294. <para>
  30295. Note that AppDomains may be loaded and unloaded within the
  30296. same process without the process terminating, however this start time
  30297. will be set per AppDomain.
  30298. </para>
  30299. </remarks>
  30300. </member>
  30301. <member name="P:log4net.Util.SystemInfo.NullText">
  30302. <summary>
  30303. Text to output when a <c>null</c> is encountered.
  30304. </summary>
  30305. <remarks>
  30306. <para>
  30307. Use this value to indicate a <c>null</c> has been encountered while
  30308. outputting a string representation of an item.
  30309. </para>
  30310. <para>
  30311. The default value is <c>(null)</c>. This value can be overridden by specifying
  30312. a value for the <c>log4net.NullText</c> appSetting in the application's
  30313. .config file.
  30314. </para>
  30315. </remarks>
  30316. </member>
  30317. <member name="P:log4net.Util.SystemInfo.NotAvailableText">
  30318. <summary>
  30319. Text to output when an unsupported feature is requested.
  30320. </summary>
  30321. <remarks>
  30322. <para>
  30323. Use this value when an unsupported feature is requested.
  30324. </para>
  30325. <para>
  30326. The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying
  30327. a value for the <c>log4net.NotAvailableText</c> appSetting in the application's
  30328. .config file.
  30329. </para>
  30330. </remarks>
  30331. </member>
  30332. <member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)">
  30333. <summary>
  30334. Gets the assembly location path for the specified assembly.
  30335. </summary>
  30336. <param name="myAssembly">The assembly to get the location for.</param>
  30337. <returns>The location of the assembly.</returns>
  30338. <remarks>
  30339. <para>
  30340. This method does not guarantee to return the correct path
  30341. to the assembly. If only tries to give an indication as to
  30342. where the assembly was loaded from.
  30343. </para>
  30344. </remarks>
  30345. </member>
  30346. <member name="M:log4net.Util.SystemInfo.AssemblyQualifiedName(System.Type)">
  30347. <summary>
  30348. Gets the fully qualified name of the <see cref="T:System.Type" />, including
  30349. the name of the assembly from which the <see cref="T:System.Type" /> was
  30350. loaded.
  30351. </summary>
  30352. <param name="type">The <see cref="T:System.Type" /> to get the fully qualified name for.</param>
  30353. <returns>The fully qualified name for the <see cref="T:System.Type" />.</returns>
  30354. <remarks>
  30355. <para>
  30356. This is equivalent to the <c>Type.AssemblyQualifiedName</c> property,
  30357. but this method works on the .NET Compact Framework 1.0 as well as
  30358. the full .NET runtime.
  30359. </para>
  30360. </remarks>
  30361. </member>
  30362. <member name="M:log4net.Util.SystemInfo.AssemblyShortName(System.Reflection.Assembly)">
  30363. <summary>
  30364. Gets the short name of the <see cref="T:System.Reflection.Assembly" />.
  30365. </summary>
  30366. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly" /> to get the name for.</param>
  30367. <returns>The short name of the <see cref="T:System.Reflection.Assembly" />.</returns>
  30368. <remarks>
  30369. <para>
  30370. The short name of the assembly is the <see cref="P:System.Reflection.Assembly.FullName" />
  30371. without the version, culture, or public key. i.e. it is just the
  30372. assembly's file name without the extension.
  30373. </para>
  30374. <para>
  30375. Use this rather than <c>Assembly.GetName().Name</c> because that
  30376. is not available on the Compact Framework.
  30377. </para>
  30378. <para>
  30379. Because of a FileIOPermission security demand we cannot do
  30380. the obvious Assembly.GetName().Name. We are allowed to get
  30381. the <see cref="P:System.Reflection.Assembly.FullName" /> of the assembly so we
  30382. start from there and strip out just the assembly name.
  30383. </para>
  30384. </remarks>
  30385. </member>
  30386. <member name="M:log4net.Util.SystemInfo.AssemblyFileName(System.Reflection.Assembly)">
  30387. <summary>
  30388. Gets the file name portion of the <see cref="T:System.Reflection.Assembly" />, including the extension.
  30389. </summary>
  30390. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly" /> to get the file name for.</param>
  30391. <returns>The file name of the assembly.</returns>
  30392. <remarks>
  30393. <para>
  30394. Gets the file name portion of the <see cref="T:System.Reflection.Assembly" />, including the extension.
  30395. </para>
  30396. </remarks>
  30397. </member>
  30398. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Type,System.String,System.Boolean,System.Boolean)">
  30399. <summary>
  30400. Loads the type specified in the type string.
  30401. </summary>
  30402. <param name="relativeType">A sibling type to use to load the type.</param>
  30403. <param name="typeName">The name of the type to load.</param>
  30404. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  30405. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  30406. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  30407. <remarks>
  30408. <para>
  30409. If the type name is fully qualified, i.e. if contains an assembly name in
  30410. the type name, the type will be loaded from the system using
  30411. <see cref="M:Type.GetType(string,bool)"/>.
  30412. </para>
  30413. <para>
  30414. If the type name is not fully qualified, it will be loaded from the assembly
  30415. containing the specified relative type. If the type is not found in the assembly
  30416. then all the loaded assemblies will be searched for the type.
  30417. </para>
  30418. </remarks>
  30419. </member>
  30420. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.String,System.Boolean,System.Boolean)">
  30421. <summary>
  30422. Loads the type specified in the type string.
  30423. </summary>
  30424. <param name="typeName">The name of the type to load.</param>
  30425. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  30426. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  30427. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  30428. <remarks>
  30429. <para>
  30430. If the type name is fully qualified, i.e. if contains an assembly name in
  30431. the type name, the type will be loaded from the system using
  30432. <see cref="M:Type.GetType(string,bool)"/>.
  30433. </para>
  30434. <para>
  30435. If the type name is not fully qualified it will be loaded from the
  30436. assembly that is directly calling this method. If the type is not found
  30437. in the assembly then all the loaded assemblies will be searched for the type.
  30438. </para>
  30439. </remarks>
  30440. </member>
  30441. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Reflection.Assembly,System.String,System.Boolean,System.Boolean)">
  30442. <summary>
  30443. Loads the type specified in the type string.
  30444. </summary>
  30445. <param name="relativeAssembly">An assembly to load the type from.</param>
  30446. <param name="typeName">The name of the type to load.</param>
  30447. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  30448. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  30449. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  30450. <remarks>
  30451. <para>
  30452. If the type name is fully qualified, i.e. if contains an assembly name in
  30453. the type name, the type will be loaded from the system using
  30454. <see cref="M:Type.GetType(string,bool)"/>.
  30455. </para>
  30456. <para>
  30457. If the type name is not fully qualified it will be loaded from the specified
  30458. assembly. If the type is not found in the assembly then all the loaded assemblies
  30459. will be searched for the type.
  30460. </para>
  30461. </remarks>
  30462. </member>
  30463. <member name="M:log4net.Util.SystemInfo.NewGuid">
  30464. <summary>
  30465. Generate a new guid
  30466. </summary>
  30467. <returns>A new Guid</returns>
  30468. <remarks>
  30469. <para>
  30470. Generate a new guid
  30471. </para>
  30472. </remarks>
  30473. </member>
  30474. <member name="M:log4net.Util.SystemInfo.CreateArgumentOutOfRangeException(System.String,System.Object,System.String)">
  30475. <summary>
  30476. Create an <see cref="T:System.ArgumentOutOfRangeException"/>
  30477. </summary>
  30478. <param name="parameterName">The name of the parameter that caused the exception</param>
  30479. <param name="actualValue">The value of the argument that causes this exception</param>
  30480. <param name="message">The message that describes the error</param>
  30481. <returns>the ArgumentOutOfRangeException object</returns>
  30482. <remarks>
  30483. <para>
  30484. Create a new instance of the <see cref="T:System.ArgumentOutOfRangeException"/> class
  30485. with a specified error message, the parameter name, and the value
  30486. of the argument.
  30487. </para>
  30488. <para>
  30489. The Compact Framework does not support the 3 parameter constructor for the
  30490. <see cref="T:System.ArgumentOutOfRangeException"/> type. This method provides an
  30491. implementation that works for all platforms.
  30492. </para>
  30493. </remarks>
  30494. </member>
  30495. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int32@)">
  30496. <summary>
  30497. Parse a string into an <see cref="T:System.Int32"/> value
  30498. </summary>
  30499. <param name="s">the string to parse</param>
  30500. <param name="val">out param where the parsed value is placed</param>
  30501. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  30502. <remarks>
  30503. <para>
  30504. Attempts to parse the string into an integer. If the string cannot
  30505. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  30506. </para>
  30507. </remarks>
  30508. </member>
  30509. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int64@)">
  30510. <summary>
  30511. Parse a string into an <see cref="T:System.Int64"/> value
  30512. </summary>
  30513. <param name="s">the string to parse</param>
  30514. <param name="val">out param where the parsed value is placed</param>
  30515. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  30516. <remarks>
  30517. <para>
  30518. Attempts to parse the string into an integer. If the string cannot
  30519. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  30520. </para>
  30521. </remarks>
  30522. </member>
  30523. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int16@)">
  30524. <summary>
  30525. Parse a string into an <see cref="T:System.Int16"/> value
  30526. </summary>
  30527. <param name="s">the string to parse</param>
  30528. <param name="val">out param where the parsed value is placed</param>
  30529. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  30530. <remarks>
  30531. <para>
  30532. Attempts to parse the string into an integer. If the string cannot
  30533. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  30534. </para>
  30535. </remarks>
  30536. </member>
  30537. <member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)">
  30538. <summary>
  30539. Lookup an application setting
  30540. </summary>
  30541. <param name="key">the application settings key to lookup</param>
  30542. <returns>the value for the key, or <c>null</c></returns>
  30543. <remarks>
  30544. <para>
  30545. Configuration APIs are not supported under the Compact Framework
  30546. </para>
  30547. </remarks>
  30548. </member>
  30549. <member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)">
  30550. <summary>
  30551. Convert a path into a fully qualified local file path.
  30552. </summary>
  30553. <param name="path">The path to convert.</param>
  30554. <returns>The fully qualified path.</returns>
  30555. <remarks>
  30556. <para>
  30557. Converts the path specified to a fully
  30558. qualified path. If the path is relative it is
  30559. taken as relative from the application base
  30560. directory.
  30561. </para>
  30562. <para>
  30563. The path specified must be a local file path, a URI is not supported.
  30564. </para>
  30565. </remarks>
  30566. </member>
  30567. <member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable">
  30568. <summary>
  30569. Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity.
  30570. </summary>
  30571. <returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns>
  30572. <remarks>
  30573. <para>
  30574. The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer.
  30575. </para>
  30576. </remarks>
  30577. </member>
  30578. <member name="M:log4net.Util.SystemInfo.EqualsIgnoringCase(System.String,System.String)">
  30579. <summary>
  30580. Tests two strings for equality, the ignoring case.
  30581. </summary>
  30582. <remarks>
  30583. If the platform permits, culture information is ignored completely (ordinal comparison).
  30584. The aim of this method is to provide a fast comparison that deals with <c>null</c> and ignores different casing.
  30585. It is not supposed to deal with various, culture-specific habits.
  30586. Use it to compare against pure ASCII constants, like keywords etc.
  30587. </remarks>
  30588. <param name="a">The one string.</param>
  30589. <param name="b">The other string.</param>
  30590. <returns><c>true</c> if the strings are equal, <c>false</c> otherwise.</returns>
  30591. </member>
  30592. <member name="F:log4net.Util.SystemInfo.EmptyTypes">
  30593. <summary>
  30594. Gets an empty array of types.
  30595. </summary>
  30596. <remarks>
  30597. <para>
  30598. The <c>Type.EmptyTypes</c> field is not available on
  30599. the .NET Compact Framework 1.0.
  30600. </para>
  30601. </remarks>
  30602. </member>
  30603. <member name="F:log4net.Util.SystemInfo.declaringType">
  30604. <summary>
  30605. The fully qualified type of the SystemInfo class.
  30606. </summary>
  30607. <remarks>
  30608. Used by the internal logger to record the Type of the
  30609. log message.
  30610. </remarks>
  30611. </member>
  30612. <member name="F:log4net.Util.SystemInfo.s_hostName">
  30613. <summary>
  30614. Cache the host name for the current machine
  30615. </summary>
  30616. </member>
  30617. <member name="F:log4net.Util.SystemInfo.s_appFriendlyName">
  30618. <summary>
  30619. Cache the application friendly name
  30620. </summary>
  30621. </member>
  30622. <member name="F:log4net.Util.SystemInfo.s_nullText">
  30623. <summary>
  30624. Text to output when a <c>null</c> is encountered.
  30625. </summary>
  30626. </member>
  30627. <member name="F:log4net.Util.SystemInfo.s_notAvailableText">
  30628. <summary>
  30629. Text to output when an unsupported feature is requested.
  30630. </summary>
  30631. </member>
  30632. <member name="F:log4net.Util.SystemInfo.s_processStartTimeUtc">
  30633. <summary>
  30634. Start time for the current process.
  30635. </summary>
  30636. </member>
  30637. <member name="T:log4net.Util.SystemStringFormat">
  30638. <summary>
  30639. Utility class that represents a format string.
  30640. </summary>
  30641. <remarks>
  30642. <para>
  30643. Utility class that represents a format string.
  30644. </para>
  30645. </remarks>
  30646. <author>Nicko Cadell</author>
  30647. </member>
  30648. <member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])">
  30649. <summary>
  30650. Initialise the <see cref="T:log4net.Util.SystemStringFormat"/>
  30651. </summary>
  30652. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  30653. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  30654. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  30655. </member>
  30656. <member name="M:log4net.Util.SystemStringFormat.ToString">
  30657. <summary>
  30658. Format the string and arguments
  30659. </summary>
  30660. <returns>the formatted string</returns>
  30661. </member>
  30662. <member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])">
  30663. <summary>
  30664. Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent
  30665. of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array.
  30666. A specified parameter supplies culture-specific formatting information.
  30667. </summary>
  30668. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  30669. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  30670. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  30671. <returns>
  30672. A copy of format in which the format items have been replaced by the <see cref="T:System.String"/>
  30673. equivalent of the corresponding instances of <see cref="T:System.Object"/> in args.
  30674. </returns>
  30675. <remarks>
  30676. <para>
  30677. This method does not throw exceptions. If an exception thrown while formatting the result the
  30678. exception and arguments are returned in the result string.
  30679. </para>
  30680. </remarks>
  30681. </member>
  30682. <member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])">
  30683. <summary>
  30684. Process an error during StringFormat
  30685. </summary>
  30686. </member>
  30687. <member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)">
  30688. <summary>
  30689. Dump the contents of an array into a string builder
  30690. </summary>
  30691. </member>
  30692. <member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)">
  30693. <summary>
  30694. Dump an object to a string
  30695. </summary>
  30696. </member>
  30697. <member name="F:log4net.Util.SystemStringFormat.declaringType">
  30698. <summary>
  30699. The fully qualified type of the SystemStringFormat class.
  30700. </summary>
  30701. <remarks>
  30702. Used by the internal logger to record the Type of the
  30703. log message.
  30704. </remarks>
  30705. </member>
  30706. <member name="T:log4net.Util.TextWriterAdapter">
  30707. <summary>
  30708. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  30709. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  30710. </summary>
  30711. <remarks>
  30712. <para>
  30713. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  30714. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  30715. </para>
  30716. </remarks>
  30717. <author>Nicko Cadell</author>
  30718. </member>
  30719. <member name="F:log4net.Util.TextWriterAdapter.m_writer">
  30720. <summary>
  30721. The writer to forward messages to
  30722. </summary>
  30723. </member>
  30724. <member name="M:log4net.Util.TextWriterAdapter.#ctor(System.IO.TextWriter)">
  30725. <summary>
  30726. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  30727. messages to a <see cref="T:System.IO.TextWriter"/>.
  30728. </summary>
  30729. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to forward to</param>
  30730. <remarks>
  30731. <para>
  30732. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  30733. messages to a <see cref="T:System.IO.TextWriter"/>.
  30734. </para>
  30735. </remarks>
  30736. </member>
  30737. <member name="P:log4net.Util.TextWriterAdapter.Writer">
  30738. <summary>
  30739. Gets or sets the underlying <see cref="T:System.IO.TextWriter" />.
  30740. </summary>
  30741. <value>
  30742. The underlying <see cref="T:System.IO.TextWriter" />.
  30743. </value>
  30744. <remarks>
  30745. <para>
  30746. Gets or sets the underlying <see cref="T:System.IO.TextWriter" />.
  30747. </para>
  30748. </remarks>
  30749. </member>
  30750. <member name="P:log4net.Util.TextWriterAdapter.Encoding">
  30751. <summary>
  30752. The Encoding in which the output is written
  30753. </summary>
  30754. <value>
  30755. The <see cref="P:log4net.Util.TextWriterAdapter.Encoding"/>
  30756. </value>
  30757. <remarks>
  30758. <para>
  30759. The Encoding in which the output is written
  30760. </para>
  30761. </remarks>
  30762. </member>
  30763. <member name="P:log4net.Util.TextWriterAdapter.FormatProvider">
  30764. <summary>
  30765. Gets an object that controls formatting
  30766. </summary>
  30767. <value>
  30768. The format provider
  30769. </value>
  30770. <remarks>
  30771. <para>
  30772. Gets an object that controls formatting
  30773. </para>
  30774. </remarks>
  30775. </member>
  30776. <member name="P:log4net.Util.TextWriterAdapter.NewLine">
  30777. <summary>
  30778. Gets or sets the line terminator string used by the TextWriter
  30779. </summary>
  30780. <value>
  30781. The line terminator to use
  30782. </value>
  30783. <remarks>
  30784. <para>
  30785. Gets or sets the line terminator string used by the TextWriter
  30786. </para>
  30787. </remarks>
  30788. </member>
  30789. <member name="M:log4net.Util.TextWriterAdapter.Close">
  30790. <summary>
  30791. Closes the writer and releases any system resources associated with the writer
  30792. </summary>
  30793. <remarks>
  30794. <para>
  30795. </para>
  30796. </remarks>
  30797. </member>
  30798. <member name="M:log4net.Util.TextWriterAdapter.Dispose(System.Boolean)">
  30799. <summary>
  30800. Dispose this writer
  30801. </summary>
  30802. <param name="disposing">flag indicating if we are being disposed</param>
  30803. <remarks>
  30804. <para>
  30805. Dispose this writer
  30806. </para>
  30807. </remarks>
  30808. </member>
  30809. <member name="M:log4net.Util.TextWriterAdapter.Flush">
  30810. <summary>
  30811. Flushes any buffered output
  30812. </summary>
  30813. <remarks>
  30814. <para>
  30815. Clears all buffers for the writer and causes any buffered data to be written
  30816. to the underlying device
  30817. </para>
  30818. </remarks>
  30819. </member>
  30820. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char)">
  30821. <summary>
  30822. Writes a character to the wrapped TextWriter
  30823. </summary>
  30824. <param name="value">the value to write to the TextWriter</param>
  30825. <remarks>
  30826. <para>
  30827. Writes a character to the wrapped TextWriter
  30828. </para>
  30829. </remarks>
  30830. </member>
  30831. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char[],System.Int32,System.Int32)">
  30832. <summary>
  30833. Writes a character buffer to the wrapped TextWriter
  30834. </summary>
  30835. <param name="buffer">the data buffer</param>
  30836. <param name="index">the start index</param>
  30837. <param name="count">the number of characters to write</param>
  30838. <remarks>
  30839. <para>
  30840. Writes a character buffer to the wrapped TextWriter
  30841. </para>
  30842. </remarks>
  30843. </member>
  30844. <member name="M:log4net.Util.TextWriterAdapter.Write(System.String)">
  30845. <summary>
  30846. Writes a string to the wrapped TextWriter
  30847. </summary>
  30848. <param name="value">the value to write to the TextWriter</param>
  30849. <remarks>
  30850. <para>
  30851. Writes a string to the wrapped TextWriter
  30852. </para>
  30853. </remarks>
  30854. </member>
  30855. <member name="T:log4net.Util.ThreadContextProperties">
  30856. <summary>
  30857. Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/>
  30858. </summary>
  30859. <remarks>
  30860. <para>
  30861. Class implements a collection of properties that is specific to each thread.
  30862. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  30863. </para>
  30864. </remarks>
  30865. <author>Nicko Cadell</author>
  30866. </member>
  30867. <member name="F:log4net.Util.ThreadContextProperties._dictionary">
  30868. <summary>
  30869. Each thread will automatically have its instance.
  30870. </summary>
  30871. </member>
  30872. <member name="M:log4net.Util.ThreadContextProperties.#ctor">
  30873. <summary>
  30874. Internal constructor
  30875. </summary>
  30876. <remarks>
  30877. <para>
  30878. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextProperties" /> class.
  30879. </para>
  30880. </remarks>
  30881. </member>
  30882. <member name="P:log4net.Util.ThreadContextProperties.Item(System.String)">
  30883. <summary>
  30884. Gets or sets the value of a property
  30885. </summary>
  30886. <value>
  30887. The value for the property with the specified key
  30888. </value>
  30889. <remarks>
  30890. <para>
  30891. Gets or sets the value of a property
  30892. </para>
  30893. </remarks>
  30894. </member>
  30895. <member name="M:log4net.Util.ThreadContextProperties.Remove(System.String)">
  30896. <summary>
  30897. Remove a property
  30898. </summary>
  30899. <param name="key">the key for the entry to remove</param>
  30900. <remarks>
  30901. <para>
  30902. Remove a property
  30903. </para>
  30904. </remarks>
  30905. </member>
  30906. <member name="M:log4net.Util.ThreadContextProperties.GetKeys">
  30907. <summary>
  30908. Get the keys stored in the properties.
  30909. </summary>
  30910. <para>
  30911. Gets the keys stored in the properties.
  30912. </para>
  30913. <returns>a set of the defined keys</returns>
  30914. </member>
  30915. <member name="M:log4net.Util.ThreadContextProperties.Clear">
  30916. <summary>
  30917. Clear all properties
  30918. </summary>
  30919. <remarks>
  30920. <para>
  30921. Clear all properties
  30922. </para>
  30923. </remarks>
  30924. </member>
  30925. <member name="M:log4net.Util.ThreadContextProperties.GetProperties(System.Boolean)">
  30926. <summary>
  30927. Get the <c>PropertiesDictionary</c> for this thread.
  30928. </summary>
  30929. <param name="create">create the dictionary if it does not exist, otherwise return null if does not exist</param>
  30930. <returns>the properties for this thread</returns>
  30931. <remarks>
  30932. <para>
  30933. The collection returned is only to be used on the calling thread. If the
  30934. caller needs to share the collection between different threads then the
  30935. caller must clone the collection before doing so.
  30936. </para>
  30937. </remarks>
  30938. </member>
  30939. <member name="T:log4net.Util.ThreadContextStack">
  30940. <summary>
  30941. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  30942. </summary>
  30943. <remarks>
  30944. <para>
  30945. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  30946. </para>
  30947. </remarks>
  30948. <author>Nicko Cadell</author>
  30949. </member>
  30950. <member name="F:log4net.Util.ThreadContextStack.m_stack">
  30951. <summary>
  30952. The stack store.
  30953. </summary>
  30954. </member>
  30955. <member name="M:log4net.Util.ThreadContextStack.#ctor">
  30956. <summary>
  30957. Internal constructor
  30958. </summary>
  30959. <remarks>
  30960. <para>
  30961. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack" /> class.
  30962. </para>
  30963. </remarks>
  30964. </member>
  30965. <member name="P:log4net.Util.ThreadContextStack.Count">
  30966. <summary>
  30967. The number of messages in the stack
  30968. </summary>
  30969. <value>
  30970. The current number of messages in the stack
  30971. </value>
  30972. <remarks>
  30973. <para>
  30974. The current number of messages in the stack. That is
  30975. the number of times <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> has been called
  30976. minus the number of times <see cref="M:log4net.Util.ThreadContextStack.Pop"/> has been called.
  30977. </para>
  30978. </remarks>
  30979. </member>
  30980. <member name="M:log4net.Util.ThreadContextStack.Clear">
  30981. <summary>
  30982. Clears all the contextual information held in this stack.
  30983. </summary>
  30984. <remarks>
  30985. <para>
  30986. Clears all the contextual information held in this stack.
  30987. Only call this if you think that this tread is being reused after
  30988. a previous call execution which may not have completed correctly.
  30989. You do not need to use this method if you always guarantee to call
  30990. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  30991. returned from <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  30992. for example by using the <c>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  30993. syntax.
  30994. </para>
  30995. </remarks>
  30996. </member>
  30997. <member name="M:log4net.Util.ThreadContextStack.Pop">
  30998. <summary>
  30999. Removes the top context from this stack.
  31000. </summary>
  31001. <returns>The message in the context that was removed from the top of this stack.</returns>
  31002. <remarks>
  31003. <para>
  31004. Remove the top context from this stack, and return
  31005. it to the caller. If this stack is empty then an
  31006. empty string (not <see langword="null"/>) is returned.
  31007. </para>
  31008. </remarks>
  31009. </member>
  31010. <member name="M:log4net.Util.ThreadContextStack.Push(System.String)">
  31011. <summary>
  31012. Pushes a new context message into this stack.
  31013. </summary>
  31014. <param name="message">The new context message.</param>
  31015. <returns>
  31016. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  31017. </returns>
  31018. <remarks>
  31019. <para>
  31020. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  31021. is returned that can be used to clean up this stack. This
  31022. can be easily combined with the <c>using</c> keyword to scope the
  31023. context.
  31024. </para>
  31025. </remarks>
  31026. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  31027. <code lang="C#">
  31028. using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
  31029. {
  31030. log.Warn("This should have an ThreadContext Stack message");
  31031. }
  31032. </code>
  31033. </example>
  31034. </member>
  31035. <member name="M:log4net.Util.ThreadContextStack.GetFullMessage">
  31036. <summary>
  31037. Gets the current context information for this stack.
  31038. </summary>
  31039. <returns>The current context information.</returns>
  31040. </member>
  31041. <member name="P:log4net.Util.ThreadContextStack.InternalStack">
  31042. <summary>
  31043. Gets and sets the internal stack used by this <see cref="T:log4net.Util.ThreadContextStack"/>
  31044. </summary>
  31045. <value>The internal storage stack</value>
  31046. <remarks>
  31047. <para>
  31048. This property is provided only to support backward compatability
  31049. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  31050. be modified.
  31051. </para>
  31052. </remarks>
  31053. </member>
  31054. <member name="M:log4net.Util.ThreadContextStack.ToString">
  31055. <summary>
  31056. Gets the current context information for this stack.
  31057. </summary>
  31058. <returns>Gets the current context information</returns>
  31059. <remarks>
  31060. <para>
  31061. Gets the current context information for this stack.
  31062. </para>
  31063. </remarks>
  31064. </member>
  31065. <member name="M:log4net.Util.ThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  31066. <summary>
  31067. Get a portable version of this object
  31068. </summary>
  31069. <returns>the portable instance of this object</returns>
  31070. <remarks>
  31071. <para>
  31072. Get a cross thread portable version of this object
  31073. </para>
  31074. </remarks>
  31075. </member>
  31076. <member name="T:log4net.Util.ThreadContextStack.StackFrame">
  31077. <summary>
  31078. Inner class used to represent a single context frame in the stack.
  31079. </summary>
  31080. <remarks>
  31081. <para>
  31082. Inner class used to represent a single context frame in the stack.
  31083. </para>
  31084. </remarks>
  31085. </member>
  31086. <member name="M:log4net.Util.ThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.ThreadContextStack.StackFrame)">
  31087. <summary>
  31088. Constructor
  31089. </summary>
  31090. <param name="message">The message for this context.</param>
  31091. <param name="parent">The parent context in the chain.</param>
  31092. <remarks>
  31093. <para>
  31094. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.StackFrame" /> class
  31095. with the specified message and parent context.
  31096. </para>
  31097. </remarks>
  31098. </member>
  31099. <member name="P:log4net.Util.ThreadContextStack.StackFrame.Message">
  31100. <summary>
  31101. Get the message.
  31102. </summary>
  31103. <value>The message.</value>
  31104. <remarks>
  31105. <para>
  31106. Get the message.
  31107. </para>
  31108. </remarks>
  31109. </member>
  31110. <member name="P:log4net.Util.ThreadContextStack.StackFrame.FullMessage">
  31111. <summary>
  31112. Gets the full text of the context down to the root level.
  31113. </summary>
  31114. <value>
  31115. The full text of the context down to the root level.
  31116. </value>
  31117. <remarks>
  31118. <para>
  31119. Gets the full text of the context down to the root level.
  31120. </para>
  31121. </remarks>
  31122. </member>
  31123. <member name="T:log4net.Util.ThreadContextStack.AutoPopStackFrame">
  31124. <summary>
  31125. Struct returned from the <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> method.
  31126. </summary>
  31127. <remarks>
  31128. <para>
  31129. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  31130. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  31131. </para>
  31132. </remarks>
  31133. </member>
  31134. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameStack">
  31135. <summary>
  31136. The ThreadContextStack internal stack
  31137. </summary>
  31138. </member>
  31139. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameDepth">
  31140. <summary>
  31141. The depth to trim the stack to when this instance is disposed
  31142. </summary>
  31143. </member>
  31144. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.#ctor(System.Collections.Stack,System.Int32)">
  31145. <summary>
  31146. Constructor
  31147. </summary>
  31148. <param name="frameStack">The internal stack used by the ThreadContextStack.</param>
  31149. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  31150. <remarks>
  31151. <para>
  31152. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.AutoPopStackFrame" /> class with
  31153. the specified stack and return depth.
  31154. </para>
  31155. </remarks>
  31156. </member>
  31157. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.Dispose">
  31158. <summary>
  31159. Returns the stack to the correct depth.
  31160. </summary>
  31161. <remarks>
  31162. <para>
  31163. Returns the stack to the correct depth.
  31164. </para>
  31165. </remarks>
  31166. </member>
  31167. <member name="T:log4net.Util.ThreadContextStacks">
  31168. <summary>
  31169. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  31170. </summary>
  31171. <remarks>
  31172. <para>
  31173. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  31174. </para>
  31175. </remarks>
  31176. <author>Nicko Cadell</author>
  31177. </member>
  31178. <member name="M:log4net.Util.ThreadContextStacks.#ctor(log4net.Util.ContextPropertiesBase)">
  31179. <summary>
  31180. Internal constructor
  31181. </summary>
  31182. <remarks>
  31183. <para>
  31184. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks" /> class.
  31185. </para>
  31186. </remarks>
  31187. </member>
  31188. <member name="P:log4net.Util.ThreadContextStacks.Item(System.String)">
  31189. <summary>
  31190. Gets the named thread context stack
  31191. </summary>
  31192. <value>
  31193. The named stack
  31194. </value>
  31195. <remarks>
  31196. <para>
  31197. Gets the named thread context stack
  31198. </para>
  31199. </remarks>
  31200. </member>
  31201. <member name="F:log4net.Util.ThreadContextStacks.declaringType">
  31202. <summary>
  31203. The fully qualified type of the ThreadContextStacks class.
  31204. </summary>
  31205. <remarks>
  31206. Used by the internal logger to record the Type of the
  31207. log message.
  31208. </remarks>
  31209. </member>
  31210. <member name="T:log4net.Util.Transform">
  31211. <summary>
  31212. Utility class for transforming strings.
  31213. </summary>
  31214. <remarks>
  31215. <para>
  31216. Utility class for transforming strings.
  31217. </para>
  31218. </remarks>
  31219. <author>Nicko Cadell</author>
  31220. <author>Gert Driesen</author>
  31221. </member>
  31222. <member name="M:log4net.Util.Transform.#ctor">
  31223. <summary>
  31224. Initializes a new instance of the <see cref="T:log4net.Util.Transform" /> class.
  31225. </summary>
  31226. <remarks>
  31227. <para>
  31228. Uses a private access modifier to prevent instantiation of this class.
  31229. </para>
  31230. </remarks>
  31231. </member>
  31232. <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)">
  31233. <summary>
  31234. Write a string to an <see cref="T:System.Xml.XmlWriter"/>
  31235. </summary>
  31236. <param name="writer">the writer to write to</param>
  31237. <param name="textData">the string to write</param>
  31238. <param name="invalidCharReplacement">The string to replace non XML compliant chars with</param>
  31239. <remarks>
  31240. <para>
  31241. The test is escaped either using XML escape entities
  31242. or using CDATA sections.
  31243. </para>
  31244. </remarks>
  31245. </member>
  31246. <member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)">
  31247. <summary>
  31248. Replace invalid XML characters in text string
  31249. </summary>
  31250. <param name="textData">the XML text input string</param>
  31251. <param name="mask">the string to use in place of invalid characters</param>
  31252. <returns>A string that does not contain invalid XML characters.</returns>
  31253. <remarks>
  31254. <para>
  31255. Certain Unicode code points are not allowed in the XML InfoSet, for
  31256. details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>.
  31257. </para>
  31258. <para>
  31259. This method replaces any illegal characters in the input string
  31260. with the mask string specified.
  31261. </para>
  31262. </remarks>
  31263. </member>
  31264. <member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)">
  31265. <summary>
  31266. Count the number of times that the substring occurs in the text
  31267. </summary>
  31268. <param name="text">the text to search</param>
  31269. <param name="substring">the substring to find</param>
  31270. <returns>the number of times the substring occurs in the text</returns>
  31271. <remarks>
  31272. <para>
  31273. The substring is assumed to be non repeating within itself.
  31274. </para>
  31275. </remarks>
  31276. </member>
  31277. <member name="F:log4net.Util.Transform.INVALIDCHARS">
  31278. <summary>
  31279. Characters illegal in XML 1.0
  31280. </summary>
  31281. </member>
  31282. <member name="T:log4net.Util.TypeConverters.BooleanConverter">
  31283. <summary>
  31284. Type converter for Boolean.
  31285. </summary>
  31286. <remarks>
  31287. <para>
  31288. Supports conversion from string to <c>bool</c> type.
  31289. </para>
  31290. </remarks>
  31291. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31292. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31293. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31294. <author>Nicko Cadell</author>
  31295. <author>Gert Driesen</author>
  31296. </member>
  31297. <member name="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)">
  31298. <summary>
  31299. Can the source type be converted to the type supported by this object
  31300. </summary>
  31301. <param name="sourceType">the type to convert</param>
  31302. <returns>true if the conversion is possible</returns>
  31303. <remarks>
  31304. <para>
  31305. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31306. the <see cref="T:System.String"/> type.
  31307. </para>
  31308. </remarks>
  31309. </member>
  31310. <member name="M:log4net.Util.TypeConverters.BooleanConverter.ConvertFrom(System.Object)">
  31311. <summary>
  31312. Convert the source object to the type supported by this object
  31313. </summary>
  31314. <param name="source">the object to convert</param>
  31315. <returns>the converted object</returns>
  31316. <remarks>
  31317. <para>
  31318. Uses the <see cref="M:System.Boolean.Parse(System.String)"/> method to convert the
  31319. <see cref="T:System.String"/> argument to a <see cref="T:System.Boolean"/>.
  31320. </para>
  31321. </remarks>
  31322. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31323. The <paramref name="source"/> object cannot be converted to the
  31324. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"/>
  31325. method.
  31326. </exception>
  31327. </member>
  31328. <member name="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31329. <summary>
  31330. Exception base type for conversion errors.
  31331. </summary>
  31332. <remarks>
  31333. <para>
  31334. This type extends <see cref="T:System.ApplicationException"/>. It
  31335. does not add any new functionality but does differentiate the
  31336. type of exception being thrown.
  31337. </para>
  31338. </remarks>
  31339. <author>Nicko Cadell</author>
  31340. <author>Gert Driesen</author>
  31341. </member>
  31342. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor">
  31343. <summary>
  31344. Constructor
  31345. </summary>
  31346. <remarks>
  31347. <para>
  31348. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  31349. </para>
  31350. </remarks>
  31351. </member>
  31352. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String)">
  31353. <summary>
  31354. Constructor
  31355. </summary>
  31356. <param name="message">A message to include with the exception.</param>
  31357. <remarks>
  31358. <para>
  31359. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class
  31360. with the specified message.
  31361. </para>
  31362. </remarks>
  31363. </member>
  31364. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String,System.Exception)">
  31365. <summary>
  31366. Constructor
  31367. </summary>
  31368. <param name="message">A message to include with the exception.</param>
  31369. <param name="innerException">A nested exception to include.</param>
  31370. <remarks>
  31371. <para>
  31372. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class
  31373. with the specified message and inner exception.
  31374. </para>
  31375. </remarks>
  31376. </member>
  31377. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  31378. <summary>
  31379. Serialization constructor
  31380. </summary>
  31381. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
  31382. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  31383. <remarks>
  31384. <para>
  31385. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class
  31386. with serialized data.
  31387. </para>
  31388. </remarks>
  31389. </member>
  31390. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object)">
  31391. <summary>
  31392. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  31393. </summary>
  31394. <param name="destinationType">The conversion destination type.</param>
  31395. <param name="sourceValue">The value to convert.</param>
  31396. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" />.</returns>
  31397. <remarks>
  31398. <para>
  31399. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  31400. </para>
  31401. </remarks>
  31402. </member>
  31403. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object,System.Exception)">
  31404. <summary>
  31405. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  31406. </summary>
  31407. <param name="destinationType">The conversion destination type.</param>
  31408. <param name="sourceValue">The value to convert.</param>
  31409. <param name="innerException">A nested exception to include.</param>
  31410. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" />.</returns>
  31411. <remarks>
  31412. <para>
  31413. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  31414. </para>
  31415. </remarks>
  31416. </member>
  31417. <member name="T:log4net.Util.TypeConverters.ConverterRegistry">
  31418. <summary>
  31419. Register of type converters for specific types.
  31420. </summary>
  31421. <remarks>
  31422. <para>
  31423. Maintains a registry of type converters used to convert between
  31424. types.
  31425. </para>
  31426. <para>
  31427. Use the <see cref="M:AddConverter(Type, object)"/> and
  31428. <see cref="M:AddConverter(Type, Type)"/> methods to register new converters.
  31429. 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
  31430. lookup appropriate converters to use.
  31431. </para>
  31432. </remarks>
  31433. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31434. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31435. <author>Nicko Cadell</author>
  31436. <author>Gert Driesen</author>
  31437. </member>
  31438. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#ctor">
  31439. <summary>
  31440. Private constructor
  31441. </summary>
  31442. <remarks>
  31443. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConverterRegistry" /> class.
  31444. </remarks>
  31445. </member>
  31446. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#cctor">
  31447. <summary>
  31448. Static constructor.
  31449. </summary>
  31450. <remarks>
  31451. <para>
  31452. This constructor defines the intrinsic type converters.
  31453. </para>
  31454. </remarks>
  31455. </member>
  31456. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)">
  31457. <summary>
  31458. Adds a converter for a specific type.
  31459. </summary>
  31460. <param name="destinationType">The type being converted to.</param>
  31461. <param name="converter">The type converter to use to convert to the destination type.</param>
  31462. <remarks>
  31463. <para>
  31464. Adds a converter instance for a specific type.
  31465. </para>
  31466. </remarks>
  31467. </member>
  31468. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)">
  31469. <summary>
  31470. Adds a converter for a specific type.
  31471. </summary>
  31472. <param name="destinationType">The type being converted to.</param>
  31473. <param name="converterType">The type of the type converter to use to convert to the destination type.</param>
  31474. <remarks>
  31475. <para>
  31476. Adds a converter <see cref="T:System.Type"/> for a specific type.
  31477. </para>
  31478. </remarks>
  31479. </member>
  31480. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)">
  31481. <summary>
  31482. Gets the type converter to use to convert values to the destination type.
  31483. </summary>
  31484. <param name="sourceType">The type being converted from.</param>
  31485. <param name="destinationType">The type being converted to.</param>
  31486. <returns>
  31487. The type converter instance to use for type conversions or <c>null</c>
  31488. if no type converter is found.
  31489. </returns>
  31490. <remarks>
  31491. <para>
  31492. Gets the type converter to use to convert values to the destination type.
  31493. </para>
  31494. </remarks>
  31495. </member>
  31496. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)">
  31497. <summary>
  31498. Gets the type converter to use to convert values to the destination type.
  31499. </summary>
  31500. <param name="destinationType">The type being converted to.</param>
  31501. <returns>
  31502. The type converter instance to use for type conversions or <c>null</c>
  31503. if no type converter is found.
  31504. </returns>
  31505. <remarks>
  31506. <para>
  31507. Gets the type converter to use to convert values to the destination type.
  31508. </para>
  31509. </remarks>
  31510. </member>
  31511. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConverterFromAttribute(System.Type)">
  31512. <summary>
  31513. Lookups the type converter to use as specified by the attributes on the
  31514. destination type.
  31515. </summary>
  31516. <param name="destinationType">The type being converted to.</param>
  31517. <returns>
  31518. The type converter instance to use for type conversions or <c>null</c>
  31519. if no type converter is found.
  31520. </returns>
  31521. </member>
  31522. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.CreateConverterInstance(System.Type)">
  31523. <summary>
  31524. Creates the instance of the type converter.
  31525. </summary>
  31526. <param name="converterType">The type of the type converter.</param>
  31527. <returns>
  31528. The type converter instance to use for type conversions or <c>null</c>
  31529. if no type converter is found.
  31530. </returns>
  31531. <remarks>
  31532. <para>
  31533. The type specified for the type converter must implement
  31534. the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> or <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces
  31535. and must have a public default (no argument) constructor.
  31536. </para>
  31537. </remarks>
  31538. </member>
  31539. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.declaringType">
  31540. <summary>
  31541. The fully qualified type of the ConverterRegistry class.
  31542. </summary>
  31543. <remarks>
  31544. Used by the internal logger to record the Type of the
  31545. log message.
  31546. </remarks>
  31547. </member>
  31548. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.s_type2converter">
  31549. <summary>
  31550. Mapping from <see cref="T:System.Type" /> to type converter.
  31551. </summary>
  31552. </member>
  31553. <member name="T:log4net.Util.TypeConverters.EncodingConverter">
  31554. <summary>
  31555. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  31556. </summary>
  31557. <remarks>
  31558. <para>
  31559. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  31560. </para>
  31561. </remarks>
  31562. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31563. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31564. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31565. <author>Nicko Cadell</author>
  31566. <author>Gert Driesen</author>
  31567. </member>
  31568. <member name="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)">
  31569. <summary>
  31570. Can the source type be converted to the type supported by this object
  31571. </summary>
  31572. <param name="sourceType">the type to convert</param>
  31573. <returns>true if the conversion is possible</returns>
  31574. <remarks>
  31575. <para>
  31576. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31577. the <see cref="T:System.String"/> type.
  31578. </para>
  31579. </remarks>
  31580. </member>
  31581. <member name="M:log4net.Util.TypeConverters.EncodingConverter.ConvertFrom(System.Object)">
  31582. <summary>
  31583. Overrides the ConvertFrom method of IConvertFrom.
  31584. </summary>
  31585. <param name="source">the object to convert to an encoding</param>
  31586. <returns>the encoding</returns>
  31587. <remarks>
  31588. <para>
  31589. Uses the <see cref="M:Encoding.GetEncoding(string)"/> method to
  31590. convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
  31591. </para>
  31592. </remarks>
  31593. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31594. The <paramref name="source"/> object cannot be converted to the
  31595. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"/>
  31596. method.
  31597. </exception>
  31598. </member>
  31599. <member name="T:log4net.Util.TypeConverters.IConvertFrom">
  31600. <summary>
  31601. Interface supported by type converters
  31602. </summary>
  31603. <remarks>
  31604. <para>
  31605. This interface supports conversion from arbitrary types
  31606. to a single target type. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  31607. </para>
  31608. </remarks>
  31609. <author>Nicko Cadell</author>
  31610. <author>Gert Driesen</author>
  31611. </member>
  31612. <member name="M:log4net.Util.TypeConverters.IConvertFrom.CanConvertFrom(System.Type)">
  31613. <summary>
  31614. Can the source type be converted to the type supported by this object
  31615. </summary>
  31616. <param name="sourceType">the type to convert</param>
  31617. <returns>true if the conversion is possible</returns>
  31618. <remarks>
  31619. <para>
  31620. Test if the <paramref name="sourceType"/> can be converted to the
  31621. type supported by this converter.
  31622. </para>
  31623. </remarks>
  31624. </member>
  31625. <member name="M:log4net.Util.TypeConverters.IConvertFrom.ConvertFrom(System.Object)">
  31626. <summary>
  31627. Convert the source object to the type supported by this object
  31628. </summary>
  31629. <param name="source">the object to convert</param>
  31630. <returns>the converted object</returns>
  31631. <remarks>
  31632. <para>
  31633. Converts the <paramref name="source"/> to the type supported
  31634. by this converter.
  31635. </para>
  31636. </remarks>
  31637. </member>
  31638. <member name="T:log4net.Util.TypeConverters.IConvertTo">
  31639. <summary>
  31640. Interface supported by type converters
  31641. </summary>
  31642. <remarks>
  31643. <para>
  31644. This interface supports conversion from a single type to arbitrary types.
  31645. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  31646. </para>
  31647. </remarks>
  31648. <author>Nicko Cadell</author>
  31649. </member>
  31650. <member name="M:log4net.Util.TypeConverters.IConvertTo.CanConvertTo(System.Type)">
  31651. <summary>
  31652. Returns whether this converter can convert the object to the specified type
  31653. </summary>
  31654. <param name="targetType">A Type that represents the type you want to convert to</param>
  31655. <returns>true if the conversion is possible</returns>
  31656. <remarks>
  31657. <para>
  31658. Test if the type supported by this converter can be converted to the
  31659. <paramref name="targetType"/>.
  31660. </para>
  31661. </remarks>
  31662. </member>
  31663. <member name="M:log4net.Util.TypeConverters.IConvertTo.ConvertTo(System.Object,System.Type)">
  31664. <summary>
  31665. Converts the given value object to the specified type, using the arguments
  31666. </summary>
  31667. <param name="source">the object to convert</param>
  31668. <param name="targetType">The Type to convert the value parameter to</param>
  31669. <returns>the converted object</returns>
  31670. <remarks>
  31671. <para>
  31672. Converts the <paramref name="source"/> (which must be of the type supported
  31673. by this converter) to the <paramref name="targetType"/> specified..
  31674. </para>
  31675. </remarks>
  31676. </member>
  31677. <member name="T:log4net.Util.TypeConverters.IPAddressConverter">
  31678. <summary>
  31679. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  31680. </summary>
  31681. <remarks>
  31682. <para>
  31683. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  31684. </para>
  31685. </remarks>
  31686. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31687. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31688. <author>Nicko Cadell</author>
  31689. </member>
  31690. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)">
  31691. <summary>
  31692. Can the source type be converted to the type supported by this object
  31693. </summary>
  31694. <param name="sourceType">the type to convert</param>
  31695. <returns>true if the conversion is possible</returns>
  31696. <remarks>
  31697. <para>
  31698. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31699. the <see cref="T:System.String"/> type.
  31700. </para>
  31701. </remarks>
  31702. </member>
  31703. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.ConvertFrom(System.Object)">
  31704. <summary>
  31705. Overrides the ConvertFrom method of IConvertFrom.
  31706. </summary>
  31707. <param name="source">the object to convert to an IPAddress</param>
  31708. <returns>the IPAddress</returns>
  31709. <remarks>
  31710. <para>
  31711. Uses the <see cref="M:System.Net.IPAddress.Parse(System.String)"/> method to convert the
  31712. <see cref="T:System.String"/> argument to an <see cref="T:System.Net.IPAddress"/>.
  31713. If that fails then the string is resolved as a DNS hostname.
  31714. </para>
  31715. </remarks>
  31716. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31717. The <paramref name="source"/> object cannot be converted to the
  31718. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"/>
  31719. method.
  31720. </exception>
  31721. </member>
  31722. <member name="F:log4net.Util.TypeConverters.IPAddressConverter.validIpAddressChars">
  31723. <summary>
  31724. Valid characters in an IPv4 or IPv6 address string. (Does not support subnets)
  31725. </summary>
  31726. </member>
  31727. <member name="T:log4net.Util.TypeConverters.PatternLayoutConverter">
  31728. <summary>
  31729. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  31730. </summary>
  31731. <remarks>
  31732. <para>
  31733. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  31734. </para>
  31735. <para>
  31736. The string is used as the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>
  31737. of the <see cref="T:log4net.Layout.PatternLayout"/>.
  31738. </para>
  31739. </remarks>
  31740. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31741. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31742. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31743. <author>Nicko Cadell</author>
  31744. </member>
  31745. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)">
  31746. <summary>
  31747. Can the source type be converted to the type supported by this object
  31748. </summary>
  31749. <param name="sourceType">the type to convert</param>
  31750. <returns>true if the conversion is possible</returns>
  31751. <remarks>
  31752. <para>
  31753. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31754. the <see cref="T:System.String"/> type.
  31755. </para>
  31756. </remarks>
  31757. </member>
  31758. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.ConvertFrom(System.Object)">
  31759. <summary>
  31760. Overrides the ConvertFrom method of IConvertFrom.
  31761. </summary>
  31762. <param name="source">the object to convert to a PatternLayout</param>
  31763. <returns>the PatternLayout</returns>
  31764. <remarks>
  31765. <para>
  31766. Creates and returns a new <see cref="T:log4net.Layout.PatternLayout"/> using
  31767. the <paramref name="source"/> <see cref="T:System.String"/> as the
  31768. <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>.
  31769. </para>
  31770. </remarks>
  31771. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31772. The <paramref name="source"/> object cannot be converted to the
  31773. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"/>
  31774. method.
  31775. </exception>
  31776. </member>
  31777. <member name="T:log4net.Util.TypeConverters.PatternStringConverter">
  31778. <summary>
  31779. Convert between string and <see cref="T:log4net.Util.PatternString"/>
  31780. </summary>
  31781. <remarks>
  31782. <para>
  31783. Supports conversion from string to <see cref="T:log4net.Util.PatternString"/> type,
  31784. and from a <see cref="T:log4net.Util.PatternString"/> type to a string.
  31785. </para>
  31786. <para>
  31787. The string is used as the <see cref="P:log4net.Util.PatternString.ConversionPattern"/>
  31788. of the <see cref="T:log4net.Util.PatternString"/>.
  31789. </para>
  31790. </remarks>
  31791. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31792. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31793. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31794. <author>Nicko Cadell</author>
  31795. </member>
  31796. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)">
  31797. <summary>
  31798. Can the target type be converted to the type supported by this object
  31799. </summary>
  31800. <param name="targetType">A <see cref="T:System.Type"/> that represents the type you want to convert to</param>
  31801. <returns>true if the conversion is possible</returns>
  31802. <remarks>
  31803. <para>
  31804. Returns <c>true</c> if the <paramref name="targetType"/> is
  31805. assignable from a <see cref="T:System.String"/> type.
  31806. </para>
  31807. </remarks>
  31808. </member>
  31809. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertTo(System.Object,System.Type)">
  31810. <summary>
  31811. Converts the given value object to the specified type, using the arguments
  31812. </summary>
  31813. <param name="source">the object to convert</param>
  31814. <param name="targetType">The Type to convert the value parameter to</param>
  31815. <returns>the converted object</returns>
  31816. <remarks>
  31817. <para>
  31818. Uses the <see cref="M:PatternString.Format()"/> method to convert the
  31819. <see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>.
  31820. </para>
  31821. </remarks>
  31822. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31823. The <paramref name="source"/> object cannot be converted to the
  31824. <paramref name="targetType"/>. To check for this condition use the
  31825. <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"/> method.
  31826. </exception>
  31827. </member>
  31828. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)">
  31829. <summary>
  31830. Can the source type be converted to the type supported by this object
  31831. </summary>
  31832. <param name="sourceType">the type to convert</param>
  31833. <returns>true if the conversion is possible</returns>
  31834. <remarks>
  31835. <para>
  31836. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31837. the <see cref="T:System.String"/> type.
  31838. </para>
  31839. </remarks>
  31840. </member>
  31841. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertFrom(System.Object)">
  31842. <summary>
  31843. Overrides the ConvertFrom method of IConvertFrom.
  31844. </summary>
  31845. <param name="source">the object to convert to a PatternString</param>
  31846. <returns>the PatternString</returns>
  31847. <remarks>
  31848. <para>
  31849. Creates and returns a new <see cref="T:log4net.Util.PatternString"/> using
  31850. the <paramref name="source"/> <see cref="T:System.String"/> as the
  31851. <see cref="P:log4net.Util.PatternString.ConversionPattern"/>.
  31852. </para>
  31853. </remarks>
  31854. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31855. The <paramref name="source"/> object cannot be converted to the
  31856. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"/>
  31857. method.
  31858. </exception>
  31859. </member>
  31860. <member name="T:log4net.Util.TypeConverters.TypeConverter">
  31861. <summary>
  31862. Supports conversion from string to <see cref="T:System.Type"/> type.
  31863. </summary>
  31864. <remarks>
  31865. <para>
  31866. Supports conversion from string to <see cref="T:System.Type"/> type.
  31867. </para>
  31868. </remarks>
  31869. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31870. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31871. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31872. <author>Nicko Cadell</author>
  31873. </member>
  31874. <member name="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)">
  31875. <summary>
  31876. Can the source type be converted to the type supported by this object
  31877. </summary>
  31878. <param name="sourceType">the type to convert</param>
  31879. <returns>true if the conversion is possible</returns>
  31880. <remarks>
  31881. <para>
  31882. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31883. the <see cref="T:System.String"/> type.
  31884. </para>
  31885. </remarks>
  31886. </member>
  31887. <member name="M:log4net.Util.TypeConverters.TypeConverter.ConvertFrom(System.Object)">
  31888. <summary>
  31889. Overrides the ConvertFrom method of IConvertFrom.
  31890. </summary>
  31891. <param name="source">the object to convert to a Type</param>
  31892. <returns>the Type</returns>
  31893. <remarks>
  31894. <para>
  31895. Uses the <see cref="M:Type.GetType(string,bool)"/> method to convert the
  31896. <see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>.
  31897. Additional effort is made to locate partially specified types
  31898. by searching the loaded assemblies.
  31899. </para>
  31900. </remarks>
  31901. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31902. The <paramref name="source"/> object cannot be converted to the
  31903. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"/>
  31904. method.
  31905. </exception>
  31906. </member>
  31907. <member name="T:log4net.Util.TypeConverters.TypeConverterAttribute">
  31908. <summary>
  31909. Attribute used to associate a type converter
  31910. </summary>
  31911. <remarks>
  31912. <para>
  31913. Class and Interface level attribute that specifies a type converter
  31914. to use with the associated type.
  31915. </para>
  31916. <para>
  31917. To associate a type converter with a target type apply a
  31918. <c>TypeConverterAttribute</c> to the target type. Specify the
  31919. type of the type converter on the attribute.
  31920. </para>
  31921. </remarks>
  31922. <author>Nicko Cadell</author>
  31923. <author>Gert Driesen</author>
  31924. </member>
  31925. <member name="F:log4net.Util.TypeConverters.TypeConverterAttribute.m_typeName">
  31926. <summary>
  31927. The string type name of the type converter
  31928. </summary>
  31929. </member>
  31930. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor">
  31931. <summary>
  31932. Default constructor
  31933. </summary>
  31934. <remarks>
  31935. <para>
  31936. Default constructor
  31937. </para>
  31938. </remarks>
  31939. </member>
  31940. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.String)">
  31941. <summary>
  31942. Create a new type converter attribute for the specified type name
  31943. </summary>
  31944. <param name="typeName">The string type name of the type converter</param>
  31945. <remarks>
  31946. <para>
  31947. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31948. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  31949. </para>
  31950. </remarks>
  31951. </member>
  31952. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.Type)">
  31953. <summary>
  31954. Create a new type converter attribute for the specified type
  31955. </summary>
  31956. <param name="converterType">The type of the type converter</param>
  31957. <remarks>
  31958. <para>
  31959. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31960. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  31961. </para>
  31962. </remarks>
  31963. </member>
  31964. <member name="P:log4net.Util.TypeConverters.TypeConverterAttribute.ConverterTypeName">
  31965. <summary>
  31966. The string type name of the type converter
  31967. </summary>
  31968. <value>
  31969. The string type name of the type converter
  31970. </value>
  31971. <remarks>
  31972. <para>
  31973. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31974. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  31975. </para>
  31976. </remarks>
  31977. </member>
  31978. <member name="T:log4net.Util.WindowsSecurityContext">
  31979. <summary>
  31980. Impersonate a Windows Account
  31981. </summary>
  31982. <remarks>
  31983. <para>
  31984. This <see cref="T:log4net.Core.SecurityContext"/> impersonates a Windows account.
  31985. </para>
  31986. <para>
  31987. How the impersonation is done depends on the value of <see cref="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)"/>.
  31988. This allows the context to either impersonate a set of user credentials specified
  31989. using username, domain name and password or to revert to the process credentials.
  31990. </para>
  31991. </remarks>
  31992. </member>
  31993. <member name="T:log4net.Util.WindowsSecurityContext.ImpersonationMode">
  31994. <summary>
  31995. The impersonation modes for the <see cref="T:log4net.Util.WindowsSecurityContext"/>
  31996. </summary>
  31997. <remarks>
  31998. <para>
  31999. See the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property for
  32000. details.
  32001. </para>
  32002. </remarks>
  32003. </member>
  32004. <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User">
  32005. <summary>
  32006. Impersonate a user using the credentials supplied
  32007. </summary>
  32008. </member>
  32009. <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process">
  32010. <summary>
  32011. Revert this the thread to the credentials of the process
  32012. </summary>
  32013. </member>
  32014. <member name="M:log4net.Util.WindowsSecurityContext.#ctor">
  32015. <summary>
  32016. Default constructor
  32017. </summary>
  32018. <remarks>
  32019. <para>
  32020. Default constructor
  32021. </para>
  32022. </remarks>
  32023. </member>
  32024. <member name="P:log4net.Util.WindowsSecurityContext.Credentials">
  32025. <summary>
  32026. Gets or sets the impersonation mode for this security context
  32027. </summary>
  32028. <value>
  32029. The impersonation mode for this security context
  32030. </value>
  32031. <remarks>
  32032. <para>
  32033. Impersonate either a user with user credentials or
  32034. revert this thread to the credentials of the process.
  32035. The value is one of the <see cref="T:log4net.Util.WindowsSecurityContext.ImpersonationMode"/>
  32036. enum.
  32037. </para>
  32038. <para>
  32039. The default value is <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
  32040. </para>
  32041. <para>
  32042. When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
  32043. the user's credentials are established using the
  32044. <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>, <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.Password"/>
  32045. values.
  32046. </para>
  32047. <para>
  32048. When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process"/>
  32049. no other properties need to be set. If the calling thread is
  32050. impersonating then it will be reverted back to the process credentials.
  32051. </para>
  32052. </remarks>
  32053. </member>
  32054. <member name="P:log4net.Util.WindowsSecurityContext.UserName">
  32055. <summary>
  32056. Gets or sets the Windows username for this security context
  32057. </summary>
  32058. <value>
  32059. The Windows username for this security context
  32060. </value>
  32061. <remarks>
  32062. <para>
  32063. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  32064. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  32065. </para>
  32066. </remarks>
  32067. </member>
  32068. <member name="P:log4net.Util.WindowsSecurityContext.DomainName">
  32069. <summary>
  32070. Gets or sets the Windows domain name for this security context
  32071. </summary>
  32072. <value>
  32073. The Windows domain name for this security context
  32074. </value>
  32075. <remarks>
  32076. <para>
  32077. The default value for <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> is the local machine name
  32078. taken from the <see cref="P:System.Environment.MachineName"/> property.
  32079. </para>
  32080. <para>
  32081. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  32082. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  32083. </para>
  32084. </remarks>
  32085. </member>
  32086. <member name="P:log4net.Util.WindowsSecurityContext.Password">
  32087. <summary>
  32088. 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.
  32089. </summary>
  32090. <value>
  32091. 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.
  32092. </value>
  32093. <remarks>
  32094. <para>
  32095. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  32096. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  32097. </para>
  32098. </remarks>
  32099. </member>
  32100. <member name="M:log4net.Util.WindowsSecurityContext.ActivateOptions">
  32101. <summary>
  32102. Initialize the SecurityContext based on the options set.
  32103. </summary>
  32104. <remarks>
  32105. <para>
  32106. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  32107. activation scheme. The <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> method must
  32108. be called on this object after the configuration properties have
  32109. been set. Until <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> is called this
  32110. object is in an undefined state and must not be used.
  32111. </para>
  32112. <para>
  32113. If any of the configuration properties are modified then
  32114. <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> must be called again.
  32115. </para>
  32116. <para>
  32117. The security context will try to Logon the specified user account and
  32118. capture a primary token for impersonation.
  32119. </para>
  32120. </remarks>
  32121. <exception cref="T:System.ArgumentNullException">The required <see cref="P:log4net.Util.WindowsSecurityContext.UserName" />,
  32122. <see cref="P:log4net.Util.WindowsSecurityContext.DomainName" /> or <see cref="P:log4net.Util.WindowsSecurityContext.Password" /> properties were not specified.</exception>
  32123. </member>
  32124. <member name="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)">
  32125. <summary>
  32126. Impersonate the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
  32127. </summary>
  32128. <param name="state">caller provided state</param>
  32129. <returns>
  32130. An <see cref="T:System.IDisposable"/> instance that will revoke the impersonation of this SecurityContext
  32131. </returns>
  32132. <remarks>
  32133. <para>
  32134. Depending on the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property either
  32135. impersonate a user using credentials supplied or revert
  32136. to the process credentials.
  32137. </para>
  32138. </remarks>
  32139. </member>
  32140. <member name="M:log4net.Util.WindowsSecurityContext.LogonUser(System.String,System.String,System.String)">
  32141. <summary>
  32142. Create a <see cref="T:System.Security.Principal.WindowsIdentity"/> given the userName, domainName and password.
  32143. </summary>
  32144. <param name="userName">the user name</param>
  32145. <param name="domainName">the domain name</param>
  32146. <param name="password">the password</param>
  32147. <returns>the <see cref="T:System.Security.Principal.WindowsIdentity"/> for the account specified</returns>
  32148. <remarks>
  32149. <para>
  32150. Uses the Windows API call LogonUser to get a principal token for the account. This
  32151. token is used to initialize the WindowsIdentity.
  32152. </para>
  32153. </remarks>
  32154. </member>
  32155. <member name="T:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext">
  32156. <summary>
  32157. Adds <see cref="T:System.IDisposable"/> to <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
  32158. </summary>
  32159. <remarks>
  32160. <para>
  32161. Helper class to expose the <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
  32162. through the <see cref="T:System.IDisposable"/> interface.
  32163. </para>
  32164. </remarks>
  32165. </member>
  32166. <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.#ctor(System.Security.Principal.WindowsImpersonationContext)">
  32167. <summary>
  32168. Constructor
  32169. </summary>
  32170. <param name="impersonationContext">the impersonation context being wrapped</param>
  32171. <remarks>
  32172. <para>
  32173. Constructor
  32174. </para>
  32175. </remarks>
  32176. </member>
  32177. <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.Dispose">
  32178. <summary>
  32179. Revert the impersonation
  32180. </summary>
  32181. <remarks>
  32182. <para>
  32183. Revert the impersonation
  32184. </para>
  32185. </remarks>
  32186. </member>
  32187. </members>
  32188. </doc>