log4net.xml 1.4 MB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407264082640926410264112641226413264142641526416264172641826419264202642126422264232642426425264262642726428264292643026431264322643326434264352643626437264382643926440264412644226443264442644526446264472644826449264502645126452264532645426455264562645726458264592646026461264622646326464264652646626467264682646926470264712647226473264742647526476264772647826479264802648126482264832648426485264862648726488264892649026491264922649326494264952649626497264982649926500265012650226503265042650526506265072650826509265102651126512265132651426515265162651726518265192652026521265222652326524265252652626527265282652926530265312653226533265342653526536265372653826539265402654126542265432654426545265462654726548265492655026551265522655326554265552655626557265582655926560265612656226563265642656526566265672656826569265702657126572265732657426575265762657726578265792658026581265822658326584265852658626587265882658926590265912659226593265942659526596265972659826599266002660126602266032660426605266062660726608266092661026611266122661326614266152661626617266182661926620266212662226623266242662526626266272662826629266302663126632266332663426635266362663726638266392664026641266422664326644266452664626647266482664926650266512665226653266542665526656266572665826659266602666126662266632666426665266662666726668266692667026671266722667326674266752667626677266782667926680266812668226683266842668526686266872668826689266902669126692266932669426695266962669726698266992670026701267022670326704267052670626707267082670926710267112671226713267142671526716267172671826719267202672126722267232672426725267262672726728267292673026731267322673326734267352673626737267382673926740267412674226743267442674526746267472674826749267502675126752267532675426755267562675726758267592676026761267622676326764267652676626767267682676926770267712677226773267742677526776267772677826779267802678126782267832678426785267862678726788267892679026791267922679326794267952679626797267982679926800268012680226803268042680526806268072680826809268102681126812268132681426815268162681726818268192682026821268222682326824268252682626827268282682926830268312683226833268342683526836268372683826839268402684126842268432684426845268462684726848268492685026851268522685326854268552685626857268582685926860268612686226863268642686526866268672686826869268702687126872268732687426875268762687726878268792688026881268822688326884268852688626887268882688926890268912689226893268942689526896268972689826899269002690126902269032690426905269062690726908269092691026911269122691326914269152691626917269182691926920269212692226923269242692526926269272692826929269302693126932269332693426935269362693726938269392694026941269422694326944269452694626947269482694926950269512695226953269542695526956269572695826959269602696126962269632696426965269662696726968269692697026971269722697326974269752697626977269782697926980269812698226983269842698526986269872698826989269902699126992269932699426995269962699726998269992700027001270022700327004270052700627007270082700927010270112701227013270142701527016270172701827019270202702127022270232702427025270262702727028270292703027031270322703327034270352703627037270382703927040270412704227043270442704527046270472704827049270502705127052270532705427055270562705727058270592706027061270622706327064270652706627067270682706927070270712707227073270742707527076270772707827079270802708127082270832708427085270862708727088270892709027091270922709327094270952709627097270982709927100271012710227103271042710527106271072710827109271102711127112271132711427115271162711727118271192712027121271222712327124271252712627127271282712927130271312713227133271342713527136271372713827139271402714127142271432714427145271462714727148271492715027151271522715327154271552715627157271582715927160271612716227163271642716527166271672716827169271702717127172271732717427175271762717727178271792718027181271822718327184271852718627187271882718927190271912719227193271942719527196271972719827199272002720127202272032720427205272062720727208272092721027211272122721327214272152721627217272182721927220272212722227223272242722527226272272722827229272302723127232272332723427235272362723727238272392724027241272422724327244272452724627247272482724927250272512725227253272542725527256272572725827259272602726127262272632726427265272662726727268272692727027271272722727327274272752727627277272782727927280272812728227283272842728527286272872728827289272902729127292272932729427295272962729727298272992730027301273022730327304273052730627307273082730927310273112731227313273142731527316273172731827319273202732127322273232732427325273262732727328273292733027331273322733327334273352733627337273382733927340273412734227343273442734527346273472734827349273502735127352273532735427355273562735727358273592736027361273622736327364273652736627367273682736927370273712737227373273742737527376273772737827379273802738127382273832738427385273862738727388273892739027391273922739327394273952739627397273982739927400274012740227403274042740527406274072740827409274102741127412274132741427415274162741727418274192742027421274222742327424274252742627427274282742927430274312743227433274342743527436274372743827439274402744127442274432744427445274462744727448274492745027451274522745327454274552745627457274582745927460274612746227463274642746527466274672746827469274702747127472274732747427475274762747727478274792748027481274822748327484274852748627487274882748927490274912749227493274942749527496274972749827499275002750127502275032750427505275062750727508275092751027511275122751327514275152751627517275182751927520275212752227523275242752527526275272752827529275302753127532275332753427535275362753727538275392754027541275422754327544275452754627547275482754927550275512755227553275542755527556275572755827559275602756127562275632756427565275662756727568275692757027571275722757327574275752757627577275782757927580275812758227583275842758527586275872758827589275902759127592275932759427595275962759727598275992760027601276022760327604276052760627607276082760927610276112761227613276142761527616276172761827619276202762127622276232762427625276262762727628276292763027631276322763327634276352763627637276382763927640276412764227643276442764527646276472764827649276502765127652276532765427655276562765727658276592766027661276622766327664276652766627667276682766927670276712767227673276742767527676276772767827679276802768127682276832768427685276862768727688276892769027691276922769327694276952769627697276982769927700277012770227703277042770527706277072770827709277102771127712277132771427715277162771727718277192772027721277222772327724277252772627727277282772927730277312773227733277342773527736277372773827739277402774127742277432774427745277462774727748277492775027751277522775327754277552775627757277582775927760277612776227763277642776527766277672776827769277702777127772277732777427775277762777727778277792778027781277822778327784277852778627787277882778927790277912779227793277942779527796277972779827799278002780127802278032780427805278062780727808278092781027811278122781327814278152781627817278182781927820278212782227823278242782527826278272782827829278302783127832278332783427835278362783727838278392784027841278422784327844278452784627847278482784927850278512785227853278542785527856278572785827859278602786127862278632786427865278662786727868278692787027871278722787327874278752787627877278782787927880278812788227883278842788527886278872788827889278902789127892278932789427895278962789727898278992790027901279022790327904279052790627907279082790927910279112791227913279142791527916279172791827919279202792127922279232792427925279262792727928279292793027931279322793327934279352793627937279382793927940279412794227943279442794527946279472794827949279502795127952279532795427955279562795727958279592796027961279622796327964279652796627967279682796927970279712797227973279742797527976279772797827979279802798127982279832798427985279862798727988279892799027991279922799327994279952799627997279982799928000280012800228003280042800528006280072800828009280102801128012280132801428015280162801728018280192802028021280222802328024280252802628027280282802928030280312803228033280342803528036280372803828039280402804128042280432804428045280462804728048280492805028051280522805328054280552805628057280582805928060280612806228063280642806528066280672806828069280702807128072280732807428075280762807728078280792808028081280822808328084280852808628087280882808928090280912809228093280942809528096280972809828099281002810128102281032810428105281062810728108281092811028111281122811328114281152811628117281182811928120281212812228123281242812528126281272812828129281302813128132281332813428135281362813728138281392814028141281422814328144281452814628147281482814928150281512815228153281542815528156281572815828159281602816128162281632816428165281662816728168281692817028171281722817328174281752817628177281782817928180281812818228183281842818528186281872818828189281902819128192281932819428195281962819728198281992820028201282022820328204282052820628207282082820928210282112821228213282142821528216282172821828219282202822128222282232822428225282262822728228282292823028231282322823328234282352823628237282382823928240282412824228243282442824528246282472824828249282502825128252282532825428255282562825728258282592826028261282622826328264282652826628267282682826928270282712827228273282742827528276282772827828279282802828128282282832828428285282862828728288282892829028291282922829328294282952829628297282982829928300283012830228303283042830528306283072830828309283102831128312283132831428315283162831728318283192832028321283222832328324283252832628327283282832928330283312833228333283342833528336283372833828339283402834128342283432834428345283462834728348283492835028351283522835328354283552835628357283582835928360283612836228363283642836528366283672836828369283702837128372283732837428375283762837728378283792838028381283822838328384283852838628387283882838928390283912839228393283942839528396283972839828399284002840128402284032840428405284062840728408284092841028411284122841328414284152841628417284182841928420284212842228423284242842528426284272842828429284302843128432284332843428435284362843728438284392844028441284422844328444284452844628447284482844928450284512845228453284542845528456284572845828459284602846128462284632846428465284662846728468284692847028471284722847328474284752847628477284782847928480284812848228483284842848528486284872848828489284902849128492284932849428495284962849728498284992850028501285022850328504285052850628507285082850928510285112851228513285142851528516285172851828519285202852128522285232852428525285262852728528285292853028531285322853328534285352853628537285382853928540285412854228543285442854528546285472854828549285502855128552285532855428555285562855728558285592856028561285622856328564285652856628567285682856928570285712857228573285742857528576285772857828579285802858128582285832858428585285862858728588285892859028591285922859328594285952859628597285982859928600286012860228603286042860528606286072860828609286102861128612286132861428615286162861728618286192862028621286222862328624286252862628627286282862928630286312863228633286342863528636286372863828639286402864128642286432864428645286462864728648286492865028651286522865328654286552865628657286582865928660286612866228663286642866528666286672866828669286702867128672286732867428675286762867728678286792868028681286822868328684286852868628687286882868928690286912869228693286942869528696286972869828699287002870128702287032870428705287062870728708287092871028711287122871328714287152871628717287182871928720287212872228723287242872528726287272872828729287302873128732287332873428735287362873728738287392874028741287422874328744287452874628747287482874928750287512875228753287542875528756287572875828759287602876128762287632876428765287662876728768287692877028771287722877328774287752877628777287782877928780287812878228783287842878528786287872878828789287902879128792287932879428795287962879728798287992880028801288022880328804288052880628807288082880928810288112881228813288142881528816288172881828819288202882128822288232882428825288262882728828288292883028831288322883328834288352883628837288382883928840288412884228843288442884528846288472884828849288502885128852288532885428855288562885728858288592886028861288622886328864288652886628867288682886928870288712887228873288742887528876288772887828879288802888128882288832888428885288862888728888288892889028891288922889328894288952889628897288982889928900289012890228903289042890528906289072890828909289102891128912289132891428915289162891728918289192892028921289222892328924289252892628927289282892928930289312893228933289342893528936289372893828939289402894128942289432894428945289462894728948289492895028951289522895328954289552895628957289582895928960289612896228963289642896528966289672896828969289702897128972289732897428975289762897728978289792898028981289822898328984289852898628987289882898928990289912899228993289942899528996289972899828999290002900129002290032900429005290062900729008290092901029011290122901329014290152901629017290182901929020290212902229023290242902529026290272902829029290302903129032290332903429035290362903729038290392904029041290422904329044290452904629047290482904929050290512905229053290542905529056290572905829059290602906129062290632906429065290662906729068290692907029071290722907329074290752907629077290782907929080290812908229083290842908529086290872908829089290902909129092290932909429095290962909729098290992910029101291022910329104291052910629107291082910929110291112911229113291142911529116291172911829119291202912129122291232912429125291262912729128291292913029131291322913329134291352913629137291382913929140291412914229143291442914529146291472914829149291502915129152291532915429155291562915729158291592916029161291622916329164291652916629167291682916929170291712917229173291742917529176291772917829179291802918129182291832918429185291862918729188291892919029191291922919329194291952919629197291982919929200292012920229203292042920529206292072920829209292102921129212292132921429215292162921729218292192922029221292222922329224292252922629227292282922929230292312923229233292342923529236292372923829239292402924129242292432924429245292462924729248292492925029251292522925329254292552925629257292582925929260292612926229263292642926529266292672926829269292702927129272292732927429275292762927729278292792928029281292822928329284292852928629287292882928929290292912929229293292942929529296292972929829299293002930129302293032930429305293062930729308293092931029311293122931329314293152931629317293182931929320293212932229323293242932529326293272932829329293302933129332293332933429335293362933729338293392934029341293422934329344293452934629347293482934929350293512935229353293542935529356293572935829359293602936129362293632936429365293662936729368293692937029371293722937329374293752937629377293782937929380293812938229383293842938529386293872938829389293902939129392293932939429395293962939729398293992940029401294022940329404294052940629407294082940929410294112941229413294142941529416294172941829419294202942129422294232942429425294262942729428294292943029431294322943329434294352943629437294382943929440294412944229443294442944529446294472944829449294502945129452294532945429455294562945729458294592946029461294622946329464294652946629467294682946929470294712947229473294742947529476294772947829479294802948129482294832948429485294862948729488294892949029491294922949329494294952949629497294982949929500295012950229503295042950529506295072950829509295102951129512295132951429515295162951729518295192952029521295222952329524295252952629527295282952929530295312953229533295342953529536295372953829539295402954129542295432954429545295462954729548295492955029551295522955329554295552955629557295582955929560295612956229563295642956529566295672956829569295702957129572295732957429575295762957729578295792958029581295822958329584295852958629587295882958929590295912959229593295942959529596295972959829599296002960129602296032960429605296062960729608296092961029611296122961329614296152961629617296182961929620296212962229623296242962529626296272962829629296302963129632296332963429635296362963729638296392964029641296422964329644296452964629647296482964929650296512965229653296542965529656296572965829659296602966129662296632966429665296662966729668296692967029671296722967329674296752967629677296782967929680296812968229683296842968529686296872968829689296902969129692296932969429695296962969729698296992970029701297022970329704297052970629707297082970929710297112971229713297142971529716297172971829719297202972129722297232972429725297262972729728297292973029731297322973329734297352973629737297382973929740297412974229743297442974529746297472974829749297502975129752297532975429755297562975729758297592976029761297622976329764297652976629767297682976929770297712977229773297742977529776297772977829779297802978129782297832978429785297862978729788297892979029791297922979329794297952979629797297982979929800298012980229803298042980529806298072980829809298102981129812298132981429815298162981729818298192982029821298222982329824298252982629827298282982929830298312983229833298342983529836298372983829839298402984129842298432984429845298462984729848298492985029851298522985329854298552985629857298582985929860298612986229863298642986529866298672986829869298702987129872298732987429875298762987729878298792988029881298822988329884298852988629887298882988929890298912989229893298942989529896298972989829899299002990129902299032990429905299062990729908299092991029911299122991329914299152991629917299182991929920299212992229923299242992529926299272992829929299302993129932299332993429935299362993729938299392994029941299422994329944299452994629947299482994929950299512995229953299542995529956299572995829959299602996129962299632996429965299662996729968299692997029971299722997329974299752997629977299782997929980299812998229983299842998529986299872998829989299902999129992299932999429995299962999729998299993000030001300023000330004300053000630007300083000930010300113001230013300143001530016300173001830019300203002130022300233002430025300263002730028300293003030031300323003330034300353003630037300383003930040300413004230043300443004530046300473004830049300503005130052300533005430055300563005730058300593006030061300623006330064300653006630067300683006930070300713007230073300743007530076300773007830079300803008130082300833008430085300863008730088300893009030091300923009330094300953009630097300983009930100301013010230103301043010530106301073010830109301103011130112301133011430115301163011730118301193012030121301223012330124301253012630127301283012930130301313013230133301343013530136301373013830139301403014130142301433014430145301463014730148301493015030151301523015330154301553015630157301583015930160301613016230163301643016530166301673016830169301703017130172301733017430175301763017730178301793018030181301823018330184301853018630187301883018930190301913019230193301943019530196301973019830199302003020130202302033020430205302063020730208302093021030211302123021330214302153021630217302183021930220302213022230223302243022530226302273022830229302303023130232302333023430235302363023730238302393024030241302423024330244302453024630247302483024930250302513025230253302543025530256302573025830259302603026130262302633026430265302663026730268302693027030271302723027330274302753027630277302783027930280302813028230283302843028530286302873028830289302903029130292302933029430295302963029730298302993030030301303023030330304303053030630307303083030930310303113031230313303143031530316303173031830319303203032130322303233032430325303263032730328303293033030331303323033330334303353033630337303383033930340303413034230343303443034530346303473034830349303503035130352303533035430355303563035730358303593036030361303623036330364303653036630367303683036930370303713037230373303743037530376303773037830379303803038130382303833038430385303863038730388303893039030391303923039330394303953039630397303983039930400304013040230403304043040530406304073040830409304103041130412304133041430415304163041730418304193042030421304223042330424304253042630427304283042930430304313043230433304343043530436304373043830439304403044130442304433044430445304463044730448304493045030451304523045330454304553045630457304583045930460304613046230463304643046530466304673046830469304703047130472304733047430475304763047730478304793048030481304823048330484304853048630487304883048930490304913049230493304943049530496304973049830499305003050130502305033050430505305063050730508305093051030511305123051330514305153051630517305183051930520305213052230523305243052530526305273052830529305303053130532305333053430535305363053730538305393054030541305423054330544305453054630547305483054930550305513055230553305543055530556305573055830559305603056130562305633056430565305663056730568305693057030571305723057330574305753057630577305783057930580305813058230583305843058530586305873058830589305903059130592305933059430595305963059730598305993060030601306023060330604306053060630607306083060930610306113061230613306143061530616306173061830619306203062130622306233062430625306263062730628306293063030631306323063330634306353063630637306383063930640306413064230643306443064530646306473064830649306503065130652306533065430655306563065730658306593066030661306623066330664306653066630667306683066930670306713067230673306743067530676306773067830679306803068130682306833068430685306863068730688306893069030691306923069330694306953069630697306983069930700307013070230703307043070530706307073070830709307103071130712307133071430715307163071730718307193072030721307223072330724307253072630727307283072930730307313073230733307343073530736307373073830739307403074130742307433074430745307463074730748307493075030751307523075330754307553075630757307583075930760307613076230763307643076530766307673076830769307703077130772307733077430775307763077730778307793078030781307823078330784307853078630787307883078930790307913079230793307943079530796307973079830799308003080130802308033080430805308063080730808308093081030811308123081330814308153081630817308183081930820308213082230823308243082530826308273082830829308303083130832308333083430835308363083730838308393084030841308423084330844308453084630847308483084930850308513085230853308543085530856308573085830859308603086130862308633086430865308663086730868308693087030871308723087330874308753087630877308783087930880308813088230883308843088530886308873088830889308903089130892308933089430895308963089730898308993090030901309023090330904309053090630907309083090930910309113091230913309143091530916309173091830919309203092130922309233092430925309263092730928309293093030931309323093330934309353093630937309383093930940309413094230943309443094530946309473094830949309503095130952309533095430955309563095730958309593096030961309623096330964309653096630967309683096930970309713097230973309743097530976309773097830979309803098130982309833098430985309863098730988309893099030991309923099330994309953099630997309983099931000310013100231003310043100531006310073100831009310103101131012310133101431015310163101731018310193102031021310223102331024310253102631027310283102931030310313103231033310343103531036310373103831039310403104131042310433104431045310463104731048310493105031051310523105331054310553105631057310583105931060310613106231063310643106531066310673106831069310703107131072310733107431075310763107731078310793108031081310823108331084310853108631087310883108931090310913109231093310943109531096310973109831099311003110131102311033110431105311063110731108311093111031111311123111331114311153111631117311183111931120311213112231123311243112531126311273112831129311303113131132311333113431135311363113731138311393114031141311423114331144311453114631147311483114931150311513115231153311543115531156311573115831159311603116131162311633116431165311663116731168311693117031171311723117331174311753117631177311783117931180311813118231183311843118531186311873118831189311903119131192311933119431195311963119731198311993120031201312023120331204312053120631207312083120931210312113121231213312143121531216312173121831219312203122131222312233122431225312263122731228312293123031231312323123331234312353123631237312383123931240312413124231243312443124531246312473124831249312503125131252312533125431255312563125731258312593126031261312623126331264312653126631267312683126931270312713127231273312743127531276312773127831279312803128131282312833128431285312863128731288312893129031291312923129331294312953129631297312983129931300313013130231303313043130531306313073130831309313103131131312313133131431315313163131731318313193132031321313223132331324313253132631327313283132931330313313133231333313343133531336313373133831339313403134131342313433134431345313463134731348313493135031351313523135331354313553135631357313583135931360313613136231363313643136531366313673136831369313703137131372313733137431375313763137731378313793138031381313823138331384313853138631387313883138931390313913139231393313943139531396313973139831399314003140131402314033140431405314063140731408314093141031411314123141331414314153141631417314183141931420314213142231423314243142531426314273142831429314303143131432314333143431435314363143731438314393144031441314423144331444314453144631447314483144931450314513145231453314543145531456314573145831459314603146131462314633146431465314663146731468314693147031471314723147331474314753147631477314783147931480314813148231483314843148531486314873148831489314903149131492314933149431495314963149731498314993150031501315023150331504315053150631507315083150931510315113151231513315143151531516315173151831519315203152131522315233152431525315263152731528315293153031531315323153331534315353153631537315383153931540315413154231543315443154531546315473154831549315503155131552315533155431555315563155731558315593156031561315623156331564315653156631567315683156931570315713157231573315743157531576315773157831579315803158131582315833158431585315863158731588315893159031591315923159331594315953159631597315983159931600316013160231603316043160531606316073160831609316103161131612316133161431615316163161731618316193162031621316223162331624316253162631627316283162931630316313163231633316343163531636316373163831639316403164131642316433164431645316463164731648316493165031651316523165331654316553165631657316583165931660316613166231663316643166531666316673166831669316703167131672316733167431675316763167731678316793168031681316823168331684316853168631687316883168931690316913169231693316943169531696316973169831699317003170131702317033170431705317063170731708317093171031711317123171331714317153171631717317183171931720317213172231723317243172531726317273172831729317303173131732317333173431735317363173731738317393174031741317423174331744317453174631747317483174931750317513175231753317543175531756317573175831759317603176131762317633176431765317663176731768317693177031771317723177331774317753177631777317783177931780317813178231783317843178531786317873178831789317903179131792317933179431795317963179731798317993180031801318023180331804318053180631807318083180931810318113181231813318143181531816318173181831819318203182131822318233182431825318263182731828318293183031831318323183331834318353183631837318383183931840318413184231843318443184531846318473184831849318503185131852318533185431855318563185731858318593186031861318623186331864318653186631867318683186931870318713187231873318743187531876318773187831879318803188131882318833188431885318863188731888318893189031891318923189331894318953189631897318983189931900319013190231903319043190531906319073190831909319103191131912319133191431915319163191731918319193192031921319223192331924319253192631927319283192931930319313193231933319343193531936319373193831939319403194131942319433194431945319463194731948319493195031951319523195331954319553195631957319583195931960319613196231963319643196531966319673196831969319703197131972319733197431975319763197731978319793198031981319823198331984319853198631987319883198931990319913199231993319943199531996319973199831999320003200132002320033200432005320063200732008320093201032011320123201332014320153201632017320183201932020320213202232023320243202532026320273202832029320303203132032320333203432035320363203732038320393204032041320423204332044320453204632047320483204932050320513205232053320543205532056320573205832059320603206132062320633206432065320663206732068320693207032071320723207332074320753207632077320783207932080320813208232083320843208532086320873208832089320903209132092320933209432095320963209732098320993210032101321023210332104321053210632107321083210932110321113211232113321143211532116321173211832119321203212132122321233212432125321263212732128321293213032131321323213332134321353213632137321383213932140321413214232143321443214532146321473214832149321503215132152321533215432155321563215732158321593216032161321623216332164321653216632167321683216932170321713217232173321743217532176321773217832179321803218132182321833218432185321863218732188321893219032191321923219332194321953219632197321983219932200322013220232203322043220532206322073220832209322103221132212322133221432215322163221732218322193222032221322223222332224322253222632227322283222932230322313223232233322343223532236322373223832239322403224132242322433224432245
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>log4net</name>
  5. </assembly>
  6. <members>
  7. <member name="T:log4net.Appender.AdoNetAppender">
  8. <summary>
  9. Appender that logs to a database.
  10. </summary>
  11. <remarks>
  12. <para>
  13. <see cref="T:log4net.Appender.AdoNetAppender"/> appends logging events to a table within a
  14. database. The appender can be configured to specify the connection
  15. string by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionString"/> property.
  16. The connection type (provider) can be specified by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/>
  17. property. For more information on database connection strings for
  18. your specific database see <a href="http://www.connectionstrings.com/">http://www.connectionstrings.com/</a>.
  19. </para>
  20. <para>
  21. Records are written into the database either using a prepared
  22. statement or a stored procedure. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property
  23. is set to <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify a prepared statement
  24. or to <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify a stored
  25. procedure.
  26. </para>
  27. <para>
  28. The prepared statement text or the name of the stored procedure
  29. must be set in the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property.
  30. </para>
  31. <para>
  32. The prepared statement or stored procedure can take a number
  33. of parameters. Parameters are added using the <see cref="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"/>
  34. method. This adds a single <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> to the
  35. ordered list of parameters. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/>
  36. type may be subclassed if required to provide database specific
  37. functionality. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> specifies
  38. the parameter name, database type, size, and how the value should
  39. be generated using a <see cref="T:log4net.Layout.ILayout"/>.
  40. </para>
  41. </remarks>
  42. <example>
  43. An example of a SQL Server table that could be logged to:
  44. <code lang="SQL">
  45. CREATE TABLE [dbo].[Log] (
  46. [ID] [int] IDENTITY (1, 1) NOT NULL ,
  47. [Date] [datetime] NOT NULL ,
  48. [Thread] [varchar] (255) NOT NULL ,
  49. [Level] [varchar] (20) NOT NULL ,
  50. [Logger] [varchar] (255) NOT NULL ,
  51. [Message] [varchar] (4000) NOT NULL
  52. ) ON [PRIMARY]
  53. </code>
  54. </example>
  55. <example>
  56. An example configuration to log to the above table:
  57. <code lang="XML" escaped="true">
  58. <appender name="AdoNetAppender_SqlServer" type="log4net.Appender.AdoNetAppender" >
  59. <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
  60. <connectionString value="data source=SQLSVR;initial catalog=test_log4net;integrated security=false;persist security info=True;User ID=sa;Password=sa" />
  61. <commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)" />
  62. <parameter>
  63. <parameterName value="@log_date" />
  64. <dbType value="DateTime" />
  65. <layout type="log4net.Layout.PatternLayout" value="%date{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}" />
  66. </parameter>
  67. <parameter>
  68. <parameterName value="@thread" />
  69. <dbType value="String" />
  70. <size value="255" />
  71. <layout type="log4net.Layout.PatternLayout" value="%thread" />
  72. </parameter>
  73. <parameter>
  74. <parameterName value="@log_level" />
  75. <dbType value="String" />
  76. <size value="50" />
  77. <layout type="log4net.Layout.PatternLayout" value="%level" />
  78. </parameter>
  79. <parameter>
  80. <parameterName value="@logger" />
  81. <dbType value="String" />
  82. <size value="255" />
  83. <layout type="log4net.Layout.PatternLayout" value="%logger" />
  84. </parameter>
  85. <parameter>
  86. <parameterName value="@message" />
  87. <dbType value="String" />
  88. <size value="4000" />
  89. <layout type="log4net.Layout.PatternLayout" value="%message" />
  90. </parameter>
  91. </appender>
  92. </code>
  93. </example>
  94. <author>Julian Biddle</author>
  95. <author>Nicko Cadell</author>
  96. <author>Gert Driesen</author>
  97. <author>Lance Nehring</author>
  98. </member>
  99. <member name="M:log4net.Appender.AdoNetAppender.#ctor">
  100. <summary>
  101. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender" /> class.
  102. </summary>
  103. <remarks>
  104. Public default constructor to initialize a new instance of this class.
  105. </remarks>
  106. </member>
  107. <member name="P:log4net.Appender.AdoNetAppender.ConnectionString">
  108. <summary>
  109. Gets or sets the database connection string that is used to connect to
  110. the database.
  111. </summary>
  112. <value>
  113. The database connection string used to connect to the database.
  114. </value>
  115. <remarks>
  116. <para>
  117. The connections string is specific to the connection type.
  118. See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information.
  119. </para>
  120. </remarks>
  121. <example>Connection string for MS Access via ODBC:
  122. <code>"DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"</code>
  123. </example>
  124. <example>Another connection string for MS Access via ODBC:
  125. <code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code>
  126. </example>
  127. <example>Connection string for MS Access via OLE DB:
  128. <code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code>
  129. </example>
  130. </member>
  131. <member name="P:log4net.Appender.AdoNetAppender.AppSettingsKey">
  132. <summary>
  133. The appSettings key from App.Config that contains the connection string.
  134. </summary>
  135. </member>
  136. <member name="P:log4net.Appender.AdoNetAppender.ConnectionStringName">
  137. <summary>
  138. The connectionStrings key from App.Config that contains the connection string.
  139. </summary>
  140. <remarks>
  141. This property requires at least .NET 2.0.
  142. </remarks>
  143. </member>
  144. <member name="P:log4net.Appender.AdoNetAppender.ConnectionType">
  145. <summary>
  146. Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection
  147. that should be created.
  148. </summary>
  149. <value>
  150. The type name of the <see cref="T:System.Data.IDbConnection"/> connection.
  151. </value>
  152. <remarks>
  153. <para>
  154. The type name of the ADO.NET provider to use.
  155. </para>
  156. <para>
  157. The default is to use the OLE DB provider.
  158. </para>
  159. </remarks>
  160. <example>Use the OLE DB Provider. This is the default value.
  161. <code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  162. </example>
  163. <example>Use the MS SQL Server Provider.
  164. <code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  165. </example>
  166. <example>Use the ODBC Provider.
  167. <code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code>
  168. This is an optional package that you can download from
  169. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  170. search for <b>ODBC .NET Data Provider</b>.
  171. </example>
  172. <example>Use the Oracle Provider.
  173. <code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  174. This is an optional package that you can download from
  175. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  176. search for <b>.NET Managed Provider for Oracle</b>.
  177. </example>
  178. </member>
  179. <member name="P:log4net.Appender.AdoNetAppender.CommandText">
  180. <summary>
  181. Gets or sets the command text that is used to insert logging events
  182. into the database.
  183. </summary>
  184. <value>
  185. The command text used to insert logging events into the database.
  186. </value>
  187. <remarks>
  188. <para>
  189. Either the text of the prepared statement or the
  190. name of the stored procedure to execute to write into
  191. the database.
  192. </para>
  193. <para>
  194. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if
  195. this text is a prepared statement or a stored procedure.
  196. </para>
  197. <para>
  198. If this property is not set, the command text is retrieved by invoking
  199. <see cref="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)"/>.
  200. </para>
  201. </remarks>
  202. </member>
  203. <member name="P:log4net.Appender.AdoNetAppender.CommandType">
  204. <summary>
  205. Gets or sets the command type to execute.
  206. </summary>
  207. <value>
  208. The command type to execute.
  209. </value>
  210. <remarks>
  211. <para>
  212. This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify
  213. that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute,
  214. or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the
  215. <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure
  216. to execute.
  217. </para>
  218. <para>
  219. The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>).
  220. </para>
  221. </remarks>
  222. </member>
  223. <member name="P:log4net.Appender.AdoNetAppender.UseTransactions">
  224. <summary>
  225. Should transactions be used to insert logging events in the database.
  226. </summary>
  227. <value>
  228. <c>true</c> if transactions should be used to insert logging events in
  229. the database, otherwise <c>false</c>. The default value is <c>true</c>.
  230. </value>
  231. <remarks>
  232. <para>
  233. Gets or sets a value that indicates whether transactions should be used
  234. to insert logging events in the database.
  235. </para>
  236. <para>
  237. When set a single transaction will be used to insert the buffered events
  238. into the database. Otherwise each event will be inserted without using
  239. an explicit transaction.
  240. </para>
  241. </remarks>
  242. </member>
  243. <member name="P:log4net.Appender.AdoNetAppender.SecurityContext">
  244. <summary>
  245. Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  246. </summary>
  247. <value>
  248. The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  249. </value>
  250. <remarks>
  251. <para>
  252. Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender
  253. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  254. security context to use. The default behavior is to use the security context
  255. of the current thread.
  256. </para>
  257. </remarks>
  258. </member>
  259. <member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError">
  260. <summary>
  261. Should this appender try to reconnect to the database on error.
  262. </summary>
  263. <value>
  264. <c>true</c> if the appender should try to reconnect to the database after an
  265. error has occurred, otherwise <c>false</c>. The default value is <c>false</c>,
  266. i.e. not to try to reconnect.
  267. </value>
  268. <remarks>
  269. <para>
  270. The default behaviour is for the appender not to try to reconnect to the
  271. database if an error occurs. Subsequent logging events are discarded.
  272. </para>
  273. <para>
  274. To force the appender to attempt to reconnect to the database set this
  275. property to <c>true</c>.
  276. </para>
  277. <note>
  278. When the appender attempts to connect to the database there may be a
  279. delay of up to the connection timeout specified in the connection string.
  280. This delay will block the calling application's thread.
  281. Until the connection can be reestablished this potential delay may occur multiple times.
  282. </note>
  283. </remarks>
  284. </member>
  285. <member name="P:log4net.Appender.AdoNetAppender.Connection">
  286. <summary>
  287. Gets or sets the underlying <see cref="T:System.Data.IDbConnection" />.
  288. </summary>
  289. <value>
  290. The underlying <see cref="T:System.Data.IDbConnection" />.
  291. </value>
  292. <remarks>
  293. <see cref="T:log4net.Appender.AdoNetAppender" /> creates a <see cref="T:System.Data.IDbConnection" /> to insert
  294. logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender" />
  295. can use this property to get or set this <see cref="T:System.Data.IDbConnection" />. Use the
  296. underlying <see cref="T:System.Data.IDbConnection" /> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection" /> if
  297. you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender" /> provides.
  298. </remarks>
  299. </member>
  300. <member name="M:log4net.Appender.AdoNetAppender.ActivateOptions">
  301. <summary>
  302. Initialize the appender based on the options set
  303. </summary>
  304. <remarks>
  305. <para>
  306. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  307. activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must
  308. be called on this object after the configuration properties have
  309. been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this
  310. object is in an undefined state and must not be used.
  311. </para>
  312. <para>
  313. If any of the configuration properties are modified then
  314. <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again.
  315. </para>
  316. </remarks>
  317. </member>
  318. <member name="M:log4net.Appender.AdoNetAppender.OnClose">
  319. <summary>
  320. Override the parent method to close the database
  321. </summary>
  322. <remarks>
  323. <para>
  324. Closes the database command and database connection.
  325. </para>
  326. </remarks>
  327. </member>
  328. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  329. <summary>
  330. Inserts the events into the database.
  331. </summary>
  332. <param name="events">The events to insert into the database.</param>
  333. <remarks>
  334. <para>
  335. Insert all the events specified in the <paramref name="events"/>
  336. array into the database.
  337. </para>
  338. </remarks>
  339. </member>
  340. <member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)">
  341. <summary>
  342. Adds a parameter to the command.
  343. </summary>
  344. <param name="parameter">The parameter to add to the command.</param>
  345. <remarks>
  346. <para>
  347. Adds a parameter to the ordered list of command parameters.
  348. </para>
  349. </remarks>
  350. </member>
  351. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])">
  352. <summary>
  353. Writes the events to the database using the transaction specified.
  354. </summary>
  355. <param name="dbTran">The transaction that the events will be executed under.</param>
  356. <param name="events">The array of events to insert into the database.</param>
  357. <remarks>
  358. <para>
  359. The transaction argument can be <c>null</c> if the appender has been
  360. configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/>
  361. property for more information.
  362. </para>
  363. </remarks>
  364. </member>
  365. <member name="M:log4net.Appender.AdoNetAppender.Prepare(System.Data.IDbCommand)">
  366. <summary>
  367. Prepare entire database command object to be executed.
  368. </summary>
  369. <param name="dbCmd">The command to prepare.</param>
  370. </member>
  371. <member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)">
  372. <summary>
  373. Formats the log message into database statement text.
  374. </summary>
  375. <param name="logEvent">The event being logged.</param>
  376. <remarks>
  377. This method can be overridden by subclasses to provide
  378. more control over the format of the database statement.
  379. </remarks>
  380. <returns>
  381. Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
  382. </returns>
  383. </member>
  384. <member name="M:log4net.Appender.AdoNetAppender.CreateConnection(System.Type,System.String)">
  385. <summary>
  386. Creates an <see cref="T:System.Data.IDbConnection"/> instance used to connect to the database.
  387. </summary>
  388. <remarks>
  389. This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary).
  390. </remarks>
  391. <param name="connectionType">The <see cref="T:System.Type"/> of the <see cref="T:System.Data.IDbConnection"/> object.</param>
  392. <param name="connectionString">The connectionString output from the ResolveConnectionString method.</param>
  393. <returns>An <see cref="T:System.Data.IDbConnection"/> instance with a valid connection string.</returns>
  394. </member>
  395. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionString(System.String@)">
  396. <summary>
  397. Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey
  398. property.
  399. </summary>
  400. <remarks>
  401. ConnectiongStringName is only supported on .NET 2.0 and higher.
  402. </remarks>
  403. <param name="connectionStringContext">Additional information describing the connection string.</param>
  404. <returns>A connection string used to connect to the database.</returns>
  405. </member>
  406. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType">
  407. <summary>
  408. Retrieves the class type of the ADO.NET provider.
  409. </summary>
  410. <remarks>
  411. <para>
  412. Gets the Type of the ADO.NET provider to use to connect to the
  413. database. This method resolves the type specified in the
  414. <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property.
  415. </para>
  416. <para>
  417. Subclasses can override this method to return a different type
  418. if necessary.
  419. </para>
  420. </remarks>
  421. <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns>
  422. </member>
  423. <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection">
  424. <summary>
  425. Connects to the database.
  426. </summary>
  427. </member>
  428. <member name="M:log4net.Appender.AdoNetAppender.DiposeConnection">
  429. <summary>
  430. Cleanup the existing connection.
  431. </summary>
  432. <remarks>
  433. Calls the IDbConnection's <see cref="M:System.Data.IDbConnection.Close"/> method.
  434. </remarks>
  435. </member>
  436. <member name="F:log4net.Appender.AdoNetAppender.m_parameters">
  437. <summary>
  438. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  439. </summary>
  440. <remarks>
  441. <para>
  442. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  443. </para>
  444. </remarks>
  445. </member>
  446. <member name="F:log4net.Appender.AdoNetAppender.m_securityContext">
  447. <summary>
  448. The security context to use for privileged calls
  449. </summary>
  450. </member>
  451. <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection">
  452. <summary>
  453. The <see cref="T:System.Data.IDbConnection" /> that will be used
  454. to insert logging events into a database.
  455. </summary>
  456. </member>
  457. <member name="F:log4net.Appender.AdoNetAppender.m_connectionString">
  458. <summary>
  459. Database connection string.
  460. </summary>
  461. </member>
  462. <member name="F:log4net.Appender.AdoNetAppender.m_appSettingsKey">
  463. <summary>
  464. The appSettings key from App.Config that contains the connection string.
  465. </summary>
  466. </member>
  467. <member name="F:log4net.Appender.AdoNetAppender.m_connectionStringName">
  468. <summary>
  469. The connectionStrings key from App.Config that contains the connection string.
  470. </summary>
  471. </member>
  472. <member name="F:log4net.Appender.AdoNetAppender.m_connectionType">
  473. <summary>
  474. String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
  475. </summary>
  476. </member>
  477. <member name="F:log4net.Appender.AdoNetAppender.m_commandText">
  478. <summary>
  479. The text of the command.
  480. </summary>
  481. </member>
  482. <member name="F:log4net.Appender.AdoNetAppender.m_commandType">
  483. <summary>
  484. The command type.
  485. </summary>
  486. </member>
  487. <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions">
  488. <summary>
  489. Indicates whether to use transactions when writing to the database.
  490. </summary>
  491. </member>
  492. <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError">
  493. <summary>
  494. Indicates whether to reconnect when a connection is lost.
  495. </summary>
  496. </member>
  497. <member name="F:log4net.Appender.AdoNetAppender.declaringType">
  498. <summary>
  499. The fully qualified type of the AdoNetAppender class.
  500. </summary>
  501. <remarks>
  502. Used by the internal logger to record the Type of the
  503. log message.
  504. </remarks>
  505. </member>
  506. <member name="T:log4net.Appender.AdoNetAppenderParameter">
  507. <summary>
  508. Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>.
  509. </summary>
  510. <remarks>
  511. <para>
  512. This class provides the basic database parameter properties
  513. as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface.
  514. </para>
  515. <para>This type can be subclassed to provide database specific
  516. functionality. The two methods that are called externally are
  517. <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>.
  518. </para>
  519. </remarks>
  520. </member>
  521. <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor">
  522. <summary>
  523. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter" /> class.
  524. </summary>
  525. <remarks>
  526. Default constructor for the AdoNetAppenderParameter class.
  527. </remarks>
  528. </member>
  529. <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName">
  530. <summary>
  531. Gets or sets the name of this parameter.
  532. </summary>
  533. <value>
  534. The name of this parameter.
  535. </value>
  536. <remarks>
  537. <para>
  538. The name of this parameter. The parameter name
  539. must match up to a named parameter to the SQL stored procedure
  540. or prepared statement.
  541. </para>
  542. </remarks>
  543. </member>
  544. <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType">
  545. <summary>
  546. Gets or sets the database type for this parameter.
  547. </summary>
  548. <value>
  549. The database type for this parameter.
  550. </value>
  551. <remarks>
  552. <para>
  553. The database type for this parameter. This property should
  554. be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/>
  555. enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>.
  556. </para>
  557. <para>
  558. This property is optional. If not specified the ADO.NET provider
  559. will attempt to infer the type from the value.
  560. </para>
  561. </remarks>
  562. <seealso cref="P:System.Data.IDataParameter.DbType" />
  563. </member>
  564. <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision">
  565. <summary>
  566. Gets or sets the precision for this parameter.
  567. </summary>
  568. <value>
  569. The precision for this parameter.
  570. </value>
  571. <remarks>
  572. <para>
  573. The maximum number of digits used to represent the Value.
  574. </para>
  575. <para>
  576. This property is optional. If not specified the ADO.NET provider
  577. will attempt to infer the precision from the value.
  578. </para>
  579. </remarks>
  580. <seealso cref="P:System.Data.IDbDataParameter.Precision" />
  581. </member>
  582. <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale">
  583. <summary>
  584. Gets or sets the scale for this parameter.
  585. </summary>
  586. <value>
  587. The scale for this parameter.
  588. </value>
  589. <remarks>
  590. <para>
  591. The number of decimal places to which Value is resolved.
  592. </para>
  593. <para>
  594. This property is optional. If not specified the ADO.NET provider
  595. will attempt to infer the scale from the value.
  596. </para>
  597. </remarks>
  598. <seealso cref="P:System.Data.IDbDataParameter.Scale" />
  599. </member>
  600. <member name="P:log4net.Appender.AdoNetAppenderParameter.Size">
  601. <summary>
  602. Gets or sets the size for this parameter.
  603. </summary>
  604. <value>
  605. The size for this parameter.
  606. </value>
  607. <remarks>
  608. <para>
  609. The maximum size, in bytes, of the data within the column.
  610. </para>
  611. <para>
  612. This property is optional. If not specified the ADO.NET provider
  613. will attempt to infer the size from the value.
  614. </para>
  615. <para>
  616. For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case.
  617. </para>
  618. </remarks>
  619. <seealso cref="P:System.Data.IDbDataParameter.Size" />
  620. </member>
  621. <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout">
  622. <summary>
  623. Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to
  624. render the logging event into an object for this
  625. parameter.
  626. </summary>
  627. <value>
  628. The <see cref="T:log4net.Layout.IRawLayout"/> used to render the
  629. logging event into an object for this parameter.
  630. </value>
  631. <remarks>
  632. <para>
  633. The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this
  634. parameter.
  635. </para>
  636. <para>
  637. The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt
  638. any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/>
  639. for use in the property.
  640. </para>
  641. </remarks>
  642. </member>
  643. <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)">
  644. <summary>
  645. Prepare the specified database command object.
  646. </summary>
  647. <param name="command">The command to prepare.</param>
  648. <remarks>
  649. <para>
  650. Prepares the database command object by adding
  651. this parameter to its collection of parameters.
  652. </para>
  653. </remarks>
  654. </member>
  655. <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)">
  656. <summary>
  657. Renders the logging event and set the parameter value in the command.
  658. </summary>
  659. <param name="command">The command containing the parameter.</param>
  660. <param name="loggingEvent">The event to be rendered.</param>
  661. <remarks>
  662. <para>
  663. Renders the logging event using this parameters layout
  664. object. Sets the value of the parameter on the command object.
  665. </para>
  666. </remarks>
  667. </member>
  668. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName">
  669. <summary>
  670. The name of this parameter.
  671. </summary>
  672. </member>
  673. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType">
  674. <summary>
  675. The database type for this parameter.
  676. </summary>
  677. </member>
  678. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType">
  679. <summary>
  680. Flag to infer type rather than use the DbType
  681. </summary>
  682. </member>
  683. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision">
  684. <summary>
  685. The precision for this parameter.
  686. </summary>
  687. </member>
  688. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale">
  689. <summary>
  690. The scale for this parameter.
  691. </summary>
  692. </member>
  693. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size">
  694. <summary>
  695. The size for this parameter.
  696. </summary>
  697. </member>
  698. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout">
  699. <summary>
  700. The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the
  701. logging event into an object for this parameter.
  702. </summary>
  703. </member>
  704. <member name="T:log4net.Appender.AnsiColorTerminalAppender">
  705. <summary>
  706. Appends logging events to the terminal using ANSI color escape sequences.
  707. </summary>
  708. <remarks>
  709. <para>
  710. AnsiColorTerminalAppender appends log events to the standard output stream
  711. or the error output stream using a layout specified by the
  712. user. It also allows the color of a specific level of message to be set.
  713. </para>
  714. <note>
  715. This appender expects the terminal to understand the VT100 control set
  716. in order to interpret the color codes. If the terminal or console does not
  717. understand the control codes the behavior is not defined.
  718. </note>
  719. <para>
  720. By default, all output is written to the console's standard output stream.
  721. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the
  722. error stream.
  723. </para>
  724. <para>
  725. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  726. <c>System.Console.Error</c> that is set at the time the event is appended.
  727. Therefore it is possible to programmatically redirect the output of this appender
  728. (for example NUnit does this to capture program output). While this is the desired
  729. behavior of this appender it may have security implications in your application.
  730. </para>
  731. <para>
  732. When configuring the ANSI colored terminal appender, a mapping should be
  733. specified to map a logging level to a color. For example:
  734. </para>
  735. <code lang="XML" escaped="true">
  736. <mapping>
  737. <level value="ERROR" />
  738. <foreColor value="White" />
  739. <backColor value="Red" />
  740. <attributes value="Bright,Underscore" />
  741. </mapping>
  742. <mapping>
  743. <level value="DEBUG" />
  744. <backColor value="Green" />
  745. </mapping>
  746. </code>
  747. <para>
  748. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  749. of the following values:
  750. <list type="bullet">
  751. <item><term>Blue</term><description></description></item>
  752. <item><term>Green</term><description></description></item>
  753. <item><term>Red</term><description></description></item>
  754. <item><term>White</term><description></description></item>
  755. <item><term>Yellow</term><description></description></item>
  756. <item><term>Purple</term><description></description></item>
  757. <item><term>Cyan</term><description></description></item>
  758. </list>
  759. These color values cannot be combined together to make new colors.
  760. </para>
  761. <para>
  762. The attributes can be any combination of the following:
  763. <list type="bullet">
  764. <item><term>Bright</term><description>foreground is brighter</description></item>
  765. <item><term>Dim</term><description>foreground is dimmer</description></item>
  766. <item><term>Underscore</term><description>message is underlined</description></item>
  767. <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item>
  768. <item><term>Reverse</term><description>foreground and background are reversed</description></item>
  769. <item><term>Hidden</term><description>output is hidden</description></item>
  770. <item><term>Strikethrough</term><description>message has a line through it</description></item>
  771. </list>
  772. While any of these attributes may be combined together not all combinations
  773. work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes
  774. no sense.
  775. </para>
  776. </remarks>
  777. <author>Patrick Wagstrom</author>
  778. <author>Nicko Cadell</author>
  779. </member>
  780. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes">
  781. <summary>
  782. The enum of possible display attributes
  783. </summary>
  784. <remarks>
  785. <para>
  786. The following flags can be combined together to
  787. form the ANSI color attributes.
  788. </para>
  789. </remarks>
  790. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender" />
  791. </member>
  792. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright">
  793. <summary>
  794. text is bright
  795. </summary>
  796. </member>
  797. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim">
  798. <summary>
  799. text is dim
  800. </summary>
  801. </member>
  802. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore">
  803. <summary>
  804. text is underlined
  805. </summary>
  806. </member>
  807. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink">
  808. <summary>
  809. text is blinking
  810. </summary>
  811. <remarks>
  812. Not all terminals support this attribute
  813. </remarks>
  814. </member>
  815. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse">
  816. <summary>
  817. text and background colors are reversed
  818. </summary>
  819. </member>
  820. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden">
  821. <summary>
  822. text is hidden
  823. </summary>
  824. </member>
  825. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough">
  826. <summary>
  827. text is displayed with a strikethrough
  828. </summary>
  829. </member>
  830. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Light">
  831. <summary>
  832. text color is light
  833. </summary>
  834. </member>
  835. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor">
  836. <summary>
  837. The enum of possible foreground or background color values for
  838. use with the color mapping method
  839. </summary>
  840. <remarks>
  841. <para>
  842. The output can be in one for the following ANSI colors.
  843. </para>
  844. </remarks>
  845. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender" />
  846. </member>
  847. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black">
  848. <summary>
  849. color is black
  850. </summary>
  851. </member>
  852. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red">
  853. <summary>
  854. color is red
  855. </summary>
  856. </member>
  857. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green">
  858. <summary>
  859. color is green
  860. </summary>
  861. </member>
  862. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow">
  863. <summary>
  864. color is yellow
  865. </summary>
  866. </member>
  867. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue">
  868. <summary>
  869. color is blue
  870. </summary>
  871. </member>
  872. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta">
  873. <summary>
  874. color is magenta
  875. </summary>
  876. </member>
  877. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan">
  878. <summary>
  879. color is cyan
  880. </summary>
  881. </member>
  882. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White">
  883. <summary>
  884. color is white
  885. </summary>
  886. </member>
  887. <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor">
  888. <summary>
  889. Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender" /> class.
  890. </summary>
  891. <remarks>
  892. The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender" /> class is set up to write
  893. to the standard output stream.
  894. </remarks>
  895. </member>
  896. <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target">
  897. <summary>
  898. Target is the value of the console output stream.
  899. </summary>
  900. <value>
  901. Target is the value of the console output stream.
  902. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  903. </value>
  904. <remarks>
  905. <para>
  906. Target is the value of the console output stream.
  907. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  908. </para>
  909. </remarks>
  910. </member>
  911. <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)">
  912. <summary>
  913. Add a mapping of level to color
  914. </summary>
  915. <param name="mapping">The mapping to add</param>
  916. <remarks>
  917. <para>
  918. Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender.
  919. Each mapping defines the foreground and background colours
  920. for a level.
  921. </para>
  922. </remarks>
  923. </member>
  924. <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)">
  925. <summary>
  926. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  927. </summary>
  928. <param name="loggingEvent">The event to log.</param>
  929. <remarks>
  930. <para>
  931. Writes the event to the console.
  932. </para>
  933. <para>
  934. The format of the output will depend on the appender's layout.
  935. </para>
  936. </remarks>
  937. </member>
  938. <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout">
  939. <summary>
  940. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  941. </summary>
  942. <value><c>true</c></value>
  943. <remarks>
  944. <para>
  945. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  946. </para>
  947. </remarks>
  948. </member>
  949. <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions">
  950. <summary>
  951. Initialize the options for this appender
  952. </summary>
  953. <remarks>
  954. <para>
  955. Initialize the level to color mappings set on this appender.
  956. </para>
  957. </remarks>
  958. </member>
  959. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut">
  960. <summary>
  961. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  962. standard output stream.
  963. </summary>
  964. <remarks>
  965. <para>
  966. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  967. standard output stream.
  968. </para>
  969. </remarks>
  970. </member>
  971. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError">
  972. <summary>
  973. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  974. standard error output stream.
  975. </summary>
  976. <remarks>
  977. <para>
  978. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  979. standard error output stream.
  980. </para>
  981. </remarks>
  982. </member>
  983. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream">
  984. <summary>
  985. Flag to write output to the error stream rather than the standard output stream
  986. </summary>
  987. </member>
  988. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping">
  989. <summary>
  990. Mapping from level object to color value
  991. </summary>
  992. </member>
  993. <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes">
  994. <summary>
  995. Ansi code to reset terminal
  996. </summary>
  997. </member>
  998. <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors">
  999. <summary>
  1000. A class to act as a mapping between the level that a logging call is made at and
  1001. the color it should be displayed as.
  1002. </summary>
  1003. <remarks>
  1004. <para>
  1005. Defines the mapping between a level and the color it should be displayed in.
  1006. </para>
  1007. </remarks>
  1008. </member>
  1009. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor">
  1010. <summary>
  1011. The mapped foreground color for the specified level
  1012. </summary>
  1013. <remarks>
  1014. <para>
  1015. Required property.
  1016. The mapped foreground color for the specified level
  1017. </para>
  1018. </remarks>
  1019. </member>
  1020. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor">
  1021. <summary>
  1022. The mapped background color for the specified level
  1023. </summary>
  1024. <remarks>
  1025. <para>
  1026. Required property.
  1027. The mapped background color for the specified level
  1028. </para>
  1029. </remarks>
  1030. </member>
  1031. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes">
  1032. <summary>
  1033. The color attributes for the specified level
  1034. </summary>
  1035. <remarks>
  1036. <para>
  1037. Required property.
  1038. The color attributes for the specified level
  1039. </para>
  1040. </remarks>
  1041. </member>
  1042. <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions">
  1043. <summary>
  1044. Initialize the options for the object
  1045. </summary>
  1046. <remarks>
  1047. <para>
  1048. Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together
  1049. and append the attributes.
  1050. </para>
  1051. </remarks>
  1052. </member>
  1053. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor">
  1054. <summary>
  1055. The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and
  1056. <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color.
  1057. </summary>
  1058. </member>
  1059. <member name="T:log4net.Appender.AppenderCollection">
  1060. <summary>
  1061. A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects.
  1062. </summary>
  1063. <author>Nicko Cadell</author>
  1064. </member>
  1065. <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator">
  1066. <summary>
  1067. Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  1068. </summary>
  1069. <exclude/>
  1070. </member>
  1071. <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current">
  1072. <summary>
  1073. Gets the current element in the collection.
  1074. </summary>
  1075. </member>
  1076. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext">
  1077. <summary>
  1078. Advances the enumerator to the next element in the collection.
  1079. </summary>
  1080. <returns>
  1081. <c>true</c> if the enumerator was successfully advanced to the next element;
  1082. <c>false</c> if the enumerator has passed the end of the collection.
  1083. </returns>
  1084. <exception cref="T:System.InvalidOperationException">
  1085. The collection was modified after the enumerator was created.
  1086. </exception>
  1087. </member>
  1088. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset">
  1089. <summary>
  1090. Sets the enumerator to its initial position, before the first element in the collection.
  1091. </summary>
  1092. </member>
  1093. <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)">
  1094. <summary>
  1095. Creates a read-only wrapper for a <c>AppenderCollection</c> instance.
  1096. </summary>
  1097. <param name="list">list to create a readonly wrapper arround</param>
  1098. <returns>
  1099. An <c>AppenderCollection</c> wrapper that is read-only.
  1100. </returns>
  1101. </member>
  1102. <member name="F:log4net.Appender.AppenderCollection.EmptyCollection">
  1103. <summary>
  1104. An empty readonly static AppenderCollection
  1105. </summary>
  1106. </member>
  1107. <member name="M:log4net.Appender.AppenderCollection.#ctor">
  1108. <summary>
  1109. Initializes a new instance of the <c>AppenderCollection</c> class
  1110. that is empty and has the default initial capacity.
  1111. </summary>
  1112. </member>
  1113. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)">
  1114. <summary>
  1115. Initializes a new instance of the <c>AppenderCollection</c> class
  1116. that has the specified initial capacity.
  1117. </summary>
  1118. <param name="capacity">
  1119. The number of elements that the new <c>AppenderCollection</c> is initially capable of storing.
  1120. </param>
  1121. </member>
  1122. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)">
  1123. <summary>
  1124. Initializes a new instance of the <c>AppenderCollection</c> class
  1125. that contains elements copied from the specified <c>AppenderCollection</c>.
  1126. </summary>
  1127. <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param>
  1128. </member>
  1129. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])">
  1130. <summary>
  1131. Initializes a new instance of the <c>AppenderCollection</c> class
  1132. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array.
  1133. </summary>
  1134. <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param>
  1135. </member>
  1136. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)">
  1137. <summary>
  1138. Initializes a new instance of the <c>AppenderCollection</c> class
  1139. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection.
  1140. </summary>
  1141. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param>
  1142. </member>
  1143. <member name="T:log4net.Appender.AppenderCollection.Tag">
  1144. <summary>
  1145. Type visible only to our subclasses
  1146. Used to access protected constructor
  1147. </summary>
  1148. <exclude/>
  1149. </member>
  1150. <member name="F:log4net.Appender.AppenderCollection.Tag.Default">
  1151. <summary>
  1152. A value
  1153. </summary>
  1154. </member>
  1155. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)">
  1156. <summary>
  1157. Allow subclasses to avoid our default constructors
  1158. </summary>
  1159. <param name="tag"></param>
  1160. <exclude/>
  1161. </member>
  1162. <member name="P:log4net.Appender.AppenderCollection.Count">
  1163. <summary>
  1164. Gets the number of elements actually contained in the <c>AppenderCollection</c>.
  1165. </summary>
  1166. </member>
  1167. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])">
  1168. <summary>
  1169. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  1170. <see cref="T:log4net.Appender.IAppender"/> array.
  1171. </summary>
  1172. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  1173. </member>
  1174. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)">
  1175. <summary>
  1176. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  1177. <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array.
  1178. </summary>
  1179. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  1180. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  1181. </member>
  1182. <member name="P:log4net.Appender.AppenderCollection.IsSynchronized">
  1183. <summary>
  1184. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  1185. </summary>
  1186. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  1187. </member>
  1188. <member name="P:log4net.Appender.AppenderCollection.SyncRoot">
  1189. <summary>
  1190. Gets an object that can be used to synchronize access to the collection.
  1191. </summary>
  1192. </member>
  1193. <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)">
  1194. <summary>
  1195. Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index.
  1196. </summary>
  1197. <param name="index">The zero-based index of the element to get or set.</param>
  1198. <exception cref="T:System.ArgumentOutOfRangeException">
  1199. <para><paramref name="index"/> is less than zero</para>
  1200. <para>-or-</para>
  1201. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1202. </exception>
  1203. </member>
  1204. <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)">
  1205. <summary>
  1206. Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>.
  1207. </summary>
  1208. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param>
  1209. <returns>The index at which the value has been added.</returns>
  1210. </member>
  1211. <member name="M:log4net.Appender.AppenderCollection.Clear">
  1212. <summary>
  1213. Removes all elements from the <c>AppenderCollection</c>.
  1214. </summary>
  1215. </member>
  1216. <member name="M:log4net.Appender.AppenderCollection.Clone">
  1217. <summary>
  1218. Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>.
  1219. </summary>
  1220. <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns>
  1221. </member>
  1222. <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)">
  1223. <summary>
  1224. Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>.
  1225. </summary>
  1226. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param>
  1227. <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns>
  1228. </member>
  1229. <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)">
  1230. <summary>
  1231. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/>
  1232. in the <c>AppenderCollection</c>.
  1233. </summary>
  1234. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param>
  1235. <returns>
  1236. The zero-based index of the first occurrence of <paramref name="item"/>
  1237. in the entire <c>AppenderCollection</c>, if found; otherwise, -1.
  1238. </returns>
  1239. </member>
  1240. <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)">
  1241. <summary>
  1242. Inserts an element into the <c>AppenderCollection</c> at the specified index.
  1243. </summary>
  1244. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  1245. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param>
  1246. <exception cref="T:System.ArgumentOutOfRangeException">
  1247. <para><paramref name="index"/> is less than zero</para>
  1248. <para>-or-</para>
  1249. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1250. </exception>
  1251. </member>
  1252. <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)">
  1253. <summary>
  1254. Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>.
  1255. </summary>
  1256. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param>
  1257. <exception cref="T:System.ArgumentException">
  1258. The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>.
  1259. </exception>
  1260. </member>
  1261. <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)">
  1262. <summary>
  1263. Removes the element at the specified index of the <c>AppenderCollection</c>.
  1264. </summary>
  1265. <param name="index">The zero-based index of the element to remove.</param>
  1266. <exception cref="T:System.ArgumentOutOfRangeException">
  1267. <para><paramref name="index"/> is less than zero</para>
  1268. <para>-or-</para>
  1269. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1270. </exception>
  1271. </member>
  1272. <member name="P:log4net.Appender.AppenderCollection.IsFixedSize">
  1273. <summary>
  1274. Gets a value indicating whether the collection has a fixed size.
  1275. </summary>
  1276. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  1277. </member>
  1278. <member name="P:log4net.Appender.AppenderCollection.IsReadOnly">
  1279. <summary>
  1280. Gets a value indicating whether the IList is read-only.
  1281. </summary>
  1282. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  1283. </member>
  1284. <member name="M:log4net.Appender.AppenderCollection.GetEnumerator">
  1285. <summary>
  1286. Returns an enumerator that can iterate through the <c>AppenderCollection</c>.
  1287. </summary>
  1288. <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns>
  1289. </member>
  1290. <member name="P:log4net.Appender.AppenderCollection.Capacity">
  1291. <summary>
  1292. Gets or sets the number of elements the <c>AppenderCollection</c> can contain.
  1293. </summary>
  1294. </member>
  1295. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)">
  1296. <summary>
  1297. Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>.
  1298. </summary>
  1299. <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param>
  1300. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1301. </member>
  1302. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])">
  1303. <summary>
  1304. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>.
  1305. </summary>
  1306. <param name="x">The <see cref="T:log4net.Appender.IAppender"/> array whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
  1307. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1308. </member>
  1309. <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)">
  1310. <summary>
  1311. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>.
  1312. </summary>
  1313. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
  1314. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1315. </member>
  1316. <member name="M:log4net.Appender.AppenderCollection.TrimToSize">
  1317. <summary>
  1318. Sets the capacity to the actual number of elements.
  1319. </summary>
  1320. </member>
  1321. <member name="M:log4net.Appender.AppenderCollection.ToArray">
  1322. <summary>
  1323. Return the collection elements as an array
  1324. </summary>
  1325. <returns>the array</returns>
  1326. </member>
  1327. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)">
  1328. <exception cref="T:System.ArgumentOutOfRangeException">
  1329. <para><paramref name="i"/> is less than zero</para>
  1330. <para>-or-</para>
  1331. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1332. </exception>
  1333. </member>
  1334. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)">
  1335. <exception cref="T:System.ArgumentOutOfRangeException">
  1336. <para><paramref name="i"/> is less than zero</para>
  1337. <para>-or-</para>
  1338. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1339. </exception>
  1340. </member>
  1341. <member name="T:log4net.Appender.AppenderCollection.Enumerator">
  1342. <summary>
  1343. Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  1344. </summary>
  1345. <exclude/>
  1346. </member>
  1347. <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)">
  1348. <summary>
  1349. Initializes a new instance of the <c>Enumerator</c> class.
  1350. </summary>
  1351. <param name="tc"></param>
  1352. </member>
  1353. <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current">
  1354. <summary>
  1355. Gets the current element in the collection.
  1356. </summary>
  1357. </member>
  1358. <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext">
  1359. <summary>
  1360. Advances the enumerator to the next element in the collection.
  1361. </summary>
  1362. <returns>
  1363. <c>true</c> if the enumerator was successfully advanced to the next element;
  1364. <c>false</c> if the enumerator has passed the end of the collection.
  1365. </returns>
  1366. <exception cref="T:System.InvalidOperationException">
  1367. The collection was modified after the enumerator was created.
  1368. </exception>
  1369. </member>
  1370. <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset">
  1371. <summary>
  1372. Sets the enumerator to its initial position, before the first element in the collection.
  1373. </summary>
  1374. </member>
  1375. <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection">
  1376. <exclude/>
  1377. </member>
  1378. <member name="T:log4net.Appender.AppenderSkeleton">
  1379. <summary>
  1380. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>.
  1381. </summary>
  1382. <remarks>
  1383. <para>
  1384. This class provides the code for common functionality, such
  1385. as support for threshold filtering and support for general filters.
  1386. </para>
  1387. <para>
  1388. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  1389. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  1390. be called after the appenders properties have been configured.
  1391. </para>
  1392. </remarks>
  1393. <author>Nicko Cadell</author>
  1394. <author>Gert Driesen</author>
  1395. </member>
  1396. <member name="M:log4net.Appender.AppenderSkeleton.#ctor">
  1397. <summary>
  1398. Default constructor
  1399. </summary>
  1400. <remarks>
  1401. <para>Empty default constructor</para>
  1402. </remarks>
  1403. </member>
  1404. <member name="M:log4net.Appender.AppenderSkeleton.Finalize">
  1405. <summary>
  1406. Finalizes this appender by calling the implementation's
  1407. <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
  1408. </summary>
  1409. <remarks>
  1410. <para>
  1411. If this appender has not been closed then the <c>Finalize</c> method
  1412. will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>.
  1413. </para>
  1414. </remarks>
  1415. </member>
  1416. <member name="P:log4net.Appender.AppenderSkeleton.Threshold">
  1417. <summary>
  1418. Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender.
  1419. </summary>
  1420. <value>
  1421. The threshold <see cref="T:log4net.Core.Level"/> of the appender.
  1422. </value>
  1423. <remarks>
  1424. <para>
  1425. All log events with lower level than the threshold level are ignored
  1426. by the appender.
  1427. </para>
  1428. <para>
  1429. In configuration files this option is specified by setting the
  1430. value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
  1431. string, such as "DEBUG", "INFO" and so on.
  1432. </para>
  1433. </remarks>
  1434. </member>
  1435. <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
  1436. <summary>
  1437. Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  1438. </summary>
  1439. <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value>
  1440. <remarks>
  1441. <para>
  1442. The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
  1443. implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
  1444. </para>
  1445. </remarks>
  1446. </member>
  1447. <member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
  1448. <summary>
  1449. The filter chain.
  1450. </summary>
  1451. <value>The head of the filter chain filter chain.</value>
  1452. <remarks>
  1453. <para>
  1454. Returns the head Filter. The Filters are organized in a linked list
  1455. and so all Filters on this Appender are available through the result.
  1456. </para>
  1457. </remarks>
  1458. </member>
  1459. <member name="P:log4net.Appender.AppenderSkeleton.Layout">
  1460. <summary>
  1461. Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
  1462. </summary>
  1463. <value>The layout of the appender.</value>
  1464. <remarks>
  1465. <para>
  1466. See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
  1467. </para>
  1468. </remarks>
  1469. <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
  1470. </member>
  1471. <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
  1472. <summary>
  1473. Initialize the appender based on the options set
  1474. </summary>
  1475. <remarks>
  1476. <para>
  1477. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  1478. activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must
  1479. be called on this object after the configuration properties have
  1480. been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this
  1481. object is in an undefined state and must not be used.
  1482. </para>
  1483. <para>
  1484. If any of the configuration properties are modified then
  1485. <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again.
  1486. </para>
  1487. </remarks>
  1488. </member>
  1489. <member name="P:log4net.Appender.AppenderSkeleton.Name">
  1490. <summary>
  1491. Gets or sets the name of this appender.
  1492. </summary>
  1493. <value>The name of the appender.</value>
  1494. <remarks>
  1495. <para>
  1496. The name uniquely identifies the appender.
  1497. </para>
  1498. </remarks>
  1499. </member>
  1500. <member name="M:log4net.Appender.AppenderSkeleton.Close">
  1501. <summary>
  1502. Closes the appender and release resources.
  1503. </summary>
  1504. <remarks>
  1505. <para>
  1506. Release any resources allocated within the appender such as file handles,
  1507. network connections, etc.
  1508. </para>
  1509. <para>
  1510. It is a programming error to append to a closed appender.
  1511. </para>
  1512. <para>
  1513. This method cannot be overridden by subclasses. This method
  1514. delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
  1515. method which must be overridden in the subclass.
  1516. </para>
  1517. </remarks>
  1518. </member>
  1519. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)">
  1520. <summary>
  1521. Performs threshold checks and invokes filters before
  1522. delegating actual logging to the subclasses specific
  1523. <see cref="M:Append(LoggingEvent)"/> method.
  1524. </summary>
  1525. <param name="loggingEvent">The event to log.</param>
  1526. <remarks>
  1527. <para>
  1528. This method cannot be overridden by derived classes. A
  1529. derived class should override the <see cref="M:Append(LoggingEvent)"/> method
  1530. which is called by this method.
  1531. </para>
  1532. <para>
  1533. The implementation of this method is as follows:
  1534. </para>
  1535. <para>
  1536. <list type="bullet">
  1537. <item>
  1538. <description>
  1539. Checks that the severity of the <paramref name="loggingEvent"/>
  1540. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1541. appender.</description>
  1542. </item>
  1543. <item>
  1544. <description>
  1545. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1546. <paramref name="loggingEvent"/>.
  1547. </description>
  1548. </item>
  1549. <item>
  1550. <description>
  1551. Calls <see cref="M:PreAppendCheck()"/> and checks that
  1552. it returns <c>true</c>.</description>
  1553. </item>
  1554. </list>
  1555. </para>
  1556. <para>
  1557. If all of the above steps succeed then the <paramref name="loggingEvent"/>
  1558. will be passed to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  1559. </para>
  1560. </remarks>
  1561. </member>
  1562. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
  1563. <summary>
  1564. Performs threshold checks and invokes filters before
  1565. delegating actual logging to the subclasses specific
  1566. <see cref="M:Append(LoggingEvent[])"/> method.
  1567. </summary>
  1568. <param name="loggingEvents">The array of events to log.</param>
  1569. <remarks>
  1570. <para>
  1571. This method cannot be overridden by derived classes. A
  1572. derived class should override the <see cref="M:Append(LoggingEvent[])"/> method
  1573. which is called by this method.
  1574. </para>
  1575. <para>
  1576. The implementation of this method is as follows:
  1577. </para>
  1578. <para>
  1579. <list type="bullet">
  1580. <item>
  1581. <description>
  1582. Checks that the severity of the <paramref name="loggingEvents"/>
  1583. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1584. appender.</description>
  1585. </item>
  1586. <item>
  1587. <description>
  1588. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1589. <paramref name="loggingEvents"/>.
  1590. </description>
  1591. </item>
  1592. <item>
  1593. <description>
  1594. Calls <see cref="M:PreAppendCheck()"/> and checks that
  1595. it returns <c>true</c>.</description>
  1596. </item>
  1597. </list>
  1598. </para>
  1599. <para>
  1600. If all of the above steps succeed then the <paramref name="loggingEvents"/>
  1601. will be passed to the <see cref="M:Append(LoggingEvent[])"/> method.
  1602. </para>
  1603. </remarks>
  1604. </member>
  1605. <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
  1606. <summary>
  1607. Test if the logging event should we output by this appender
  1608. </summary>
  1609. <param name="loggingEvent">the event to test</param>
  1610. <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
  1611. <remarks>
  1612. <para>
  1613. This method checks the logging event against the threshold level set
  1614. on this appender and also against the filters specified on this
  1615. appender.
  1616. </para>
  1617. <para>
  1618. The implementation of this method is as follows:
  1619. </para>
  1620. <para>
  1621. <list type="bullet">
  1622. <item>
  1623. <description>
  1624. Checks that the severity of the <paramref name="loggingEvent"/>
  1625. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1626. appender.</description>
  1627. </item>
  1628. <item>
  1629. <description>
  1630. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1631. <paramref name="loggingEvent"/>.
  1632. </description>
  1633. </item>
  1634. </list>
  1635. </para>
  1636. </remarks>
  1637. </member>
  1638. <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
  1639. <summary>
  1640. Adds a filter to the end of the filter chain.
  1641. </summary>
  1642. <param name="filter">the filter to add to this appender</param>
  1643. <remarks>
  1644. <para>
  1645. The Filters are organized in a linked list.
  1646. </para>
  1647. <para>
  1648. Setting this property causes the new filter to be pushed onto the
  1649. back of the filter chain.
  1650. </para>
  1651. </remarks>
  1652. </member>
  1653. <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
  1654. <summary>
  1655. Clears the filter list for this appender.
  1656. </summary>
  1657. <remarks>
  1658. <para>
  1659. Clears the filter list for this appender.
  1660. </para>
  1661. </remarks>
  1662. </member>
  1663. <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)">
  1664. <summary>
  1665. Checks if the message level is below this appender's threshold.
  1666. </summary>
  1667. <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param>
  1668. <remarks>
  1669. <para>
  1670. If there is no threshold set, then the return value is always <c>true</c>.
  1671. </para>
  1672. </remarks>
  1673. <returns>
  1674. <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
  1675. requirements of this appender.
  1676. </returns>
  1677. </member>
  1678. <member name="M:log4net.Appender.AppenderSkeleton.OnClose">
  1679. <summary>
  1680. Is called when the appender is closed. Derived classes should override
  1681. this method if resources need to be released.
  1682. </summary>
  1683. <remarks>
  1684. <para>
  1685. Releases any resources allocated within the appender such as file handles,
  1686. network connections, etc.
  1687. </para>
  1688. <para>
  1689. It is a programming error to append to a closed appender.
  1690. </para>
  1691. </remarks>
  1692. </member>
  1693. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  1694. <summary>
  1695. Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
  1696. to perform actual logging.
  1697. </summary>
  1698. <param name="loggingEvent">The event to append.</param>
  1699. <remarks>
  1700. <para>
  1701. A subclass must implement this method to perform
  1702. logging of the <paramref name="loggingEvent"/>.
  1703. </para>
  1704. <para>This method will be called by <see cref="M:DoAppend(LoggingEvent)"/>
  1705. if all the conditions listed for that method are met.
  1706. </para>
  1707. <para>
  1708. To restrict the logging of events in the appender
  1709. override the <see cref="M:PreAppendCheck()"/> method.
  1710. </para>
  1711. </remarks>
  1712. </member>
  1713. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
  1714. <summary>
  1715. Append a bulk array of logging events.
  1716. </summary>
  1717. <param name="loggingEvents">the array of logging events</param>
  1718. <remarks>
  1719. <para>
  1720. This base class implementation calls the <see cref="M:Append(LoggingEvent)"/>
  1721. method for each element in the bulk array.
  1722. </para>
  1723. <para>
  1724. A sub class that can better process a bulk array of events should
  1725. override this method in addition to <see cref="M:Append(LoggingEvent)"/>.
  1726. </para>
  1727. </remarks>
  1728. </member>
  1729. <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
  1730. <summary>
  1731. Called before <see cref="M:Append(LoggingEvent)"/> as a precondition.
  1732. </summary>
  1733. <remarks>
  1734. <para>
  1735. This method is called by <see cref="M:DoAppend(LoggingEvent)"/>
  1736. before the call to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  1737. </para>
  1738. <para>
  1739. This method can be overridden in a subclass to extend the checks
  1740. made before the event is passed to the <see cref="M:Append(LoggingEvent)"/> method.
  1741. </para>
  1742. <para>
  1743. A subclass should ensure that they delegate this call to
  1744. this base class if it is overridden.
  1745. </para>
  1746. </remarks>
  1747. <returns><c>true</c> if the call to <see cref="M:Append(LoggingEvent)"/> should proceed.</returns>
  1748. </member>
  1749. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)">
  1750. <summary>
  1751. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  1752. </summary>
  1753. <param name="loggingEvent">The event to render.</param>
  1754. <returns>The event rendered as a string.</returns>
  1755. <remarks>
  1756. <para>
  1757. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  1758. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  1759. set to render the <paramref name="loggingEvent"/> to
  1760. a string.
  1761. </para>
  1762. <para>If there is exception data in the logging event and
  1763. the layout does not process the exception, this method
  1764. will append the exception text to the rendered string.
  1765. </para>
  1766. <para>
  1767. Where possible use the alternative version of this method
  1768. <see cref="M:RenderLoggingEvent(TextWriter,LoggingEvent)"/>.
  1769. That method streams the rendering onto an existing Writer
  1770. which can give better performance if the caller already has
  1771. a <see cref="T:System.IO.TextWriter"/> open and ready for writing.
  1772. </para>
  1773. </remarks>
  1774. </member>
  1775. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  1776. <summary>
  1777. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  1778. </summary>
  1779. <param name="loggingEvent">The event to render.</param>
  1780. <param name="writer">The TextWriter to write the formatted event to</param>
  1781. <remarks>
  1782. <para>
  1783. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  1784. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  1785. set to render the <paramref name="loggingEvent"/> to
  1786. a string.
  1787. </para>
  1788. <para>If there is exception data in the logging event and
  1789. the layout does not process the exception, this method
  1790. will append the exception text to the rendered string.
  1791. </para>
  1792. <para>
  1793. Use this method in preference to <see cref="M:RenderLoggingEvent(LoggingEvent)"/>
  1794. where possible. If, however, the caller needs to render the event
  1795. to a string then <see cref="M:RenderLoggingEvent(LoggingEvent)"/> does
  1796. provide an efficient mechanism for doing so.
  1797. </para>
  1798. </remarks>
  1799. </member>
  1800. <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
  1801. <summary>
  1802. Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  1803. </summary>
  1804. <remarks>
  1805. <para>
  1806. In the rather exceptional case, where the appender
  1807. implementation admits a layout but can also work without it,
  1808. then the appender should return <c>true</c>.
  1809. </para>
  1810. <para>
  1811. This default implementation always returns <c>false</c>.
  1812. </para>
  1813. </remarks>
  1814. <returns>
  1815. <c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
  1816. </returns>
  1817. </member>
  1818. <member name="M:log4net.Appender.AppenderSkeleton.Flush(System.Int32)">
  1819. <summary>
  1820. Flushes any buffered log data.
  1821. </summary>
  1822. <remarks>
  1823. This implementation doesn't flush anything and always returns true
  1824. </remarks>
  1825. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  1826. </member>
  1827. <member name="F:log4net.Appender.AppenderSkeleton.m_layout">
  1828. <summary>
  1829. The layout of this appender.
  1830. </summary>
  1831. <remarks>
  1832. See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
  1833. </remarks>
  1834. </member>
  1835. <member name="F:log4net.Appender.AppenderSkeleton.m_name">
  1836. <summary>
  1837. The name of this appender.
  1838. </summary>
  1839. <remarks>
  1840. See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
  1841. </remarks>
  1842. </member>
  1843. <member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
  1844. <summary>
  1845. The level threshold of this appender.
  1846. </summary>
  1847. <remarks>
  1848. <para>
  1849. There is no level threshold filtering by default.
  1850. </para>
  1851. <para>
  1852. See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
  1853. </para>
  1854. </remarks>
  1855. </member>
  1856. <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
  1857. <summary>
  1858. It is assumed and enforced that errorHandler is never null.
  1859. </summary>
  1860. <remarks>
  1861. <para>
  1862. It is assumed and enforced that errorHandler is never null.
  1863. </para>
  1864. <para>
  1865. See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
  1866. </para>
  1867. </remarks>
  1868. </member>
  1869. <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
  1870. <summary>
  1871. The first filter in the filter chain.
  1872. </summary>
  1873. <remarks>
  1874. <para>
  1875. Set to <c>null</c> initially.
  1876. </para>
  1877. <para>
  1878. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  1879. </para>
  1880. </remarks>
  1881. </member>
  1882. <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
  1883. <summary>
  1884. The last filter in the filter chain.
  1885. </summary>
  1886. <remarks>
  1887. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  1888. </remarks>
  1889. </member>
  1890. <member name="F:log4net.Appender.AppenderSkeleton.m_closed">
  1891. <summary>
  1892. Flag indicating if this appender is closed.
  1893. </summary>
  1894. <remarks>
  1895. See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
  1896. </remarks>
  1897. </member>
  1898. <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
  1899. <summary>
  1900. The guard prevents an appender from repeatedly calling its own DoAppend method
  1901. </summary>
  1902. </member>
  1903. <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter">
  1904. <summary>
  1905. StringWriter used to render events
  1906. </summary>
  1907. </member>
  1908. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize">
  1909. <summary>
  1910. Initial buffer size
  1911. </summary>
  1912. </member>
  1913. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity">
  1914. <summary>
  1915. Maximum buffer size before it is recycled
  1916. </summary>
  1917. </member>
  1918. <member name="F:log4net.Appender.AppenderSkeleton.declaringType">
  1919. <summary>
  1920. The fully qualified type of the AppenderSkeleton class.
  1921. </summary>
  1922. <remarks>
  1923. Used by the internal logger to record the Type of the
  1924. log message.
  1925. </remarks>
  1926. </member>
  1927. <member name="T:log4net.Appender.BufferingAppenderSkeleton">
  1928. <summary>
  1929. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that
  1930. buffers events in a fixed size buffer.
  1931. </summary>
  1932. <remarks>
  1933. <para>
  1934. This base class should be used by appenders that need to buffer a
  1935. number of events before logging them.
  1936. For example the <see cref="T:log4net.Appender.AdoNetAppender"/>
  1937. buffers events and then submits the entire contents of the buffer to
  1938. the underlying database in one go.
  1939. </para>
  1940. <para>
  1941. Subclasses should override the <see cref="M:SendBuffer(LoggingEvent[])"/>
  1942. method to deliver the buffered events.
  1943. </para>
  1944. <para>The BufferingAppenderSkeleton maintains a fixed size cyclic
  1945. buffer of events. The size of the buffer is set using
  1946. the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property.
  1947. </para>
  1948. <para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect
  1949. each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  1950. triggers, then the current buffer is sent immediately
  1951. (see <see cref="M:SendBuffer(LoggingEvent[])"/>). Otherwise the event
  1952. is stored in the buffer. For example, an evaluator can be used to
  1953. deliver the events immediately when an ERROR event arrives.
  1954. </para>
  1955. <para>
  1956. The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode.
  1957. By default the appender is NOT lossy. When the buffer is full all
  1958. the buffered events are sent with <see cref="M:SendBuffer(LoggingEvent[])"/>.
  1959. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the
  1960. buffer will not be sent when it is full, and new events arriving
  1961. in the appender will overwrite the oldest event in the buffer.
  1962. In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  1963. triggers. This can be useful behavior when you need to know about
  1964. ERROR events but not about events with a lower level, configure an
  1965. evaluator that will trigger when an ERROR event arrives, the whole
  1966. buffer will be sent which gives a history of events leading up to
  1967. the ERROR event.
  1968. </para>
  1969. </remarks>
  1970. <author>Nicko Cadell</author>
  1971. <author>Gert Driesen</author>
  1972. </member>
  1973. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
  1974. <summary>
  1975. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton" /> class.
  1976. </summary>
  1977. <remarks>
  1978. <para>
  1979. Protected default constructor to allow subclassing.
  1980. </para>
  1981. </remarks>
  1982. </member>
  1983. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
  1984. <summary>
  1985. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton" /> class.
  1986. </summary>
  1987. <param name="eventMustBeFixed">the events passed through this appender must be
  1988. fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param>
  1989. <remarks>
  1990. <para>
  1991. Protected constructor to allow subclassing.
  1992. </para>
  1993. <para>
  1994. The <paramref name="eventMustBeFixed"/> should be set if the subclass
  1995. expects the events delivered to be fixed even if the
  1996. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs.
  1997. </para>
  1998. </remarks>
  1999. </member>
  2000. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
  2001. <summary>
  2002. Gets or sets a value that indicates whether the appender is lossy.
  2003. </summary>
  2004. <value>
  2005. <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
  2006. </value>
  2007. <remarks>
  2008. <para>
  2009. This appender uses a buffer to store logging events before
  2010. delivering them. A triggering event causes the whole buffer
  2011. to be send to the remote sink. If the buffer overruns before
  2012. a triggering event then logging events could be lost. Set
  2013. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
  2014. from being lost.
  2015. </para>
  2016. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  2017. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  2018. </remarks>
  2019. </member>
  2020. <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
  2021. <summary>
  2022. Gets or sets the size of the cyclic buffer used to hold the
  2023. logging events.
  2024. </summary>
  2025. <value>
  2026. The size of the cyclic buffer used to hold the logging events.
  2027. </value>
  2028. <remarks>
  2029. <para>
  2030. The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
  2031. representing the maximum number of logging events to collect in
  2032. a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
  2033. oldest events are deleted as new events are added to the
  2034. buffer. By default the size of the cyclic buffer is 512 events.
  2035. </para>
  2036. <para>
  2037. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than
  2038. or equal to 1 then no buffering will occur. The logging event
  2039. will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>
  2040. and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will
  2041. be buffered.
  2042. </para>
  2043. </remarks>
  2044. </member>
  2045. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
  2046. <summary>
  2047. Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the
  2048. buffer to be sent immediately.
  2049. </summary>
  2050. <value>
  2051. The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be
  2052. sent immediately.
  2053. </value>
  2054. <remarks>
  2055. <para>
  2056. The evaluator will be called for each event that is appended to this
  2057. appender. If the evaluator triggers then the current buffer will
  2058. immediately be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  2059. </para>
  2060. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  2061. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  2062. </remarks>
  2063. </member>
  2064. <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
  2065. <summary>
  2066. Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  2067. </summary>
  2068. <value>
  2069. The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  2070. </value>
  2071. <remarks>
  2072. <para>
  2073. The evaluator will be called for each event that is discarded from this
  2074. appender. If the evaluator triggers then the current buffer will immediately
  2075. be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  2076. </para>
  2077. </remarks>
  2078. </member>
  2079. <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
  2080. <summary>
  2081. Gets or sets a value indicating if only part of the logging event data
  2082. should be fixed.
  2083. </summary>
  2084. <value>
  2085. <c>true</c> if the appender should only fix part of the logging event
  2086. data, otherwise <c>false</c>. The default is <c>false</c>.
  2087. </value>
  2088. <remarks>
  2089. <para>
  2090. Setting this property to <c>true</c> will cause only part of the
  2091. event data to be fixed and serialized. This will improve performance.
  2092. </para>
  2093. <para>
  2094. See <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/> for more information.
  2095. </para>
  2096. </remarks>
  2097. </member>
  2098. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
  2099. <summary>
  2100. Gets or sets a the fields that will be fixed in the event
  2101. </summary>
  2102. <value>
  2103. The event fields that will be fixed before the event is buffered
  2104. </value>
  2105. <remarks>
  2106. <para>
  2107. The logging event needs to have certain thread specific values
  2108. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  2109. for details.
  2110. </para>
  2111. </remarks>
  2112. <seealso cref="P:log4net.Core.LoggingEvent.Fix"/>
  2113. </member>
  2114. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Int32)">
  2115. <summary>
  2116. Flushes any buffered log data.
  2117. </summary>
  2118. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  2119. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  2120. </member>
  2121. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
  2122. <summary>
  2123. Flush the currently buffered events
  2124. </summary>
  2125. <remarks>
  2126. <para>
  2127. Flushes any events that have been buffered.
  2128. </para>
  2129. <para>
  2130. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  2131. of the buffer will NOT be flushed to the appender.
  2132. </para>
  2133. </remarks>
  2134. </member>
  2135. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
  2136. <summary>
  2137. Flush the currently buffered events
  2138. </summary>
  2139. <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
  2140. <remarks>
  2141. <para>
  2142. Flushes events that have been buffered. If <paramref name="flushLossyBuffer" /> is
  2143. <c>false</c> then events will only be flushed if this buffer is non-lossy mode.
  2144. </para>
  2145. <para>
  2146. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  2147. of the buffer will only be flushed if <paramref name="flushLossyBuffer" /> is <c>true</c>.
  2148. In this case the contents of the buffer will be tested against the
  2149. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
  2150. events will be discarded.
  2151. </para>
  2152. <para>
  2153. If <paramref name="flushLossyBuffer" /> is <c>true</c> then the buffer will always
  2154. be emptied by calling this method.
  2155. </para>
  2156. </remarks>
  2157. </member>
  2158. <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
  2159. <summary>
  2160. Initialize the appender based on the options set
  2161. </summary>
  2162. <remarks>
  2163. <para>
  2164. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  2165. activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must
  2166. be called on this object after the configuration properties have
  2167. been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this
  2168. object is in an undefined state and must not be used.
  2169. </para>
  2170. <para>
  2171. If any of the configuration properties are modified then
  2172. <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again.
  2173. </para>
  2174. </remarks>
  2175. </member>
  2176. <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
  2177. <summary>
  2178. Close this appender instance.
  2179. </summary>
  2180. <remarks>
  2181. <para>
  2182. Close this appender instance. If this appender is marked
  2183. as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
  2184. the buffer must be sent when the appender is closed.
  2185. </para>
  2186. </remarks>
  2187. </member>
  2188. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  2189. <summary>
  2190. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  2191. </summary>
  2192. <param name="loggingEvent">the event to log</param>
  2193. <remarks>
  2194. <para>
  2195. Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
  2196. </para>
  2197. <para>
  2198. The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
  2199. method) if one of the following conditions is met:
  2200. </para>
  2201. <list type="bullet">
  2202. <item>
  2203. <description>The cyclic buffer is full and this appender is
  2204. marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
  2205. </item>
  2206. <item>
  2207. <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
  2208. it is triggered for the <paramref name="loggingEvent"/>
  2209. specified.</description>
  2210. </item>
  2211. </list>
  2212. <para>
  2213. Before the event is stored in the buffer it is fixed
  2214. (see <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/>) to ensure that
  2215. any data referenced by the event will be valid when the buffer
  2216. is processed.
  2217. </para>
  2218. </remarks>
  2219. </member>
  2220. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
  2221. <summary>
  2222. Sends the contents of the buffer.
  2223. </summary>
  2224. <param name="firstLoggingEvent">The first logging event.</param>
  2225. <param name="buffer">The buffer containing the events that need to be send.</param>
  2226. <remarks>
  2227. <para>
  2228. The subclass must override <see cref="M:SendBuffer(LoggingEvent[])"/>.
  2229. </para>
  2230. </remarks>
  2231. </member>
  2232. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
  2233. <summary>
  2234. Sends the events.
  2235. </summary>
  2236. <param name="events">The events that need to be send.</param>
  2237. <remarks>
  2238. <para>
  2239. The subclass must override this method to process the buffered events.
  2240. </para>
  2241. </remarks>
  2242. </member>
  2243. <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
  2244. <summary>
  2245. The default buffer size.
  2246. </summary>
  2247. <remarks>
  2248. The default size of the cyclic buffer used to store events.
  2249. This is set to 512 by default.
  2250. </remarks>
  2251. </member>
  2252. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
  2253. <summary>
  2254. The size of the cyclic buffer used to hold the logging events.
  2255. </summary>
  2256. <remarks>
  2257. Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
  2258. </remarks>
  2259. </member>
  2260. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
  2261. <summary>
  2262. The cyclic buffer used to store the logging events.
  2263. </summary>
  2264. </member>
  2265. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
  2266. <summary>
  2267. The triggering event evaluator that causes the buffer to be sent immediately.
  2268. </summary>
  2269. <remarks>
  2270. The object that is used to determine if an event causes the entire
  2271. buffer to be sent immediately. This field can be <c>null</c>, which
  2272. indicates that event triggering is not to be done. The evaluator
  2273. can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
  2274. has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
  2275. <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
  2276. </remarks>
  2277. </member>
  2278. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
  2279. <summary>
  2280. Indicates if the appender should overwrite events in the cyclic buffer
  2281. when it becomes full, or if the buffer should be flushed when the
  2282. buffer is full.
  2283. </summary>
  2284. <remarks>
  2285. If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
  2286. be set.
  2287. </remarks>
  2288. </member>
  2289. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
  2290. <summary>
  2291. The triggering event evaluator filters discarded events.
  2292. </summary>
  2293. <remarks>
  2294. The object that is used to determine if an event that is discarded should
  2295. really be discarded or if it should be sent to the appenders.
  2296. This field can be <c>null</c>, which indicates that all discarded events will
  2297. be discarded.
  2298. </remarks>
  2299. </member>
  2300. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
  2301. <summary>
  2302. Value indicating which fields in the event should be fixed
  2303. </summary>
  2304. <remarks>
  2305. By default all fields are fixed
  2306. </remarks>
  2307. </member>
  2308. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
  2309. <summary>
  2310. The events delivered to the subclass must be fixed.
  2311. </summary>
  2312. </member>
  2313. <member name="T:log4net.Appender.BufferingForwardingAppender">
  2314. <summary>
  2315. Buffers events and then forwards them to attached appenders.
  2316. </summary>
  2317. <remarks>
  2318. <para>
  2319. The events are buffered in this appender until conditions are
  2320. met to allow the appender to deliver the events to the attached
  2321. appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the
  2322. conditions that cause the buffer to be sent.
  2323. </para>
  2324. <para>The forwarding appender can be used to specify different
  2325. thresholds and filters for the same appender at different locations
  2326. within the hierarchy.
  2327. </para>
  2328. </remarks>
  2329. <author>Nicko Cadell</author>
  2330. <author>Gert Driesen</author>
  2331. </member>
  2332. <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor">
  2333. <summary>
  2334. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender" /> class.
  2335. </summary>
  2336. <remarks>
  2337. <para>
  2338. Default constructor.
  2339. </para>
  2340. </remarks>
  2341. </member>
  2342. <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose">
  2343. <summary>
  2344. Closes the appender and releases resources.
  2345. </summary>
  2346. <remarks>
  2347. <para>
  2348. Releases any resources allocated within the appender such as file handles,
  2349. network connections, etc.
  2350. </para>
  2351. <para>
  2352. It is a programming error to append to a closed appender.
  2353. </para>
  2354. </remarks>
  2355. </member>
  2356. <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  2357. <summary>
  2358. Send the events.
  2359. </summary>
  2360. <param name="events">The events that need to be send.</param>
  2361. <remarks>
  2362. <para>
  2363. Forwards the events to the attached appenders.
  2364. </para>
  2365. </remarks>
  2366. </member>
  2367. <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  2368. <summary>
  2369. Adds an <see cref="T:log4net.Appender.IAppender" /> to the list of appenders of this
  2370. instance.
  2371. </summary>
  2372. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender" /> to add to this appender.</param>
  2373. <remarks>
  2374. <para>
  2375. If the specified <see cref="T:log4net.Appender.IAppender" /> is already in the list of
  2376. appenders, then it won't be added again.
  2377. </para>
  2378. </remarks>
  2379. </member>
  2380. <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders">
  2381. <summary>
  2382. Gets the appenders contained in this appender as an
  2383. <see cref="T:System.Collections.ICollection"/>.
  2384. </summary>
  2385. <remarks>
  2386. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  2387. is returned.
  2388. </remarks>
  2389. <returns>
  2390. A collection of the appenders in this appender.
  2391. </returns>
  2392. </member>
  2393. <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)">
  2394. <summary>
  2395. Looks for the appender with the specified name.
  2396. </summary>
  2397. <param name="name">The name of the appender to lookup.</param>
  2398. <returns>
  2399. The appender with the specified name, or <c>null</c>.
  2400. </returns>
  2401. <remarks>
  2402. <para>
  2403. Get the named appender attached to this buffering appender.
  2404. </para>
  2405. </remarks>
  2406. </member>
  2407. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders">
  2408. <summary>
  2409. Removes all previously added appenders from this appender.
  2410. </summary>
  2411. <remarks>
  2412. <para>
  2413. This is useful when re-reading configuration information.
  2414. </para>
  2415. </remarks>
  2416. </member>
  2417. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  2418. <summary>
  2419. Removes the specified appender from the list of appenders.
  2420. </summary>
  2421. <param name="appender">The appender to remove.</param>
  2422. <returns>The appender removed from the list</returns>
  2423. <remarks>
  2424. The appender removed is not closed.
  2425. If you are discarding the appender you must call
  2426. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2427. </remarks>
  2428. </member>
  2429. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)">
  2430. <summary>
  2431. Removes the appender with the specified name from the list of appenders.
  2432. </summary>
  2433. <param name="name">The name of the appender to remove.</param>
  2434. <returns>The appender removed from the list</returns>
  2435. <remarks>
  2436. The appender removed is not closed.
  2437. If you are discarding the appender you must call
  2438. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2439. </remarks>
  2440. </member>
  2441. <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl">
  2442. <summary>
  2443. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  2444. </summary>
  2445. </member>
  2446. <member name="T:log4net.Appender.ColoredConsoleAppender">
  2447. <summary>
  2448. Appends logging events to the console.
  2449. </summary>
  2450. <remarks>
  2451. <para>
  2452. ColoredConsoleAppender appends log events to the standard output stream
  2453. or the error output stream using a layout specified by the
  2454. user. It also allows the color of a specific type of message to be set.
  2455. </para>
  2456. <para>
  2457. By default, all output is written to the console's standard output stream.
  2458. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> property can be set to direct the output to the
  2459. error stream.
  2460. </para>
  2461. <para>
  2462. NOTE: This appender writes directly to the application's attached console
  2463. not to the <c>System.Console.Out</c> or <c>System.Console.Error</c> <c>TextWriter</c>.
  2464. The <c>System.Console.Out</c> and <c>System.Console.Error</c> streams can be
  2465. programmatically redirected (for example NUnit does this to capture program output).
  2466. This appender will ignore these redirections because it needs to use Win32
  2467. API calls to colorize the output. To respect these redirections the <see cref="T:log4net.Appender.ConsoleAppender"/>
  2468. must be used.
  2469. </para>
  2470. <para>
  2471. When configuring the colored console appender, mapping should be
  2472. specified to map a logging level to a color. For example:
  2473. </para>
  2474. <code lang="XML" escaped="true">
  2475. <mapping>
  2476. <level value="ERROR" />
  2477. <foreColor value="White" />
  2478. <backColor value="Red, HighIntensity" />
  2479. </mapping>
  2480. <mapping>
  2481. <level value="DEBUG" />
  2482. <backColor value="Green" />
  2483. </mapping>
  2484. </code>
  2485. <para>
  2486. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  2487. combination of the following values:
  2488. <list type="bullet">
  2489. <item><term>Blue</term><description></description></item>
  2490. <item><term>Green</term><description></description></item>
  2491. <item><term>Red</term><description></description></item>
  2492. <item><term>White</term><description></description></item>
  2493. <item><term>Yellow</term><description></description></item>
  2494. <item><term>Purple</term><description></description></item>
  2495. <item><term>Cyan</term><description></description></item>
  2496. <item><term>HighIntensity</term><description></description></item>
  2497. </list>
  2498. </para>
  2499. </remarks>
  2500. <author>Rick Hobbs</author>
  2501. <author>Nicko Cadell</author>
  2502. </member>
  2503. <member name="T:log4net.Appender.ColoredConsoleAppender.Colors">
  2504. <summary>
  2505. The enum of possible color values for use with the color mapping method
  2506. </summary>
  2507. <remarks>
  2508. <para>
  2509. The following flags can be combined together to
  2510. form the colors.
  2511. </para>
  2512. </remarks>
  2513. <seealso cref="T:log4net.Appender.ColoredConsoleAppender" />
  2514. </member>
  2515. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Blue">
  2516. <summary>
  2517. color is blue
  2518. </summary>
  2519. </member>
  2520. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Green">
  2521. <summary>
  2522. color is green
  2523. </summary>
  2524. </member>
  2525. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Red">
  2526. <summary>
  2527. color is red
  2528. </summary>
  2529. </member>
  2530. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.White">
  2531. <summary>
  2532. color is white
  2533. </summary>
  2534. </member>
  2535. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Yellow">
  2536. <summary>
  2537. color is yellow
  2538. </summary>
  2539. </member>
  2540. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Purple">
  2541. <summary>
  2542. color is purple
  2543. </summary>
  2544. </member>
  2545. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Cyan">
  2546. <summary>
  2547. color is cyan
  2548. </summary>
  2549. </member>
  2550. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.HighIntensity">
  2551. <summary>
  2552. color is intensified
  2553. </summary>
  2554. </member>
  2555. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor">
  2556. <summary>
  2557. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender" /> class.
  2558. </summary>
  2559. <remarks>
  2560. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender" /> class is set up to write
  2561. to the standard output stream.
  2562. </remarks>
  2563. </member>
  2564. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout)">
  2565. <summary>
  2566. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender" /> class
  2567. with the specified layout.
  2568. </summary>
  2569. <param name="layout">the layout to use for this appender</param>
  2570. <remarks>
  2571. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender" /> class is set up to write
  2572. to the standard output stream.
  2573. </remarks>
  2574. </member>
  2575. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  2576. <summary>
  2577. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender" /> class
  2578. with the specified layout.
  2579. </summary>
  2580. <param name="layout">the layout to use for this appender</param>
  2581. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  2582. <remarks>
  2583. When <paramref name="writeToErrorStream" /> is set to <c>true</c>, output is written to
  2584. the standard error output stream. Otherwise, output is written to the standard
  2585. output stream.
  2586. </remarks>
  2587. </member>
  2588. <member name="P:log4net.Appender.ColoredConsoleAppender.Target">
  2589. <summary>
  2590. Target is the value of the console output stream.
  2591. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2592. </summary>
  2593. <value>
  2594. Target is the value of the console output stream.
  2595. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2596. </value>
  2597. <remarks>
  2598. <para>
  2599. Target is the value of the console output stream.
  2600. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2601. </para>
  2602. </remarks>
  2603. </member>
  2604. <member name="M:log4net.Appender.ColoredConsoleAppender.AddMapping(log4net.Appender.ColoredConsoleAppender.LevelColors)">
  2605. <summary>
  2606. Add a mapping of level to color - done by the config file
  2607. </summary>
  2608. <param name="mapping">The mapping to add</param>
  2609. <remarks>
  2610. <para>
  2611. Add a <see cref="T:log4net.Appender.ColoredConsoleAppender.LevelColors"/> mapping to this appender.
  2612. Each mapping defines the foreground and background colors
  2613. for a level.
  2614. </para>
  2615. </remarks>
  2616. </member>
  2617. <member name="M:log4net.Appender.ColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  2618. <summary>
  2619. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  2620. </summary>
  2621. <param name="loggingEvent">The event to log.</param>
  2622. <remarks>
  2623. <para>
  2624. Writes the event to the console.
  2625. </para>
  2626. <para>
  2627. The format of the output will depend on the appender's layout.
  2628. </para>
  2629. </remarks>
  2630. </member>
  2631. <member name="P:log4net.Appender.ColoredConsoleAppender.RequiresLayout">
  2632. <summary>
  2633. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2634. </summary>
  2635. <value><c>true</c></value>
  2636. <remarks>
  2637. <para>
  2638. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2639. </para>
  2640. </remarks>
  2641. </member>
  2642. <member name="M:log4net.Appender.ColoredConsoleAppender.ActivateOptions">
  2643. <summary>
  2644. Initialize the options for this appender
  2645. </summary>
  2646. <remarks>
  2647. <para>
  2648. Initialize the level to color mappings set on this appender.
  2649. </para>
  2650. </remarks>
  2651. </member>
  2652. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleOut">
  2653. <summary>
  2654. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2655. standard output stream.
  2656. </summary>
  2657. <remarks>
  2658. <para>
  2659. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2660. standard output stream.
  2661. </para>
  2662. </remarks>
  2663. </member>
  2664. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleError">
  2665. <summary>
  2666. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2667. standard error output stream.
  2668. </summary>
  2669. <remarks>
  2670. <para>
  2671. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2672. standard error output stream.
  2673. </para>
  2674. </remarks>
  2675. </member>
  2676. <member name="F:log4net.Appender.ColoredConsoleAppender.m_writeToErrorStream">
  2677. <summary>
  2678. Flag to write output to the error stream rather than the standard output stream
  2679. </summary>
  2680. </member>
  2681. <member name="F:log4net.Appender.ColoredConsoleAppender.m_levelMapping">
  2682. <summary>
  2683. Mapping from level object to color value
  2684. </summary>
  2685. </member>
  2686. <member name="F:log4net.Appender.ColoredConsoleAppender.m_consoleOutputWriter">
  2687. <summary>
  2688. The console output stream writer to write to
  2689. </summary>
  2690. <remarks>
  2691. <para>
  2692. This writer is not thread safe.
  2693. </para>
  2694. </remarks>
  2695. </member>
  2696. <member name="T:log4net.Appender.ColoredConsoleAppender.LevelColors">
  2697. <summary>
  2698. A class to act as a mapping between the level that a logging call is made at and
  2699. the color it should be displayed as.
  2700. </summary>
  2701. <remarks>
  2702. <para>
  2703. Defines the mapping between a level and the color it should be displayed in.
  2704. </para>
  2705. </remarks>
  2706. </member>
  2707. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor">
  2708. <summary>
  2709. The mapped foreground color for the specified level
  2710. </summary>
  2711. <remarks>
  2712. <para>
  2713. Required property.
  2714. The mapped foreground color for the specified level.
  2715. </para>
  2716. </remarks>
  2717. </member>
  2718. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor">
  2719. <summary>
  2720. The mapped background color for the specified level
  2721. </summary>
  2722. <remarks>
  2723. <para>
  2724. Required property.
  2725. The mapped background color for the specified level.
  2726. </para>
  2727. </remarks>
  2728. </member>
  2729. <member name="M:log4net.Appender.ColoredConsoleAppender.LevelColors.ActivateOptions">
  2730. <summary>
  2731. Initialize the options for the object
  2732. </summary>
  2733. <remarks>
  2734. <para>
  2735. Combine the <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> together.
  2736. </para>
  2737. </remarks>
  2738. </member>
  2739. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.CombinedColor">
  2740. <summary>
  2741. The combined <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> suitable for
  2742. setting the console color.
  2743. </summary>
  2744. </member>
  2745. <member name="T:log4net.Appender.ConsoleAppender">
  2746. <summary>
  2747. Appends logging events to the console.
  2748. </summary>
  2749. <remarks>
  2750. <para>
  2751. ConsoleAppender appends log events to the standard output stream
  2752. or the error output stream using a layout specified by the
  2753. user.
  2754. </para>
  2755. <para>
  2756. By default, all output is written to the console's standard output stream.
  2757. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
  2758. error stream.
  2759. </para>
  2760. <para>
  2761. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  2762. <c>System.Console.Error</c> that is set at the time the event is appended.
  2763. Therefore it is possible to programmatically redirect the output of this appender
  2764. (for example NUnit does this to capture program output). While this is the desired
  2765. behavior of this appender it may have security implications in your application.
  2766. </para>
  2767. </remarks>
  2768. <author>Nicko Cadell</author>
  2769. <author>Gert Driesen</author>
  2770. </member>
  2771. <member name="M:log4net.Appender.ConsoleAppender.#ctor">
  2772. <summary>
  2773. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class.
  2774. </summary>
  2775. <remarks>
  2776. The instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class is set up to write
  2777. to the standard output stream.
  2778. </remarks>
  2779. </member>
  2780. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
  2781. <summary>
  2782. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class
  2783. with the specified layout.
  2784. </summary>
  2785. <param name="layout">the layout to use for this appender</param>
  2786. <remarks>
  2787. The instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class is set up to write
  2788. to the standard output stream.
  2789. </remarks>
  2790. </member>
  2791. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  2792. <summary>
  2793. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class
  2794. with the specified layout.
  2795. </summary>
  2796. <param name="layout">the layout to use for this appender</param>
  2797. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  2798. <remarks>
  2799. When <paramref name="writeToErrorStream" /> is set to <c>true</c>, output is written to
  2800. the standard error output stream. Otherwise, output is written to the standard
  2801. output stream.
  2802. </remarks>
  2803. </member>
  2804. <member name="P:log4net.Appender.ConsoleAppender.Target">
  2805. <summary>
  2806. Target is the value of the console output stream.
  2807. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2808. </summary>
  2809. <value>
  2810. Target is the value of the console output stream.
  2811. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2812. </value>
  2813. <remarks>
  2814. <para>
  2815. Target is the value of the console output stream.
  2816. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2817. </para>
  2818. </remarks>
  2819. </member>
  2820. <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
  2821. <summary>
  2822. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  2823. </summary>
  2824. <param name="loggingEvent">The event to log.</param>
  2825. <remarks>
  2826. <para>
  2827. Writes the event to the console.
  2828. </para>
  2829. <para>
  2830. The format of the output will depend on the appender's layout.
  2831. </para>
  2832. </remarks>
  2833. </member>
  2834. <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
  2835. <summary>
  2836. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2837. </summary>
  2838. <value><c>true</c></value>
  2839. <remarks>
  2840. <para>
  2841. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2842. </para>
  2843. </remarks>
  2844. </member>
  2845. <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
  2846. <summary>
  2847. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2848. standard output stream.
  2849. </summary>
  2850. <remarks>
  2851. <para>
  2852. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2853. standard output stream.
  2854. </para>
  2855. </remarks>
  2856. </member>
  2857. <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
  2858. <summary>
  2859. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2860. standard error output stream.
  2861. </summary>
  2862. <remarks>
  2863. <para>
  2864. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2865. standard error output stream.
  2866. </para>
  2867. </remarks>
  2868. </member>
  2869. <member name="T:log4net.Appender.DebugAppender">
  2870. <summary>
  2871. Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
  2872. </summary>
  2873. <remarks>
  2874. <para>
  2875. The application configuration file can be used to control what listeners
  2876. are actually used. See the MSDN documentation for the
  2877. <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
  2878. debug system.
  2879. </para>
  2880. <para>
  2881. Events are written using the <see cref="M:System.Diagnostics.Debug.Write(string,string)"/>
  2882. method. The event's logger name is passed as the value for the category name to the Write method.
  2883. </para>
  2884. </remarks>
  2885. <author>Nicko Cadell</author>
  2886. </member>
  2887. <member name="M:log4net.Appender.DebugAppender.#ctor">
  2888. <summary>
  2889. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender" />.
  2890. </summary>
  2891. <remarks>
  2892. <para>
  2893. Default constructor.
  2894. </para>
  2895. </remarks>
  2896. </member>
  2897. <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
  2898. <summary>
  2899. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender" />
  2900. with a specified layout.
  2901. </summary>
  2902. <param name="layout">The layout to use with this appender.</param>
  2903. <remarks>
  2904. <para>
  2905. Obsolete constructor.
  2906. </para>
  2907. </remarks>
  2908. </member>
  2909. <member name="P:log4net.Appender.DebugAppender.ImmediateFlush">
  2910. <summary>
  2911. Gets or sets a value that indicates whether the appender will
  2912. flush at the end of each write.
  2913. </summary>
  2914. <remarks>
  2915. <para>The default behavior is to flush at the end of each
  2916. write. If the option is set to<c>false</c>, then the underlying
  2917. stream can defer writing to physical medium to a later time.
  2918. </para>
  2919. <para>
  2920. Avoiding the flush operation at the end of each append results
  2921. in a performance gain of 10 to 20 percent. However, there is safety
  2922. trade-off involved in skipping flushing. Indeed, when flushing is
  2923. skipped, then it is likely that the last few log events will not
  2924. be recorded on disk when the application exits. This is a high
  2925. price to pay even for a 20% performance gain.
  2926. </para>
  2927. </remarks>
  2928. </member>
  2929. <member name="P:log4net.Appender.DebugAppender.Category">
  2930. <summary>
  2931. Formats the category parameter sent to the Debug method.
  2932. </summary>
  2933. <remarks>
  2934. <para>
  2935. Defaults to a <see cref="T:log4net.Layout.PatternLayout"/> with %logger as the pattern which will use the logger name of the current
  2936. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  2937. </para>
  2938. <para>
  2939. </para>
  2940. </remarks>
  2941. </member>
  2942. <member name="M:log4net.Appender.DebugAppender.Flush(System.Int32)">
  2943. <summary>
  2944. Flushes any buffered log data.
  2945. </summary>
  2946. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  2947. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  2948. </member>
  2949. <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
  2950. <summary>
  2951. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  2952. </summary>
  2953. <param name="loggingEvent">The event to log.</param>
  2954. <remarks>
  2955. <para>
  2956. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  2957. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/>
  2958. is called.
  2959. </para>
  2960. </remarks>
  2961. </member>
  2962. <member name="P:log4net.Appender.DebugAppender.RequiresLayout">
  2963. <summary>
  2964. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2965. </summary>
  2966. <value><c>true</c></value>
  2967. <remarks>
  2968. <para>
  2969. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2970. </para>
  2971. </remarks>
  2972. </member>
  2973. <member name="F:log4net.Appender.DebugAppender.m_immediateFlush">
  2974. <summary>
  2975. Immediate flush means that the underlying writer or output stream
  2976. will be flushed at the end of each append operation.
  2977. </summary>
  2978. <remarks>
  2979. <para>
  2980. Immediate flush is slower but ensures that each append request is
  2981. actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to
  2982. <c>false</c>, then there is a good chance that the last few
  2983. logs events are not actually written to persistent media if and
  2984. when the application crashes.
  2985. </para>
  2986. <para>
  2987. The default value is <c>true</c>.</para>
  2988. </remarks>
  2989. </member>
  2990. <member name="F:log4net.Appender.DebugAppender.m_category">
  2991. <summary>
  2992. Defaults to a <see cref="T:log4net.Layout.PatternLayout"/> with %logger as the pattern.
  2993. </summary>
  2994. </member>
  2995. <member name="T:log4net.Appender.EventLogAppender">
  2996. <summary>
  2997. Writes events to the system event log.
  2998. </summary>
  2999. <remarks>
  3000. <para>
  3001. 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.
  3002. See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog
  3003. </para>
  3004. <para>
  3005. The <c>EventID</c> of the event log entry can be
  3006. set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3007. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3008. </para>
  3009. <para>
  3010. The <c>Category</c> of the event log entry can be
  3011. set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3012. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3013. </para>
  3014. <para>
  3015. There is a limit of 32K characters for an event log message
  3016. </para>
  3017. <para>
  3018. When configuring the EventLogAppender a mapping can be
  3019. specified to map a logging level to an event log entry type. For example:
  3020. </para>
  3021. <code lang="XML">
  3022. &lt;mapping&gt;
  3023. &lt;level value="ERROR" /&gt;
  3024. &lt;eventLogEntryType value="Error" /&gt;
  3025. &lt;/mapping&gt;
  3026. &lt;mapping&gt;
  3027. &lt;level value="DEBUG" /&gt;
  3028. &lt;eventLogEntryType value="Information" /&gt;
  3029. &lt;/mapping&gt;
  3030. </code>
  3031. <para>
  3032. The Level is the standard log4net logging level and eventLogEntryType can be any value
  3033. from the <see cref="T:System.Diagnostics.EventLogEntryType"/> enum, i.e.:
  3034. <list type="bullet">
  3035. <item><term>Error</term><description>an error event</description></item>
  3036. <item><term>Warning</term><description>a warning event</description></item>
  3037. <item><term>Information</term><description>an informational event</description></item>
  3038. </list>
  3039. </para>
  3040. </remarks>
  3041. <author>Aspi Havewala</author>
  3042. <author>Douglas de la Torre</author>
  3043. <author>Nicko Cadell</author>
  3044. <author>Gert Driesen</author>
  3045. <author>Thomas Voss</author>
  3046. </member>
  3047. <member name="M:log4net.Appender.EventLogAppender.#ctor">
  3048. <summary>
  3049. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender" /> class.
  3050. </summary>
  3051. <remarks>
  3052. <para>
  3053. Default constructor.
  3054. </para>
  3055. </remarks>
  3056. </member>
  3057. <member name="M:log4net.Appender.EventLogAppender.#ctor(log4net.Layout.ILayout)">
  3058. <summary>
  3059. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender" /> class
  3060. with the specified <see cref="T:log4net.Layout.ILayout" />.
  3061. </summary>
  3062. <param name="layout">The <see cref="T:log4net.Layout.ILayout" /> to use with this appender.</param>
  3063. <remarks>
  3064. <para>
  3065. Obsolete constructor.
  3066. </para>
  3067. </remarks>
  3068. </member>
  3069. <member name="P:log4net.Appender.EventLogAppender.LogName">
  3070. <summary>
  3071. The name of the log where messages will be stored.
  3072. </summary>
  3073. <value>
  3074. The string name of the log where messages will be stored.
  3075. </value>
  3076. <remarks>
  3077. <para>This is the name of the log as it appears in the Event Viewer
  3078. tree. The default value is to log into the <c>Application</c>
  3079. log, this is where most applications write their events. However
  3080. if you need a separate log for your application (or applications)
  3081. then you should set the <see cref="P:log4net.Appender.EventLogAppender.LogName"/> appropriately.</para>
  3082. <para>This should not be used to distinguish your event log messages
  3083. from those of other applications, the <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>
  3084. property should be used to distinguish events. This property should be
  3085. used to group together events into a single log.
  3086. </para>
  3087. </remarks>
  3088. </member>
  3089. <member name="P:log4net.Appender.EventLogAppender.ApplicationName">
  3090. <summary>
  3091. Property used to set the Application name. This appears in the
  3092. event logs when logging.
  3093. </summary>
  3094. <value>
  3095. The string used to distinguish events from different sources.
  3096. </value>
  3097. <remarks>
  3098. Sets the event log source property.
  3099. </remarks>
  3100. </member>
  3101. <member name="P:log4net.Appender.EventLogAppender.MachineName">
  3102. <summary>
  3103. This property is used to return the name of the computer to use
  3104. when accessing the event logs. Currently, this is the current
  3105. computer, denoted by a dot "."
  3106. </summary>
  3107. <value>
  3108. The string name of the machine holding the event log that
  3109. will be logged into.
  3110. </value>
  3111. <remarks>
  3112. This property cannot be changed. It is currently set to '.'
  3113. i.e. the local machine. This may be changed in future.
  3114. </remarks>
  3115. </member>
  3116. <member name="M:log4net.Appender.EventLogAppender.AddMapping(log4net.Appender.EventLogAppender.Level2EventLogEntryType)">
  3117. <summary>
  3118. Add a mapping of level to <see cref="T:System.Diagnostics.EventLogEntryType"/> - done by the config file
  3119. </summary>
  3120. <param name="mapping">The mapping to add</param>
  3121. <remarks>
  3122. <para>
  3123. Add a <see cref="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"/> mapping to this appender.
  3124. Each mapping defines the event log entry type for a level.
  3125. </para>
  3126. </remarks>
  3127. </member>
  3128. <member name="P:log4net.Appender.EventLogAppender.SecurityContext">
  3129. <summary>
  3130. Gets or sets the <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3131. </summary>
  3132. <value>
  3133. The <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3134. </value>
  3135. <remarks>
  3136. <para>
  3137. The system security context used to write to the EventLog.
  3138. </para>
  3139. <para>
  3140. Unless a <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> specified here for this appender
  3141. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  3142. security context to use. The default behavior is to use the security context
  3143. of the current thread.
  3144. </para>
  3145. </remarks>
  3146. </member>
  3147. <member name="P:log4net.Appender.EventLogAppender.EventId">
  3148. <summary>
  3149. Gets or sets the <c>EventId</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3150. </summary>
  3151. <remarks>
  3152. <para>
  3153. The <c>EventID</c> of the event log entry will normally be
  3154. set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3155. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3156. This property provides the fallback value which defaults to 0.
  3157. </para>
  3158. </remarks>
  3159. </member>
  3160. <member name="P:log4net.Appender.EventLogAppender.Category">
  3161. <summary>
  3162. Gets or sets the <c>Category</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3163. </summary>
  3164. <remarks>
  3165. <para>
  3166. The <c>Category</c> of the event log entry will normally be
  3167. set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3168. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3169. This property provides the fallback value which defaults to 0.
  3170. </para>
  3171. </remarks>
  3172. </member>
  3173. <member name="M:log4net.Appender.EventLogAppender.ActivateOptions">
  3174. <summary>
  3175. Initialize the appender based on the options set
  3176. </summary>
  3177. <remarks>
  3178. <para>
  3179. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3180. activation scheme. The <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> method must
  3181. be called on this object after the configuration properties have
  3182. been set. Until <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> is called this
  3183. object is in an undefined state and must not be used.
  3184. </para>
  3185. <para>
  3186. If any of the configuration properties are modified then
  3187. <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> must be called again.
  3188. </para>
  3189. </remarks>
  3190. </member>
  3191. <member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)">
  3192. <summary>
  3193. Create an event log source
  3194. </summary>
  3195. <remarks>
  3196. Uses different API calls under NET_2_0
  3197. </remarks>
  3198. </member>
  3199. <member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)">
  3200. <summary>
  3201. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3202. method.
  3203. </summary>
  3204. <param name="loggingEvent">the event to log</param>
  3205. <remarks>
  3206. <para>Writes the event to the system event log using the
  3207. <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>.</para>
  3208. <para>If the event has an <c>EventID</c> property (see <see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3209. set then this integer will be used as the event log event id.</para>
  3210. <para>
  3211. There is a limit of 32K characters for an event log message
  3212. </para>
  3213. </remarks>
  3214. </member>
  3215. <member name="P:log4net.Appender.EventLogAppender.RequiresLayout">
  3216. <summary>
  3217. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3218. </summary>
  3219. <value><c>true</c></value>
  3220. <remarks>
  3221. <para>
  3222. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3223. </para>
  3224. </remarks>
  3225. </member>
  3226. <member name="M:log4net.Appender.EventLogAppender.GetEntryType(log4net.Core.Level)">
  3227. <summary>
  3228. Get the equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/>
  3229. </summary>
  3230. <param name="level">the Level to convert to an EventLogEntryType</param>
  3231. <returns>The equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/></returns>
  3232. <remarks>
  3233. Because there are fewer applicable <see cref="T:System.Diagnostics.EventLogEntryType"/>
  3234. values to use in logging levels than there are in the
  3235. <see cref="T:log4net.Core.Level"/> this is a one way mapping. There is
  3236. a loss of information during the conversion.
  3237. </remarks>
  3238. </member>
  3239. <member name="F:log4net.Appender.EventLogAppender.m_logName">
  3240. <summary>
  3241. The log name is the section in the event logs where the messages
  3242. are stored.
  3243. </summary>
  3244. </member>
  3245. <member name="F:log4net.Appender.EventLogAppender.m_applicationName">
  3246. <summary>
  3247. Name of the application to use when logging. This appears in the
  3248. application column of the event log named by <see cref="F:log4net.Appender.EventLogAppender.m_logName"/>.
  3249. </summary>
  3250. </member>
  3251. <member name="F:log4net.Appender.EventLogAppender.m_machineName">
  3252. <summary>
  3253. The name of the machine which holds the event log. This is
  3254. currently only allowed to be '.' i.e. the current machine.
  3255. </summary>
  3256. </member>
  3257. <member name="F:log4net.Appender.EventLogAppender.m_levelMapping">
  3258. <summary>
  3259. Mapping from level object to EventLogEntryType
  3260. </summary>
  3261. </member>
  3262. <member name="F:log4net.Appender.EventLogAppender.m_securityContext">
  3263. <summary>
  3264. The security context to use for privileged calls
  3265. </summary>
  3266. </member>
  3267. <member name="F:log4net.Appender.EventLogAppender.m_eventId">
  3268. <summary>
  3269. The event ID to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3270. </summary>
  3271. </member>
  3272. <member name="F:log4net.Appender.EventLogAppender.m_category">
  3273. <summary>
  3274. The event category to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3275. </summary>
  3276. </member>
  3277. <member name="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType">
  3278. <summary>
  3279. A class to act as a mapping between the level that a logging call is made at and
  3280. the color it should be displayed as.
  3281. </summary>
  3282. <remarks>
  3283. <para>
  3284. Defines the mapping between a level and its event log entry type.
  3285. </para>
  3286. </remarks>
  3287. </member>
  3288. <member name="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType">
  3289. <summary>
  3290. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3291. </summary>
  3292. <remarks>
  3293. <para>
  3294. Required property.
  3295. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3296. </para>
  3297. </remarks>
  3298. </member>
  3299. <member name="F:log4net.Appender.EventLogAppender.declaringType">
  3300. <summary>
  3301. The fully qualified type of the EventLogAppender class.
  3302. </summary>
  3303. <remarks>
  3304. Used by the internal logger to record the Type of the
  3305. log message.
  3306. </remarks>
  3307. </member>
  3308. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_DEFAULT">
  3309. <summary>
  3310. The maximum size supported by default.
  3311. </summary>
  3312. <remarks>
  3313. http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx
  3314. The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766
  3315. may leave space for a two byte null terminator of #0#0). The 32766 max
  3316. length is what the .NET 4.0 source code checks for, but this is WRONG!
  3317. Strings with a length > 31839 on Windows Vista or higher can CORRUPT
  3318. the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent()
  3319. for the use of the 32766 max size.
  3320. </remarks>
  3321. </member>
  3322. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_VISTA_OR_NEWER">
  3323. <summary>
  3324. The maximum size supported by a windows operating system that is vista
  3325. or newer.
  3326. </summary>
  3327. <remarks>
  3328. See ReportEvent API:
  3329. http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx
  3330. ReportEvent's lpStrings parameter:
  3331. "A pointer to a buffer containing an array of
  3332. null-terminated strings that are merged into the message before Event Viewer
  3333. displays the string to the user. This parameter must be a valid pointer
  3334. (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters."
  3335. Going beyond the size of 31839 will (at some point) corrupt the event log on Windows
  3336. Vista or higher! It may succeed for a while...but you will eventually run into the
  3337. error: "System.ComponentModel.Win32Exception : A device attached to the system is
  3338. not functioning", and the event log will then be corrupt (I was able to corrupt
  3339. an event log using a length of 31877 on Windows 7).
  3340. The max size for Windows Vista or higher is documented here:
  3341. http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx.
  3342. Going over this size may succeed a few times but the buffer will overrun and
  3343. eventually corrupt the log (based on testing).
  3344. The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API.
  3345. The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a
  3346. terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the
  3347. buffer, given enough time).
  3348. </remarks>
  3349. </member>
  3350. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE">
  3351. <summary>
  3352. The maximum size that the operating system supports for
  3353. a event log message.
  3354. </summary>
  3355. <remarks>
  3356. Used to determine the maximum string length that can be written
  3357. to the operating system event log and eventually truncate a string
  3358. that exceeds the limits.
  3359. </remarks>
  3360. </member>
  3361. <member name="M:log4net.Appender.EventLogAppender.GetMaxEventLogMessageSize">
  3362. <summary>
  3363. This method determines the maximum event log message size allowed for
  3364. the current environment.
  3365. </summary>
  3366. <returns></returns>
  3367. </member>
  3368. <member name="T:log4net.Appender.FileAppender">
  3369. <summary>
  3370. Appends logging events to a file.
  3371. </summary>
  3372. <remarks>
  3373. <para>
  3374. Logging events are sent to the file specified by
  3375. the <see cref="P:log4net.Appender.FileAppender.File"/> property.
  3376. </para>
  3377. <para>
  3378. The file can be opened in either append or overwrite mode
  3379. by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property.
  3380. If the file path is relative it is taken as relative from
  3381. the application base directory. The file encoding can be
  3382. specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property.
  3383. </para>
  3384. <para>
  3385. The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  3386. values will be written each time the file is opened and closed
  3387. respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/>
  3388. then the file may contain multiple copies of the header and footer.
  3389. </para>
  3390. <para>
  3391. This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/>
  3392. is called. This will typically be during configuration.
  3393. If the file cannot be opened for writing the appender will attempt
  3394. to open the file again each time a message is logged to the appender.
  3395. If the file cannot be opened for writing when a message is logged then
  3396. the message will be discarded by this appender.
  3397. </para>
  3398. <para>
  3399. The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via
  3400. the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property.
  3401. The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>
  3402. is to obtain an exclusive write lock on the file until this appender is closed.
  3403. The alternative models only hold a
  3404. write lock while the appender is writing a logging event (<see cref="T:log4net.Appender.FileAppender.MinimalLock"/>)
  3405. or synchronize by using a named system wide Mutex (<see cref="T:log4net.Appender.FileAppender.InterProcessLock"/>).
  3406. </para>
  3407. <para>
  3408. All locking strategies have issues and you should seriously consider using a different strategy that
  3409. avoids having multiple processes logging to the same file.
  3410. </para>
  3411. </remarks>
  3412. <author>Nicko Cadell</author>
  3413. <author>Gert Driesen</author>
  3414. <author>Rodrigo B. de Oliveira</author>
  3415. <author>Douglas de la Torre</author>
  3416. <author>Niall Daley</author>
  3417. </member>
  3418. <member name="T:log4net.Appender.FileAppender.LockingStream">
  3419. <summary>
  3420. Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/>
  3421. to manage access to an underlying resource.
  3422. </summary>
  3423. </member>
  3424. <member name="M:log4net.Appender.FileAppender.LockingStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
  3425. <summary>
  3426. True asynchronous writes are not supported, the implementation forces a synchronous write.
  3427. </summary>
  3428. </member>
  3429. <member name="T:log4net.Appender.FileAppender.LockingModelBase">
  3430. <summary>
  3431. Locking model base class
  3432. </summary>
  3433. <remarks>
  3434. <para>
  3435. Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers.
  3436. </para>
  3437. </remarks>
  3438. </member>
  3439. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  3440. <summary>
  3441. Open the output file
  3442. </summary>
  3443. <param name="filename">The filename to use</param>
  3444. <param name="append">Whether to append to the file, or overwrite</param>
  3445. <param name="encoding">The encoding to use</param>
  3446. <remarks>
  3447. <para>
  3448. Open the file specified and prepare for logging.
  3449. No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called.
  3450. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>,
  3451. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>.
  3452. </para>
  3453. </remarks>
  3454. </member>
  3455. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile">
  3456. <summary>
  3457. Close the file
  3458. </summary>
  3459. <remarks>
  3460. <para>
  3461. Close the file. No further writes will be made.
  3462. </para>
  3463. </remarks>
  3464. </member>
  3465. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ActivateOptions">
  3466. <summary>
  3467. Initializes all resources used by this locking model.
  3468. </summary>
  3469. </member>
  3470. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OnClose">
  3471. <summary>
  3472. Disposes all resources that were initialized by this locking model.
  3473. </summary>
  3474. </member>
  3475. <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock">
  3476. <summary>
  3477. Acquire the lock on the file
  3478. </summary>
  3479. <returns>A stream that is ready to be written to.</returns>
  3480. <remarks>
  3481. <para>
  3482. Acquire the lock on the file in preparation for writing to it.
  3483. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/>
  3484. must be called to release the lock on the output file.
  3485. </para>
  3486. </remarks>
  3487. </member>
  3488. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock">
  3489. <summary>
  3490. Release the lock on the file
  3491. </summary>
  3492. <remarks>
  3493. <para>
  3494. Release the lock on the file. No further writes will be made to the
  3495. stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again.
  3496. </para>
  3497. </remarks>
  3498. </member>
  3499. <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender">
  3500. <summary>
  3501. Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  3502. </summary>
  3503. <value>
  3504. The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  3505. </value>
  3506. <remarks>
  3507. <para>
  3508. The file appender this locking model is attached to and working on
  3509. behalf of.
  3510. </para>
  3511. <para>
  3512. The file appender is used to locate the security context and the error handler to use.
  3513. </para>
  3514. <para>
  3515. 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
  3516. called.
  3517. </para>
  3518. </remarks>
  3519. </member>
  3520. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CreateStream(System.String,System.Boolean,System.IO.FileShare)">
  3521. <summary>
  3522. Helper method that creates a FileStream under CurrentAppender's SecurityContext.
  3523. </summary>
  3524. <remarks>
  3525. <para>
  3526. Typically called during OpenFile or AcquireLock.
  3527. </para>
  3528. <para>
  3529. If the directory portion of the <paramref name="filename"/> does not exist, it is created
  3530. via Directory.CreateDirecctory.
  3531. </para>
  3532. </remarks>
  3533. <param name="filename"></param>
  3534. <param name="append"></param>
  3535. <param name="fileShare"></param>
  3536. <returns></returns>
  3537. </member>
  3538. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseStream(System.IO.Stream)">
  3539. <summary>
  3540. Helper method to close <paramref name="stream"/> under CurrentAppender's SecurityContext.
  3541. </summary>
  3542. <remarks>
  3543. Does not set <paramref name="stream"/> to null.
  3544. </remarks>
  3545. <param name="stream"></param>
  3546. </member>
  3547. <member name="T:log4net.Appender.FileAppender.ExclusiveLock">
  3548. <summary>
  3549. Hold an exclusive lock on the output file
  3550. </summary>
  3551. <remarks>
  3552. <para>
  3553. Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called.
  3554. Maintains an exclusive lock on the file during this time.
  3555. </para>
  3556. </remarks>
  3557. </member>
  3558. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  3559. <summary>
  3560. Open the file specified and prepare for logging.
  3561. </summary>
  3562. <param name="filename">The filename to use</param>
  3563. <param name="append">Whether to append to the file, or overwrite</param>
  3564. <param name="encoding">The encoding to use</param>
  3565. <remarks>
  3566. <para>
  3567. Open the file specified and prepare for logging.
  3568. No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called.
  3569. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>,
  3570. <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>.
  3571. </para>
  3572. </remarks>
  3573. </member>
  3574. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile">
  3575. <summary>
  3576. Close the file
  3577. </summary>
  3578. <remarks>
  3579. <para>
  3580. Close the file. No further writes will be made.
  3581. </para>
  3582. </remarks>
  3583. </member>
  3584. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock">
  3585. <summary>
  3586. Acquire the lock on the file
  3587. </summary>
  3588. <returns>A stream that is ready to be written to.</returns>
  3589. <remarks>
  3590. <para>
  3591. Does nothing. The lock is already taken
  3592. </para>
  3593. </remarks>
  3594. </member>
  3595. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock">
  3596. <summary>
  3597. Release the lock on the file
  3598. </summary>
  3599. <remarks>
  3600. <para>
  3601. Does nothing. The lock will be released when the file is closed.
  3602. </para>
  3603. </remarks>
  3604. </member>
  3605. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ActivateOptions">
  3606. <summary>
  3607. Initializes all resources used by this locking model.
  3608. </summary>
  3609. </member>
  3610. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OnClose">
  3611. <summary>
  3612. Disposes all resources that were initialized by this locking model.
  3613. </summary>
  3614. </member>
  3615. <member name="T:log4net.Appender.FileAppender.MinimalLock">
  3616. <summary>
  3617. Acquires the file lock for each write
  3618. </summary>
  3619. <remarks>
  3620. <para>
  3621. Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle,
  3622. thus holding the lock for the minimal amount of time. This method of locking
  3623. is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows
  3624. other processes to move/delete the log file whilst logging continues.
  3625. </para>
  3626. </remarks>
  3627. </member>
  3628. <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  3629. <summary>
  3630. Prepares to open the file when the first message is logged.
  3631. </summary>
  3632. <param name="filename">The filename to use</param>
  3633. <param name="append">Whether to append to the file, or overwrite</param>
  3634. <param name="encoding">The encoding to use</param>
  3635. <remarks>
  3636. <para>
  3637. Open the file specified and prepare for logging.
  3638. No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called.
  3639. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>,
  3640. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>.
  3641. </para>
  3642. </remarks>
  3643. </member>
  3644. <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile">
  3645. <summary>
  3646. Close the file
  3647. </summary>
  3648. <remarks>
  3649. <para>
  3650. Close the file. No further writes will be made.
  3651. </para>
  3652. </remarks>
  3653. </member>
  3654. <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock">
  3655. <summary>
  3656. Acquire the lock on the file
  3657. </summary>
  3658. <returns>A stream that is ready to be written to.</returns>
  3659. <remarks>
  3660. <para>
  3661. Acquire the lock on the file in preparation for writing to it.
  3662. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/>
  3663. must be called to release the lock on the output file.
  3664. </para>
  3665. </remarks>
  3666. </member>
  3667. <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock">
  3668. <summary>
  3669. Release the lock on the file
  3670. </summary>
  3671. <remarks>
  3672. <para>
  3673. Release the lock on the file. No further writes will be made to the
  3674. stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again.
  3675. </para>
  3676. </remarks>
  3677. </member>
  3678. <member name="M:log4net.Appender.FileAppender.MinimalLock.ActivateOptions">
  3679. <summary>
  3680. Initializes all resources used by this locking model.
  3681. </summary>
  3682. </member>
  3683. <member name="M:log4net.Appender.FileAppender.MinimalLock.OnClose">
  3684. <summary>
  3685. Disposes all resources that were initialized by this locking model.
  3686. </summary>
  3687. </member>
  3688. <member name="T:log4net.Appender.FileAppender.InterProcessLock">
  3689. <summary>
  3690. Provides cross-process file locking.
  3691. </summary>
  3692. <author>Ron Grabowski</author>
  3693. <author>Steve Wranovsky</author>
  3694. </member>
  3695. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  3696. <summary>
  3697. Open the file specified and prepare for logging.
  3698. </summary>
  3699. <param name="filename">The filename to use</param>
  3700. <param name="append">Whether to append to the file, or overwrite</param>
  3701. <param name="encoding">The encoding to use</param>
  3702. <remarks>
  3703. <para>
  3704. Open the file specified and prepare for logging.
  3705. No writes will be made until <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/> is called.
  3706. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/>,
  3707. -<see cref="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"/>.
  3708. </para>
  3709. </remarks>
  3710. </member>
  3711. <member name="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile">
  3712. <summary>
  3713. Close the file
  3714. </summary>
  3715. <remarks>
  3716. <para>
  3717. Close the file. No further writes will be made.
  3718. </para>
  3719. </remarks>
  3720. </member>
  3721. <member name="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock">
  3722. <summary>
  3723. Acquire the lock on the file
  3724. </summary>
  3725. <returns>A stream that is ready to be written to.</returns>
  3726. <remarks>
  3727. <para>
  3728. Does nothing. The lock is already taken
  3729. </para>
  3730. </remarks>
  3731. </member>
  3732. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock">
  3733. <summary>
  3734. Releases the lock and allows others to acquire a lock.
  3735. </summary>
  3736. </member>
  3737. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ActivateOptions">
  3738. <summary>
  3739. Initializes all resources used by this locking model.
  3740. </summary>
  3741. </member>
  3742. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OnClose">
  3743. <summary>
  3744. Disposes all resources that were initialized by this locking model.
  3745. </summary>
  3746. </member>
  3747. <member name="M:log4net.Appender.FileAppender.#ctor">
  3748. <summary>
  3749. Default constructor
  3750. </summary>
  3751. <remarks>
  3752. <para>
  3753. Default constructor
  3754. </para>
  3755. </remarks>
  3756. </member>
  3757. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)">
  3758. <summary>
  3759. Construct a new appender using the layout, file and append mode.
  3760. </summary>
  3761. <param name="layout">the layout to use with this appender</param>
  3762. <param name="filename">the full path to the file to write to</param>
  3763. <param name="append">flag to indicate if the file should be appended to</param>
  3764. <remarks>
  3765. <para>
  3766. Obsolete constructor.
  3767. </para>
  3768. </remarks>
  3769. </member>
  3770. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)">
  3771. <summary>
  3772. Construct a new appender using the layout and file specified.
  3773. The file will be appended to.
  3774. </summary>
  3775. <param name="layout">the layout to use with this appender</param>
  3776. <param name="filename">the full path to the file to write to</param>
  3777. <remarks>
  3778. <para>
  3779. Obsolete constructor.
  3780. </para>
  3781. </remarks>
  3782. </member>
  3783. <member name="P:log4net.Appender.FileAppender.File">
  3784. <summary>
  3785. Gets or sets the path to the file that logging will be written to.
  3786. </summary>
  3787. <value>
  3788. The path to the file that logging will be written to.
  3789. </value>
  3790. <remarks>
  3791. <para>
  3792. If the path is relative it is taken as relative from
  3793. the application base directory.
  3794. </para>
  3795. </remarks>
  3796. </member>
  3797. <member name="P:log4net.Appender.FileAppender.AppendToFile">
  3798. <summary>
  3799. Gets or sets a flag that indicates whether the file should be
  3800. appended to or overwritten.
  3801. </summary>
  3802. <value>
  3803. Indicates whether the file should be appended to or overwritten.
  3804. </value>
  3805. <remarks>
  3806. <para>
  3807. If the value is set to false then the file will be overwritten, if
  3808. it is set to true then the file will be appended to.
  3809. </para>
  3810. The default value is true.
  3811. </remarks>
  3812. </member>
  3813. <member name="P:log4net.Appender.FileAppender.Encoding">
  3814. <summary>
  3815. Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  3816. </summary>
  3817. <value>
  3818. The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  3819. </value>
  3820. <remarks>
  3821. <para>
  3822. The default encoding set is <see cref="P:System.Text.Encoding.Default"/>
  3823. which is the encoding for the system's current ANSI code page.
  3824. </para>
  3825. </remarks>
  3826. </member>
  3827. <member name="P:log4net.Appender.FileAppender.SecurityContext">
  3828. <summary>
  3829. Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  3830. </summary>
  3831. <value>
  3832. The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  3833. </value>
  3834. <remarks>
  3835. <para>
  3836. Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender
  3837. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  3838. security context to use. The default behavior is to use the security context
  3839. of the current thread.
  3840. </para>
  3841. </remarks>
  3842. </member>
  3843. <member name="P:log4net.Appender.FileAppender.LockingModel">
  3844. <summary>
  3845. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  3846. </summary>
  3847. <value>
  3848. The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file.
  3849. </value>
  3850. <remarks>
  3851. <para>
  3852. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  3853. </para>
  3854. <para>
  3855. 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"/> .
  3856. The first locks the file from the start of logging to the end, the
  3857. second locks only for the minimal amount of time when logging each message
  3858. and the last synchronizes processes using a named system wide Mutex.
  3859. </para>
  3860. <para>
  3861. The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>.
  3862. </para>
  3863. </remarks>
  3864. </member>
  3865. <member name="M:log4net.Appender.FileAppender.ActivateOptions">
  3866. <summary>
  3867. Activate the options on the file appender.
  3868. </summary>
  3869. <remarks>
  3870. <para>
  3871. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3872. activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must
  3873. be called on this object after the configuration properties have
  3874. been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this
  3875. object is in an undefined state and must not be used.
  3876. </para>
  3877. <para>
  3878. If any of the configuration properties are modified then
  3879. <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again.
  3880. </para>
  3881. <para>
  3882. This will cause the file to be opened.
  3883. </para>
  3884. </remarks>
  3885. </member>
  3886. <member name="M:log4net.Appender.FileAppender.Reset">
  3887. <summary>
  3888. Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>.
  3889. </summary>
  3890. <remarks>
  3891. <para>
  3892. Resets the filename and the file stream.
  3893. </para>
  3894. </remarks>
  3895. </member>
  3896. <member name="M:log4net.Appender.FileAppender.OnClose">
  3897. <summary>
  3898. Close this appender instance. The underlying stream or writer is also closed.
  3899. </summary>
  3900. </member>
  3901. <member name="M:log4net.Appender.FileAppender.PrepareWriter">
  3902. <summary>
  3903. Called to initialize the file writer
  3904. </summary>
  3905. <remarks>
  3906. <para>
  3907. Will be called for each logged message until the file is
  3908. successfully opened.
  3909. </para>
  3910. </remarks>
  3911. </member>
  3912. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)">
  3913. <summary>
  3914. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3915. method.
  3916. </summary>
  3917. <param name="loggingEvent">The event to log.</param>
  3918. <remarks>
  3919. <para>
  3920. Writes a log statement to the output stream if the output stream exists
  3921. and is writable.
  3922. </para>
  3923. <para>
  3924. The format of the output will depend on the appender's layout.
  3925. </para>
  3926. </remarks>
  3927. </member>
  3928. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
  3929. <summary>
  3930. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  3931. method.
  3932. </summary>
  3933. <param name="loggingEvents">The array of events to log.</param>
  3934. <remarks>
  3935. <para>
  3936. Acquires the output file locks once before writing all the events to
  3937. the stream.
  3938. </para>
  3939. </remarks>
  3940. </member>
  3941. <member name="M:log4net.Appender.FileAppender.WriteFooter">
  3942. <summary>
  3943. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3944. </summary>
  3945. <remarks>
  3946. <para>
  3947. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3948. </para>
  3949. </remarks>
  3950. </member>
  3951. <member name="M:log4net.Appender.FileAppender.WriteHeader">
  3952. <summary>
  3953. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3954. </summary>
  3955. <remarks>
  3956. <para>
  3957. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3958. </para>
  3959. </remarks>
  3960. </member>
  3961. <member name="M:log4net.Appender.FileAppender.CloseWriter">
  3962. <summary>
  3963. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3964. </summary>
  3965. <remarks>
  3966. <para>
  3967. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3968. </para>
  3969. </remarks>
  3970. </member>
  3971. <member name="M:log4net.Appender.FileAppender.CloseFile">
  3972. <summary>
  3973. Closes the previously opened file.
  3974. </summary>
  3975. <remarks>
  3976. <para>
  3977. Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then
  3978. closes the file.
  3979. </para>
  3980. </remarks>
  3981. </member>
  3982. <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)">
  3983. <summary>
  3984. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  3985. </summary>
  3986. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  3987. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  3988. <remarks>
  3989. <para>
  3990. Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception.
  3991. Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>.
  3992. </para>
  3993. </remarks>
  3994. </member>
  3995. <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)">
  3996. <summary>
  3997. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  3998. </summary>
  3999. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  4000. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  4001. <remarks>
  4002. <para>
  4003. If there was already an opened file, then the previous file
  4004. is closed first.
  4005. </para>
  4006. <para>
  4007. This method will ensure that the directory structure
  4008. for the <paramref name="fileName"/> specified exists.
  4009. </para>
  4010. </remarks>
  4011. </member>
  4012. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)">
  4013. <summary>
  4014. Sets the quiet writer used for file output
  4015. </summary>
  4016. <param name="fileStream">the file stream that has been opened for writing</param>
  4017. <remarks>
  4018. <para>
  4019. This implementation of <see cref="M:SetQWForFiles(Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/>
  4020. over the <paramref name="fileStream"/> and passes it to the
  4021. <see cref="M:SetQWForFiles(TextWriter)"/> method.
  4022. </para>
  4023. <para>
  4024. This method can be overridden by sub classes that want to wrap the
  4025. <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output
  4026. data using a <c>System.Security.Cryptography.CryptoStream</c>.
  4027. </para>
  4028. </remarks>
  4029. </member>
  4030. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)">
  4031. <summary>
  4032. Sets the quiet writer being used.
  4033. </summary>
  4034. <param name="writer">the writer over the file stream that has been opened for writing</param>
  4035. <remarks>
  4036. <para>
  4037. This method can be overridden by sub classes that want to
  4038. wrap the <see cref="T:System.IO.TextWriter"/> in some way.
  4039. </para>
  4040. </remarks>
  4041. </member>
  4042. <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)">
  4043. <summary>
  4044. Convert a path into a fully qualified path.
  4045. </summary>
  4046. <param name="path">The path to convert.</param>
  4047. <returns>The fully qualified path.</returns>
  4048. <remarks>
  4049. <para>
  4050. Converts the path specified to a fully
  4051. qualified path. If the path is relative it is
  4052. taken as relative from the application base
  4053. directory.
  4054. </para>
  4055. </remarks>
  4056. </member>
  4057. <member name="F:log4net.Appender.FileAppender.m_appendToFile">
  4058. <summary>
  4059. Flag to indicate if we should append to the file
  4060. or overwrite the file. The default is to append.
  4061. </summary>
  4062. </member>
  4063. <member name="F:log4net.Appender.FileAppender.m_fileName">
  4064. <summary>
  4065. The name of the log file.
  4066. </summary>
  4067. </member>
  4068. <member name="F:log4net.Appender.FileAppender.m_encoding">
  4069. <summary>
  4070. The encoding to use for the file stream.
  4071. </summary>
  4072. </member>
  4073. <member name="F:log4net.Appender.FileAppender.m_securityContext">
  4074. <summary>
  4075. The security context to use for privileged calls
  4076. </summary>
  4077. </member>
  4078. <member name="F:log4net.Appender.FileAppender.m_stream">
  4079. <summary>
  4080. The stream to log to. Has added locking semantics
  4081. </summary>
  4082. </member>
  4083. <member name="F:log4net.Appender.FileAppender.m_lockingModel">
  4084. <summary>
  4085. The locking model to use
  4086. </summary>
  4087. </member>
  4088. <member name="F:log4net.Appender.FileAppender.declaringType">
  4089. <summary>
  4090. The fully qualified type of the FileAppender class.
  4091. </summary>
  4092. <remarks>
  4093. Used by the internal logger to record the Type of the
  4094. log message.
  4095. </remarks>
  4096. </member>
  4097. <member name="T:log4net.Appender.ForwardingAppender">
  4098. <summary>
  4099. This appender forwards logging events to attached appenders.
  4100. </summary>
  4101. <remarks>
  4102. <para>
  4103. The forwarding appender can be used to specify different thresholds
  4104. and filters for the same appender at different locations within the hierarchy.
  4105. </para>
  4106. </remarks>
  4107. <author>Nicko Cadell</author>
  4108. <author>Gert Driesen</author>
  4109. </member>
  4110. <member name="M:log4net.Appender.ForwardingAppender.#ctor">
  4111. <summary>
  4112. Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender" /> class.
  4113. </summary>
  4114. <remarks>
  4115. <para>
  4116. Default constructor.
  4117. </para>
  4118. </remarks>
  4119. </member>
  4120. <member name="M:log4net.Appender.ForwardingAppender.OnClose">
  4121. <summary>
  4122. Closes the appender and releases resources.
  4123. </summary>
  4124. <remarks>
  4125. <para>
  4126. Releases any resources allocated within the appender such as file handles,
  4127. network connections, etc.
  4128. </para>
  4129. <para>
  4130. It is a programming error to append to a closed appender.
  4131. </para>
  4132. </remarks>
  4133. </member>
  4134. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
  4135. <summary>
  4136. Forward the logging event to the attached appenders
  4137. </summary>
  4138. <param name="loggingEvent">The event to log.</param>
  4139. <remarks>
  4140. <para>
  4141. Delivers the logging event to all the attached appenders.
  4142. </para>
  4143. </remarks>
  4144. </member>
  4145. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
  4146. <summary>
  4147. Forward the logging events to the attached appenders
  4148. </summary>
  4149. <param name="loggingEvents">The array of events to log.</param>
  4150. <remarks>
  4151. <para>
  4152. Delivers the logging events to all the attached appenders.
  4153. </para>
  4154. </remarks>
  4155. </member>
  4156. <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  4157. <summary>
  4158. Adds an <see cref="T:log4net.Appender.IAppender" /> to the list of appenders of this
  4159. instance.
  4160. </summary>
  4161. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender" /> to add to this appender.</param>
  4162. <remarks>
  4163. <para>
  4164. If the specified <see cref="T:log4net.Appender.IAppender" /> is already in the list of
  4165. appenders, then it won't be added again.
  4166. </para>
  4167. </remarks>
  4168. </member>
  4169. <member name="P:log4net.Appender.ForwardingAppender.Appenders">
  4170. <summary>
  4171. Gets the appenders contained in this appender as an
  4172. <see cref="T:System.Collections.ICollection"/>.
  4173. </summary>
  4174. <remarks>
  4175. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  4176. is returned.
  4177. </remarks>
  4178. <returns>
  4179. A collection of the appenders in this appender.
  4180. </returns>
  4181. </member>
  4182. <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)">
  4183. <summary>
  4184. Looks for the appender with the specified name.
  4185. </summary>
  4186. <param name="name">The name of the appender to lookup.</param>
  4187. <returns>
  4188. The appender with the specified name, or <c>null</c>.
  4189. </returns>
  4190. <remarks>
  4191. <para>
  4192. Get the named appender attached to this appender.
  4193. </para>
  4194. </remarks>
  4195. </member>
  4196. <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders">
  4197. <summary>
  4198. Removes all previously added appenders from this appender.
  4199. </summary>
  4200. <remarks>
  4201. <para>
  4202. This is useful when re-reading configuration information.
  4203. </para>
  4204. </remarks>
  4205. </member>
  4206. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  4207. <summary>
  4208. Removes the specified appender from the list of appenders.
  4209. </summary>
  4210. <param name="appender">The appender to remove.</param>
  4211. <returns>The appender removed from the list</returns>
  4212. <remarks>
  4213. The appender removed is not closed.
  4214. If you are discarding the appender you must call
  4215. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4216. </remarks>
  4217. </member>
  4218. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)">
  4219. <summary>
  4220. Removes the appender with the specified name from the list of appenders.
  4221. </summary>
  4222. <param name="name">The name of the appender to remove.</param>
  4223. <returns>The appender removed from the list</returns>
  4224. <remarks>
  4225. The appender removed is not closed.
  4226. If you are discarding the appender you must call
  4227. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4228. </remarks>
  4229. </member>
  4230. <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl">
  4231. <summary>
  4232. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  4233. </summary>
  4234. </member>
  4235. <member name="T:log4net.Appender.IAppender">
  4236. <summary>
  4237. Implement this interface for your own strategies for printing log statements.
  4238. </summary>
  4239. <remarks>
  4240. <para>
  4241. Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/>
  4242. class which provides a default implementation of this interface.
  4243. </para>
  4244. <para>
  4245. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  4246. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  4247. be called after the appenders properties have been configured.
  4248. </para>
  4249. </remarks>
  4250. <author>Nicko Cadell</author>
  4251. <author>Gert Driesen</author>
  4252. </member>
  4253. <member name="M:log4net.Appender.IAppender.Close">
  4254. <summary>
  4255. Closes the appender and releases resources.
  4256. </summary>
  4257. <remarks>
  4258. <para>
  4259. Releases any resources allocated within the appender such as file handles,
  4260. network connections, etc.
  4261. </para>
  4262. <para>
  4263. It is a programming error to append to a closed appender.
  4264. </para>
  4265. </remarks>
  4266. </member>
  4267. <member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)">
  4268. <summary>
  4269. Log the logging event in Appender specific way.
  4270. </summary>
  4271. <param name="loggingEvent">The event to log</param>
  4272. <remarks>
  4273. <para>
  4274. This method is called to log a message into this appender.
  4275. </para>
  4276. </remarks>
  4277. </member>
  4278. <member name="P:log4net.Appender.IAppender.Name">
  4279. <summary>
  4280. Gets or sets the name of this appender.
  4281. </summary>
  4282. <value>The name of the appender.</value>
  4283. <remarks>
  4284. <para>The name uniquely identifies the appender.</para>
  4285. </remarks>
  4286. </member>
  4287. <member name="T:log4net.Appender.IBulkAppender">
  4288. <summary>
  4289. Interface for appenders that support bulk logging.
  4290. </summary>
  4291. <remarks>
  4292. <para>
  4293. This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to
  4294. support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders
  4295. should only implement this interface if they can bulk log efficiently.
  4296. </para>
  4297. </remarks>
  4298. <author>Nicko Cadell</author>
  4299. </member>
  4300. <member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])">
  4301. <summary>
  4302. Log the array of logging events in Appender specific way.
  4303. </summary>
  4304. <param name="loggingEvents">The events to log</param>
  4305. <remarks>
  4306. <para>
  4307. This method is called to log an array of events into this appender.
  4308. </para>
  4309. </remarks>
  4310. </member>
  4311. <member name="T:log4net.Appender.IFlushable">
  4312. <summary>
  4313. Interface that can be implemented by Appenders that buffer logging data and expose a <see cref="M:log4net.Appender.IFlushable.Flush(System.Int32)"/> method.
  4314. </summary>
  4315. </member>
  4316. <member name="M:log4net.Appender.IFlushable.Flush(System.Int32)">
  4317. <summary>
  4318. Flushes any buffered log data.
  4319. </summary>
  4320. <remarks>
  4321. 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
  4322. the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  4323. <para>
  4324. Typically this is done by locking on the Appender instance, e.g.:
  4325. <code>
  4326. <![CDATA[
  4327. public bool Flush(int millisecondsTimeout)
  4328. {
  4329. lock(this)
  4330. {
  4331. // Flush buffered logging data
  4332. ...
  4333. }
  4334. }
  4335. ]]>
  4336. </code>
  4337. </para>
  4338. <para>
  4339. The <paramref name="millisecondsTimeout"/> parameter is only relevant for appenders that process logging events asynchronously,
  4340. such as <see cref="T:log4net.Appender.RemotingAppender"/>.
  4341. </para>
  4342. </remarks>
  4343. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  4344. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  4345. </member>
  4346. <member name="T:log4net.Appender.LocalSyslogAppender">
  4347. <summary>
  4348. Logs events to a local syslog service.
  4349. </summary>
  4350. <remarks>
  4351. <note>
  4352. This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>.
  4353. If these functions are not available on the local system then this appender will not work!
  4354. </note>
  4355. <para>
  4356. The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and
  4357. POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service.
  4358. </para>
  4359. <para>
  4360. This appender talks to a local syslog service. If you need to log to a remote syslog
  4361. daemon and you cannot configure your local syslog service to do this you may be
  4362. able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP.
  4363. </para>
  4364. <para>
  4365. Syslog messages must have a facility and and a severity. The severity
  4366. is derived from the Level of the logging event.
  4367. The facility must be chosen from the set of defined syslog
  4368. <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  4369. and cannot be extended.
  4370. </para>
  4371. <para>
  4372. An identifier is specified with each log message. This can be specified
  4373. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  4374. as the tag) must not contain white space. The default value for the
  4375. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  4376. </para>
  4377. </remarks>
  4378. <author>Rob Lyon</author>
  4379. <author>Nicko Cadell</author>
  4380. </member>
  4381. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity">
  4382. <summary>
  4383. syslog severities
  4384. </summary>
  4385. <remarks>
  4386. <para>
  4387. The log4net Level maps to a syslog severity using the
  4388. <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/>
  4389. class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>.
  4390. </para>
  4391. </remarks>
  4392. </member>
  4393. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency">
  4394. <summary>
  4395. system is unusable
  4396. </summary>
  4397. </member>
  4398. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert">
  4399. <summary>
  4400. action must be taken immediately
  4401. </summary>
  4402. </member>
  4403. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical">
  4404. <summary>
  4405. critical conditions
  4406. </summary>
  4407. </member>
  4408. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error">
  4409. <summary>
  4410. error conditions
  4411. </summary>
  4412. </member>
  4413. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning">
  4414. <summary>
  4415. warning conditions
  4416. </summary>
  4417. </member>
  4418. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice">
  4419. <summary>
  4420. normal but significant condition
  4421. </summary>
  4422. </member>
  4423. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational">
  4424. <summary>
  4425. informational
  4426. </summary>
  4427. </member>
  4428. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug">
  4429. <summary>
  4430. debug-level messages
  4431. </summary>
  4432. </member>
  4433. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility">
  4434. <summary>
  4435. syslog facilities
  4436. </summary>
  4437. <remarks>
  4438. <para>
  4439. The syslog facility defines which subsystem the logging comes from.
  4440. This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property.
  4441. </para>
  4442. </remarks>
  4443. </member>
  4444. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel">
  4445. <summary>
  4446. kernel messages
  4447. </summary>
  4448. </member>
  4449. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User">
  4450. <summary>
  4451. random user-level messages
  4452. </summary>
  4453. </member>
  4454. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail">
  4455. <summary>
  4456. mail system
  4457. </summary>
  4458. </member>
  4459. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons">
  4460. <summary>
  4461. system daemons
  4462. </summary>
  4463. </member>
  4464. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization">
  4465. <summary>
  4466. security/authorization messages
  4467. </summary>
  4468. </member>
  4469. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog">
  4470. <summary>
  4471. messages generated internally by syslogd
  4472. </summary>
  4473. </member>
  4474. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer">
  4475. <summary>
  4476. line printer subsystem
  4477. </summary>
  4478. </member>
  4479. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News">
  4480. <summary>
  4481. network news subsystem
  4482. </summary>
  4483. </member>
  4484. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp">
  4485. <summary>
  4486. UUCP subsystem
  4487. </summary>
  4488. </member>
  4489. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock">
  4490. <summary>
  4491. clock (cron/at) daemon
  4492. </summary>
  4493. </member>
  4494. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2">
  4495. <summary>
  4496. security/authorization messages (private)
  4497. </summary>
  4498. </member>
  4499. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp">
  4500. <summary>
  4501. ftp daemon
  4502. </summary>
  4503. </member>
  4504. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp">
  4505. <summary>
  4506. NTP subsystem
  4507. </summary>
  4508. </member>
  4509. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit">
  4510. <summary>
  4511. log audit
  4512. </summary>
  4513. </member>
  4514. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert">
  4515. <summary>
  4516. log alert
  4517. </summary>
  4518. </member>
  4519. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2">
  4520. <summary>
  4521. clock daemon
  4522. </summary>
  4523. </member>
  4524. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0">
  4525. <summary>
  4526. reserved for local use
  4527. </summary>
  4528. </member>
  4529. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1">
  4530. <summary>
  4531. reserved for local use
  4532. </summary>
  4533. </member>
  4534. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2">
  4535. <summary>
  4536. reserved for local use
  4537. </summary>
  4538. </member>
  4539. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3">
  4540. <summary>
  4541. reserved for local use
  4542. </summary>
  4543. </member>
  4544. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4">
  4545. <summary>
  4546. reserved for local use
  4547. </summary>
  4548. </member>
  4549. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5">
  4550. <summary>
  4551. reserved for local use
  4552. </summary>
  4553. </member>
  4554. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6">
  4555. <summary>
  4556. reserved for local use
  4557. </summary>
  4558. </member>
  4559. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7">
  4560. <summary>
  4561. reserved for local use
  4562. </summary>
  4563. </member>
  4564. <member name="M:log4net.Appender.LocalSyslogAppender.#ctor">
  4565. <summary>
  4566. Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender" /> class.
  4567. </summary>
  4568. <remarks>
  4569. This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender" /> class is set up to write
  4570. to a local syslog service.
  4571. </remarks>
  4572. </member>
  4573. <member name="P:log4net.Appender.LocalSyslogAppender.Identity">
  4574. <summary>
  4575. Message identity
  4576. </summary>
  4577. <remarks>
  4578. <para>
  4579. An identifier is specified with each log message. This can be specified
  4580. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  4581. as the tag) must not contain white space. The default value for the
  4582. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  4583. </para>
  4584. </remarks>
  4585. </member>
  4586. <member name="P:log4net.Appender.LocalSyslogAppender.Facility">
  4587. <summary>
  4588. Syslog facility
  4589. </summary>
  4590. <remarks>
  4591. Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of
  4592. facilities is predefined and cannot be extended. The default value
  4593. is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  4594. </remarks>
  4595. </member>
  4596. <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)">
  4597. <summary>
  4598. Add a mapping of level to severity
  4599. </summary>
  4600. <param name="mapping">The mapping to add</param>
  4601. <remarks>
  4602. <para>
  4603. Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender.
  4604. </para>
  4605. </remarks>
  4606. </member>
  4607. <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions">
  4608. <summary>
  4609. Initialize the appender based on the options set.
  4610. </summary>
  4611. <remarks>
  4612. <para>
  4613. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4614. activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must
  4615. be called on this object after the configuration properties have
  4616. been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this
  4617. object is in an undefined state and must not be used.
  4618. </para>
  4619. <para>
  4620. If any of the configuration properties are modified then
  4621. <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again.
  4622. </para>
  4623. </remarks>
  4624. </member>
  4625. <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)">
  4626. <summary>
  4627. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  4628. </summary>
  4629. <param name="loggingEvent">The event to log.</param>
  4630. <remarks>
  4631. <para>
  4632. Writes the event to a remote syslog daemon.
  4633. </para>
  4634. <para>
  4635. The format of the output will depend on the appender's layout.
  4636. </para>
  4637. </remarks>
  4638. </member>
  4639. <member name="M:log4net.Appender.LocalSyslogAppender.OnClose">
  4640. <summary>
  4641. Close the syslog when the appender is closed
  4642. </summary>
  4643. <remarks>
  4644. <para>
  4645. Close the syslog when the appender is closed
  4646. </para>
  4647. </remarks>
  4648. </member>
  4649. <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout">
  4650. <summary>
  4651. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  4652. </summary>
  4653. <value><c>true</c></value>
  4654. <remarks>
  4655. <para>
  4656. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  4657. </para>
  4658. </remarks>
  4659. </member>
  4660. <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)">
  4661. <summary>
  4662. Translates a log4net level to a syslog severity.
  4663. </summary>
  4664. <param name="level">A log4net level.</param>
  4665. <returns>A syslog severity.</returns>
  4666. <remarks>
  4667. <para>
  4668. Translates a log4net level to a syslog severity.
  4669. </para>
  4670. </remarks>
  4671. </member>
  4672. <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)">
  4673. <summary>
  4674. Generate a syslog priority.
  4675. </summary>
  4676. <param name="facility">The syslog facility.</param>
  4677. <param name="severity">The syslog severity.</param>
  4678. <returns>A syslog priority.</returns>
  4679. </member>
  4680. <member name="F:log4net.Appender.LocalSyslogAppender.m_facility">
  4681. <summary>
  4682. The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  4683. </summary>
  4684. </member>
  4685. <member name="F:log4net.Appender.LocalSyslogAppender.m_identity">
  4686. <summary>
  4687. The message identity
  4688. </summary>
  4689. </member>
  4690. <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity">
  4691. <summary>
  4692. Marshaled handle to the identity string. We have to hold on to the
  4693. string as the <c>openlog</c> and <c>syslog</c> APIs just hold the
  4694. pointer to the ident and dereference it for each log message.
  4695. </summary>
  4696. </member>
  4697. <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping">
  4698. <summary>
  4699. Mapping from level object to syslog severity
  4700. </summary>
  4701. </member>
  4702. <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)">
  4703. <summary>
  4704. Open connection to system logger.
  4705. </summary>
  4706. </member>
  4707. <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
  4708. <summary>
  4709. Generate a log message.
  4710. </summary>
  4711. <remarks>
  4712. <para>
  4713. The libc syslog method takes a format string and a variable argument list similar
  4714. to the classic printf function. As this type of vararg list is not supported
  4715. by C# we need to specify the arguments explicitly. Here we have specified the
  4716. format string with a single message argument. The caller must set the format
  4717. string to <c>"%s"</c>.
  4718. </para>
  4719. </remarks>
  4720. </member>
  4721. <member name="M:log4net.Appender.LocalSyslogAppender.closelog">
  4722. <summary>
  4723. Close descriptor used to write to system logger.
  4724. </summary>
  4725. </member>
  4726. <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity">
  4727. <summary>
  4728. A class to act as a mapping between the level that a logging call is made at and
  4729. the syslog severity that is should be logged at.
  4730. </summary>
  4731. <remarks>
  4732. <para>
  4733. A class to act as a mapping between the level that a logging call is made at and
  4734. the syslog severity that is should be logged at.
  4735. </para>
  4736. </remarks>
  4737. </member>
  4738. <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity">
  4739. <summary>
  4740. The mapped syslog severity for the specified level
  4741. </summary>
  4742. <remarks>
  4743. <para>
  4744. Required property.
  4745. The mapped syslog severity for the specified level
  4746. </para>
  4747. </remarks>
  4748. </member>
  4749. <member name="T:log4net.Appender.ManagedColoredConsoleAppender">
  4750. <summary>
  4751. Appends colorful logging events to the console, using the .NET 2
  4752. built-in capabilities.
  4753. </summary>
  4754. <remarks>
  4755. <para>
  4756. ManagedColoredConsoleAppender appends log events to the standard output stream
  4757. or the error output stream using a layout specified by the
  4758. user. It also allows the color of a specific type of message to be set.
  4759. </para>
  4760. <para>
  4761. By default, all output is written to the console's standard output stream.
  4762. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> property can be set to direct the output to the
  4763. error stream.
  4764. </para>
  4765. <para>
  4766. When configuring the colored console appender, mappings should be
  4767. specified to map logging levels to colors. For example:
  4768. </para>
  4769. <code lang="XML" escaped="true">
  4770. <mapping>
  4771. <level value="ERROR" />
  4772. <foreColor value="DarkRed" />
  4773. <backColor value="White" />
  4774. </mapping>
  4775. <mapping>
  4776. <level value="WARN" />
  4777. <foreColor value="Yellow" />
  4778. </mapping>
  4779. <mapping>
  4780. <level value="INFO" />
  4781. <foreColor value="White" />
  4782. </mapping>
  4783. <mapping>
  4784. <level value="DEBUG" />
  4785. <foreColor value="Blue" />
  4786. </mapping>
  4787. </code>
  4788. <para>
  4789. The Level is the standard log4net logging level while
  4790. ForeColor and BackColor are the values of <see cref="T:System.ConsoleColor"/>
  4791. enumeration.
  4792. </para>
  4793. <para>
  4794. Based on the ColoredConsoleAppender
  4795. </para>
  4796. </remarks>
  4797. <author>Rick Hobbs</author>
  4798. <author>Nicko Cadell</author>
  4799. <author>Pavlos Touboulidis</author>
  4800. </member>
  4801. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.#ctor">
  4802. <summary>
  4803. Initializes a new instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender" /> class.
  4804. </summary>
  4805. <remarks>
  4806. The instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender" /> class is set up to write
  4807. to the standard output stream.
  4808. </remarks>
  4809. </member>
  4810. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.Target">
  4811. <summary>
  4812. Target is the value of the console output stream.
  4813. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4814. </summary>
  4815. <value>
  4816. Target is the value of the console output stream.
  4817. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4818. </value>
  4819. <remarks>
  4820. <para>
  4821. Target is the value of the console output stream.
  4822. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4823. </para>
  4824. </remarks>
  4825. </member>
  4826. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.AddMapping(log4net.Appender.ManagedColoredConsoleAppender.LevelColors)">
  4827. <summary>
  4828. Add a mapping of level to color - done by the config file
  4829. </summary>
  4830. <param name="mapping">The mapping to add</param>
  4831. <remarks>
  4832. <para>
  4833. Add a <see cref="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors"/> mapping to this appender.
  4834. Each mapping defines the foreground and background colors
  4835. for a level.
  4836. </para>
  4837. </remarks>
  4838. </member>
  4839. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  4840. <summary>
  4841. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  4842. </summary>
  4843. <param name="loggingEvent">The event to log.</param>
  4844. <remarks>
  4845. <para>
  4846. Writes the event to the console.
  4847. </para>
  4848. <para>
  4849. The format of the output will depend on the appender's layout.
  4850. </para>
  4851. </remarks>
  4852. </member>
  4853. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.RequiresLayout">
  4854. <summary>
  4855. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4856. </summary>
  4857. <value><c>true</c></value>
  4858. <remarks>
  4859. <para>
  4860. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4861. </para>
  4862. </remarks>
  4863. </member>
  4864. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.ActivateOptions">
  4865. <summary>
  4866. Initialize the options for this appender
  4867. </summary>
  4868. <remarks>
  4869. <para>
  4870. Initialize the level to color mappings set on this appender.
  4871. </para>
  4872. </remarks>
  4873. </member>
  4874. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleOut">
  4875. <summary>
  4876. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4877. standard output stream.
  4878. </summary>
  4879. <remarks>
  4880. <para>
  4881. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4882. standard output stream.
  4883. </para>
  4884. </remarks>
  4885. </member>
  4886. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleError">
  4887. <summary>
  4888. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4889. standard error output stream.
  4890. </summary>
  4891. <remarks>
  4892. <para>
  4893. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4894. standard error output stream.
  4895. </para>
  4896. </remarks>
  4897. </member>
  4898. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_writeToErrorStream">
  4899. <summary>
  4900. Flag to write output to the error stream rather than the standard output stream
  4901. </summary>
  4902. </member>
  4903. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_levelMapping">
  4904. <summary>
  4905. Mapping from level object to color value
  4906. </summary>
  4907. </member>
  4908. <member name="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors">
  4909. <summary>
  4910. A class to act as a mapping between the level that a logging call is made at and
  4911. the color it should be displayed as.
  4912. </summary>
  4913. <remarks>
  4914. <para>
  4915. Defines the mapping between a level and the color it should be displayed in.
  4916. </para>
  4917. </remarks>
  4918. </member>
  4919. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.ForeColor">
  4920. <summary>
  4921. The mapped foreground color for the specified level
  4922. </summary>
  4923. <remarks>
  4924. <para>
  4925. Required property.
  4926. The mapped foreground color for the specified level.
  4927. </para>
  4928. </remarks>
  4929. </member>
  4930. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.BackColor">
  4931. <summary>
  4932. The mapped background color for the specified level
  4933. </summary>
  4934. <remarks>
  4935. <para>
  4936. Required property.
  4937. The mapped background color for the specified level.
  4938. </para>
  4939. </remarks>
  4940. </member>
  4941. <member name="T:log4net.Appender.MemoryAppender">
  4942. <summary>
  4943. Stores logging events in an array.
  4944. </summary>
  4945. <remarks>
  4946. <para>
  4947. The memory appender stores all the logging events
  4948. that are appended in an in-memory array.
  4949. </para>
  4950. <para>
  4951. Use the <see cref="M:PopAllEvents()"/> method to get
  4952. and clear the current list of events that have been appended.
  4953. </para>
  4954. <para>
  4955. Use the <see cref="M:GetEvents()"/> method to get the current
  4956. list of events that have been appended. Note there is a
  4957. race-condition when calling <see cref="M:GetEvents()"/> and
  4958. <see cref="M:Clear()"/> in pairs, you better use <see
  4959. mref="M:PopAllEvents()"/> in that case.
  4960. </para>
  4961. <para>
  4962. Use the <see cref="M:Clear()"/> method to clear the
  4963. current list of events. Note there is a
  4964. race-condition when calling <see cref="M:GetEvents()"/> and
  4965. <see cref="M:Clear()"/> in pairs, you better use <see
  4966. mref="M:PopAllEvents()"/> in that case.
  4967. </para>
  4968. </remarks>
  4969. <author>Julian Biddle</author>
  4970. <author>Nicko Cadell</author>
  4971. <author>Gert Driesen</author>
  4972. </member>
  4973. <member name="M:log4net.Appender.MemoryAppender.#ctor">
  4974. <summary>
  4975. Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender" /> class.
  4976. </summary>
  4977. <remarks>
  4978. <para>
  4979. Default constructor.
  4980. </para>
  4981. </remarks>
  4982. </member>
  4983. <member name="M:log4net.Appender.MemoryAppender.GetEvents">
  4984. <summary>
  4985. Gets the events that have been logged.
  4986. </summary>
  4987. <returns>The events that have been logged</returns>
  4988. <remarks>
  4989. <para>
  4990. Gets the events that have been logged.
  4991. </para>
  4992. </remarks>
  4993. </member>
  4994. <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
  4995. <summary>
  4996. Gets or sets a value indicating whether only part of the logging event
  4997. data should be fixed.
  4998. </summary>
  4999. <value>
  5000. <c>true</c> if the appender should only fix part of the logging event
  5001. data, otherwise <c>false</c>. The default is <c>false</c>.
  5002. </value>
  5003. <remarks>
  5004. <para>
  5005. Setting this property to <c>true</c> will cause only part of the event
  5006. data to be fixed and stored in the appender, hereby improving performance.
  5007. </para>
  5008. <para>
  5009. See <see cref="M:LoggingEvent.FixVolatileData(bool)"/> for more information.
  5010. </para>
  5011. </remarks>
  5012. </member>
  5013. <member name="P:log4net.Appender.MemoryAppender.Fix">
  5014. <summary>
  5015. Gets or sets the fields that will be fixed in the event
  5016. </summary>
  5017. <remarks>
  5018. <para>
  5019. The logging event needs to have certain thread specific values
  5020. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  5021. for details.
  5022. </para>
  5023. </remarks>
  5024. </member>
  5025. <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)">
  5026. <summary>
  5027. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5028. </summary>
  5029. <param name="loggingEvent">the event to log</param>
  5030. <remarks>
  5031. <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
  5032. </remarks>
  5033. </member>
  5034. <member name="M:log4net.Appender.MemoryAppender.Clear">
  5035. <summary>
  5036. Clear the list of events
  5037. </summary>
  5038. <remarks>
  5039. Clear the list of events
  5040. </remarks>
  5041. </member>
  5042. <member name="M:log4net.Appender.MemoryAppender.PopAllEvents">
  5043. <summary>
  5044. Gets the events that have been logged and clears the list of events.
  5045. </summary>
  5046. <returns>The events that have been logged</returns>
  5047. <remarks>
  5048. <para>
  5049. Gets the events that have been logged and clears the list of events.
  5050. </para>
  5051. </remarks>
  5052. </member>
  5053. <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
  5054. <summary>
  5055. The list of events that have been appended.
  5056. </summary>
  5057. </member>
  5058. <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
  5059. <summary>
  5060. Value indicating which fields in the event should be fixed
  5061. </summary>
  5062. <remarks>
  5063. By default all fields are fixed
  5064. </remarks>
  5065. </member>
  5066. <member name="T:log4net.Appender.NetSendAppender">
  5067. <summary>
  5068. Logs entries by sending network messages using the
  5069. <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)" /> native function.
  5070. </summary>
  5071. <remarks>
  5072. <para>
  5073. You can send messages only to names that are active
  5074. on the network. If you send the message to a user name,
  5075. that user must be logged on and running the Messenger
  5076. service to receive the message.
  5077. </para>
  5078. <para>
  5079. The receiver will get a top most window displaying the
  5080. messages one at a time, therefore this appender should
  5081. not be used to deliver a high volume of messages.
  5082. </para>
  5083. <para>
  5084. The following table lists some possible uses for this appender :
  5085. </para>
  5086. <para>
  5087. <list type="table">
  5088. <listheader>
  5089. <term>Action</term>
  5090. <description>Property Value(s)</description>
  5091. </listheader>
  5092. <item>
  5093. <term>Send a message to a user account on the local machine</term>
  5094. <description>
  5095. <para>
  5096. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine&gt;
  5097. </para>
  5098. <para>
  5099. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5100. </para>
  5101. </description>
  5102. </item>
  5103. <item>
  5104. <term>Send a message to a user account on a remote machine</term>
  5105. <description>
  5106. <para>
  5107. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the remote machine&gt;
  5108. </para>
  5109. <para>
  5110. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5111. </para>
  5112. </description>
  5113. </item>
  5114. <item>
  5115. <term>Send a message to a domain user account</term>
  5116. <description>
  5117. <para>
  5118. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of a domain controller | uninitialized&gt;
  5119. </para>
  5120. <para>
  5121. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5122. </para>
  5123. </description>
  5124. </item>
  5125. <item>
  5126. <term>Send a message to all the names in a workgroup or domain</term>
  5127. <description>
  5128. <para>
  5129. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;workgroup name | domain name&gt;*
  5130. </para>
  5131. </description>
  5132. </item>
  5133. <item>
  5134. <term>Send a message from the local machine to a remote machine</term>
  5135. <description>
  5136. <para>
  5137. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine | uninitialized&gt;
  5138. </para>
  5139. <para>
  5140. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;name of the remote machine&gt;
  5141. </para>
  5142. </description>
  5143. </item>
  5144. </list>
  5145. </para>
  5146. <para>
  5147. <b>Note :</b> security restrictions apply for sending
  5148. network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)" />
  5149. for more information.
  5150. </para>
  5151. </remarks>
  5152. <example>
  5153. <para>
  5154. An example configuration section to log information
  5155. using this appender from the local machine, named
  5156. LOCAL_PC, to machine OPERATOR_PC :
  5157. </para>
  5158. <code lang="XML" escaped="true">
  5159. <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
  5160. <server value="LOCAL_PC" />
  5161. <recipient value="OPERATOR_PC" />
  5162. <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n" />
  5163. </appender>
  5164. </code>
  5165. </example>
  5166. <author>Nicko Cadell</author>
  5167. <author>Gert Driesen</author>
  5168. </member>
  5169. <member name="F:log4net.Appender.NetSendAppender.m_server">
  5170. <summary>
  5171. The DNS or NetBIOS name of the server on which the function is to execute.
  5172. </summary>
  5173. </member>
  5174. <member name="F:log4net.Appender.NetSendAppender.m_sender">
  5175. <summary>
  5176. The sender of the network message.
  5177. </summary>
  5178. </member>
  5179. <member name="F:log4net.Appender.NetSendAppender.m_recipient">
  5180. <summary>
  5181. The message alias to which the message should be sent.
  5182. </summary>
  5183. </member>
  5184. <member name="F:log4net.Appender.NetSendAppender.m_securityContext">
  5185. <summary>
  5186. The security context to use for privileged calls
  5187. </summary>
  5188. </member>
  5189. <member name="M:log4net.Appender.NetSendAppender.#ctor">
  5190. <summary>
  5191. Initializes the appender.
  5192. </summary>
  5193. <remarks>
  5194. The default constructor initializes all fields to their default values.
  5195. </remarks>
  5196. </member>
  5197. <member name="P:log4net.Appender.NetSendAppender.Sender">
  5198. <summary>
  5199. Gets or sets the sender of the message.
  5200. </summary>
  5201. <value>
  5202. The sender of the message.
  5203. </value>
  5204. <remarks>
  5205. If this property is not specified, the message is sent from the local computer.
  5206. </remarks>
  5207. </member>
  5208. <member name="P:log4net.Appender.NetSendAppender.Recipient">
  5209. <summary>
  5210. Gets or sets the message alias to which the message should be sent.
  5211. </summary>
  5212. <value>
  5213. The recipient of the message.
  5214. </value>
  5215. <remarks>
  5216. This property should always be specified in order to send a message.
  5217. </remarks>
  5218. </member>
  5219. <member name="P:log4net.Appender.NetSendAppender.Server">
  5220. <summary>
  5221. Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
  5222. </summary>
  5223. <value>
  5224. DNS or NetBIOS name of the remote server on which the function is to execute.
  5225. </value>
  5226. <remarks>
  5227. <para>
  5228. For Windows NT 4.0 and earlier, the string should begin with \\.
  5229. </para>
  5230. <para>
  5231. If this property is not specified, the local computer is used.
  5232. </para>
  5233. </remarks>
  5234. </member>
  5235. <member name="P:log4net.Appender.NetSendAppender.SecurityContext">
  5236. <summary>
  5237. Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5238. </summary>
  5239. <value>
  5240. The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5241. </value>
  5242. <remarks>
  5243. <para>
  5244. Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
  5245. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  5246. security context to use. The default behavior is to use the security context
  5247. of the current thread.
  5248. </para>
  5249. </remarks>
  5250. </member>
  5251. <member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
  5252. <summary>
  5253. Initialize the appender based on the options set.
  5254. </summary>
  5255. <remarks>
  5256. <para>
  5257. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5258. activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
  5259. be called on this object after the configuration properties have
  5260. been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
  5261. object is in an undefined state and must not be used.
  5262. </para>
  5263. <para>
  5264. If any of the configuration properties are modified then
  5265. <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
  5266. </para>
  5267. <para>
  5268. The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient" /> was specified.
  5269. </para>
  5270. </remarks>
  5271. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient" /> was not specified.</exception>
  5272. </member>
  5273. <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
  5274. <summary>
  5275. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5276. </summary>
  5277. <param name="loggingEvent">The event to log.</param>
  5278. <remarks>
  5279. <para>
  5280. Sends the event using a network message.
  5281. </para>
  5282. </remarks>
  5283. </member>
  5284. <member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
  5285. <summary>
  5286. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5287. </summary>
  5288. <value><c>true</c></value>
  5289. <remarks>
  5290. <para>
  5291. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5292. </para>
  5293. </remarks>
  5294. </member>
  5295. <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
  5296. <summary>
  5297. Sends a buffer of information to a registered message alias.
  5298. </summary>
  5299. <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
  5300. <param name="msgName">The message alias to which the message buffer should be sent</param>
  5301. <param name="fromName">The originator of the message.</param>
  5302. <param name="buffer">The message text.</param>
  5303. <param name="bufferSize">The length, in bytes, of the message text.</param>
  5304. <remarks>
  5305. <para>
  5306. The following restrictions apply for sending network messages:
  5307. </para>
  5308. <para>
  5309. <list type="table">
  5310. <listheader>
  5311. <term>Platform</term>
  5312. <description>Requirements</description>
  5313. </listheader>
  5314. <item>
  5315. <term>Windows NT</term>
  5316. <description>
  5317. <para>
  5318. No special group membership is required to send a network message.
  5319. </para>
  5320. <para>
  5321. Admin, Accounts, Print, or Server Operator group membership is required to
  5322. successfully send a network message on a remote server.
  5323. </para>
  5324. </description>
  5325. </item>
  5326. <item>
  5327. <term>Windows 2000 or later</term>
  5328. <description>
  5329. <para>
  5330. If you send a message on a domain controller that is running Active Directory,
  5331. access is allowed or denied based on the access control list (ACL) for the securable
  5332. object. The default ACL permits only Domain Admins and Account Operators to send a network message.
  5333. </para>
  5334. <para>
  5335. On a member server or workstation, only Administrators and Server Operators can send a network message.
  5336. </para>
  5337. </description>
  5338. </item>
  5339. </list>
  5340. </para>
  5341. <para>
  5342. 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>.
  5343. </para>
  5344. </remarks>
  5345. <returns>
  5346. <para>
  5347. If the function succeeds, the return value is zero.
  5348. </para>
  5349. </returns>
  5350. </member>
  5351. <member name="T:log4net.Appender.OutputDebugStringAppender">
  5352. <summary>
  5353. Appends log events to the OutputDebugString system.
  5354. </summary>
  5355. <remarks>
  5356. <para>
  5357. OutputDebugStringAppender appends log events to the
  5358. OutputDebugString system.
  5359. </para>
  5360. <para>
  5361. The string is passed to the native <c>OutputDebugString</c>
  5362. function.
  5363. </para>
  5364. </remarks>
  5365. <author>Nicko Cadell</author>
  5366. <author>Gert Driesen</author>
  5367. </member>
  5368. <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
  5369. <summary>
  5370. Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender" /> class.
  5371. </summary>
  5372. <remarks>
  5373. <para>
  5374. Default constructor.
  5375. </para>
  5376. </remarks>
  5377. </member>
  5378. <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
  5379. <summary>
  5380. Write the logging event to the output debug string API
  5381. </summary>
  5382. <param name="loggingEvent">the event to log</param>
  5383. <remarks>
  5384. <para>
  5385. Write the logging event to the output debug string API
  5386. </para>
  5387. </remarks>
  5388. </member>
  5389. <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
  5390. <summary>
  5391. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5392. </summary>
  5393. <value><c>true</c></value>
  5394. <remarks>
  5395. <para>
  5396. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5397. </para>
  5398. </remarks>
  5399. </member>
  5400. <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
  5401. <summary>
  5402. Stub for OutputDebugString native method
  5403. </summary>
  5404. <param name="message">the string to output</param>
  5405. <remarks>
  5406. <para>
  5407. Stub for OutputDebugString native method
  5408. </para>
  5409. </remarks>
  5410. </member>
  5411. <member name="T:log4net.Appender.RemoteSyslogAppender">
  5412. <summary>
  5413. Logs events to a remote syslog daemon.
  5414. </summary>
  5415. <remarks>
  5416. <para>
  5417. The BSD syslog protocol is used to remotely log to
  5418. a syslog daemon. The syslogd listens for for messages
  5419. on UDP port 514.
  5420. </para>
  5421. <para>
  5422. The syslog UDP protocol is not authenticated. Most syslog daemons
  5423. do not accept remote log messages because of the security implications.
  5424. You may be able to use the LocalSyslogAppender to talk to a local
  5425. syslog service.
  5426. </para>
  5427. <para>
  5428. There is an RFC 3164 that claims to document the BSD Syslog Protocol.
  5429. This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html.
  5430. This appender generates what the RFC calls an "Original Device Message",
  5431. i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation
  5432. this format of message will be accepted by all current syslog daemon
  5433. implementations. The daemon will attach the current time and the source
  5434. hostname or IP address to any messages received.
  5435. </para>
  5436. <para>
  5437. Syslog messages must have a facility and and a severity. The severity
  5438. is derived from the Level of the logging event.
  5439. The facility must be chosen from the set of defined syslog
  5440. <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  5441. and cannot be extended.
  5442. </para>
  5443. <para>
  5444. An identifier is specified with each log message. This can be specified
  5445. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  5446. as the tag) must not contain white space. The default value for the
  5447. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  5448. </para>
  5449. </remarks>
  5450. <author>Rob Lyon</author>
  5451. <author>Nicko Cadell</author>
  5452. </member>
  5453. <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort">
  5454. <summary>
  5455. Syslog port 514
  5456. </summary>
  5457. </member>
  5458. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity">
  5459. <summary>
  5460. syslog severities
  5461. </summary>
  5462. <remarks>
  5463. <para>
  5464. The syslog severities.
  5465. </para>
  5466. </remarks>
  5467. </member>
  5468. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency">
  5469. <summary>
  5470. system is unusable
  5471. </summary>
  5472. </member>
  5473. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert">
  5474. <summary>
  5475. action must be taken immediately
  5476. </summary>
  5477. </member>
  5478. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical">
  5479. <summary>
  5480. critical conditions
  5481. </summary>
  5482. </member>
  5483. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error">
  5484. <summary>
  5485. error conditions
  5486. </summary>
  5487. </member>
  5488. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning">
  5489. <summary>
  5490. warning conditions
  5491. </summary>
  5492. </member>
  5493. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice">
  5494. <summary>
  5495. normal but significant condition
  5496. </summary>
  5497. </member>
  5498. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational">
  5499. <summary>
  5500. informational
  5501. </summary>
  5502. </member>
  5503. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug">
  5504. <summary>
  5505. debug-level messages
  5506. </summary>
  5507. </member>
  5508. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility">
  5509. <summary>
  5510. syslog facilities
  5511. </summary>
  5512. <remarks>
  5513. <para>
  5514. The syslog facilities
  5515. </para>
  5516. </remarks>
  5517. </member>
  5518. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel">
  5519. <summary>
  5520. kernel messages
  5521. </summary>
  5522. </member>
  5523. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User">
  5524. <summary>
  5525. random user-level messages
  5526. </summary>
  5527. </member>
  5528. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail">
  5529. <summary>
  5530. mail system
  5531. </summary>
  5532. </member>
  5533. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons">
  5534. <summary>
  5535. system daemons
  5536. </summary>
  5537. </member>
  5538. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization">
  5539. <summary>
  5540. security/authorization messages
  5541. </summary>
  5542. </member>
  5543. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog">
  5544. <summary>
  5545. messages generated internally by syslogd
  5546. </summary>
  5547. </member>
  5548. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer">
  5549. <summary>
  5550. line printer subsystem
  5551. </summary>
  5552. </member>
  5553. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News">
  5554. <summary>
  5555. network news subsystem
  5556. </summary>
  5557. </member>
  5558. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp">
  5559. <summary>
  5560. UUCP subsystem
  5561. </summary>
  5562. </member>
  5563. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock">
  5564. <summary>
  5565. clock (cron/at) daemon
  5566. </summary>
  5567. </member>
  5568. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2">
  5569. <summary>
  5570. security/authorization messages (private)
  5571. </summary>
  5572. </member>
  5573. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp">
  5574. <summary>
  5575. ftp daemon
  5576. </summary>
  5577. </member>
  5578. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp">
  5579. <summary>
  5580. NTP subsystem
  5581. </summary>
  5582. </member>
  5583. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit">
  5584. <summary>
  5585. log audit
  5586. </summary>
  5587. </member>
  5588. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert">
  5589. <summary>
  5590. log alert
  5591. </summary>
  5592. </member>
  5593. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2">
  5594. <summary>
  5595. clock daemon
  5596. </summary>
  5597. </member>
  5598. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0">
  5599. <summary>
  5600. reserved for local use
  5601. </summary>
  5602. </member>
  5603. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1">
  5604. <summary>
  5605. reserved for local use
  5606. </summary>
  5607. </member>
  5608. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2">
  5609. <summary>
  5610. reserved for local use
  5611. </summary>
  5612. </member>
  5613. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3">
  5614. <summary>
  5615. reserved for local use
  5616. </summary>
  5617. </member>
  5618. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4">
  5619. <summary>
  5620. reserved for local use
  5621. </summary>
  5622. </member>
  5623. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5">
  5624. <summary>
  5625. reserved for local use
  5626. </summary>
  5627. </member>
  5628. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6">
  5629. <summary>
  5630. reserved for local use
  5631. </summary>
  5632. </member>
  5633. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7">
  5634. <summary>
  5635. reserved for local use
  5636. </summary>
  5637. </member>
  5638. <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor">
  5639. <summary>
  5640. Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender" /> class.
  5641. </summary>
  5642. <remarks>
  5643. This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender" /> class is set up to write
  5644. to a remote syslog daemon.
  5645. </remarks>
  5646. </member>
  5647. <member name="P:log4net.Appender.RemoteSyslogAppender.Identity">
  5648. <summary>
  5649. Message identity
  5650. </summary>
  5651. <remarks>
  5652. <para>
  5653. An identifier is specified with each log message. This can be specified
  5654. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  5655. as the tag) must not contain white space. The default value for the
  5656. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  5657. </para>
  5658. </remarks>
  5659. </member>
  5660. <member name="P:log4net.Appender.RemoteSyslogAppender.Facility">
  5661. <summary>
  5662. Syslog facility
  5663. </summary>
  5664. <remarks>
  5665. Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of
  5666. facilities is predefined and cannot be extended. The default value
  5667. is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  5668. </remarks>
  5669. </member>
  5670. <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)">
  5671. <summary>
  5672. Add a mapping of level to severity
  5673. </summary>
  5674. <param name="mapping">The mapping to add</param>
  5675. <remarks>
  5676. <para>
  5677. Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender.
  5678. </para>
  5679. </remarks>
  5680. </member>
  5681. <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)">
  5682. <summary>
  5683. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5684. </summary>
  5685. <param name="loggingEvent">The event to log.</param>
  5686. <remarks>
  5687. <para>
  5688. Writes the event to a remote syslog daemon.
  5689. </para>
  5690. <para>
  5691. The format of the output will depend on the appender's layout.
  5692. </para>
  5693. </remarks>
  5694. </member>
  5695. <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions">
  5696. <summary>
  5697. Initialize the options for this appender
  5698. </summary>
  5699. <remarks>
  5700. <para>
  5701. Initialize the level to syslog severity mappings set on this appender.
  5702. </para>
  5703. </remarks>
  5704. </member>
  5705. <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)">
  5706. <summary>
  5707. Translates a log4net level to a syslog severity.
  5708. </summary>
  5709. <param name="level">A log4net level.</param>
  5710. <returns>A syslog severity.</returns>
  5711. <remarks>
  5712. <para>
  5713. Translates a log4net level to a syslog severity.
  5714. </para>
  5715. </remarks>
  5716. </member>
  5717. <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)">
  5718. <summary>
  5719. Generate a syslog priority.
  5720. </summary>
  5721. <param name="facility">The syslog facility.</param>
  5722. <param name="severity">The syslog severity.</param>
  5723. <returns>A syslog priority.</returns>
  5724. <remarks>
  5725. <para>
  5726. Generate a syslog priority.
  5727. </para>
  5728. </remarks>
  5729. </member>
  5730. <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility">
  5731. <summary>
  5732. The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  5733. </summary>
  5734. </member>
  5735. <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity">
  5736. <summary>
  5737. The message identity
  5738. </summary>
  5739. </member>
  5740. <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping">
  5741. <summary>
  5742. Mapping from level object to syslog severity
  5743. </summary>
  5744. </member>
  5745. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferSize">
  5746. <summary>
  5747. Initial buffer size
  5748. </summary>
  5749. </member>
  5750. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferMaxCapacity">
  5751. <summary>
  5752. Maximum buffer size before it is recycled
  5753. </summary>
  5754. </member>
  5755. <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity">
  5756. <summary>
  5757. A class to act as a mapping between the level that a logging call is made at and
  5758. the syslog severity that is should be logged at.
  5759. </summary>
  5760. <remarks>
  5761. <para>
  5762. A class to act as a mapping between the level that a logging call is made at and
  5763. the syslog severity that is should be logged at.
  5764. </para>
  5765. </remarks>
  5766. </member>
  5767. <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity">
  5768. <summary>
  5769. The mapped syslog severity for the specified level
  5770. </summary>
  5771. <remarks>
  5772. <para>
  5773. Required property.
  5774. The mapped syslog severity for the specified level
  5775. </para>
  5776. </remarks>
  5777. </member>
  5778. <member name="T:log4net.Appender.RemotingAppender">
  5779. <summary>
  5780. Delivers logging events to a remote logging sink.
  5781. </summary>
  5782. <remarks>
  5783. <para>
  5784. This Appender is designed to deliver events to a remote sink.
  5785. That is any object that implements the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  5786. interface. It delivers the events using .NET remoting. The
  5787. object to deliver events to is specified by setting the
  5788. appenders <see cref="P:log4net.Appender.RemotingAppender.Sink"/> property.</para>
  5789. <para>
  5790. The RemotingAppender buffers events before sending them. This allows it to
  5791. make more efficient use of the remoting infrastructure.</para>
  5792. <para>
  5793. Once the buffer is full the events are still not sent immediately.
  5794. They are scheduled to be sent using a pool thread. The effect is that
  5795. the send occurs asynchronously. This is very important for a
  5796. number of non obvious reasons. The remoting infrastructure will
  5797. flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  5798. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  5799. remoting boundary. If the server is not contactable then
  5800. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  5801. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  5802. having side effects on the calling application the remoting call must be made
  5803. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  5804. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  5805. the events will block in the thread pool manager until a thread is available.</para>
  5806. <para>
  5807. Because the events are sent asynchronously using pool threads it is possible to close
  5808. this appender before all the queued events have been sent.
  5809. When closing the appender attempts to wait until all the queued events have been sent, but
  5810. this will timeout after 30 seconds regardless.</para>
  5811. <para>
  5812. If this appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
  5813. event has fired it may not be possible to send all the queued events. During process
  5814. exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
  5815. event handler is allowed to run for. If the runtime terminates the threads before
  5816. the queued events have been sent then they will be lost. To ensure that all events
  5817. are sent the appender must be closed before the application exits. See
  5818. <see cref="M:log4net.Core.LoggerManager.Shutdown"/> for details on how to shutdown
  5819. log4net programmatically.</para>
  5820. </remarks>
  5821. <seealso cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink" />
  5822. <author>Nicko Cadell</author>
  5823. <author>Gert Driesen</author>
  5824. <author>Daniel Cazzulino</author>
  5825. </member>
  5826. <member name="M:log4net.Appender.RemotingAppender.#ctor">
  5827. <summary>
  5828. Initializes a new instance of the <see cref="T:log4net.Appender.RemotingAppender" /> class.
  5829. </summary>
  5830. <remarks>
  5831. <para>
  5832. Default constructor.
  5833. </para>
  5834. </remarks>
  5835. </member>
  5836. <member name="P:log4net.Appender.RemotingAppender.Sink">
  5837. <summary>
  5838. Gets or sets the URL of the well-known object that will accept
  5839. the logging events.
  5840. </summary>
  5841. <value>
  5842. The well-known URL of the remote sink.
  5843. </value>
  5844. <remarks>
  5845. <para>
  5846. The URL of the remoting sink that will accept logging events.
  5847. The sink must implement the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  5848. interface.
  5849. </para>
  5850. </remarks>
  5851. </member>
  5852. <member name="M:log4net.Appender.RemotingAppender.ActivateOptions">
  5853. <summary>
  5854. Initialize the appender based on the options set
  5855. </summary>
  5856. <remarks>
  5857. <para>
  5858. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5859. activation scheme. The <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> method must
  5860. be called on this object after the configuration properties have
  5861. been set. Until <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> is called this
  5862. object is in an undefined state and must not be used.
  5863. </para>
  5864. <para>
  5865. If any of the configuration properties are modified then
  5866. <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> must be called again.
  5867. </para>
  5868. </remarks>
  5869. </member>
  5870. <member name="M:log4net.Appender.RemotingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  5871. <summary>
  5872. Send the contents of the buffer to the remote sink.
  5873. </summary>
  5874. <remarks>
  5875. The events are not sent immediately. They are scheduled to be sent
  5876. using a pool thread. The effect is that the send occurs asynchronously.
  5877. This is very important for a number of non obvious reasons. The remoting
  5878. infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  5879. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  5880. remoting boundary. If the server is not contactable then
  5881. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  5882. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  5883. having side effects on the calling application the remoting call must be made
  5884. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  5885. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  5886. the events will block in the thread pool manager until a thread is available.
  5887. </remarks>
  5888. <param name="events">The events to send.</param>
  5889. </member>
  5890. <member name="M:log4net.Appender.RemotingAppender.OnClose">
  5891. <summary>
  5892. Override base class close.
  5893. </summary>
  5894. <remarks>
  5895. <para>
  5896. This method waits while there are queued work items. The events are
  5897. sent asynchronously using <see cref="T:System.Threading.ThreadPool"/> work items. These items
  5898. will be sent once a thread pool thread is available to send them, therefore
  5899. it is possible to close the appender before all the queued events have been
  5900. sent.</para>
  5901. <para>
  5902. This method attempts to wait until all the queued events have been sent, but this
  5903. method will timeout after 30 seconds regardless.</para>
  5904. <para>
  5905. If the appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
  5906. event has fired it may not be possible to send all the queued events. During process
  5907. exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
  5908. event handler is allowed to run for.</para>
  5909. </remarks>
  5910. </member>
  5911. <member name="M:log4net.Appender.RemotingAppender.Flush(System.Int32)">
  5912. <summary>
  5913. Flushes any buffered log data.
  5914. </summary>
  5915. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  5916. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  5917. </member>
  5918. <member name="M:log4net.Appender.RemotingAppender.BeginAsyncSend">
  5919. <summary>
  5920. A work item is being queued into the thread pool
  5921. </summary>
  5922. </member>
  5923. <member name="M:log4net.Appender.RemotingAppender.EndAsyncSend">
  5924. <summary>
  5925. A work item from the thread pool has completed
  5926. </summary>
  5927. </member>
  5928. <member name="M:log4net.Appender.RemotingAppender.SendBufferCallback(System.Object)">
  5929. <summary>
  5930. Send the contents of the buffer to the remote sink.
  5931. </summary>
  5932. <remarks>
  5933. This method is designed to be used with the <see cref="T:System.Threading.ThreadPool"/>.
  5934. This method expects to be passed an array of <see cref="T:log4net.Core.LoggingEvent"/>
  5935. objects in the state param.
  5936. </remarks>
  5937. <param name="state">the logging events to send</param>
  5938. </member>
  5939. <member name="F:log4net.Appender.RemotingAppender.m_sinkUrl">
  5940. <summary>
  5941. The URL of the remote sink.
  5942. </summary>
  5943. </member>
  5944. <member name="F:log4net.Appender.RemotingAppender.m_sinkObj">
  5945. <summary>
  5946. The local proxy (.NET remoting) for the remote logging sink.
  5947. </summary>
  5948. </member>
  5949. <member name="F:log4net.Appender.RemotingAppender.m_queuedCallbackCount">
  5950. <summary>
  5951. The number of queued callbacks currently waiting or executing
  5952. </summary>
  5953. </member>
  5954. <member name="F:log4net.Appender.RemotingAppender.m_workQueueEmptyEvent">
  5955. <summary>
  5956. Event used to signal when there are no queued work items
  5957. </summary>
  5958. <remarks>
  5959. This event is set when there are no queued work items. In this
  5960. state it is safe to close the appender.
  5961. </remarks>
  5962. </member>
  5963. <member name="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink">
  5964. <summary>
  5965. Interface used to deliver <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  5966. </summary>
  5967. <remarks>
  5968. This interface must be implemented by a remoting sink
  5969. if the <see cref="T:log4net.Appender.RemotingAppender"/> is to be used
  5970. to deliver logging events to the sink.
  5971. </remarks>
  5972. </member>
  5973. <member name="M:log4net.Appender.RemotingAppender.IRemoteLoggingSink.LogEvents(log4net.Core.LoggingEvent[])">
  5974. <summary>
  5975. Delivers logging events to the remote sink
  5976. </summary>
  5977. <param name="events">Array of events to log.</param>
  5978. <remarks>
  5979. <para>
  5980. Delivers logging events to the remote sink
  5981. </para>
  5982. </remarks>
  5983. </member>
  5984. <member name="T:log4net.Appender.RollingFileAppender">
  5985. <summary>
  5986. Appender that rolls log files based on size or date or both.
  5987. </summary>
  5988. <remarks>
  5989. <para>
  5990. RollingFileAppender can roll log files based on size or date or both
  5991. depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property.
  5992. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled
  5993. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  5994. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled
  5995. once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  5996. is crossed.
  5997. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be
  5998. rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  5999. is crossed, but within a date boundary the file will also be rolled
  6000. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  6001. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when
  6002. the appender is configured. This effectively means that the log file can be
  6003. rolled once per program execution.
  6004. </para>
  6005. <para>
  6006. A of few additional optional features have been added:
  6007. <list type="bullet">
  6008. <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item>
  6009. <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item>
  6010. <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item>
  6011. </list>
  6012. </para>
  6013. <note>
  6014. <para>
  6015. For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/>
  6016. greater than zero is highly recommended, otherwise all the backup files need
  6017. to be renamed each time a new backup is created.
  6018. </para>
  6019. <para>
  6020. When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6021. to <see langword="true"/> will reduce the number of file renamings to few or none.
  6022. </para>
  6023. </note>
  6024. <note type="caution">
  6025. <para>
  6026. Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing
  6027. the log file directory of backup files will cause unexpected and unwanted side effects.
  6028. </para>
  6029. </note>
  6030. <para>
  6031. If Date/Time based rolling is enabled this appender will attempt to roll existing files
  6032. in the directory without a Date/Time tag based on the last write date of the base log file.
  6033. The appender only rolls the log file when a message is logged. If Date/Time based rolling
  6034. is enabled then the appender will not roll the log file at the Date/Time boundary but
  6035. at the point when the next message is logged after the boundary has been crossed.
  6036. </para>
  6037. <para>
  6038. The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and
  6039. has the same behavior when opening the log file.
  6040. The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>
  6041. is called. This will typically be during configuration.
  6042. If the file cannot be opened for writing the appender will attempt
  6043. to open the file again each time a message is logged to the appender.
  6044. If the file cannot be opened for writing when a message is logged then
  6045. the message will be discarded by this appender.
  6046. </para>
  6047. <para>
  6048. When rolling a backup file necessitates deleting an older backup file the
  6049. file to be deleted is moved to a temporary name before being deleted.
  6050. </para>
  6051. <note type="caution">
  6052. <para>
  6053. A maximum number of backup files when rolling on date/time boundaries is not supported.
  6054. </para>
  6055. </note>
  6056. </remarks>
  6057. <author>Nicko Cadell</author>
  6058. <author>Gert Driesen</author>
  6059. <author>Aspi Havewala</author>
  6060. <author>Douglas de la Torre</author>
  6061. <author>Edward Smit</author>
  6062. </member>
  6063. <member name="T:log4net.Appender.RollingFileAppender.RollingMode">
  6064. <summary>
  6065. Style of rolling to use
  6066. </summary>
  6067. <remarks>
  6068. <para>
  6069. Style of rolling to use
  6070. </para>
  6071. </remarks>
  6072. </member>
  6073. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once">
  6074. <summary>
  6075. Roll files once per program execution
  6076. </summary>
  6077. <remarks>
  6078. <para>
  6079. Roll files once per program execution.
  6080. Well really once each time this appender is
  6081. configured.
  6082. </para>
  6083. <para>
  6084. Setting this option also sets <c>AppendToFile</c> to
  6085. <c>false</c> on the <c>RollingFileAppender</c>, otherwise
  6086. this appender would just be a normal file appender.
  6087. </para>
  6088. </remarks>
  6089. </member>
  6090. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size">
  6091. <summary>
  6092. Roll files based only on the size of the file
  6093. </summary>
  6094. </member>
  6095. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date">
  6096. <summary>
  6097. Roll files based only on the date
  6098. </summary>
  6099. </member>
  6100. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite">
  6101. <summary>
  6102. Roll files based on both the size and date of the file
  6103. </summary>
  6104. </member>
  6105. <member name="T:log4net.Appender.RollingFileAppender.RollPoint">
  6106. <summary>
  6107. The code assumes that the following 'time' constants are in a increasing sequence.
  6108. </summary>
  6109. <remarks>
  6110. <para>
  6111. The code assumes that the following 'time' constants are in a increasing sequence.
  6112. </para>
  6113. </remarks>
  6114. </member>
  6115. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint">
  6116. <summary>
  6117. Roll the log not based on the date
  6118. </summary>
  6119. </member>
  6120. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute">
  6121. <summary>
  6122. Roll the log for each minute
  6123. </summary>
  6124. </member>
  6125. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour">
  6126. <summary>
  6127. Roll the log for each hour
  6128. </summary>
  6129. </member>
  6130. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay">
  6131. <summary>
  6132. Roll the log twice a day (midday and midnight)
  6133. </summary>
  6134. </member>
  6135. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay">
  6136. <summary>
  6137. Roll the log each day (midnight)
  6138. </summary>
  6139. </member>
  6140. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek">
  6141. <summary>
  6142. Roll the log each week
  6143. </summary>
  6144. </member>
  6145. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth">
  6146. <summary>
  6147. Roll the log each month
  6148. </summary>
  6149. </member>
  6150. <member name="M:log4net.Appender.RollingFileAppender.#ctor">
  6151. <summary>
  6152. Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender" /> class.
  6153. </summary>
  6154. <remarks>
  6155. <para>
  6156. Default constructor.
  6157. </para>
  6158. </remarks>
  6159. </member>
  6160. <member name="M:log4net.Appender.RollingFileAppender.Finalize">
  6161. <summary>
  6162. Cleans up all resources used by this appender.
  6163. </summary>
  6164. </member>
  6165. <member name="P:log4net.Appender.RollingFileAppender.DateTimeStrategy">
  6166. <summary>
  6167. Gets or sets the strategy for determining the current date and time. The default
  6168. implementation is to use LocalDateTime which internally calls through to DateTime.Now.
  6169. DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying
  6170. <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  6171. </summary>
  6172. <value>
  6173. An implementation of the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> interface which returns the current date and time.
  6174. </value>
  6175. <remarks>
  6176. <para>
  6177. Gets or sets the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> used to return the current date and time.
  6178. </para>
  6179. <para>
  6180. There are two built strategies for determining the current date and time,
  6181. <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>
  6182. and <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  6183. </para>
  6184. <para>
  6185. The default strategy is <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>.
  6186. </para>
  6187. </remarks>
  6188. </member>
  6189. <member name="P:log4net.Appender.RollingFileAppender.DatePattern">
  6190. <summary>
  6191. Gets or sets the date pattern to be used for generating file names
  6192. when rolling over on date.
  6193. </summary>
  6194. <value>
  6195. The date pattern to be used for generating file names when rolling
  6196. over on date.
  6197. </value>
  6198. <remarks>
  6199. <para>
  6200. Takes a string in the same format as expected by
  6201. <see cref="T:log4net.DateFormatter.SimpleDateFormatter" />.
  6202. </para>
  6203. <para>
  6204. This property determines the rollover schedule when rolling over
  6205. on date.
  6206. </para>
  6207. </remarks>
  6208. </member>
  6209. <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups">
  6210. <summary>
  6211. Gets or sets the maximum number of backup files that are kept before
  6212. the oldest is erased.
  6213. </summary>
  6214. <value>
  6215. The maximum number of backup files that are kept before the oldest is
  6216. erased.
  6217. </value>
  6218. <remarks>
  6219. <para>
  6220. If set to zero, then there will be no backup files and the log file
  6221. will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>.
  6222. </para>
  6223. <para>
  6224. If a negative number is supplied then no deletions will be made. Note
  6225. that this could result in very slow performance as a large number of
  6226. files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used.
  6227. </para>
  6228. <para>
  6229. The maximum applies to <b>each</b> time based group of files and
  6230. <b>not</b> the total.
  6231. </para>
  6232. </remarks>
  6233. </member>
  6234. <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize">
  6235. <summary>
  6236. Gets or sets the maximum size that the output file is allowed to reach
  6237. before being rolled over to backup files.
  6238. </summary>
  6239. <value>
  6240. The maximum size in bytes that the output file is allowed to reach before being
  6241. rolled over to backup files.
  6242. </value>
  6243. <remarks>
  6244. <para>
  6245. This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except
  6246. that it is required for differentiating the setter taking a
  6247. <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/>
  6248. argument.
  6249. </para>
  6250. <para>
  6251. The default maximum file size is 10MB (10*1024*1024).
  6252. </para>
  6253. </remarks>
  6254. </member>
  6255. <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize">
  6256. <summary>
  6257. Gets or sets the maximum size that the output file is allowed to reach
  6258. before being rolled over to backup files.
  6259. </summary>
  6260. <value>
  6261. The maximum size that the output file is allowed to reach before being
  6262. rolled over to backup files.
  6263. </value>
  6264. <remarks>
  6265. <para>
  6266. This property allows you to specify the maximum size with the
  6267. suffixes "KB", "MB" or "GB" so that the size is interpreted being
  6268. expressed respectively in kilobytes, megabytes or gigabytes.
  6269. </para>
  6270. <para>
  6271. For example, the value "10KB" will be interpreted as 10240 bytes.
  6272. </para>
  6273. <para>
  6274. The default maximum file size is 10MB.
  6275. </para>
  6276. <para>
  6277. If you have the option to set the maximum file size programmatically
  6278. consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this
  6279. allows you to set the size in bytes as a <see cref="T:System.Int64"/>.
  6280. </para>
  6281. </remarks>
  6282. </member>
  6283. <member name="P:log4net.Appender.RollingFileAppender.CountDirection">
  6284. <summary>
  6285. Gets or sets the rolling file count direction.
  6286. </summary>
  6287. <value>
  6288. The rolling file count direction.
  6289. </value>
  6290. <remarks>
  6291. <para>
  6292. Indicates if the current file is the lowest numbered file or the
  6293. highest numbered file.
  6294. </para>
  6295. <para>
  6296. By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &lt; 0),
  6297. i.e. log.1 is most recent, log.5 is the 5th backup, etc...
  6298. </para>
  6299. <para>
  6300. <see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &gt;= 0 does the opposite i.e.
  6301. log.1 is the first backup made, log.5 is the 5th backup made, etc.
  6302. For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &gt;= 0 to reduce
  6303. rollover costs.
  6304. </para>
  6305. <para>The default file count direction is -1.</para>
  6306. </remarks>
  6307. </member>
  6308. <member name="P:log4net.Appender.RollingFileAppender.RollingStyle">
  6309. <summary>
  6310. Gets or sets the rolling style.
  6311. </summary>
  6312. <value>The rolling style.</value>
  6313. <remarks>
  6314. <para>
  6315. The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite" />.
  6316. </para>
  6317. <para>
  6318. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's
  6319. <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
  6320. the appender would append to a single file rather than rolling
  6321. the file each time it is opened.
  6322. </para>
  6323. </remarks>
  6324. </member>
  6325. <member name="P:log4net.Appender.RollingFileAppender.PreserveLogFileNameExtension">
  6326. <summary>
  6327. Gets or sets a value indicating whether to preserve the file name extension when rolling.
  6328. </summary>
  6329. <value>
  6330. <c>true</c> if the file name extension should be preserved.
  6331. </value>
  6332. <remarks>
  6333. <para>
  6334. By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup.
  6335. However, under Windows the new file name will loose any program associations as the
  6336. extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or
  6337. file.curSizeRollBackup.log to maintain any program associations.
  6338. </para>
  6339. </remarks>
  6340. </member>
  6341. <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName">
  6342. <summary>
  6343. Gets or sets a value indicating whether to always log to
  6344. the same file.
  6345. </summary>
  6346. <value>
  6347. <c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
  6348. </value>
  6349. <remarks>
  6350. <para>
  6351. By default file.log is always the current file. Optionally
  6352. file.log.yyyy-mm-dd for current formatted datePattern can by the currently
  6353. logging file (or file.log.curSizeRollBackup or even
  6354. file.log.yyyy-mm-dd.curSizeRollBackup).
  6355. </para>
  6356. <para>
  6357. This will make time based rollovers with a large number of backups
  6358. much faster as the appender it won't have to rename all the backups!
  6359. </para>
  6360. </remarks>
  6361. </member>
  6362. <member name="F:log4net.Appender.RollingFileAppender.declaringType">
  6363. <summary>
  6364. The fully qualified type of the RollingFileAppender class.
  6365. </summary>
  6366. <remarks>
  6367. Used by the internal logger to record the Type of the
  6368. log message.
  6369. </remarks>
  6370. </member>
  6371. <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)">
  6372. <summary>
  6373. Sets the quiet writer being used.
  6374. </summary>
  6375. <remarks>
  6376. This method can be overridden by sub classes.
  6377. </remarks>
  6378. <param name="writer">the writer to set</param>
  6379. </member>
  6380. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)">
  6381. <summary>
  6382. Write out a logging event.
  6383. </summary>
  6384. <param name="loggingEvent">the event to write to file.</param>
  6385. <remarks>
  6386. <para>
  6387. Handles append time behavior for RollingFileAppender. This checks
  6388. if a roll over either by date (checked first) or time (checked second)
  6389. is need and then appends to the file last.
  6390. </para>
  6391. </remarks>
  6392. </member>
  6393. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
  6394. <summary>
  6395. Write out an array of logging events.
  6396. </summary>
  6397. <param name="loggingEvents">the events to write to file.</param>
  6398. <remarks>
  6399. <para>
  6400. Handles append time behavior for RollingFileAppender. This checks
  6401. if a roll over either by date (checked first) or time (checked second)
  6402. is need and then appends to the file last.
  6403. </para>
  6404. </remarks>
  6405. </member>
  6406. <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
  6407. <summary>
  6408. Performs any required rolling before outputting the next event
  6409. </summary>
  6410. <remarks>
  6411. <para>
  6412. Handles append time behavior for RollingFileAppender. This checks
  6413. if a roll over either by date (checked first) or time (checked second)
  6414. is need and then appends to the file last.
  6415. </para>
  6416. </remarks>
  6417. </member>
  6418. <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)">
  6419. <summary>
  6420. Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6421. is false then the fully qualified name is determined and used.
  6422. </summary>
  6423. <param name="fileName">the name of the file to open</param>
  6424. <param name="append">true to append to existing file</param>
  6425. <remarks>
  6426. <para>This method will ensure that the directory structure
  6427. for the <paramref name="fileName"/> specified exists.</para>
  6428. </remarks>
  6429. </member>
  6430. <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)">
  6431. <summary>
  6432. Get the current output file name
  6433. </summary>
  6434. <param name="fileName">the base file name</param>
  6435. <returns>the output file name</returns>
  6436. <remarks>
  6437. The output file name is based on the base fileName specified.
  6438. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output
  6439. file name is the same as the base file passed in. Otherwise
  6440. the output file depends on the date pattern, on the count
  6441. direction or both.
  6442. </remarks>
  6443. </member>
  6444. <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups">
  6445. <summary>
  6446. Determines curSizeRollBackups (only within the current roll point)
  6447. </summary>
  6448. </member>
  6449. <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)">
  6450. <summary>
  6451. Generates a wildcard pattern that can be used to find all files
  6452. that are similar to the base file name.
  6453. </summary>
  6454. <param name="baseFileName"></param>
  6455. <returns></returns>
  6456. </member>
  6457. <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)">
  6458. <summary>
  6459. Builds a list of filenames for all files matching the base filename plus a file
  6460. pattern.
  6461. </summary>
  6462. <param name="baseFilePath"></param>
  6463. <returns></returns>
  6464. </member>
  6465. <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing">
  6466. <summary>
  6467. Initiates a roll over if needed for crossing a date boundary since the last run.
  6468. </summary>
  6469. </member>
  6470. <member name="M:log4net.Appender.RollingFileAppender.ExistingInit">
  6471. <summary>
  6472. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  6473. </summary>
  6474. <remarks>
  6475. <para>
  6476. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  6477. The following is done
  6478. <list type="bullet">
  6479. <item>determine curSizeRollBackups (only within the current roll point)</item>
  6480. <item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
  6481. </list>
  6482. </para>
  6483. </remarks>
  6484. </member>
  6485. <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)">
  6486. <summary>
  6487. Does the work of bumping the 'current' file counter higher
  6488. to the highest count when an incremental file name is seen.
  6489. The highest count is either the first file (when count direction
  6490. is greater than 0) or the last file (when count direction less than 0).
  6491. In either case, we want to know the highest count that is present.
  6492. </summary>
  6493. <param name="baseFile"></param>
  6494. <param name="curFileName"></param>
  6495. </member>
  6496. <member name="M:log4net.Appender.RollingFileAppender.GetBackUpIndex(System.String)">
  6497. <summary>
  6498. Attempts to extract a number from the end of the file name that indicates
  6499. the number of the times the file has been rolled over.
  6500. </summary>
  6501. <remarks>
  6502. Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes.
  6503. </remarks>
  6504. <param name="curFileName"></param>
  6505. <returns></returns>
  6506. </member>
  6507. <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)">
  6508. <summary>
  6509. Takes a list of files and a base file name, and looks for
  6510. 'incremented' versions of the base file. Bumps the max
  6511. count up to the highest count seen.
  6512. </summary>
  6513. <param name="baseFile"></param>
  6514. <param name="arrayFiles"></param>
  6515. </member>
  6516. <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)">
  6517. <summary>
  6518. Calculates the RollPoint for the datePattern supplied.
  6519. </summary>
  6520. <param name="datePattern">the date pattern to calculate the check period for</param>
  6521. <returns>The RollPoint that is most accurate for the date pattern supplied</returns>
  6522. <remarks>
  6523. Essentially the date pattern is examined to determine what the
  6524. most suitable roll point is. The roll point chosen is the roll point
  6525. with the smallest period that can be detected using the date pattern
  6526. supplied. i.e. if the date pattern only outputs the year, month, day
  6527. and hour then the smallest roll point that can be detected would be
  6528. and hourly roll point as minutes could not be detected.
  6529. </remarks>
  6530. </member>
  6531. <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions">
  6532. <summary>
  6533. Initialize the appender based on the options set
  6534. </summary>
  6535. <remarks>
  6536. <para>
  6537. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6538. activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must
  6539. be called on this object after the configuration properties have
  6540. been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this
  6541. object is in an undefined state and must not be used.
  6542. </para>
  6543. <para>
  6544. If any of the configuration properties are modified then
  6545. <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again.
  6546. </para>
  6547. <para>
  6548. Sets initial conditions including date/time roll over information, first check,
  6549. scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize
  6550. the current number of backups.
  6551. </para>
  6552. </remarks>
  6553. </member>
  6554. <member name="M:log4net.Appender.RollingFileAppender.CombinePath(System.String,System.String)">
  6555. <summary>
  6556. </summary>
  6557. <param name="path1"></param>
  6558. <param name="path2">.1, .2, .3, etc.</param>
  6559. <returns></returns>
  6560. </member>
  6561. <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)">
  6562. <summary>
  6563. Rollover the file(s) to date/time tagged file(s).
  6564. </summary>
  6565. <param name="fileIsOpen">set to true if the file to be rolled is currently open</param>
  6566. <remarks>
  6567. <para>
  6568. Rollover the file(s) to date/time tagged file(s).
  6569. Resets curSizeRollBackups.
  6570. If fileIsOpen is set then the new file is opened (through SafeOpenFile).
  6571. </para>
  6572. </remarks>
  6573. </member>
  6574. <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)">
  6575. <summary>
  6576. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>.
  6577. </summary>
  6578. <param name="fromFile">Name of existing file to roll.</param>
  6579. <param name="toFile">New name for file.</param>
  6580. <remarks>
  6581. <para>
  6582. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It
  6583. also checks for existence of target file and deletes if it does.
  6584. </para>
  6585. </remarks>
  6586. </member>
  6587. <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)">
  6588. <summary>
  6589. Test if a file exists at a specified path
  6590. </summary>
  6591. <param name="path">the path to the file</param>
  6592. <returns>true if the file exists</returns>
  6593. <remarks>
  6594. <para>
  6595. Test if a file exists at a specified path
  6596. </para>
  6597. </remarks>
  6598. </member>
  6599. <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)">
  6600. <summary>
  6601. Deletes the specified file if it exists.
  6602. </summary>
  6603. <param name="fileName">The file to delete.</param>
  6604. <remarks>
  6605. <para>
  6606. Delete a file if is exists.
  6607. The file is first moved to a new filename then deleted.
  6608. This allows the file to be removed even when it cannot
  6609. be deleted, but it still can be moved.
  6610. </para>
  6611. </remarks>
  6612. </member>
  6613. <member name="M:log4net.Appender.RollingFileAppender.RollOverSize">
  6614. <summary>
  6615. Implements file roll base on file size.
  6616. </summary>
  6617. <remarks>
  6618. <para>
  6619. If the maximum number of size based backups is reached
  6620. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  6621. file is deleted -- its index determined by the sign of countDirection.
  6622. If <c>countDirection</c> &lt; 0, then files
  6623. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  6624. are renamed to {<c>File.2</c>, ...,
  6625. <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is
  6626. renamed <c>File.1</c> and closed.
  6627. </para>
  6628. <para>
  6629. A new file is created to receive further log output.
  6630. </para>
  6631. <para>
  6632. If <c>maxSizeRollBackups</c> is equal to zero, then the
  6633. <c>File</c> is truncated with no backup files created.
  6634. </para>
  6635. <para>
  6636. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  6637. renamed if needed and no files are deleted.
  6638. </para>
  6639. </remarks>
  6640. </member>
  6641. <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)">
  6642. <summary>
  6643. Implements file roll.
  6644. </summary>
  6645. <param name="baseFileName">the base name to rename</param>
  6646. <remarks>
  6647. <para>
  6648. If the maximum number of size based backups is reached
  6649. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  6650. file is deleted -- its index determined by the sign of countDirection.
  6651. If <c>countDirection</c> &lt; 0, then files
  6652. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  6653. are renamed to {<c>File.2</c>, ...,
  6654. <c>File.curSizeRollBackups</c>}.
  6655. </para>
  6656. <para>
  6657. If <c>maxSizeRollBackups</c> is equal to zero, then the
  6658. <c>File</c> is truncated with no backup files created.
  6659. </para>
  6660. <para>
  6661. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  6662. renamed if needed and no files are deleted.
  6663. </para>
  6664. <para>
  6665. This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files.
  6666. </para>
  6667. </remarks>
  6668. </member>
  6669. <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
  6670. <summary>
  6671. Get the start time of the next window for the current rollpoint
  6672. </summary>
  6673. <param name="currentDateTime">the current date</param>
  6674. <param name="rollPoint">the type of roll point we are working with</param>
  6675. <returns>the start time for the next roll point an interval after the currentDateTime date</returns>
  6676. <remarks>
  6677. <para>
  6678. Returns the date of the next roll point after the currentDateTime date passed to the method.
  6679. </para>
  6680. <para>
  6681. The basic strategy is to subtract the time parts that are less significant
  6682. than the rollpoint from the current time. This should roll the time back to
  6683. the start of the time window for the current rollpoint. Then we add 1 window
  6684. worth of time and get the start time of the next window for the rollpoint.
  6685. </para>
  6686. </remarks>
  6687. </member>
  6688. <member name="F:log4net.Appender.RollingFileAppender.m_dateTime">
  6689. <summary>
  6690. This object supplies the current date/time. Allows test code to plug in
  6691. a method to control this class when testing date/time based rolling. The default
  6692. implementation uses the underlying value of DateTime.Now.
  6693. </summary>
  6694. </member>
  6695. <member name="F:log4net.Appender.RollingFileAppender.m_datePattern">
  6696. <summary>
  6697. The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c>
  6698. meaning daily rollover.
  6699. </summary>
  6700. </member>
  6701. <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename">
  6702. <summary>
  6703. The actual formatted filename that is currently being written to
  6704. or will be the file transferred to on roll over
  6705. (based on staticLogFileName).
  6706. </summary>
  6707. </member>
  6708. <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck">
  6709. <summary>
  6710. The timestamp when we shall next recompute the filename.
  6711. </summary>
  6712. </member>
  6713. <member name="F:log4net.Appender.RollingFileAppender.m_now">
  6714. <summary>
  6715. Holds date of last roll over
  6716. </summary>
  6717. </member>
  6718. <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint">
  6719. <summary>
  6720. The type of rolling done
  6721. </summary>
  6722. </member>
  6723. <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize">
  6724. <summary>
  6725. The default maximum file size is 10MB
  6726. </summary>
  6727. </member>
  6728. <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups">
  6729. <summary>
  6730. There is zero backup files by default
  6731. </summary>
  6732. </member>
  6733. <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups">
  6734. <summary>
  6735. How many sized based backups have been made so far
  6736. </summary>
  6737. </member>
  6738. <member name="F:log4net.Appender.RollingFileAppender.m_countDirection">
  6739. <summary>
  6740. The rolling file count direction.
  6741. </summary>
  6742. </member>
  6743. <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle">
  6744. <summary>
  6745. The rolling mode used in this appender.
  6746. </summary>
  6747. </member>
  6748. <member name="F:log4net.Appender.RollingFileAppender.m_rollDate">
  6749. <summary>
  6750. Cache flag set if we are rolling by date.
  6751. </summary>
  6752. </member>
  6753. <member name="F:log4net.Appender.RollingFileAppender.m_rollSize">
  6754. <summary>
  6755. Cache flag set if we are rolling by size.
  6756. </summary>
  6757. </member>
  6758. <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName">
  6759. <summary>
  6760. Value indicating whether to always log to the same file.
  6761. </summary>
  6762. </member>
  6763. <member name="F:log4net.Appender.RollingFileAppender.m_preserveLogFileNameExtension">
  6764. <summary>
  6765. Value indicating whether to preserve the file name extension when rolling.
  6766. </summary>
  6767. </member>
  6768. <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName">
  6769. <summary>
  6770. FileName provided in configuration. Used for rolling properly
  6771. </summary>
  6772. </member>
  6773. <member name="F:log4net.Appender.RollingFileAppender.m_mutexForRolling">
  6774. <summary>
  6775. A mutex that is used to lock rolling of files.
  6776. </summary>
  6777. </member>
  6778. <member name="F:log4net.Appender.RollingFileAppender.s_date1970">
  6779. <summary>
  6780. The 1st of January 1970 in UTC
  6781. </summary>
  6782. </member>
  6783. <member name="T:log4net.Appender.RollingFileAppender.IDateTime">
  6784. <summary>
  6785. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  6786. </summary>
  6787. <remarks>
  6788. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  6789. Used primarily to allow test classes to plug themselves in so they can
  6790. supply test date/times.
  6791. </remarks>
  6792. </member>
  6793. <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now">
  6794. <summary>
  6795. Gets the <i>current</i> time.
  6796. </summary>
  6797. <value>The <i>current</i> time.</value>
  6798. <remarks>
  6799. <para>
  6800. Gets the <i>current</i> time.
  6801. </para>
  6802. </remarks>
  6803. </member>
  6804. <member name="T:log4net.Appender.RollingFileAppender.LocalDateTime">
  6805. <summary>
  6806. Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time.
  6807. </summary>
  6808. </member>
  6809. <member name="P:log4net.Appender.RollingFileAppender.LocalDateTime.Now">
  6810. <summary>
  6811. Gets the <b>current</b> time.
  6812. </summary>
  6813. <value>The <b>current</b> time.</value>
  6814. <remarks>
  6815. <para>
  6816. Gets the <b>current</b> time.
  6817. </para>
  6818. </remarks>
  6819. </member>
  6820. <member name="T:log4net.Appender.RollingFileAppender.UniversalDateTime">
  6821. <summary>
  6822. Implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time as the coordinated universal time (UTC).
  6823. </summary>
  6824. </member>
  6825. <member name="P:log4net.Appender.RollingFileAppender.UniversalDateTime.Now">
  6826. <summary>
  6827. Gets the <b>current</b> time.
  6828. </summary>
  6829. <value>The <b>current</b> time.</value>
  6830. <remarks>
  6831. <para>
  6832. Gets the <b>current</b> time.
  6833. </para>
  6834. </remarks>
  6835. </member>
  6836. <member name="T:log4net.Appender.SmtpAppender">
  6837. <summary>
  6838. Send an e-mail when a specific logging event occurs, typically on errors
  6839. or fatal errors.
  6840. </summary>
  6841. <remarks>
  6842. <para>
  6843. The number of logging events delivered in this e-mail depend on
  6844. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  6845. <see cref="T:log4net.Appender.SmtpAppender"/> keeps only the last
  6846. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  6847. cyclic buffer. This keeps memory requirements at a reasonable level while
  6848. still delivering useful application context.
  6849. </para>
  6850. <note type="caution">
  6851. Authentication and setting the server Port are only available on the MS .NET 1.1 runtime.
  6852. For these features to be enabled you need to ensure that you are using a version of
  6853. the log4net assembly that is built against the MS .NET 1.1 framework and that you are
  6854. running the your application on the MS .NET 1.1 runtime. On all other platforms only sending
  6855. unauthenticated messages to a server listening on port 25 (the default) is supported.
  6856. </note>
  6857. <para>
  6858. Authentication is supported by setting the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property to
  6859. either <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> or <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  6860. If using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> authentication then the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  6861. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> properties must also be set.
  6862. </para>
  6863. <para>
  6864. To set the SMTP server port use the <see cref="P:log4net.Appender.SmtpAppender.Port"/> property. The default port is 25.
  6865. </para>
  6866. </remarks>
  6867. <author>Nicko Cadell</author>
  6868. <author>Gert Driesen</author>
  6869. </member>
  6870. <member name="M:log4net.Appender.SmtpAppender.#ctor">
  6871. <summary>
  6872. Default constructor
  6873. </summary>
  6874. <remarks>
  6875. <para>
  6876. Default constructor
  6877. </para>
  6878. </remarks>
  6879. </member>
  6880. <member name="P:log4net.Appender.SmtpAppender.To">
  6881. <summary>
  6882. 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).
  6883. </summary>
  6884. <value>
  6885. <para>
  6886. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  6887. </para>
  6888. <para>
  6889. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  6890. </para>
  6891. </value>
  6892. <remarks>
  6893. <para>
  6894. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  6895. </para>
  6896. <para>
  6897. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  6898. </para>
  6899. </remarks>
  6900. </member>
  6901. <member name="P:log4net.Appender.SmtpAppender.Cc">
  6902. <summary>
  6903. Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses
  6904. that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions).
  6905. </summary>
  6906. <value>
  6907. <para>
  6908. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  6909. </para>
  6910. <para>
  6911. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  6912. </para>
  6913. </value>
  6914. <remarks>
  6915. <para>
  6916. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  6917. </para>
  6918. <para>
  6919. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  6920. </para>
  6921. </remarks>
  6922. </member>
  6923. <member name="P:log4net.Appender.SmtpAppender.Bcc">
  6924. <summary>
  6925. Gets or sets a semicolon-delimited list of recipient e-mail addresses
  6926. that will be blind carbon copied.
  6927. </summary>
  6928. <value>
  6929. A semicolon-delimited list of e-mail addresses.
  6930. </value>
  6931. <remarks>
  6932. <para>
  6933. A semicolon-delimited list of recipient e-mail addresses.
  6934. </para>
  6935. </remarks>
  6936. </member>
  6937. <member name="P:log4net.Appender.SmtpAppender.From">
  6938. <summary>
  6939. Gets or sets the e-mail address of the sender.
  6940. </summary>
  6941. <value>
  6942. The e-mail address of the sender.
  6943. </value>
  6944. <remarks>
  6945. <para>
  6946. The e-mail address of the sender.
  6947. </para>
  6948. </remarks>
  6949. </member>
  6950. <member name="P:log4net.Appender.SmtpAppender.Subject">
  6951. <summary>
  6952. Gets or sets the subject line of the e-mail message.
  6953. </summary>
  6954. <value>
  6955. The subject line of the e-mail message.
  6956. </value>
  6957. <remarks>
  6958. <para>
  6959. The subject line of the e-mail message.
  6960. </para>
  6961. </remarks>
  6962. </member>
  6963. <member name="P:log4net.Appender.SmtpAppender.SmtpHost">
  6964. <summary>
  6965. Gets or sets the name of the SMTP relay mail server to use to send
  6966. the e-mail messages.
  6967. </summary>
  6968. <value>
  6969. The name of the e-mail relay server. If SmtpServer is not set, the
  6970. name of the local SMTP server is used.
  6971. </value>
  6972. <remarks>
  6973. <para>
  6974. The name of the e-mail relay server. If SmtpServer is not set, the
  6975. name of the local SMTP server is used.
  6976. </para>
  6977. </remarks>
  6978. </member>
  6979. <member name="P:log4net.Appender.SmtpAppender.LocationInfo">
  6980. <summary>
  6981. Obsolete
  6982. </summary>
  6983. <remarks>
  6984. Use the BufferingAppenderSkeleton Fix methods instead
  6985. </remarks>
  6986. <remarks>
  6987. <para>
  6988. Obsolete property.
  6989. </para>
  6990. </remarks>
  6991. </member>
  6992. <member name="P:log4net.Appender.SmtpAppender.Authentication">
  6993. <summary>
  6994. The mode to use to authentication with the SMTP server
  6995. </summary>
  6996. <remarks>
  6997. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  6998. <para>
  6999. Valid Authentication mode values are: <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>,
  7000. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, and <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  7001. The default value is <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>. When using
  7002. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> you must specify the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  7003. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> to use to authenticate.
  7004. When using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/> the Windows credentials for the current
  7005. thread, if impersonating, or the process will be used to authenticate.
  7006. </para>
  7007. </remarks>
  7008. </member>
  7009. <member name="P:log4net.Appender.SmtpAppender.Username">
  7010. <summary>
  7011. The username to use to authenticate with the SMTP server
  7012. </summary>
  7013. <remarks>
  7014. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7015. <para>
  7016. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7017. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7018. otherwise the username will be ignored.
  7019. </para>
  7020. </remarks>
  7021. </member>
  7022. <member name="P:log4net.Appender.SmtpAppender.Password">
  7023. <summary>
  7024. The password to use to authenticate with the SMTP server
  7025. </summary>
  7026. <remarks>
  7027. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7028. <para>
  7029. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7030. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7031. otherwise the password will be ignored.
  7032. </para>
  7033. </remarks>
  7034. </member>
  7035. <member name="P:log4net.Appender.SmtpAppender.Port">
  7036. <summary>
  7037. The port on which the SMTP server is listening
  7038. </summary>
  7039. <remarks>
  7040. <note type="caution">Server Port is only available on the MS .NET 1.1 runtime.</note>
  7041. <para>
  7042. The port on which the SMTP server is listening. The default
  7043. port is <c>25</c>. The Port can only be changed when running on
  7044. the MS .NET 1.1 runtime.
  7045. </para>
  7046. </remarks>
  7047. </member>
  7048. <member name="P:log4net.Appender.SmtpAppender.Priority">
  7049. <summary>
  7050. Gets or sets the priority of the e-mail message
  7051. </summary>
  7052. <value>
  7053. One of the <see cref="T:System.Net.Mail.MailPriority"/> values.
  7054. </value>
  7055. <remarks>
  7056. <para>
  7057. Sets the priority of the e-mails generated by this
  7058. appender. The default priority is <see cref="F:System.Net.Mail.MailPriority.Normal"/>.
  7059. </para>
  7060. <para>
  7061. If you are using this appender to report errors then
  7062. you may want to set the priority to <see cref="F:System.Net.Mail.MailPriority.High"/>.
  7063. </para>
  7064. </remarks>
  7065. </member>
  7066. <member name="P:log4net.Appender.SmtpAppender.EnableSsl">
  7067. <summary>
  7068. Enable or disable use of SSL when sending e-mail message
  7069. </summary>
  7070. <remarks>
  7071. This is available on MS .NET 2.0 runtime and higher
  7072. </remarks>
  7073. </member>
  7074. <member name="P:log4net.Appender.SmtpAppender.ReplyTo">
  7075. <summary>
  7076. Gets or sets the reply-to e-mail address.
  7077. </summary>
  7078. <remarks>
  7079. This is available on MS .NET 2.0 runtime and higher
  7080. </remarks>
  7081. </member>
  7082. <member name="P:log4net.Appender.SmtpAppender.SubjectEncoding">
  7083. <summary>
  7084. Gets or sets the subject encoding to be used.
  7085. </summary>
  7086. <remarks>
  7087. The default encoding is the operating system's current ANSI codepage.
  7088. </remarks>
  7089. </member>
  7090. <member name="P:log4net.Appender.SmtpAppender.BodyEncoding">
  7091. <summary>
  7092. Gets or sets the body encoding to be used.
  7093. </summary>
  7094. <remarks>
  7095. The default encoding is the operating system's current ANSI codepage.
  7096. </remarks>
  7097. </member>
  7098. <member name="M:log4net.Appender.SmtpAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  7099. <summary>
  7100. Sends the contents of the cyclic buffer as an e-mail message.
  7101. </summary>
  7102. <param name="events">The logging events to send.</param>
  7103. </member>
  7104. <member name="P:log4net.Appender.SmtpAppender.RequiresLayout">
  7105. <summary>
  7106. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7107. </summary>
  7108. <value><c>true</c></value>
  7109. <remarks>
  7110. <para>
  7111. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7112. </para>
  7113. </remarks>
  7114. </member>
  7115. <member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)">
  7116. <summary>
  7117. Send the email message
  7118. </summary>
  7119. <param name="messageBody">the body text to include in the mail</param>
  7120. </member>
  7121. <member name="T:log4net.Appender.SmtpAppender.SmtpAuthentication">
  7122. <summary>
  7123. Values for the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property.
  7124. </summary>
  7125. <remarks>
  7126. <para>
  7127. SMTP authentication modes.
  7128. </para>
  7129. </remarks>
  7130. </member>
  7131. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None">
  7132. <summary>
  7133. No authentication
  7134. </summary>
  7135. </member>
  7136. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic">
  7137. <summary>
  7138. Basic authentication.
  7139. </summary>
  7140. <remarks>
  7141. Requires a username and password to be supplied
  7142. </remarks>
  7143. </member>
  7144. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm">
  7145. <summary>
  7146. Integrated authentication
  7147. </summary>
  7148. <remarks>
  7149. Uses the Windows credentials from the current thread or process to authenticate.
  7150. </remarks>
  7151. </member>
  7152. <member name="M:log4net.Appender.SmtpAppender.MaybeTrimSeparators(System.String)">
  7153. <summary>
  7154. trims leading and trailing commas or semicolons
  7155. </summary>
  7156. </member>
  7157. <member name="T:log4net.Appender.SmtpPickupDirAppender">
  7158. <summary>
  7159. Send an email when a specific logging event occurs, typically on errors
  7160. or fatal errors. Rather than sending via smtp it writes a file into the
  7161. directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such
  7162. as the IIS SMTP agent to manage sending the messages.
  7163. </summary>
  7164. <remarks>
  7165. <para>
  7166. The configuration for this appender is identical to that of the <c>SMTPAppender</c>,
  7167. except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify
  7168. <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>.
  7169. </para>
  7170. <para>
  7171. The number of logging events delivered in this e-mail depend on
  7172. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  7173. <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last
  7174. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  7175. cyclic buffer. This keeps memory requirements at a reasonable level while
  7176. still delivering useful application context.
  7177. </para>
  7178. </remarks>
  7179. <author>Niall Daley</author>
  7180. <author>Nicko Cadell</author>
  7181. </member>
  7182. <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor">
  7183. <summary>
  7184. Default constructor
  7185. </summary>
  7186. <remarks>
  7187. <para>
  7188. Default constructor
  7189. </para>
  7190. </remarks>
  7191. </member>
  7192. <member name="P:log4net.Appender.SmtpPickupDirAppender.To">
  7193. <summary>
  7194. Gets or sets a semicolon-delimited list of recipient e-mail addresses.
  7195. </summary>
  7196. <value>
  7197. A semicolon-delimited list of e-mail addresses.
  7198. </value>
  7199. <remarks>
  7200. <para>
  7201. A semicolon-delimited list of e-mail addresses.
  7202. </para>
  7203. </remarks>
  7204. </member>
  7205. <member name="P:log4net.Appender.SmtpPickupDirAppender.From">
  7206. <summary>
  7207. Gets or sets the e-mail address of the sender.
  7208. </summary>
  7209. <value>
  7210. The e-mail address of the sender.
  7211. </value>
  7212. <remarks>
  7213. <para>
  7214. The e-mail address of the sender.
  7215. </para>
  7216. </remarks>
  7217. </member>
  7218. <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject">
  7219. <summary>
  7220. Gets or sets the subject line of the e-mail message.
  7221. </summary>
  7222. <value>
  7223. The subject line of the e-mail message.
  7224. </value>
  7225. <remarks>
  7226. <para>
  7227. The subject line of the e-mail message.
  7228. </para>
  7229. </remarks>
  7230. </member>
  7231. <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir">
  7232. <summary>
  7233. Gets or sets the path to write the messages to.
  7234. </summary>
  7235. <remarks>
  7236. <para>
  7237. Gets or sets the path to write the messages to. This should be the same
  7238. as that used by the agent sending the messages.
  7239. </para>
  7240. </remarks>
  7241. </member>
  7242. <member name="P:log4net.Appender.SmtpPickupDirAppender.FileExtension">
  7243. <summary>
  7244. Gets or sets the file extension for the generated files
  7245. </summary>
  7246. <value>
  7247. The file extension for the generated files
  7248. </value>
  7249. <remarks>
  7250. <para>
  7251. The file extension for the generated files
  7252. </para>
  7253. </remarks>
  7254. </member>
  7255. <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext">
  7256. <summary>
  7257. Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  7258. </summary>
  7259. <value>
  7260. The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  7261. </value>
  7262. <remarks>
  7263. <para>
  7264. Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender
  7265. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  7266. security context to use. The default behavior is to use the security context
  7267. of the current thread.
  7268. </para>
  7269. </remarks>
  7270. </member>
  7271. <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  7272. <summary>
  7273. Sends the contents of the cyclic buffer as an e-mail message.
  7274. </summary>
  7275. <param name="events">The logging events to send.</param>
  7276. <remarks>
  7277. <para>
  7278. Sends the contents of the cyclic buffer as an e-mail message.
  7279. </para>
  7280. </remarks>
  7281. </member>
  7282. <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions">
  7283. <summary>
  7284. Activate the options on this appender.
  7285. </summary>
  7286. <remarks>
  7287. <para>
  7288. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  7289. activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must
  7290. be called on this object after the configuration properties have
  7291. been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this
  7292. object is in an undefined state and must not be used.
  7293. </para>
  7294. <para>
  7295. If any of the configuration properties are modified then
  7296. <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again.
  7297. </para>
  7298. </remarks>
  7299. </member>
  7300. <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout">
  7301. <summary>
  7302. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7303. </summary>
  7304. <value><c>true</c></value>
  7305. <remarks>
  7306. <para>
  7307. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7308. </para>
  7309. </remarks>
  7310. </member>
  7311. <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)">
  7312. <summary>
  7313. Convert a path into a fully qualified path.
  7314. </summary>
  7315. <param name="path">The path to convert.</param>
  7316. <returns>The fully qualified path.</returns>
  7317. <remarks>
  7318. <para>
  7319. Converts the path specified to a fully
  7320. qualified path. If the path is relative it is
  7321. taken as relative from the application base
  7322. directory.
  7323. </para>
  7324. </remarks>
  7325. </member>
  7326. <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext">
  7327. <summary>
  7328. The security context to use for privileged calls
  7329. </summary>
  7330. </member>
  7331. <member name="T:log4net.Appender.TelnetAppender">
  7332. <summary>
  7333. Appender that allows clients to connect via Telnet to receive log messages
  7334. </summary>
  7335. <remarks>
  7336. <para>
  7337. The TelnetAppender accepts socket connections and streams logging messages
  7338. back to the client.
  7339. The output is provided in a telnet-friendly way so that a log can be monitored
  7340. over a TCP/IP socket.
  7341. This allows simple remote monitoring of application logging.
  7342. </para>
  7343. <para>
  7344. The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port).
  7345. </para>
  7346. </remarks>
  7347. <author>Keith Long</author>
  7348. <author>Nicko Cadell</author>
  7349. </member>
  7350. <member name="M:log4net.Appender.TelnetAppender.#ctor">
  7351. <summary>
  7352. Default constructor
  7353. </summary>
  7354. <remarks>
  7355. <para>
  7356. Default constructor
  7357. </para>
  7358. </remarks>
  7359. </member>
  7360. <member name="F:log4net.Appender.TelnetAppender.declaringType">
  7361. <summary>
  7362. The fully qualified type of the TelnetAppender class.
  7363. </summary>
  7364. <remarks>
  7365. Used by the internal logger to record the Type of the
  7366. log message.
  7367. </remarks>
  7368. </member>
  7369. <member name="P:log4net.Appender.TelnetAppender.Port">
  7370. <summary>
  7371. Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  7372. </summary>
  7373. <value>
  7374. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  7375. indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  7376. </value>
  7377. <remarks>
  7378. <para>
  7379. The default value is 23 (the telnet port).
  7380. </para>
  7381. </remarks>
  7382. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort" />
  7383. or greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
  7384. </member>
  7385. <member name="M:log4net.Appender.TelnetAppender.OnClose">
  7386. <summary>
  7387. Overrides the parent method to close the socket handler
  7388. </summary>
  7389. <remarks>
  7390. <para>
  7391. Closes all the outstanding connections.
  7392. </para>
  7393. </remarks>
  7394. </member>
  7395. <member name="P:log4net.Appender.TelnetAppender.RequiresLayout">
  7396. <summary>
  7397. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7398. </summary>
  7399. <value><c>true</c></value>
  7400. <remarks>
  7401. <para>
  7402. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7403. </para>
  7404. </remarks>
  7405. </member>
  7406. <member name="M:log4net.Appender.TelnetAppender.ActivateOptions">
  7407. <summary>
  7408. Initialize the appender based on the options set.
  7409. </summary>
  7410. <remarks>
  7411. <para>
  7412. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  7413. activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must
  7414. be called on this object after the configuration properties have
  7415. been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this
  7416. object is in an undefined state and must not be used.
  7417. </para>
  7418. <para>
  7419. If any of the configuration properties are modified then
  7420. <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again.
  7421. </para>
  7422. <para>
  7423. Create the socket handler and wait for connections
  7424. </para>
  7425. </remarks>
  7426. </member>
  7427. <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)">
  7428. <summary>
  7429. Writes the logging event to each connected client.
  7430. </summary>
  7431. <param name="loggingEvent">The event to log.</param>
  7432. <remarks>
  7433. <para>
  7434. Writes the logging event to each connected client.
  7435. </para>
  7436. </remarks>
  7437. </member>
  7438. <member name="T:log4net.Appender.TelnetAppender.SocketHandler">
  7439. <summary>
  7440. Helper class to manage connected clients
  7441. </summary>
  7442. <remarks>
  7443. <para>
  7444. The SocketHandler class is used to accept connections from
  7445. clients. It is threaded so that clients can connect/disconnect
  7446. asynchronously.
  7447. </para>
  7448. </remarks>
  7449. </member>
  7450. <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient">
  7451. <summary>
  7452. Class that represents a client connected to this handler
  7453. </summary>
  7454. <remarks>
  7455. <para>
  7456. Class that represents a client connected to this handler
  7457. </para>
  7458. </remarks>
  7459. </member>
  7460. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)">
  7461. <summary>
  7462. Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/>
  7463. </summary>
  7464. <param name="socket">the client's socket</param>
  7465. <remarks>
  7466. <para>
  7467. Opens a stream writer on the socket.
  7468. </para>
  7469. </remarks>
  7470. </member>
  7471. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)">
  7472. <summary>
  7473. Write a string to the client
  7474. </summary>
  7475. <param name="message">string to send</param>
  7476. <remarks>
  7477. <para>
  7478. Write a string to the client
  7479. </para>
  7480. </remarks>
  7481. </member>
  7482. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose">
  7483. <summary>
  7484. Cleanup the clients connection
  7485. </summary>
  7486. <remarks>
  7487. <para>
  7488. Close the socket connection.
  7489. </para>
  7490. </remarks>
  7491. </member>
  7492. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)">
  7493. <summary>
  7494. Opens a new server port on <paramref ref="port"/>
  7495. </summary>
  7496. <param name="port">the local port to listen on for connections</param>
  7497. <remarks>
  7498. <para>
  7499. Creates a socket handler on the specified local server port.
  7500. </para>
  7501. </remarks>
  7502. </member>
  7503. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)">
  7504. <summary>
  7505. Sends a string message to each of the connected clients
  7506. </summary>
  7507. <param name="message">the text to send</param>
  7508. <remarks>
  7509. <para>
  7510. Sends a string message to each of the connected clients
  7511. </para>
  7512. </remarks>
  7513. </member>
  7514. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  7515. <summary>
  7516. Add a client to the internal clients list
  7517. </summary>
  7518. <param name="client">client to add</param>
  7519. </member>
  7520. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  7521. <summary>
  7522. Remove a client from the internal clients list
  7523. </summary>
  7524. <param name="client">client to remove</param>
  7525. </member>
  7526. <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections">
  7527. <summary>
  7528. Test if this handler has active connections
  7529. </summary>
  7530. <value>
  7531. <c>true</c> if this handler has active connections
  7532. </value>
  7533. <remarks>
  7534. <para>
  7535. This property will be <c>true</c> while this handler has
  7536. active connections, that is at least one connection that
  7537. the handler will attempt to send a message to.
  7538. </para>
  7539. </remarks>
  7540. </member>
  7541. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.OnConnect(System.IAsyncResult)">
  7542. <summary>
  7543. Callback used to accept a connection on the server socket
  7544. </summary>
  7545. <param name="asyncResult">The result of the asynchronous operation</param>
  7546. <remarks>
  7547. <para>
  7548. On connection adds to the list of connections
  7549. if there are two many open connections you will be disconnected
  7550. </para>
  7551. </remarks>
  7552. </member>
  7553. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose">
  7554. <summary>
  7555. Close all network connections
  7556. </summary>
  7557. <remarks>
  7558. <para>
  7559. Make sure we close all network connections
  7560. </para>
  7561. </remarks>
  7562. </member>
  7563. <member name="T:log4net.Appender.TextWriterAppender">
  7564. <summary>
  7565. Sends logging events to a <see cref="T:System.IO.TextWriter"/>.
  7566. </summary>
  7567. <remarks>
  7568. <para>
  7569. An Appender that writes to a <see cref="T:System.IO.TextWriter"/>.
  7570. </para>
  7571. <para>
  7572. This appender may be used stand alone if initialized with an appropriate
  7573. writer, however it is typically used as a base class for an appender that
  7574. can open a <see cref="T:System.IO.TextWriter"/> to write to.
  7575. </para>
  7576. </remarks>
  7577. <author>Nicko Cadell</author>
  7578. <author>Gert Driesen</author>
  7579. <author>Douglas de la Torre</author>
  7580. </member>
  7581. <member name="M:log4net.Appender.TextWriterAppender.#ctor">
  7582. <summary>
  7583. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class.
  7584. </summary>
  7585. <remarks>
  7586. <para>
  7587. Default constructor.
  7588. </para>
  7589. </remarks>
  7590. </member>
  7591. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)">
  7592. <summary>
  7593. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class and
  7594. sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized
  7595. with the specified <see cref="T:System.IO.Stream"/>.
  7596. </summary>
  7597. <param name="layout">The layout to use with this appender.</param>
  7598. <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param>
  7599. <remarks>
  7600. <para>
  7601. Obsolete constructor.
  7602. </para>
  7603. </remarks>
  7604. </member>
  7605. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)">
  7606. <summary>
  7607. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class and sets
  7608. the output destination to the specified <see cref="T:System.IO.StreamWriter" />.
  7609. </summary>
  7610. <param name="layout">The layout to use with this appender</param>
  7611. <param name="writer">The <see cref="T:System.IO.TextWriter" /> to output to</param>
  7612. <remarks>
  7613. The <see cref="T:System.IO.TextWriter" /> must have been previously opened.
  7614. </remarks>
  7615. <remarks>
  7616. <para>
  7617. Obsolete constructor.
  7618. </para>
  7619. </remarks>
  7620. </member>
  7621. <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush">
  7622. <summary>
  7623. Gets or set whether the appender will flush at the end
  7624. of each append operation.
  7625. </summary>
  7626. <value>
  7627. <para>
  7628. The default behavior is to flush at the end of each
  7629. append operation.
  7630. </para>
  7631. <para>
  7632. If this option is set to <c>false</c>, then the underlying
  7633. stream can defer persisting the logging event to a later
  7634. time.
  7635. </para>
  7636. </value>
  7637. <remarks>
  7638. Avoiding the flush operation at the end of each append results in
  7639. a performance gain of 10 to 20 percent. However, there is safety
  7640. trade-off involved in skipping flushing. Indeed, when flushing is
  7641. skipped, then it is likely that the last few log events will not
  7642. be recorded on disk when the application exits. This is a high
  7643. price to pay even for a 20% performance gain.
  7644. </remarks>
  7645. </member>
  7646. <member name="P:log4net.Appender.TextWriterAppender.Writer">
  7647. <summary>
  7648. Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go.
  7649. </summary>
  7650. <remarks>
  7651. <para>
  7652. The specified <see cref="T:System.IO.TextWriter"/> must be open and writable.
  7653. </para>
  7654. <para>
  7655. The <see cref="T:System.IO.TextWriter"/> will be closed when the appender
  7656. instance is closed.
  7657. </para>
  7658. <para>
  7659. <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail.
  7660. </para>
  7661. </remarks>
  7662. </member>
  7663. <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck">
  7664. <summary>
  7665. This method determines if there is a sense in attempting to append.
  7666. </summary>
  7667. <remarks>
  7668. <para>
  7669. This method checks if an output target has been set and if a
  7670. layout has been set.
  7671. </para>
  7672. </remarks>
  7673. <returns><c>false</c> if any of the preconditions fail.</returns>
  7674. </member>
  7675. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)">
  7676. <summary>
  7677. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  7678. method.
  7679. </summary>
  7680. <param name="loggingEvent">The event to log.</param>
  7681. <remarks>
  7682. <para>
  7683. Writes a log statement to the output stream if the output stream exists
  7684. and is writable.
  7685. </para>
  7686. <para>
  7687. The format of the output will depend on the appender's layout.
  7688. </para>
  7689. </remarks>
  7690. </member>
  7691. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
  7692. <summary>
  7693. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  7694. method.
  7695. </summary>
  7696. <param name="loggingEvents">The array of events to log.</param>
  7697. <remarks>
  7698. <para>
  7699. This method writes all the bulk logged events to the output writer
  7700. before flushing the stream.
  7701. </para>
  7702. </remarks>
  7703. </member>
  7704. <member name="M:log4net.Appender.TextWriterAppender.OnClose">
  7705. <summary>
  7706. Close this appender instance. The underlying stream or writer is also closed.
  7707. </summary>
  7708. <remarks>
  7709. Closed appenders cannot be reused.
  7710. </remarks>
  7711. </member>
  7712. <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler">
  7713. <summary>
  7714. Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying
  7715. <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender.
  7716. </summary>
  7717. <value>
  7718. The <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  7719. </value>
  7720. </member>
  7721. <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout">
  7722. <summary>
  7723. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7724. </summary>
  7725. <value><c>true</c></value>
  7726. <remarks>
  7727. <para>
  7728. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7729. </para>
  7730. </remarks>
  7731. </member>
  7732. <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter">
  7733. <summary>
  7734. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  7735. </summary>
  7736. <remarks>
  7737. <para>
  7738. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  7739. </para>
  7740. </remarks>
  7741. </member>
  7742. <member name="M:log4net.Appender.TextWriterAppender.CloseWriter">
  7743. <summary>
  7744. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  7745. </summary>
  7746. <remarks>
  7747. <para>
  7748. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  7749. </para>
  7750. </remarks>
  7751. </member>
  7752. <member name="M:log4net.Appender.TextWriterAppender.Reset">
  7753. <summary>
  7754. Clears internal references to the underlying <see cref="T:System.IO.TextWriter" />
  7755. and other variables.
  7756. </summary>
  7757. <remarks>
  7758. <para>
  7759. Subclasses can override this method for an alternate closing behavior.
  7760. </para>
  7761. </remarks>
  7762. </member>
  7763. <member name="M:log4net.Appender.TextWriterAppender.WriteFooter">
  7764. <summary>
  7765. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  7766. </summary>
  7767. <remarks>
  7768. <para>
  7769. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  7770. </para>
  7771. </remarks>
  7772. </member>
  7773. <member name="M:log4net.Appender.TextWriterAppender.WriteHeader">
  7774. <summary>
  7775. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  7776. </summary>
  7777. <remarks>
  7778. <para>
  7779. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  7780. </para>
  7781. </remarks>
  7782. </member>
  7783. <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter">
  7784. <summary>
  7785. Called to allow a subclass to lazily initialize the writer
  7786. </summary>
  7787. <remarks>
  7788. <para>
  7789. This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or
  7790. <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to
  7791. attempt to initialize the writer multiple times.
  7792. </para>
  7793. </remarks>
  7794. </member>
  7795. <member name="P:log4net.Appender.TextWriterAppender.QuietWriter">
  7796. <summary>
  7797. Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  7798. will be written to.
  7799. </summary>
  7800. <value>
  7801. The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written.
  7802. </value>
  7803. <remarks>
  7804. <para>
  7805. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  7806. will be written to.
  7807. </para>
  7808. </remarks>
  7809. </member>
  7810. <member name="F:log4net.Appender.TextWriterAppender.m_qtw">
  7811. <summary>
  7812. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  7813. will be written to.
  7814. </summary>
  7815. </member>
  7816. <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush">
  7817. <summary>
  7818. Immediate flush means that the underlying <see cref="T:System.IO.TextWriter" />
  7819. or output stream will be flushed at the end of each append operation.
  7820. </summary>
  7821. <remarks>
  7822. <para>
  7823. Immediate flush is slower but ensures that each append request is
  7824. actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to
  7825. <c>false</c>, then there is a good chance that the last few
  7826. logging events are not actually persisted if and when the application
  7827. crashes.
  7828. </para>
  7829. <para>
  7830. The default value is <c>true</c>.
  7831. </para>
  7832. </remarks>
  7833. </member>
  7834. <member name="F:log4net.Appender.TextWriterAppender.declaringType">
  7835. <summary>
  7836. The fully qualified type of the TextWriterAppender class.
  7837. </summary>
  7838. <remarks>
  7839. Used by the internal logger to record the Type of the
  7840. log message.
  7841. </remarks>
  7842. </member>
  7843. <member name="M:log4net.Appender.TextWriterAppender.Flush(System.Int32)">
  7844. <summary>
  7845. Flushes any buffered log data.
  7846. </summary>
  7847. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  7848. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  7849. </member>
  7850. <member name="T:log4net.Appender.TraceAppender">
  7851. <summary>
  7852. Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system.
  7853. </summary>
  7854. <remarks>
  7855. <para>
  7856. The application configuration file can be used to control what listeners
  7857. are actually used. See the MSDN documentation for the
  7858. <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the
  7859. trace system.
  7860. </para>
  7861. <para>
  7862. Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c>
  7863. method. The event's logger name is the default value for the category parameter
  7864. of the Write method.
  7865. </para>
  7866. <para>
  7867. <b>Compact Framework</b><br />
  7868. The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/>
  7869. class for any operation except <c>Assert</c>. When using the Compact Framework this
  7870. appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than
  7871. the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>.
  7872. </para>
  7873. </remarks>
  7874. <author>Douglas de la Torre</author>
  7875. <author>Nicko Cadell</author>
  7876. <author>Gert Driesen</author>
  7877. <author>Ron Grabowski</author>
  7878. </member>
  7879. <member name="M:log4net.Appender.TraceAppender.#ctor">
  7880. <summary>
  7881. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender" />.
  7882. </summary>
  7883. <remarks>
  7884. <para>
  7885. Default constructor.
  7886. </para>
  7887. </remarks>
  7888. </member>
  7889. <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)">
  7890. <summary>
  7891. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender" />
  7892. with a specified layout.
  7893. </summary>
  7894. <param name="layout">The layout to use with this appender.</param>
  7895. <remarks>
  7896. <para>
  7897. Obsolete constructor.
  7898. </para>
  7899. </remarks>
  7900. </member>
  7901. <member name="P:log4net.Appender.TraceAppender.ImmediateFlush">
  7902. <summary>
  7903. Gets or sets a value that indicates whether the appender will
  7904. flush at the end of each write.
  7905. </summary>
  7906. <remarks>
  7907. <para>The default behavior is to flush at the end of each
  7908. write. If the option is set to<c>false</c>, then the underlying
  7909. stream can defer writing to physical medium to a later time.
  7910. </para>
  7911. <para>
  7912. Avoiding the flush operation at the end of each append results
  7913. in a performance gain of 10 to 20 percent. However, there is safety
  7914. trade-off involved in skipping flushing. Indeed, when flushing is
  7915. skipped, then it is likely that the last few log events will not
  7916. be recorded on disk when the application exits. This is a high
  7917. price to pay even for a 20% performance gain.
  7918. </para>
  7919. </remarks>
  7920. </member>
  7921. <member name="P:log4net.Appender.TraceAppender.Category">
  7922. <summary>
  7923. The category parameter sent to the Trace method.
  7924. </summary>
  7925. <remarks>
  7926. <para>
  7927. Defaults to %logger which will use the logger name of the current
  7928. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  7929. </para>
  7930. <para>
  7931. </para>
  7932. </remarks>
  7933. </member>
  7934. <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)">
  7935. <summary>
  7936. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  7937. </summary>
  7938. <param name="loggingEvent">The event to log.</param>
  7939. <remarks>
  7940. <para>
  7941. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  7942. </para>
  7943. </remarks>
  7944. </member>
  7945. <member name="P:log4net.Appender.TraceAppender.RequiresLayout">
  7946. <summary>
  7947. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7948. </summary>
  7949. <value><c>true</c></value>
  7950. <remarks>
  7951. <para>
  7952. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7953. </para>
  7954. </remarks>
  7955. </member>
  7956. <member name="F:log4net.Appender.TraceAppender.m_immediateFlush">
  7957. <summary>
  7958. Immediate flush means that the underlying writer or output stream
  7959. will be flushed at the end of each append operation.
  7960. </summary>
  7961. <remarks>
  7962. <para>
  7963. Immediate flush is slower but ensures that each append request is
  7964. actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to
  7965. <c>false</c>, then there is a good chance that the last few
  7966. logs events are not actually written to persistent media if and
  7967. when the application crashes.
  7968. </para>
  7969. <para>
  7970. The default value is <c>true</c>.</para>
  7971. </remarks>
  7972. </member>
  7973. <member name="F:log4net.Appender.TraceAppender.m_category">
  7974. <summary>
  7975. Defaults to %logger
  7976. </summary>
  7977. </member>
  7978. <member name="M:log4net.Appender.TraceAppender.Flush(System.Int32)">
  7979. <summary>
  7980. Flushes any buffered log data.
  7981. </summary>
  7982. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  7983. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  7984. </member>
  7985. <member name="T:log4net.Appender.UdpAppender">
  7986. <summary>
  7987. Sends logging events as connectionless UDP datagrams to a remote host or a
  7988. multicast group using an <see cref="T:System.Net.Sockets.UdpClient" />.
  7989. </summary>
  7990. <remarks>
  7991. <para>
  7992. UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
  7993. </para>
  7994. <para>
  7995. To view the logging results, a custom application can be developed that listens for logging
  7996. events.
  7997. </para>
  7998. <para>
  7999. When decoding events send via this appender remember to use the same encoding
  8000. to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
  8001. property to specify the encoding to use.
  8002. </para>
  8003. </remarks>
  8004. <example>
  8005. This example shows how to log receive logging events that are sent
  8006. on IP address 244.0.0.1 and port 8080 to the console. The event is
  8007. encoded in the packet as a unicode string and it is decoded as such.
  8008. <code lang="C#">
  8009. IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
  8010. UdpClient udpClient;
  8011. byte[] buffer;
  8012. string loggingEvent;
  8013. try
  8014. {
  8015. udpClient = new UdpClient(8080);
  8016. while(true)
  8017. {
  8018. buffer = udpClient.Receive(ref remoteEndPoint);
  8019. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
  8020. Console.WriteLine(loggingEvent);
  8021. }
  8022. }
  8023. catch(Exception e)
  8024. {
  8025. Console.WriteLine(e.ToString());
  8026. }
  8027. </code>
  8028. <code lang="Visual Basic">
  8029. Dim remoteEndPoint as IPEndPoint
  8030. Dim udpClient as UdpClient
  8031. Dim buffer as Byte()
  8032. Dim loggingEvent as String
  8033. Try
  8034. remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
  8035. udpClient = new UdpClient(8080)
  8036. While True
  8037. buffer = udpClient.Receive(ByRef remoteEndPoint)
  8038. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
  8039. Console.WriteLine(loggingEvent)
  8040. Wend
  8041. Catch e As Exception
  8042. Console.WriteLine(e.ToString())
  8043. End Try
  8044. </code>
  8045. <para>
  8046. An example configuration section to log information using this appender to the
  8047. IP 224.0.0.1 on port 8080:
  8048. </para>
  8049. <code lang="XML" escaped="true">
  8050. <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
  8051. <remoteAddress value="224.0.0.1" />
  8052. <remotePort value="8080" />
  8053. <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline" />
  8054. </appender>
  8055. </code>
  8056. </example>
  8057. <author>Gert Driesen</author>
  8058. <author>Nicko Cadell</author>
  8059. </member>
  8060. <member name="M:log4net.Appender.UdpAppender.#ctor">
  8061. <summary>
  8062. Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender" /> class.
  8063. </summary>
  8064. <remarks>
  8065. The default constructor initializes all fields to their default values.
  8066. </remarks>
  8067. </member>
  8068. <member name="P:log4net.Appender.UdpAppender.RemoteAddress">
  8069. <summary>
  8070. Gets or sets the IP address of the remote host or multicast group to which
  8071. the underlying <see cref="T:System.Net.Sockets.UdpClient" /> should sent the logging event.
  8072. </summary>
  8073. <value>
  8074. The IP address of the remote host or multicast group to which the logging event
  8075. will be sent.
  8076. </value>
  8077. <remarks>
  8078. <para>
  8079. Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to
  8080. 239.255.255.255). Multicast packets can pass across different networks through routers, so
  8081. it is possible to use multicasts in an Internet scenario as long as your network provider
  8082. supports multicasting.
  8083. </para>
  8084. <para>
  8085. Hosts that want to receive particular multicast messages must register their interest by joining
  8086. the multicast group. Multicast messages are not sent to networks where no host has joined
  8087. the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate
  8088. them from normal host addresses, allowing nodes to easily detect if a message is of interest.
  8089. </para>
  8090. <para>
  8091. Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below:
  8092. </para>
  8093. <para>
  8094. <list type="table">
  8095. <listheader>
  8096. <term>IP Address</term>
  8097. <description>Description</description>
  8098. </listheader>
  8099. <item>
  8100. <term>224.0.0.1</term>
  8101. <description>
  8102. <para>
  8103. Sends a message to all system on the subnet.
  8104. </para>
  8105. </description>
  8106. </item>
  8107. <item>
  8108. <term>224.0.0.2</term>
  8109. <description>
  8110. <para>
  8111. Sends a message to all routers on the subnet.
  8112. </para>
  8113. </description>
  8114. </item>
  8115. <item>
  8116. <term>224.0.0.12</term>
  8117. <description>
  8118. <para>
  8119. The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet.
  8120. </para>
  8121. </description>
  8122. </item>
  8123. </list>
  8124. </para>
  8125. <para>
  8126. A complete list of actually reserved multicast addresses and their owners in the ranges
  8127. defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>.
  8128. </para>
  8129. <para>
  8130. The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative
  8131. addresses. These addresses can be reused with other local groups. Routers are typically
  8132. configured with filters to prevent multicast traffic in this range from flowing outside
  8133. of the local network.
  8134. </para>
  8135. </remarks>
  8136. </member>
  8137. <member name="P:log4net.Appender.UdpAppender.RemotePort">
  8138. <summary>
  8139. Gets or sets the TCP port number of the remote host or multicast group to which
  8140. the underlying <see cref="T:System.Net.Sockets.UdpClient" /> should sent the logging event.
  8141. </summary>
  8142. <value>
  8143. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  8144. indicating the TCP port number of the remote host or multicast group to which the logging event
  8145. will be sent.
  8146. </value>
  8147. <remarks>
  8148. The underlying <see cref="T:System.Net.Sockets.UdpClient" /> will send messages to this TCP port number
  8149. on the remote host or multicast group.
  8150. </remarks>
  8151. <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>
  8152. </member>
  8153. <member name="P:log4net.Appender.UdpAppender.LocalPort">
  8154. <summary>
  8155. Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  8156. </summary>
  8157. <value>
  8158. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  8159. indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  8160. </value>
  8161. <remarks>
  8162. <para>
  8163. The underlying <see cref="T:System.Net.Sockets.UdpClient" /> will bind to this port for sending messages.
  8164. </para>
  8165. <para>
  8166. Setting the value to 0 (the default) will cause the udp client not to bind to
  8167. a local port.
  8168. </para>
  8169. </remarks>
  8170. <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>
  8171. </member>
  8172. <member name="P:log4net.Appender.UdpAppender.Encoding">
  8173. <summary>
  8174. Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  8175. </summary>
  8176. <value>
  8177. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  8178. </value>
  8179. <remarks>
  8180. <para>
  8181. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  8182. </para>
  8183. </remarks>
  8184. </member>
  8185. <member name="P:log4net.Appender.UdpAppender.Client">
  8186. <summary>
  8187. Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient" />.
  8188. </summary>
  8189. <value>
  8190. The underlying <see cref="T:System.Net.Sockets.UdpClient" />.
  8191. </value>
  8192. <remarks>
  8193. <see cref="T:log4net.Appender.UdpAppender" /> creates a <see cref="T:System.Net.Sockets.UdpClient" /> to send logging events
  8194. over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender" /> can use this
  8195. property to get or set this <see cref="T:System.Net.Sockets.UdpClient" />. Use the underlying <see cref="T:System.Net.Sockets.UdpClient" />
  8196. returned from <see cref="P:log4net.Appender.UdpAppender.Client" /> if you require access beyond that which
  8197. <see cref="T:log4net.Appender.UdpAppender" /> provides.
  8198. </remarks>
  8199. </member>
  8200. <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint">
  8201. <summary>
  8202. Gets or sets the cached remote endpoint to which the logging events should be sent.
  8203. </summary>
  8204. <value>
  8205. The cached remote endpoint to which the logging events will be sent.
  8206. </value>
  8207. <remarks>
  8208. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions" /> method will initialize the remote endpoint
  8209. with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/>
  8210. properties.
  8211. </remarks>
  8212. </member>
  8213. <member name="M:log4net.Appender.UdpAppender.ActivateOptions">
  8214. <summary>
  8215. Initialize the appender based on the options set.
  8216. </summary>
  8217. <remarks>
  8218. <para>
  8219. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  8220. activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must
  8221. be called on this object after the configuration properties have
  8222. been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this
  8223. object is in an undefined state and must not be used.
  8224. </para>
  8225. <para>
  8226. If any of the configuration properties are modified then
  8227. <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again.
  8228. </para>
  8229. <para>
  8230. The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> was specified or
  8231. an invalid remote or local TCP port number was specified.
  8232. </para>
  8233. </remarks>
  8234. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> was not specified.</exception>
  8235. <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>
  8236. </member>
  8237. <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)">
  8238. <summary>
  8239. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  8240. </summary>
  8241. <param name="loggingEvent">The event to log.</param>
  8242. <remarks>
  8243. <para>
  8244. Sends the event using an UDP datagram.
  8245. </para>
  8246. <para>
  8247. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  8248. </para>
  8249. </remarks>
  8250. </member>
  8251. <member name="P:log4net.Appender.UdpAppender.RequiresLayout">
  8252. <summary>
  8253. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8254. </summary>
  8255. <value><c>true</c></value>
  8256. <remarks>
  8257. <para>
  8258. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8259. </para>
  8260. </remarks>
  8261. </member>
  8262. <member name="M:log4net.Appender.UdpAppender.OnClose">
  8263. <summary>
  8264. Closes the UDP connection and releases all resources associated with
  8265. this <see cref="T:log4net.Appender.UdpAppender" /> instance.
  8266. </summary>
  8267. <remarks>
  8268. <para>
  8269. Disables the underlying <see cref="T:System.Net.Sockets.UdpClient" /> and releases all managed
  8270. and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender" />.
  8271. </para>
  8272. </remarks>
  8273. </member>
  8274. <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection">
  8275. <summary>
  8276. Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient" /> connection.
  8277. </summary>
  8278. <remarks>
  8279. <para>
  8280. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the
  8281. port number from which you intend to communicate.
  8282. </para>
  8283. <para>
  8284. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  8285. </para>
  8286. </remarks>
  8287. </member>
  8288. <member name="F:log4net.Appender.UdpAppender.m_remoteAddress">
  8289. <summary>
  8290. The IP address of the remote host or multicast group to which
  8291. the logging event will be sent.
  8292. </summary>
  8293. </member>
  8294. <member name="F:log4net.Appender.UdpAppender.m_remotePort">
  8295. <summary>
  8296. The TCP port number of the remote host or multicast group to
  8297. which the logging event will be sent.
  8298. </summary>
  8299. </member>
  8300. <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint">
  8301. <summary>
  8302. The cached remote endpoint to which the logging events will be sent.
  8303. </summary>
  8304. </member>
  8305. <member name="F:log4net.Appender.UdpAppender.m_localPort">
  8306. <summary>
  8307. The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  8308. </summary>
  8309. </member>
  8310. <member name="F:log4net.Appender.UdpAppender.m_client">
  8311. <summary>
  8312. The <see cref="T:System.Net.Sockets.UdpClient" /> instance that will be used for sending the
  8313. logging events.
  8314. </summary>
  8315. </member>
  8316. <member name="F:log4net.Appender.UdpAppender.m_encoding">
  8317. <summary>
  8318. The encoding to use for the packet.
  8319. </summary>
  8320. </member>
  8321. <member name="T:log4net.Config.AliasDomainAttribute">
  8322. <summary>
  8323. Assembly level attribute that specifies a domain to alias to this assembly's repository.
  8324. </summary>
  8325. <remarks>
  8326. <para>
  8327. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  8328. </para>
  8329. <para>
  8330. An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>,
  8331. however this can be overridden by an assembly loaded before the target assembly.
  8332. </para>
  8333. <para>
  8334. An assembly can alias another assembly's domain to its repository by
  8335. specifying this attribute with the name of the target domain.
  8336. </para>
  8337. <para>
  8338. This attribute can only be specified on the assembly and may be used
  8339. as many times as necessary to alias all the required domains.
  8340. </para>
  8341. </remarks>
  8342. <author>Nicko Cadell</author>
  8343. <author>Gert Driesen</author>
  8344. </member>
  8345. <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)">
  8346. <summary>
  8347. Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute" /> class with
  8348. the specified domain to alias to this assembly's repository.
  8349. </summary>
  8350. <param name="name">The domain to alias to this assemby's repository.</param>
  8351. <remarks>
  8352. <para>
  8353. Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>.
  8354. </para>
  8355. </remarks>
  8356. </member>
  8357. <member name="T:log4net.Config.AliasRepositoryAttribute">
  8358. <summary>
  8359. Assembly level attribute that specifies a repository to alias to this assembly's repository.
  8360. </summary>
  8361. <remarks>
  8362. <para>
  8363. An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>,
  8364. however this can be overridden by an assembly loaded before the target assembly.
  8365. </para>
  8366. <para>
  8367. An assembly can alias another assembly's repository to its repository by
  8368. specifying this attribute with the name of the target repository.
  8369. </para>
  8370. <para>
  8371. This attribute can only be specified on the assembly and may be used
  8372. as many times as necessary to alias all the required repositories.
  8373. </para>
  8374. </remarks>
  8375. <author>Nicko Cadell</author>
  8376. <author>Gert Driesen</author>
  8377. </member>
  8378. <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)">
  8379. <summary>
  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. </summary>
  8383. <param name="name">The repository to alias to this assemby's repository.</param>
  8384. <remarks>
  8385. <para>
  8386. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute" /> class with
  8387. the specified repository to alias to this assembly's repository.
  8388. </para>
  8389. </remarks>
  8390. </member>
  8391. <member name="P:log4net.Config.AliasRepositoryAttribute.Name">
  8392. <summary>
  8393. Gets or sets the repository to alias to this assemby's repository.
  8394. </summary>
  8395. <value>
  8396. The repository to alias to this assemby's repository.
  8397. </value>
  8398. <remarks>
  8399. <para>
  8400. The name of the repository to alias to this assemby's repository.
  8401. </para>
  8402. </remarks>
  8403. </member>
  8404. <member name="T:log4net.Config.BasicConfigurator">
  8405. <summary>
  8406. Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  8407. </summary>
  8408. <remarks>
  8409. <para>
  8410. Allows very simple programmatic configuration of log4net.
  8411. </para>
  8412. <para>
  8413. Only one appender can be configured using this configurator.
  8414. The appender is set at the root of the hierarchy and all logging
  8415. events will be delivered to that appender.
  8416. </para>
  8417. <para>
  8418. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  8419. they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions()"/> method
  8420. be called after the appenders properties have been configured.
  8421. </para>
  8422. </remarks>
  8423. <author>Nicko Cadell</author>
  8424. <author>Gert Driesen</author>
  8425. </member>
  8426. <member name="F:log4net.Config.BasicConfigurator.declaringType">
  8427. <summary>
  8428. The fully qualified type of the BasicConfigurator class.
  8429. </summary>
  8430. <remarks>
  8431. Used by the internal logger to record the Type of the
  8432. log message.
  8433. </remarks>
  8434. </member>
  8435. <member name="M:log4net.Config.BasicConfigurator.#ctor">
  8436. <summary>
  8437. Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator" /> class.
  8438. </summary>
  8439. <remarks>
  8440. <para>
  8441. Uses a private access modifier to prevent instantiation of this class.
  8442. </para>
  8443. </remarks>
  8444. </member>
  8445. <member name="M:log4net.Config.BasicConfigurator.Configure">
  8446. <summary>
  8447. Initializes the log4net system with a default configuration.
  8448. </summary>
  8449. <remarks>
  8450. <para>
  8451. Initializes the log4net logging system using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  8452. that will write to <c>Console.Out</c>. The log messages are
  8453. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  8454. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  8455. layout style.
  8456. </para>
  8457. </remarks>
  8458. </member>
  8459. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender[])">
  8460. <summary>
  8461. Initializes the log4net system using the specified appenders.
  8462. </summary>
  8463. <param name="appenders">The appenders to use to log all logging events.</param>
  8464. <remarks>
  8465. <para>
  8466. Initializes the log4net system using the specified appenders.
  8467. </para>
  8468. </remarks>
  8469. </member>
  8470. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender)">
  8471. <summary>
  8472. Initializes the log4net system using the specified appender.
  8473. </summary>
  8474. <param name="appender">The appender to use to log all logging events.</param>
  8475. <remarks>
  8476. <para>
  8477. Initializes the log4net system using the specified appender.
  8478. </para>
  8479. </remarks>
  8480. </member>
  8481. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8482. <summary>
  8483. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration.
  8484. </summary>
  8485. <param name="repository">The repository to configure.</param>
  8486. <remarks>
  8487. <para>
  8488. Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  8489. that will write to <c>Console.Out</c>. The log messages are
  8490. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  8491. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  8492. layout style.
  8493. </para>
  8494. </remarks>
  8495. </member>
  8496. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)">
  8497. <summary>
  8498. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8499. </summary>
  8500. <param name="repository">The repository to configure.</param>
  8501. <param name="appender">The appender to use to log all logging events.</param>
  8502. <remarks>
  8503. <para>
  8504. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8505. </para>
  8506. </remarks>
  8507. </member>
  8508. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender[])">
  8509. <summary>
  8510. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appenders.
  8511. </summary>
  8512. <param name="repository">The repository to configure.</param>
  8513. <param name="appenders">The appenders to use to log all logging events.</param>
  8514. <remarks>
  8515. <para>
  8516. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8517. </para>
  8518. </remarks>
  8519. </member>
  8520. <member name="T:log4net.Config.ConfiguratorAttribute">
  8521. <summary>
  8522. Base class for all log4net configuration attributes.
  8523. </summary>
  8524. <remarks>
  8525. This is an abstract class that must be extended by
  8526. specific configurators. This attribute allows the
  8527. configurator to be parameterized by an assembly level
  8528. attribute.
  8529. </remarks>
  8530. <author>Nicko Cadell</author>
  8531. <author>Gert Driesen</author>
  8532. </member>
  8533. <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)">
  8534. <summary>
  8535. Constructor used by subclasses.
  8536. </summary>
  8537. <param name="priority">the ordering priority for this configurator</param>
  8538. <remarks>
  8539. <para>
  8540. The <paramref name="priority"/> is used to order the configurator
  8541. attributes before they are invoked. Higher priority configurators are executed
  8542. before lower priority ones.
  8543. </para>
  8544. </remarks>
  8545. </member>
  8546. <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8547. <summary>
  8548. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  8549. </summary>
  8550. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8551. <param name="targetRepository">The repository to configure.</param>
  8552. <remarks>
  8553. <para>
  8554. Abstract method implemented by a subclass. When this method is called
  8555. the subclass should configure the <paramref name="targetRepository"/>.
  8556. </para>
  8557. </remarks>
  8558. </member>
  8559. <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)">
  8560. <summary>
  8561. Compare this instance to another ConfiguratorAttribute
  8562. </summary>
  8563. <param name="obj">the object to compare to</param>
  8564. <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns>
  8565. <remarks>
  8566. <para>
  8567. Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances.
  8568. Sorts by priority in descending order. Objects with the same priority are
  8569. randomly ordered.
  8570. </para>
  8571. </remarks>
  8572. </member>
  8573. <member name="T:log4net.Config.DomainAttribute">
  8574. <summary>
  8575. Assembly level attribute that specifies the logging domain for the assembly.
  8576. </summary>
  8577. <remarks>
  8578. <para>
  8579. <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b>
  8580. </para>
  8581. <para>
  8582. Assemblies are mapped to logging domains. Each domain has its own
  8583. logging repository. This attribute specified on the assembly controls
  8584. the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  8585. of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  8586. specifies the type of the repository objects to create for the domain. If
  8587. this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified
  8588. then the assembly will be part of the default shared logging domain.
  8589. </para>
  8590. <para>
  8591. This attribute can only be specified on the assembly and may only be used
  8592. once per assembly.
  8593. </para>
  8594. </remarks>
  8595. <author>Nicko Cadell</author>
  8596. <author>Gert Driesen</author>
  8597. </member>
  8598. <member name="M:log4net.Config.DomainAttribute.#ctor">
  8599. <summary>
  8600. Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute" /> class.
  8601. </summary>
  8602. <remarks>
  8603. <para>
  8604. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8605. </para>
  8606. </remarks>
  8607. </member>
  8608. <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)">
  8609. <summary>
  8610. Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute" /> class
  8611. with the name of the domain.
  8612. </summary>
  8613. <param name="name">The name of the domain.</param>
  8614. <remarks>
  8615. <para>
  8616. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8617. </para>
  8618. </remarks>
  8619. </member>
  8620. <member name="T:log4net.Config.DOMConfigurator">
  8621. <summary>
  8622. Use this class to initialize the log4net environment using an Xml tree.
  8623. </summary>
  8624. <remarks>
  8625. <para>
  8626. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8627. </para>
  8628. <para>
  8629. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  8630. </para>
  8631. </remarks>
  8632. <author>Nicko Cadell</author>
  8633. <author>Gert Driesen</author>
  8634. </member>
  8635. <member name="M:log4net.Config.DOMConfigurator.#ctor">
  8636. <summary>
  8637. Private constructor
  8638. </summary>
  8639. </member>
  8640. <member name="M:log4net.Config.DOMConfigurator.Configure">
  8641. <summary>
  8642. Automatically configures the log4net system based on the
  8643. application's configuration settings.
  8644. </summary>
  8645. <remarks>
  8646. <para>
  8647. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8648. </para>
  8649. Each application has a configuration file. This has the
  8650. same name as the application with '.config' appended.
  8651. This file is XML and calling this function prompts the
  8652. configurator to look in that file for a section called
  8653. <c>log4net</c> that contains the configuration data.
  8654. </remarks>
  8655. </member>
  8656. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8657. <summary>
  8658. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  8659. stored in the application's configuration file.
  8660. </summary>
  8661. <remarks>
  8662. <para>
  8663. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8664. </para>
  8665. Each application has a configuration file. This has the
  8666. same name as the application with '.config' appended.
  8667. This file is XML and calling this function prompts the
  8668. configurator to look in that file for a section called
  8669. <c>log4net</c> that contains the configuration data.
  8670. </remarks>
  8671. <param name="repository">The repository to configure.</param>
  8672. </member>
  8673. <member name="M:log4net.Config.DOMConfigurator.Configure(System.Xml.XmlElement)">
  8674. <summary>
  8675. Configures log4net using a <c>log4net</c> element
  8676. </summary>
  8677. <remarks>
  8678. <para>
  8679. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8680. </para>
  8681. Loads the log4net configuration from the XML element
  8682. supplied as <paramref name="element"/>.
  8683. </remarks>
  8684. <param name="element">The element to parse.</param>
  8685. </member>
  8686. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  8687. <summary>
  8688. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  8689. element.
  8690. </summary>
  8691. <remarks>
  8692. <para>
  8693. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8694. </para>
  8695. Loads the log4net configuration from the XML element
  8696. supplied as <paramref name="element"/>.
  8697. </remarks>
  8698. <param name="repository">The repository to configure.</param>
  8699. <param name="element">The element to parse.</param>
  8700. </member>
  8701. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)">
  8702. <summary>
  8703. Configures log4net using the specified configuration file.
  8704. </summary>
  8705. <param name="configFile">The XML file to load the configuration from.</param>
  8706. <remarks>
  8707. <para>
  8708. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8709. </para>
  8710. <para>
  8711. The configuration file must be valid XML. It must contain
  8712. at least one element called <c>log4net</c> that holds
  8713. the log4net configuration data.
  8714. </para>
  8715. <para>
  8716. The log4net configuration file can possible be specified in the application's
  8717. configuration file (either <c>MyAppName.exe.config</c> for a
  8718. normal application on <c>Web.config</c> for an ASP.NET application).
  8719. </para>
  8720. <example>
  8721. The following example configures log4net using a configuration file, of which the
  8722. location is stored in the application's configuration file :
  8723. </example>
  8724. <code lang="C#">
  8725. using log4net.Config;
  8726. using System.IO;
  8727. using System.Configuration;
  8728. ...
  8729. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  8730. </code>
  8731. <para>
  8732. In the <c>.config</c> file, the path to the log4net can be specified like this :
  8733. </para>
  8734. <code lang="XML" escaped="true">
  8735. <configuration>
  8736. <appSettings>
  8737. <add key="log4net-config-file" value="log.config"/>
  8738. </appSettings>
  8739. </configuration>
  8740. </code>
  8741. </remarks>
  8742. </member>
  8743. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.Stream)">
  8744. <summary>
  8745. Configures log4net using the specified configuration file.
  8746. </summary>
  8747. <param name="configStream">A stream to load the XML configuration from.</param>
  8748. <remarks>
  8749. <para>
  8750. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8751. </para>
  8752. <para>
  8753. The configuration data must be valid XML. It must contain
  8754. at least one element called <c>log4net</c> that holds
  8755. the log4net configuration data.
  8756. </para>
  8757. <para>
  8758. Note that this method will NOT close the stream parameter.
  8759. </para>
  8760. </remarks>
  8761. </member>
  8762. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8763. <summary>
  8764. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  8765. file.
  8766. </summary>
  8767. <param name="repository">The repository to configure.</param>
  8768. <param name="configFile">The XML file to load the configuration from.</param>
  8769. <remarks>
  8770. <para>
  8771. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8772. </para>
  8773. <para>
  8774. The configuration file must be valid XML. It must contain
  8775. at least one element called <c>log4net</c> that holds
  8776. the configuration data.
  8777. </para>
  8778. <para>
  8779. The log4net configuration file can possible be specified in the application's
  8780. configuration file (either <c>MyAppName.exe.config</c> for a
  8781. normal application on <c>Web.config</c> for an ASP.NET application).
  8782. </para>
  8783. <example>
  8784. The following example configures log4net using a configuration file, of which the
  8785. location is stored in the application's configuration file :
  8786. </example>
  8787. <code lang="C#">
  8788. using log4net.Config;
  8789. using System.IO;
  8790. using System.Configuration;
  8791. ...
  8792. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  8793. </code>
  8794. <para>
  8795. In the <c>.config</c> file, the path to the log4net can be specified like this :
  8796. </para>
  8797. <code lang="XML" escaped="true">
  8798. <configuration>
  8799. <appSettings>
  8800. <add key="log4net-config-file" value="log.config"/>
  8801. </appSettings>
  8802. </configuration>
  8803. </code>
  8804. </remarks>
  8805. </member>
  8806. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  8807. <summary>
  8808. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  8809. file.
  8810. </summary>
  8811. <param name="repository">The repository to configure.</param>
  8812. <param name="configStream">The stream to load the XML configuration from.</param>
  8813. <remarks>
  8814. <para>
  8815. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8816. </para>
  8817. <para>
  8818. The configuration data must be valid XML. It must contain
  8819. at least one element called <c>log4net</c> that holds
  8820. the configuration data.
  8821. </para>
  8822. <para>
  8823. Note that this method will NOT close the stream parameter.
  8824. </para>
  8825. </remarks>
  8826. </member>
  8827. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  8828. <summary>
  8829. Configures log4net using the file specified, monitors the file for changes
  8830. and reloads the configuration if a change is detected.
  8831. </summary>
  8832. <param name="configFile">The XML file to load the configuration from.</param>
  8833. <remarks>
  8834. <para>
  8835. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8836. </para>
  8837. <para>
  8838. The configuration file must be valid XML. It must contain
  8839. at least one element called <c>log4net</c> that holds
  8840. the configuration data.
  8841. </para>
  8842. <para>
  8843. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  8844. and depends on the behavior of that class.
  8845. </para>
  8846. <para>
  8847. For more information on how to configure log4net using
  8848. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  8849. </para>
  8850. </remarks>
  8851. <seealso cref="M:Configure(FileInfo)"/>
  8852. </member>
  8853. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8854. <summary>
  8855. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  8856. monitors the file for changes and reloads the configuration if a change
  8857. is detected.
  8858. </summary>
  8859. <param name="repository">The repository to configure.</param>
  8860. <param name="configFile">The XML file to load the configuration from.</param>
  8861. <remarks>
  8862. <para>
  8863. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8864. </para>
  8865. <para>
  8866. The configuration file must be valid XML. It must contain
  8867. at least one element called <c>log4net</c> that holds
  8868. the configuration data.
  8869. </para>
  8870. <para>
  8871. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  8872. and depends on the behavior of that class.
  8873. </para>
  8874. <para>
  8875. For more information on how to configure log4net using
  8876. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  8877. </para>
  8878. </remarks>
  8879. <seealso cref="M:Configure(FileInfo)"/>
  8880. </member>
  8881. <member name="T:log4net.Config.DOMConfiguratorAttribute">
  8882. <summary>
  8883. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  8884. </summary>
  8885. <remarks>
  8886. <para>
  8887. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  8888. </para>
  8889. <para>
  8890. This attribute may only be used at the assembly scope and can only
  8891. be used once per assembly.
  8892. </para>
  8893. <para>
  8894. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  8895. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  8896. methods.
  8897. </para>
  8898. </remarks>
  8899. <author>Nicko Cadell</author>
  8900. <author>Gert Driesen</author>
  8901. </member>
  8902. <member name="T:log4net.Config.Log4NetConfigurationSectionHandler">
  8903. <summary>
  8904. Class to register for the log4net section of the configuration file
  8905. </summary>
  8906. <remarks>
  8907. The log4net section of the configuration file needs to have a section
  8908. handler registered. This is the section handler used. It simply returns
  8909. the XML element that is the root of the section.
  8910. </remarks>
  8911. <example>
  8912. Example of registering the log4net section handler :
  8913. <code lang="XML" escaped="true">
  8914. <configuration>
  8915. <configSections>
  8916. <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  8917. </configSections>
  8918. <log4net>
  8919. log4net configuration XML goes here
  8920. </log4net>
  8921. </configuration>
  8922. </code>
  8923. </example>
  8924. <author>Nicko Cadell</author>
  8925. <author>Gert Driesen</author>
  8926. </member>
  8927. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.#ctor">
  8928. <summary>
  8929. Initializes a new instance of the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> class.
  8930. </summary>
  8931. <remarks>
  8932. <para>
  8933. Default constructor.
  8934. </para>
  8935. </remarks>
  8936. </member>
  8937. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.Create(System.Object,System.Object,System.Xml.XmlNode)">
  8938. <summary>
  8939. Parses the configuration section.
  8940. </summary>
  8941. <param name="parent">The configuration settings in a corresponding parent configuration section.</param>
  8942. <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>
  8943. <param name="section">The <see cref="T:System.Xml.XmlNode" /> for the log4net section.</param>
  8944. <returns>The <see cref="T:System.Xml.XmlNode" /> for the log4net section.</returns>
  8945. <remarks>
  8946. <para>
  8947. Returns the <see cref="T:System.Xml.XmlNode"/> containing the configuration data,
  8948. </para>
  8949. </remarks>
  8950. </member>
  8951. <member name="T:log4net.Config.PluginAttribute">
  8952. <summary>
  8953. Assembly level attribute that specifies a plugin to attach to
  8954. the repository.
  8955. </summary>
  8956. <remarks>
  8957. <para>
  8958. Specifies the type of a plugin to create and attach to the
  8959. assembly's repository. The plugin type must implement the
  8960. <see cref="T:log4net.Plugin.IPlugin"/> interface.
  8961. </para>
  8962. </remarks>
  8963. <author>Nicko Cadell</author>
  8964. <author>Gert Driesen</author>
  8965. </member>
  8966. <member name="M:log4net.Config.PluginAttribute.#ctor(System.String)">
  8967. <summary>
  8968. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute" /> class
  8969. with the specified type.
  8970. </summary>
  8971. <param name="typeName">The type name of plugin to create.</param>
  8972. <remarks>
  8973. <para>
  8974. Create the attribute with the plugin type specified.
  8975. </para>
  8976. <para>
  8977. Where possible use the constructor that takes a <see cref="T:System.Type"/>.
  8978. </para>
  8979. </remarks>
  8980. </member>
  8981. <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
  8982. <summary>
  8983. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute" /> class
  8984. with the specified type.
  8985. </summary>
  8986. <param name="type">The type of plugin to create.</param>
  8987. <remarks>
  8988. <para>
  8989. Create the attribute with the plugin type specified.
  8990. </para>
  8991. </remarks>
  8992. </member>
  8993. <member name="P:log4net.Config.PluginAttribute.Type">
  8994. <summary>
  8995. Gets or sets the type for the plugin.
  8996. </summary>
  8997. <value>
  8998. The type for the plugin.
  8999. </value>
  9000. <remarks>
  9001. <para>
  9002. The type for the plugin.
  9003. </para>
  9004. </remarks>
  9005. </member>
  9006. <member name="P:log4net.Config.PluginAttribute.TypeName">
  9007. <summary>
  9008. Gets or sets the type name for the plugin.
  9009. </summary>
  9010. <value>
  9011. The type name for the plugin.
  9012. </value>
  9013. <remarks>
  9014. <para>
  9015. The type name for the plugin.
  9016. </para>
  9017. <para>
  9018. Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
  9019. </para>
  9020. </remarks>
  9021. </member>
  9022. <member name="M:log4net.Config.PluginAttribute.CreatePlugin">
  9023. <summary>
  9024. Creates the plugin object defined by this attribute.
  9025. </summary>
  9026. <remarks>
  9027. <para>
  9028. Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as
  9029. specified by this attribute.
  9030. </para>
  9031. </remarks>
  9032. <returns>The plugin object.</returns>
  9033. </member>
  9034. <member name="M:log4net.Config.PluginAttribute.ToString">
  9035. <summary>
  9036. Returns a representation of the properties of this object.
  9037. </summary>
  9038. <remarks>
  9039. <para>
  9040. Overrides base class <see cref="M:Object.ToString()" /> method to
  9041. return a representation of the properties of this object.
  9042. </para>
  9043. </remarks>
  9044. <returns>A representation of the properties of this object</returns>
  9045. </member>
  9046. <member name="T:log4net.Config.RepositoryAttribute">
  9047. <summary>
  9048. Assembly level attribute that specifies the logging repository for the assembly.
  9049. </summary>
  9050. <remarks>
  9051. <para>
  9052. Assemblies are mapped to logging repository. This attribute specified
  9053. on the assembly controls
  9054. the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  9055. of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  9056. specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object
  9057. to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/>
  9058. is not specified then the assembly will be part of the default shared logging repository.
  9059. </para>
  9060. <para>
  9061. This attribute can only be specified on the assembly and may only be used
  9062. once per assembly.
  9063. </para>
  9064. </remarks>
  9065. <author>Nicko Cadell</author>
  9066. <author>Gert Driesen</author>
  9067. </member>
  9068. <member name="M:log4net.Config.RepositoryAttribute.#ctor">
  9069. <summary>
  9070. Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute" /> class.
  9071. </summary>
  9072. <remarks>
  9073. <para>
  9074. Default constructor.
  9075. </para>
  9076. </remarks>
  9077. </member>
  9078. <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)">
  9079. <summary>
  9080. Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute" /> class
  9081. with the name of the repository.
  9082. </summary>
  9083. <param name="name">The name of the repository.</param>
  9084. <remarks>
  9085. <para>
  9086. Initialize the attribute with the name for the assembly's repository.
  9087. </para>
  9088. </remarks>
  9089. </member>
  9090. <member name="P:log4net.Config.RepositoryAttribute.Name">
  9091. <summary>
  9092. Gets or sets the name of the logging repository.
  9093. </summary>
  9094. <value>
  9095. The string name to use as the name of the repository associated with this
  9096. assembly.
  9097. </value>
  9098. <remarks>
  9099. <para>
  9100. This value does not have to be unique. Several assemblies can share the
  9101. same repository. They will share the logging configuration of the repository.
  9102. </para>
  9103. </remarks>
  9104. </member>
  9105. <member name="P:log4net.Config.RepositoryAttribute.RepositoryType">
  9106. <summary>
  9107. Gets or sets the type of repository to create for this assembly.
  9108. </summary>
  9109. <value>
  9110. The type of repository to create for this assembly.
  9111. </value>
  9112. <remarks>
  9113. <para>
  9114. The type of the repository to create for the assembly.
  9115. The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/>
  9116. interface.
  9117. </para>
  9118. <para>
  9119. This will be the type of repository created when
  9120. the repository is created. If multiple assemblies reference the
  9121. same repository then the repository is only created once using the
  9122. <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType" /> of the first assembly to call into the
  9123. repository.
  9124. </para>
  9125. </remarks>
  9126. </member>
  9127. <member name="T:log4net.Config.SecurityContextProviderAttribute">
  9128. <summary>
  9129. Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>.
  9130. </summary>
  9131. <remarks>
  9132. <para>
  9133. This attribute may only be used at the assembly scope and can only
  9134. be used once per assembly.
  9135. </para>
  9136. <para>
  9137. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9138. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9139. methods.
  9140. </para>
  9141. </remarks>
  9142. <author>Nicko Cadell</author>
  9143. </member>
  9144. <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)">
  9145. <summary>
  9146. Construct provider attribute with type specified
  9147. </summary>
  9148. <param name="providerType">the type of the provider to use</param>
  9149. <remarks>
  9150. <para>
  9151. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  9152. class.
  9153. </para>
  9154. </remarks>
  9155. </member>
  9156. <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType">
  9157. <summary>
  9158. Gets or sets the type of the provider to use.
  9159. </summary>
  9160. <value>
  9161. the type of the provider to use.
  9162. </value>
  9163. <remarks>
  9164. <para>
  9165. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  9166. class.
  9167. </para>
  9168. </remarks>
  9169. </member>
  9170. <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9171. <summary>
  9172. Configures the SecurityContextProvider
  9173. </summary>
  9174. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9175. <param name="targetRepository">The repository to configure.</param>
  9176. <remarks>
  9177. <para>
  9178. Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified.
  9179. Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>.
  9180. </para>
  9181. </remarks>
  9182. </member>
  9183. <member name="F:log4net.Config.SecurityContextProviderAttribute.declaringType">
  9184. <summary>
  9185. The fully qualified type of the SecurityContextProviderAttribute class.
  9186. </summary>
  9187. <remarks>
  9188. Used by the internal logger to record the Type of the
  9189. log message.
  9190. </remarks>
  9191. </member>
  9192. <member name="T:log4net.Config.XmlConfigurator">
  9193. <summary>
  9194. Use this class to initialize the log4net environment using an Xml tree.
  9195. </summary>
  9196. <remarks>
  9197. <para>
  9198. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  9199. </para>
  9200. </remarks>
  9201. <author>Nicko Cadell</author>
  9202. <author>Gert Driesen</author>
  9203. </member>
  9204. <member name="M:log4net.Config.XmlConfigurator.#ctor">
  9205. <summary>
  9206. Private constructor
  9207. </summary>
  9208. </member>
  9209. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  9210. <summary>
  9211. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  9212. stored in the application's configuration file.
  9213. </summary>
  9214. <remarks>
  9215. <para>
  9216. Each application has a configuration file. This has the
  9217. same name as the application with '.config' appended.
  9218. This file is XML and calling this function prompts the
  9219. configurator to look in that file for a section called
  9220. <c>log4net</c> that contains the configuration data.
  9221. </para>
  9222. <para>
  9223. To use this method to configure log4net you must specify
  9224. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  9225. handler for the <c>log4net</c> configuration section. See the
  9226. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  9227. </para>
  9228. </remarks>
  9229. <param name="repository">The repository to configure.</param>
  9230. </member>
  9231. <member name="M:log4net.Config.XmlConfigurator.Configure">
  9232. <summary>
  9233. Automatically configures the log4net system based on the
  9234. application's configuration settings.
  9235. </summary>
  9236. <remarks>
  9237. <para>
  9238. Each application has a configuration file. This has the
  9239. same name as the application with '.config' appended.
  9240. This file is XML and calling this function prompts the
  9241. configurator to look in that file for a section called
  9242. <c>log4net</c> that contains the configuration data.
  9243. </para>
  9244. <para>
  9245. To use this method to configure log4net you must specify
  9246. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  9247. handler for the <c>log4net</c> configuration section. See the
  9248. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  9249. </para>
  9250. </remarks>
  9251. <seealso cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/>
  9252. </member>
  9253. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Xml.XmlElement)">
  9254. <summary>
  9255. Configures log4net using a <c>log4net</c> element
  9256. </summary>
  9257. <remarks>
  9258. <para>
  9259. Loads the log4net configuration from the XML element
  9260. supplied as <paramref name="element"/>.
  9261. </para>
  9262. </remarks>
  9263. <param name="element">The element to parse.</param>
  9264. </member>
  9265. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)">
  9266. <summary>
  9267. Configures log4net using the specified configuration file.
  9268. </summary>
  9269. <param name="configFile">The XML file to load the configuration from.</param>
  9270. <remarks>
  9271. <para>
  9272. The configuration file must be valid XML. It must contain
  9273. at least one element called <c>log4net</c> that holds
  9274. the log4net configuration data.
  9275. </para>
  9276. <para>
  9277. The log4net configuration file can possible be specified in the application's
  9278. configuration file (either <c>MyAppName.exe.config</c> for a
  9279. normal application on <c>Web.config</c> for an ASP.NET application).
  9280. </para>
  9281. <para>
  9282. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  9283. configuration. If this file is also a .NET .config file then you must specify
  9284. a configuration section for the <c>log4net</c> element otherwise .NET will
  9285. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  9286. <code lang="XML" escaped="true">
  9287. <configSections>
  9288. <section name="log4net" type="System.Configuration.IgnoreSectionHandler" />
  9289. </configSections>
  9290. </code>
  9291. </para>
  9292. <example>
  9293. The following example configures log4net using a configuration file, of which the
  9294. location is stored in the application's configuration file :
  9295. </example>
  9296. <code lang="C#">
  9297. using log4net.Config;
  9298. using System.IO;
  9299. using System.Configuration;
  9300. ...
  9301. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9302. </code>
  9303. <para>
  9304. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9305. </para>
  9306. <code lang="XML" escaped="true">
  9307. <configuration>
  9308. <appSettings>
  9309. <add key="log4net-config-file" value="log.config"/>
  9310. </appSettings>
  9311. </configuration>
  9312. </code>
  9313. </remarks>
  9314. </member>
  9315. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Uri)">
  9316. <summary>
  9317. Configures log4net using the specified configuration URI.
  9318. </summary>
  9319. <param name="configUri">A URI to load the XML configuration from.</param>
  9320. <remarks>
  9321. <para>
  9322. The configuration data must be valid XML. It must contain
  9323. at least one element called <c>log4net</c> that holds
  9324. the log4net configuration data.
  9325. </para>
  9326. <para>
  9327. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  9328. </para>
  9329. </remarks>
  9330. </member>
  9331. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.Stream)">
  9332. <summary>
  9333. Configures log4net using the specified configuration data stream.
  9334. </summary>
  9335. <param name="configStream">A stream to load the XML configuration from.</param>
  9336. <remarks>
  9337. <para>
  9338. The configuration data must be valid XML. It must contain
  9339. at least one element called <c>log4net</c> that holds
  9340. the log4net configuration data.
  9341. </para>
  9342. <para>
  9343. Note that this method will NOT close the stream parameter.
  9344. </para>
  9345. </remarks>
  9346. </member>
  9347. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9348. <summary>
  9349. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  9350. element.
  9351. </summary>
  9352. <remarks>
  9353. Loads the log4net configuration from the XML element
  9354. supplied as <paramref name="element"/>.
  9355. </remarks>
  9356. <param name="repository">The repository to configure.</param>
  9357. <param name="element">The element to parse.</param>
  9358. </member>
  9359. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9360. <summary>
  9361. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9362. file.
  9363. </summary>
  9364. <param name="repository">The repository to configure.</param>
  9365. <param name="configFile">The XML file to load the configuration from.</param>
  9366. <remarks>
  9367. <para>
  9368. The configuration file must be valid XML. It must contain
  9369. at least one element called <c>log4net</c> that holds
  9370. the configuration data.
  9371. </para>
  9372. <para>
  9373. The log4net configuration file can possible be specified in the application's
  9374. configuration file (either <c>MyAppName.exe.config</c> for a
  9375. normal application on <c>Web.config</c> for an ASP.NET application).
  9376. </para>
  9377. <para>
  9378. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  9379. configuration. If this file is also a .NET .config file then you must specify
  9380. a configuration section for the <c>log4net</c> element otherwise .NET will
  9381. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  9382. <code lang="XML" escaped="true">
  9383. <configSections>
  9384. <section name="log4net" type="System.Configuration.IgnoreSectionHandler" />
  9385. </configSections>
  9386. </code>
  9387. </para>
  9388. <example>
  9389. The following example configures log4net using a configuration file, of which the
  9390. location is stored in the application's configuration file :
  9391. </example>
  9392. <code lang="C#">
  9393. using log4net.Config;
  9394. using System.IO;
  9395. using System.Configuration;
  9396. ...
  9397. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9398. </code>
  9399. <para>
  9400. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9401. </para>
  9402. <code lang="XML" escaped="true">
  9403. <configuration>
  9404. <appSettings>
  9405. <add key="log4net-config-file" value="log.config"/>
  9406. </appSettings>
  9407. </configuration>
  9408. </code>
  9409. </remarks>
  9410. </member>
  9411. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)">
  9412. <summary>
  9413. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9414. URI.
  9415. </summary>
  9416. <param name="repository">The repository to configure.</param>
  9417. <param name="configUri">A URI to load the XML configuration from.</param>
  9418. <remarks>
  9419. <para>
  9420. The configuration data must be valid XML. It must contain
  9421. at least one element called <c>log4net</c> that holds
  9422. the configuration data.
  9423. </para>
  9424. <para>
  9425. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  9426. </para>
  9427. </remarks>
  9428. </member>
  9429. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  9430. <summary>
  9431. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9432. file.
  9433. </summary>
  9434. <param name="repository">The repository to configure.</param>
  9435. <param name="configStream">The stream to load the XML configuration from.</param>
  9436. <remarks>
  9437. <para>
  9438. The configuration data must be valid XML. It must contain
  9439. at least one element called <c>log4net</c> that holds
  9440. the configuration data.
  9441. </para>
  9442. <para>
  9443. Note that this method will NOT close the stream parameter.
  9444. </para>
  9445. </remarks>
  9446. </member>
  9447. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  9448. <summary>
  9449. Configures log4net using the file specified, monitors the file for changes
  9450. and reloads the configuration if a change is detected.
  9451. </summary>
  9452. <param name="configFile">The XML file to load the configuration from.</param>
  9453. <remarks>
  9454. <para>
  9455. The configuration file must be valid XML. It must contain
  9456. at least one element called <c>log4net</c> that holds
  9457. the configuration data.
  9458. </para>
  9459. <para>
  9460. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9461. and depends on the behavior of that class.
  9462. </para>
  9463. <para>
  9464. For more information on how to configure log4net using
  9465. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9466. </para>
  9467. </remarks>
  9468. <seealso cref="M:Configure(FileInfo)"/>
  9469. </member>
  9470. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9471. <summary>
  9472. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  9473. monitors the file for changes and reloads the configuration if a change
  9474. is detected.
  9475. </summary>
  9476. <param name="repository">The repository to configure.</param>
  9477. <param name="configFile">The XML file to load the configuration from.</param>
  9478. <remarks>
  9479. <para>
  9480. The configuration file must be valid XML. It must contain
  9481. at least one element called <c>log4net</c> that holds
  9482. the configuration data.
  9483. </para>
  9484. <para>
  9485. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9486. and depends on the behavior of that class.
  9487. </para>
  9488. <para>
  9489. For more information on how to configure log4net using
  9490. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9491. </para>
  9492. </remarks>
  9493. <seealso cref="M:Configure(FileInfo)"/>
  9494. </member>
  9495. <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler">
  9496. <summary>
  9497. Class used to watch config files.
  9498. </summary>
  9499. <remarks>
  9500. <para>
  9501. Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor
  9502. changes to a specified file. Because multiple change notifications
  9503. may be raised when the file is modified, a timer is used to
  9504. compress the notifications into a single event. The timer
  9505. waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering
  9506. the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/>
  9507. change notifications arrive while the timer is waiting it
  9508. is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to
  9509. elapse.
  9510. </para>
  9511. </remarks>
  9512. </member>
  9513. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile">
  9514. <summary>
  9515. Holds the FileInfo used to configure the XmlConfigurator
  9516. </summary>
  9517. </member>
  9518. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository">
  9519. <summary>
  9520. Holds the repository being configured.
  9521. </summary>
  9522. </member>
  9523. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer">
  9524. <summary>
  9525. The timer used to compress the notification events.
  9526. </summary>
  9527. </member>
  9528. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis">
  9529. <summary>
  9530. The default amount of time to wait after receiving notification
  9531. before reloading the config file.
  9532. </summary>
  9533. </member>
  9534. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_watcher">
  9535. <summary>
  9536. Watches file for changes. This object should be disposed when no longer
  9537. needed to free system handles on the watched resources.
  9538. </summary>
  9539. </member>
  9540. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9541. <summary>
  9542. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler" /> class to
  9543. watch a specified config file used to configure a repository.
  9544. </summary>
  9545. <param name="repository">The repository to configure.</param>
  9546. <param name="configFile">The configuration file to watch.</param>
  9547. <remarks>
  9548. <para>
  9549. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler" /> class.
  9550. </para>
  9551. </remarks>
  9552. </member>
  9553. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)">
  9554. <summary>
  9555. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  9556. </summary>
  9557. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  9558. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  9559. <remarks>
  9560. <para>
  9561. This handler reloads the configuration from the file when the event is fired.
  9562. </para>
  9563. </remarks>
  9564. </member>
  9565. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)">
  9566. <summary>
  9567. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  9568. </summary>
  9569. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  9570. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  9571. <remarks>
  9572. <para>
  9573. This handler reloads the configuration from the file when the event is fired.
  9574. </para>
  9575. </remarks>
  9576. </member>
  9577. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)">
  9578. <summary>
  9579. Called by the timer when the configuration has been updated.
  9580. </summary>
  9581. <param name="state">null</param>
  9582. </member>
  9583. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.Dispose">
  9584. <summary>
  9585. Release the handles held by the watcher and timer.
  9586. </summary>
  9587. </member>
  9588. <member name="M:log4net.Config.XmlConfigurator.InternalConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9589. <summary>
  9590. Configures the specified repository using a <c>log4net</c> element.
  9591. </summary>
  9592. <param name="repository">The hierarchy to configure.</param>
  9593. <param name="element">The element to parse.</param>
  9594. <remarks>
  9595. <para>
  9596. Loads the log4net configuration from the XML element
  9597. supplied as <paramref name="element"/>.
  9598. </para>
  9599. <para>
  9600. This method is ultimately called by one of the Configure methods
  9601. to load the configuration from an <see cref="T:System.Xml.XmlElement"/>.
  9602. </para>
  9603. </remarks>
  9604. </member>
  9605. <member name="F:log4net.Config.XmlConfigurator.m_repositoryName2ConfigAndWatchHandler">
  9606. <summary>
  9607. Maps repository names to ConfigAndWatchHandler instances to allow a particular
  9608. ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is
  9609. reconfigured.
  9610. </summary>
  9611. </member>
  9612. <member name="F:log4net.Config.XmlConfigurator.declaringType">
  9613. <summary>
  9614. The fully qualified type of the XmlConfigurator class.
  9615. </summary>
  9616. <remarks>
  9617. Used by the internal logger to record the Type of the
  9618. log message.
  9619. </remarks>
  9620. </member>
  9621. <member name="T:log4net.Config.XmlConfiguratorAttribute">
  9622. <summary>
  9623. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  9624. </summary>
  9625. <remarks>
  9626. <para>
  9627. This attribute may only be used at the assembly scope and can only
  9628. be used once per assembly.
  9629. </para>
  9630. <para>
  9631. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9632. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9633. methods.
  9634. </para>
  9635. <para>
  9636. If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>
  9637. properties are set the configuration is loaded from the application's .config file.
  9638. If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the
  9639. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property
  9640. specifies a path to a file to load the config from. The path is relative to the
  9641. application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  9642. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name.
  9643. The config file must be located in the application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  9644. For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to
  9645. <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or
  9646. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties.
  9647. </para>
  9648. <para>
  9649. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/>
  9650. to watch the configuration file for changes.
  9651. </para>
  9652. <note>
  9653. <para>
  9654. Log4net will only look for assembly level configuration attributes once.
  9655. When using the log4net assembly level attributes to control the configuration
  9656. of log4net you must ensure that the first call to any of the
  9657. <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration
  9658. attributes.
  9659. </para>
  9660. <para>
  9661. If you cannot guarantee the order in which log4net calls will be made from
  9662. different assemblies you must use programmatic configuration instead, i.e.
  9663. call the <see cref="M:XmlConfigurator.Configure()"/> method directly.
  9664. </para>
  9665. </note>
  9666. </remarks>
  9667. <author>Nicko Cadell</author>
  9668. <author>Gert Driesen</author>
  9669. </member>
  9670. <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor">
  9671. <summary>
  9672. Default constructor
  9673. </summary>
  9674. <remarks>
  9675. <para>
  9676. Default constructor
  9677. </para>
  9678. </remarks>
  9679. </member>
  9680. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile">
  9681. <summary>
  9682. Gets or sets the filename of the configuration file.
  9683. </summary>
  9684. <value>
  9685. The filename of the configuration file.
  9686. </value>
  9687. <remarks>
  9688. <para>
  9689. If specified, this is the name of the configuration file to use with
  9690. the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the
  9691. <b>application base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>).
  9692. </para>
  9693. <para>
  9694. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  9695. </para>
  9696. </remarks>
  9697. </member>
  9698. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension">
  9699. <summary>
  9700. Gets or sets the extension of the configuration file.
  9701. </summary>
  9702. <value>
  9703. The extension of the configuration file.
  9704. </value>
  9705. <remarks>
  9706. <para>
  9707. If specified this is the extension for the configuration file.
  9708. The path to the config file is built by using the <b>application
  9709. base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>),
  9710. the <b>assembly file name</b> and the config file extension.
  9711. </para>
  9712. <para>
  9713. If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then
  9714. possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or
  9715. <c>MyClassLibrary.dll.MyExt</c>.
  9716. </para>
  9717. <para>
  9718. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  9719. </para>
  9720. </remarks>
  9721. </member>
  9722. <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch">
  9723. <summary>
  9724. Gets or sets a value indicating whether to watch the configuration file.
  9725. </summary>
  9726. <value>
  9727. <c>true</c> if the configuration should be watched, <c>false</c> otherwise.
  9728. </value>
  9729. <remarks>
  9730. <para>
  9731. If this flag is specified and set to <c>true</c> then the framework
  9732. will watch the configuration file and will reload the config each time
  9733. the file is modified.
  9734. </para>
  9735. <para>
  9736. The config file can only be watched if it is loaded from local disk.
  9737. In a No-Touch (Smart Client) deployment where the application is downloaded
  9738. from a web server the config file may not reside on the local disk
  9739. and therefore it may not be able to watch it.
  9740. </para>
  9741. <note>
  9742. Watching configuration is not supported on the SSCLI.
  9743. </note>
  9744. </remarks>
  9745. </member>
  9746. <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9747. <summary>
  9748. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9749. </summary>
  9750. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9751. <param name="targetRepository">The repository to configure.</param>
  9752. <remarks>
  9753. <para>
  9754. Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>.
  9755. The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  9756. class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to
  9757. configure it.
  9758. </para>
  9759. </remarks>
  9760. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetRepository" /> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception>
  9761. </member>
  9762. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9763. <summary>
  9764. Attempt to load configuration from the local file system
  9765. </summary>
  9766. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9767. <param name="targetRepository">The repository to configure.</param>
  9768. </member>
  9769. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9770. <summary>
  9771. Configure the specified repository using a <see cref="T:System.IO.FileInfo"/>
  9772. </summary>
  9773. <param name="targetRepository">The repository to configure.</param>
  9774. <param name="configFile">the FileInfo pointing to the config file</param>
  9775. </member>
  9776. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9777. <summary>
  9778. Attempt to load configuration from a URI
  9779. </summary>
  9780. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9781. <param name="targetRepository">The repository to configure.</param>
  9782. </member>
  9783. <member name="F:log4net.Config.XmlConfiguratorAttribute.declaringType">
  9784. <summary>
  9785. The fully qualified type of the XmlConfiguratorAttribute class.
  9786. </summary>
  9787. <remarks>
  9788. Used by the internal logger to record the Type of the
  9789. log message.
  9790. </remarks>
  9791. </member>
  9792. <member name="T:log4net.Core.CompactRepositorySelector">
  9793. <summary>
  9794. The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable
  9795. for use with the compact framework
  9796. </summary>
  9797. <remarks>
  9798. <para>
  9799. This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple
  9800. mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9801. object.
  9802. </para>
  9803. <para>
  9804. The .NET Compact Framework 1.0 does not support retrieving assembly
  9805. level attributes therefore unlike the <c>DefaultRepositorySelector</c>
  9806. this selector does not examine the calling assembly for attributes.
  9807. </para>
  9808. </remarks>
  9809. <author>Nicko Cadell</author>
  9810. </member>
  9811. <member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)">
  9812. <summary>
  9813. Create a new repository selector
  9814. </summary>
  9815. <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9816. <remarks>
  9817. <para>
  9818. Create an new compact repository selector.
  9819. The default type for repositories must be specified,
  9820. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  9821. </para>
  9822. </remarks>
  9823. <exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception>
  9824. <exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception>
  9825. </member>
  9826. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)">
  9827. <summary>
  9828. Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly
  9829. </summary>
  9830. <param name="assembly">not used</param>
  9831. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9832. <remarks>
  9833. <para>
  9834. The <paramref name="assembly"/> argument is not used. This selector does not create a
  9835. separate repository for each assembly.
  9836. </para>
  9837. <para>
  9838. As a named repository is not specified the default repository is
  9839. returned. The default repository is named <c>log4net-default-repository</c>.
  9840. </para>
  9841. </remarks>
  9842. </member>
  9843. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)">
  9844. <summary>
  9845. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>
  9846. </summary>
  9847. <param name="repositoryName">the name of the repository to lookup</param>
  9848. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9849. <remarks>
  9850. <para>
  9851. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default
  9852. repository is <c>log4net-default-repository</c>. Other repositories
  9853. must be created using the <see cref="M:CreateRepository(string, Type)"/>.
  9854. If the named repository does not exist an exception is thrown.
  9855. </para>
  9856. </remarks>
  9857. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  9858. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception>
  9859. </member>
  9860. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  9861. <summary>
  9862. Create a new repository for the assembly specified
  9863. </summary>
  9864. <param name="assembly">not used</param>
  9865. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9866. <returns>the repository created</returns>
  9867. <remarks>
  9868. <para>
  9869. The <paramref name="assembly"/> argument is not used. This selector does not create a
  9870. separate repository for each assembly.
  9871. </para>
  9872. <para>
  9873. If the <paramref name="repositoryType"/> is <c>null</c> then the
  9874. default repository type specified to the constructor is used.
  9875. </para>
  9876. <para>
  9877. As a named repository is not specified the default repository is
  9878. returned. The default repository is named <c>log4net-default-repository</c>.
  9879. </para>
  9880. </remarks>
  9881. </member>
  9882. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)">
  9883. <summary>
  9884. Create a new repository for the repository specified
  9885. </summary>
  9886. <param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9887. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9888. If this param is null then the default repository type is used.</param>
  9889. <returns>the repository created</returns>
  9890. <remarks>
  9891. <para>
  9892. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  9893. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  9894. same repository specified will return the same repository instance.
  9895. </para>
  9896. <para>
  9897. If the named repository already exists an exception will be thrown.
  9898. </para>
  9899. <para>
  9900. If <paramref name="repositoryType"/> is <c>null</c> then the default
  9901. repository type specified to the constructor is used.
  9902. </para>
  9903. </remarks>
  9904. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  9905. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception>
  9906. </member>
  9907. <member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)">
  9908. <summary>
  9909. Test if a named repository exists
  9910. </summary>
  9911. <param name="repositoryName">the named repository to check</param>
  9912. <returns><c>true</c> if the repository exists</returns>
  9913. <remarks>
  9914. <para>
  9915. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  9916. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  9917. a repository.
  9918. </para>
  9919. </remarks>
  9920. </member>
  9921. <member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories">
  9922. <summary>
  9923. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  9924. </summary>
  9925. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  9926. <remarks>
  9927. <para>
  9928. Gets an array of all of the repositories created by this selector.
  9929. </para>
  9930. </remarks>
  9931. </member>
  9932. <member name="F:log4net.Core.CompactRepositorySelector.declaringType">
  9933. <summary>
  9934. The fully qualified type of the CompactRepositorySelector class.
  9935. </summary>
  9936. <remarks>
  9937. Used by the internal logger to record the Type of the
  9938. log message.
  9939. </remarks>
  9940. </member>
  9941. <member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">
  9942. <summary>
  9943. Event to notify that a logger repository has been created.
  9944. </summary>
  9945. <value>
  9946. Event to notify that a logger repository has been created.
  9947. </value>
  9948. <remarks>
  9949. <para>
  9950. Event raised when a new repository is created.
  9951. The event source will be this selector. The event args will
  9952. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  9953. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9954. </para>
  9955. </remarks>
  9956. </member>
  9957. <member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  9958. <summary>
  9959. Notify the registered listeners that the repository has been created
  9960. </summary>
  9961. <param name="repository">The repository that has been created</param>
  9962. <remarks>
  9963. <para>
  9964. Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event>
  9965. event.
  9966. </para>
  9967. </remarks>
  9968. </member>
  9969. <member name="T:log4net.Core.DefaultRepositorySelector">
  9970. <summary>
  9971. The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface.
  9972. </summary>
  9973. <remarks>
  9974. <para>
  9975. Uses attributes defined on the calling assembly to determine how to
  9976. configure the hierarchy for the repository.
  9977. </para>
  9978. </remarks>
  9979. <author>Nicko Cadell</author>
  9980. <author>Gert Driesen</author>
  9981. </member>
  9982. <member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent">
  9983. <summary>
  9984. Event to notify that a logger repository has been created.
  9985. </summary>
  9986. <value>
  9987. Event to notify that a logger repository has been created.
  9988. </value>
  9989. <remarks>
  9990. <para>
  9991. Event raised when a new repository is created.
  9992. The event source will be this selector. The event args will
  9993. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  9994. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9995. </para>
  9996. </remarks>
  9997. </member>
  9998. <member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)">
  9999. <summary>
  10000. Creates a new repository selector.
  10001. </summary>
  10002. <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10003. <remarks>
  10004. <para>
  10005. Create an new repository selector.
  10006. The default type for repositories must be specified,
  10007. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  10008. </para>
  10009. </remarks>
  10010. <exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null" />.</exception>
  10011. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception>
  10012. </member>
  10013. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10014. <summary>
  10015. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10016. </summary>
  10017. <param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10018. <remarks>
  10019. <para>
  10020. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
  10021. to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
  10022. attribute on the <paramref name="repositoryAssembly"/>.
  10023. </para>
  10024. <para>
  10025. The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  10026. implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10027. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10028. </para>
  10029. <para>
  10030. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
  10031. any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
  10032. the <paramref name="repositoryAssembly"/>.
  10033. </para>
  10034. </remarks>
  10035. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
  10036. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  10037. </member>
  10038. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
  10039. <summary>
  10040. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.
  10041. </summary>
  10042. <param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10043. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns>
  10044. <remarks>
  10045. <para>
  10046. Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c>
  10047. a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository
  10048. does not exist a <see cref="T:log4net.Core.LogException"/> is thrown.
  10049. </para>
  10050. <para>
  10051. Use <see cref="M:CreateRepository(string, Type)"/> to create a repository.
  10052. </para>
  10053. </remarks>
  10054. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null" />.</exception>
  10055. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception>
  10056. </member>
  10057. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10058. <summary>
  10059. Create a new repository for the assembly specified
  10060. </summary>
  10061. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10062. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10063. <returns>The repository created.</returns>
  10064. <remarks>
  10065. <para>
  10066. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10067. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10068. same assembly specified will return the same repository instance.
  10069. </para>
  10070. <para>
  10071. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  10072. the repository to create can be overridden by specifying the
  10073. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10074. <paramref name="repositoryAssembly"/>. The default values are to use the
  10075. <paramref name="repositoryType"/> implementation of the
  10076. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10077. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10078. </para>
  10079. <para>
  10080. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  10081. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10082. attributes defined on the <paramref name="repositoryAssembly"/>.
  10083. </para>
  10084. <para>
  10085. If a repository for the <paramref name="repositoryAssembly"/> already exists
  10086. that repository will be returned. An error will not be raised and that
  10087. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  10088. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10089. assembly may be used to override the repository type specified in
  10090. <paramref name="repositoryType"/>.
  10091. </para>
  10092. </remarks>
  10093. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  10094. </member>
  10095. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)">
  10096. <summary>
  10097. Creates a new repository for the assembly specified.
  10098. </summary>
  10099. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10100. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10101. <param name="repositoryName">The name to assign to the created repository</param>
  10102. <param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param>
  10103. <returns>The repository created.</returns>
  10104. <remarks>
  10105. <para>
  10106. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10107. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10108. same assembly specified will return the same repository instance.
  10109. </para>
  10110. <para>
  10111. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  10112. the repository to create can be overridden by specifying the
  10113. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10114. <paramref name="repositoryAssembly"/>. The default values are to use the
  10115. <paramref name="repositoryType"/> implementation of the
  10116. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10117. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10118. </para>
  10119. <para>
  10120. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  10121. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10122. attributes defined on the <paramref name="repositoryAssembly"/>.
  10123. </para>
  10124. <para>
  10125. If a repository for the <paramref name="repositoryAssembly"/> already exists
  10126. that repository will be returned. An error will not be raised and that
  10127. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  10128. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10129. assembly may be used to override the repository type specified in
  10130. <paramref name="repositoryType"/>.
  10131. </para>
  10132. </remarks>
  10133. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  10134. </member>
  10135. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)">
  10136. <summary>
  10137. Creates a new repository for the specified repository.
  10138. </summary>
  10139. <param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10140. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10141. If this param is <see langword="null" /> then the default repository type is used.</param>
  10142. <returns>The new repository.</returns>
  10143. <remarks>
  10144. <para>
  10145. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10146. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10147. same repository specified will return the same repository instance.
  10148. </para>
  10149. </remarks>
  10150. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null" />.</exception>
  10151. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception>
  10152. </member>
  10153. <member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)">
  10154. <summary>
  10155. Test if a named repository exists
  10156. </summary>
  10157. <param name="repositoryName">the named repository to check</param>
  10158. <returns><c>true</c> if the repository exists</returns>
  10159. <remarks>
  10160. <para>
  10161. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  10162. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  10163. a repository.
  10164. </para>
  10165. </remarks>
  10166. </member>
  10167. <member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories">
  10168. <summary>
  10169. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  10170. </summary>
  10171. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  10172. <remarks>
  10173. <para>
  10174. Gets an array of all of the repositories created by this selector.
  10175. </para>
  10176. </remarks>
  10177. </member>
  10178. <member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)">
  10179. <summary>
  10180. Aliases a repository to an existing repository.
  10181. </summary>
  10182. <param name="repositoryAlias">The repository to alias.</param>
  10183. <param name="repositoryTarget">The repository that the repository is aliased to.</param>
  10184. <remarks>
  10185. <para>
  10186. The repository specified will be aliased to the repository when created.
  10187. The repository must not already exist.
  10188. </para>
  10189. <para>
  10190. When the repository is created it must utilize the same repository type as
  10191. the repository it is aliased to, otherwise the aliasing will fail.
  10192. </para>
  10193. </remarks>
  10194. <exception cref="T:System.ArgumentNullException">
  10195. <para><paramref name="repositoryAlias" /> is <see langword="null" />.</para>
  10196. <para>-or-</para>
  10197. <para><paramref name="repositoryTarget" /> is <see langword="null" />.</para>
  10198. </exception>
  10199. </member>
  10200. <member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  10201. <summary>
  10202. Notifies the registered listeners that the repository has been created.
  10203. </summary>
  10204. <param name="repository">The repository that has been created.</param>
  10205. <remarks>
  10206. <para>
  10207. Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  10208. </para>
  10209. </remarks>
  10210. </member>
  10211. <member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)">
  10212. <summary>
  10213. Gets the repository name and repository type for the specified assembly.
  10214. </summary>
  10215. <param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param>
  10216. <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>
  10217. <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>
  10218. <exception cref="T:System.ArgumentNullException"><paramref name="assembly" /> is <see langword="null" />.</exception>
  10219. </member>
  10220. <member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10221. <summary>
  10222. Configures the repository using information from the assembly.
  10223. </summary>
  10224. <param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10225. attributes which define the configuration for the repository.</param>
  10226. <param name="repository">The repository to configure.</param>
  10227. <exception cref="T:System.ArgumentNullException">
  10228. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  10229. <para>-or-</para>
  10230. <para><paramref name="repository" /> is <see langword="null" />.</para>
  10231. </exception>
  10232. </member>
  10233. <member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10234. <summary>
  10235. Loads the attribute defined plugins on the assembly.
  10236. </summary>
  10237. <param name="assembly">The assembly that contains the attributes.</param>
  10238. <param name="repository">The repository to add the plugins to.</param>
  10239. <exception cref="T:System.ArgumentNullException">
  10240. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  10241. <para>-or-</para>
  10242. <para><paramref name="repository" /> is <see langword="null" />.</para>
  10243. </exception>
  10244. </member>
  10245. <member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10246. <summary>
  10247. Loads the attribute defined aliases on the assembly.
  10248. </summary>
  10249. <param name="assembly">The assembly that contains the attributes.</param>
  10250. <param name="repository">The repository to alias to.</param>
  10251. <exception cref="T:System.ArgumentNullException">
  10252. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  10253. <para>-or-</para>
  10254. <para><paramref name="repository" /> is <see langword="null" />.</para>
  10255. </exception>
  10256. </member>
  10257. <member name="F:log4net.Core.DefaultRepositorySelector.declaringType">
  10258. <summary>
  10259. The fully qualified type of the DefaultRepositorySelector class.
  10260. </summary>
  10261. <remarks>
  10262. Used by the internal logger to record the Type of the
  10263. log message.
  10264. </remarks>
  10265. </member>
  10266. <member name="T:log4net.Core.ErrorCode">
  10267. <summary>
  10268. Defined error codes that can be passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  10269. </summary>
  10270. <remarks>
  10271. <para>
  10272. Values passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  10273. </para>
  10274. </remarks>
  10275. <author>Nicko Cadell</author>
  10276. </member>
  10277. <member name="F:log4net.Core.ErrorCode.GenericFailure">
  10278. <summary>
  10279. A general error
  10280. </summary>
  10281. </member>
  10282. <member name="F:log4net.Core.ErrorCode.WriteFailure">
  10283. <summary>
  10284. Error while writing output
  10285. </summary>
  10286. </member>
  10287. <member name="F:log4net.Core.ErrorCode.FlushFailure">
  10288. <summary>
  10289. Failed to flush file
  10290. </summary>
  10291. </member>
  10292. <member name="F:log4net.Core.ErrorCode.CloseFailure">
  10293. <summary>
  10294. Failed to close file
  10295. </summary>
  10296. </member>
  10297. <member name="F:log4net.Core.ErrorCode.FileOpenFailure">
  10298. <summary>
  10299. Unable to open output file
  10300. </summary>
  10301. </member>
  10302. <member name="F:log4net.Core.ErrorCode.MissingLayout">
  10303. <summary>
  10304. No layout specified
  10305. </summary>
  10306. </member>
  10307. <member name="F:log4net.Core.ErrorCode.AddressParseFailure">
  10308. <summary>
  10309. Failed to parse address
  10310. </summary>
  10311. </member>
  10312. <member name="T:log4net.Core.ExceptionEvaluator">
  10313. <summary>
  10314. An evaluator that triggers on an Exception type
  10315. </summary>
  10316. <remarks>
  10317. <para>
  10318. This evaluator will trigger if the type of the Exception
  10319. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  10320. is equal to a Type in <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. ///
  10321. </para>
  10322. </remarks>
  10323. <author>Drew Schaeffer</author>
  10324. </member>
  10325. <member name="F:log4net.Core.ExceptionEvaluator.m_type">
  10326. <summary>
  10327. The type that causes the trigger to fire.
  10328. </summary>
  10329. </member>
  10330. <member name="F:log4net.Core.ExceptionEvaluator.m_triggerOnSubclass">
  10331. <summary>
  10332. Causes subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/> to cause the trigger to fire.
  10333. </summary>
  10334. </member>
  10335. <member name="M:log4net.Core.ExceptionEvaluator.#ctor">
  10336. <summary>
  10337. Default ctor to allow dynamic creation through a configurator.
  10338. </summary>
  10339. </member>
  10340. <member name="M:log4net.Core.ExceptionEvaluator.#ctor(System.Type,System.Boolean)">
  10341. <summary>
  10342. Constructs an evaluator and initializes to trigger on <paramref name="exType"/>
  10343. </summary>
  10344. <param name="exType">the type that triggers this evaluator.</param>
  10345. <param name="triggerOnSubClass">If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.</param>
  10346. </member>
  10347. <member name="P:log4net.Core.ExceptionEvaluator.ExceptionType">
  10348. <summary>
  10349. The type that triggers this evaluator.
  10350. </summary>
  10351. </member>
  10352. <member name="P:log4net.Core.ExceptionEvaluator.TriggerOnSubclass">
  10353. <summary>
  10354. If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10355. </summary>
  10356. </member>
  10357. <member name="M:log4net.Core.ExceptionEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10358. <summary>
  10359. Is this <paramref name="loggingEvent"/> the triggering event?
  10360. </summary>
  10361. <param name="loggingEvent">The event to check</param>
  10362. <returns>This method returns <c>true</c>, if the logging event Exception
  10363. Type is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10364. Otherwise it returns <c>false</c></returns>
  10365. <remarks>
  10366. <para>
  10367. This evaluator will trigger if the Exception Type of the event
  10368. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  10369. is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10370. </para>
  10371. </remarks>
  10372. </member>
  10373. <member name="T:log4net.Core.IAppenderAttachable">
  10374. <summary>
  10375. Interface for attaching appenders to objects.
  10376. </summary>
  10377. <remarks>
  10378. <para>
  10379. Interface for attaching, removing and retrieving appenders.
  10380. </para>
  10381. </remarks>
  10382. <author>Nicko Cadell</author>
  10383. <author>Gert Driesen</author>
  10384. </member>
  10385. <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)">
  10386. <summary>
  10387. Attaches an appender.
  10388. </summary>
  10389. <param name="appender">The appender to add.</param>
  10390. <remarks>
  10391. <para>
  10392. Add the specified appender. The implementation may
  10393. choose to allow or deny duplicate appenders.
  10394. </para>
  10395. </remarks>
  10396. </member>
  10397. <member name="P:log4net.Core.IAppenderAttachable.Appenders">
  10398. <summary>
  10399. Gets all attached appenders.
  10400. </summary>
  10401. <value>
  10402. A collection of attached appenders.
  10403. </value>
  10404. <remarks>
  10405. <para>
  10406. Gets a collection of attached appenders.
  10407. If there are no attached appenders the
  10408. implementation should return an empty
  10409. collection rather than <c>null</c>.
  10410. </para>
  10411. </remarks>
  10412. </member>
  10413. <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)">
  10414. <summary>
  10415. Gets an attached appender with the specified name.
  10416. </summary>
  10417. <param name="name">The name of the appender to get.</param>
  10418. <returns>
  10419. The appender with the name specified, or <c>null</c> if no appender with the
  10420. specified name is found.
  10421. </returns>
  10422. <remarks>
  10423. <para>
  10424. Returns an attached appender with the <paramref name="name"/> specified.
  10425. If no appender with the specified name is found <c>null</c> will be
  10426. returned.
  10427. </para>
  10428. </remarks>
  10429. </member>
  10430. <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders">
  10431. <summary>
  10432. Removes all attached appenders.
  10433. </summary>
  10434. <remarks>
  10435. <para>
  10436. Removes and closes all attached appenders
  10437. </para>
  10438. </remarks>
  10439. </member>
  10440. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)">
  10441. <summary>
  10442. Removes the specified appender from the list of attached appenders.
  10443. </summary>
  10444. <param name="appender">The appender to remove.</param>
  10445. <returns>The appender removed from the list</returns>
  10446. <remarks>
  10447. <para>
  10448. The appender removed is not closed.
  10449. If you are discarding the appender you must call
  10450. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  10451. </para>
  10452. </remarks>
  10453. </member>
  10454. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)">
  10455. <summary>
  10456. Removes the appender with the specified name from the list of appenders.
  10457. </summary>
  10458. <param name="name">The name of the appender to remove.</param>
  10459. <returns>The appender removed from the list</returns>
  10460. <remarks>
  10461. <para>
  10462. The appender removed is not closed.
  10463. If you are discarding the appender you must call
  10464. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  10465. </para>
  10466. </remarks>
  10467. </member>
  10468. <member name="T:log4net.Core.IErrorHandler">
  10469. <summary>
  10470. Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler" />.
  10471. </summary>
  10472. <remarks>
  10473. <para>
  10474. Error handling is a particularly tedious to get right because by
  10475. definition errors are hard to predict and to reproduce.
  10476. </para>
  10477. </remarks>
  10478. <author>Nicko Cadell</author>
  10479. <author>Gert Driesen</author>
  10480. </member>
  10481. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  10482. <summary>
  10483. Handles the error and information about the error condition is passed as
  10484. a parameter.
  10485. </summary>
  10486. <param name="message">The message associated with the error.</param>
  10487. <param name="e">The <see cref="T:System.Exception" /> that was thrown when the error occurred.</param>
  10488. <param name="errorCode">The error code associated with the error.</param>
  10489. <remarks>
  10490. <para>
  10491. Handles the error and information about the error condition is passed as
  10492. a parameter.
  10493. </para>
  10494. </remarks>
  10495. </member>
  10496. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)">
  10497. <summary>
  10498. Prints the error message passed as a parameter.
  10499. </summary>
  10500. <param name="message">The message associated with the error.</param>
  10501. <param name="e">The <see cref="T:System.Exception" /> that was thrown when the error occurred.</param>
  10502. <remarks>
  10503. <para>
  10504. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  10505. </para>
  10506. </remarks>
  10507. </member>
  10508. <member name="M:log4net.Core.IErrorHandler.Error(System.String)">
  10509. <summary>
  10510. Prints the error message passed as a parameter.
  10511. </summary>
  10512. <param name="message">The message associated with the error.</param>
  10513. <remarks>
  10514. <para>
  10515. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  10516. </para>
  10517. </remarks>
  10518. </member>
  10519. <member name="T:log4net.Core.IFixingRequired">
  10520. <summary>
  10521. Interface for objects that require fixing.
  10522. </summary>
  10523. <remarks>
  10524. <para>
  10525. Interface that indicates that the object requires fixing before it
  10526. can be taken outside the context of the appender's
  10527. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  10528. </para>
  10529. <para>
  10530. When objects that implement this interface are stored
  10531. in the context properties maps <see cref="T:log4net.GlobalContext"/>
  10532. <see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/>
  10533. <see cref="P:log4net.ThreadContext.Properties"/> are fixed
  10534. (see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/>
  10535. method will be called.
  10536. </para>
  10537. </remarks>
  10538. <author>Nicko Cadell</author>
  10539. </member>
  10540. <member name="M:log4net.Core.IFixingRequired.GetFixedObject">
  10541. <summary>
  10542. Get a portable version of this object
  10543. </summary>
  10544. <returns>the portable instance of this object</returns>
  10545. <remarks>
  10546. <para>
  10547. Get a portable instance object that represents the current
  10548. state of this object. The portable object can be stored
  10549. and logged from any thread with identical results.
  10550. </para>
  10551. </remarks>
  10552. </member>
  10553. <member name="T:log4net.Core.ILogger">
  10554. <summary>
  10555. Interface that all loggers implement
  10556. </summary>
  10557. <remarks>
  10558. <para>
  10559. This interface supports logging events and testing if a level
  10560. is enabled for logging.
  10561. </para>
  10562. <para>
  10563. These methods will not throw exceptions. Note to implementor, ensure
  10564. that the implementation of these methods cannot allow an exception
  10565. to be thrown to the caller.
  10566. </para>
  10567. </remarks>
  10568. <author>Nicko Cadell</author>
  10569. <author>Gert Driesen</author>
  10570. </member>
  10571. <member name="P:log4net.Core.ILogger.Name">
  10572. <summary>
  10573. Gets the name of the logger.
  10574. </summary>
  10575. <value>
  10576. The name of the logger.
  10577. </value>
  10578. <remarks>
  10579. <para>
  10580. The name of this logger
  10581. </para>
  10582. </remarks>
  10583. </member>
  10584. <member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  10585. <summary>
  10586. This generic form is intended to be used by wrappers.
  10587. </summary>
  10588. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  10589. the stack boundary into the logging system for this call.</param>
  10590. <param name="level">The level of the message to be logged.</param>
  10591. <param name="message">The message object to log.</param>
  10592. <param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param>
  10593. <remarks>
  10594. <para>
  10595. Generates a logging event for the specified <paramref name="level"/> using
  10596. the <paramref name="message"/> and <paramref name="exception"/>.
  10597. </para>
  10598. </remarks>
  10599. </member>
  10600. <member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)">
  10601. <summary>
  10602. This is the most generic printing method that is intended to be used
  10603. by wrappers.
  10604. </summary>
  10605. <param name="logEvent">The event being logged.</param>
  10606. <remarks>
  10607. <para>
  10608. Logs the specified logging event through this logger.
  10609. </para>
  10610. </remarks>
  10611. </member>
  10612. <member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)">
  10613. <summary>
  10614. Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter.
  10615. </summary>
  10616. <param name="level">The level to check.</param>
  10617. <returns>
  10618. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  10619. </returns>
  10620. <remarks>
  10621. <para>
  10622. Test if this logger is going to log events of the specified <paramref name="level"/>.
  10623. </para>
  10624. </remarks>
  10625. </member>
  10626. <member name="P:log4net.Core.ILogger.Repository">
  10627. <summary>
  10628. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  10629. <c>Logger</c> instance is attached to.
  10630. </summary>
  10631. <value>
  10632. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this logger belongs to.
  10633. </value>
  10634. <remarks>
  10635. <para>
  10636. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  10637. <c>Logger</c> instance is attached to.
  10638. </para>
  10639. </remarks>
  10640. </member>
  10641. <member name="T:log4net.Core.ILoggerWrapper">
  10642. <summary>
  10643. Base interface for all wrappers
  10644. </summary>
  10645. <remarks>
  10646. <para>
  10647. Base interface for all wrappers.
  10648. </para>
  10649. <para>
  10650. All wrappers must implement this interface.
  10651. </para>
  10652. </remarks>
  10653. <author>Nicko Cadell</author>
  10654. </member>
  10655. <member name="P:log4net.Core.ILoggerWrapper.Logger">
  10656. <summary>
  10657. Get the implementation behind this wrapper object.
  10658. </summary>
  10659. <value>
  10660. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object.
  10661. </value>
  10662. <remarks>
  10663. <para>
  10664. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this
  10665. object. The <c>Logger</c> object may not
  10666. be the same object as this object because of logger decorators.
  10667. This gets the actual underlying objects that is used to process
  10668. the log events.
  10669. </para>
  10670. </remarks>
  10671. </member>
  10672. <member name="T:log4net.Core.IOptionHandler">
  10673. <summary>
  10674. Interface used to delay activate a configured object.
  10675. </summary>
  10676. <remarks>
  10677. <para>
  10678. This allows an object to defer activation of its options until all
  10679. options have been set. This is required for components which have
  10680. related options that remain ambiguous until all are set.
  10681. </para>
  10682. <para>
  10683. If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method
  10684. must be called by the container after its all the configured properties have been set
  10685. and before the component can be used.
  10686. </para>
  10687. </remarks>
  10688. <author>Nicko Cadell</author>
  10689. </member>
  10690. <member name="M:log4net.Core.IOptionHandler.ActivateOptions">
  10691. <summary>
  10692. Activate the options that were previously set with calls to properties.
  10693. </summary>
  10694. <remarks>
  10695. <para>
  10696. This allows an object to defer activation of its options until all
  10697. options have been set. This is required for components which have
  10698. related options that remain ambiguous until all are set.
  10699. </para>
  10700. <para>
  10701. If a component implements this interface then this method must be called
  10702. after its properties have been set before the component can be used.
  10703. </para>
  10704. </remarks>
  10705. </member>
  10706. <member name="T:log4net.Core.LoggerRepositoryCreationEventHandler">
  10707. <summary>
  10708. Delegate used to handle logger repository creation event notifications
  10709. </summary>
  10710. <param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param>
  10711. <param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args
  10712. that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param>
  10713. <remarks>
  10714. <para>
  10715. Delegate used to handle logger repository creation event notifications.
  10716. </para>
  10717. </remarks>
  10718. </member>
  10719. <member name="T:log4net.Core.LoggerRepositoryCreationEventArgs">
  10720. <summary>
  10721. Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  10722. </summary>
  10723. <remarks>
  10724. <para>
  10725. A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/>
  10726. event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created.
  10727. </para>
  10728. </remarks>
  10729. </member>
  10730. <member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository">
  10731. <summary>
  10732. The <see cref="T:log4net.Repository.ILoggerRepository"/> created
  10733. </summary>
  10734. </member>
  10735. <member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)">
  10736. <summary>
  10737. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  10738. </summary>
  10739. <param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param>
  10740. <remarks>
  10741. <para>
  10742. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  10743. </para>
  10744. </remarks>
  10745. </member>
  10746. <member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository">
  10747. <summary>
  10748. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10749. </summary>
  10750. <value>
  10751. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10752. </value>
  10753. <remarks>
  10754. <para>
  10755. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10756. </para>
  10757. </remarks>
  10758. </member>
  10759. <member name="T:log4net.Core.IRepositorySelector">
  10760. <summary>
  10761. Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10762. </summary>
  10763. <remarks>
  10764. <para>
  10765. The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/>
  10766. to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/>
  10767. to return to the caller.
  10768. </para>
  10769. </remarks>
  10770. <author>Nicko Cadell</author>
  10771. <author>Gert Driesen</author>
  10772. </member>
  10773. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10774. <summary>
  10775. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10776. </summary>
  10777. <param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10778. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns>
  10779. <remarks>
  10780. <para>
  10781. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10782. </para>
  10783. <para>
  10784. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  10785. is made is not defined. The implementation may choose any method for
  10786. this association. The results of this method must be repeatable, i.e.
  10787. when called again with the same arguments the result must be the
  10788. save value.
  10789. </para>
  10790. </remarks>
  10791. </member>
  10792. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)">
  10793. <summary>
  10794. Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10795. </summary>
  10796. <param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10797. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  10798. <remarks>
  10799. Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by
  10800. calling <see cref="M:CreateRepository(string,Type)"/>.
  10801. </remarks>
  10802. </member>
  10803. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10804. <summary>
  10805. Creates a new repository for the assembly specified.
  10806. </summary>
  10807. <param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10808. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10809. <returns>The repository created.</returns>
  10810. <remarks>
  10811. <para>
  10812. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain
  10813. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10814. same assembly specified will return the same repository instance.
  10815. </para>
  10816. <para>
  10817. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  10818. is made is not defined. The implementation may choose any method for
  10819. this association.
  10820. </para>
  10821. </remarks>
  10822. </member>
  10823. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)">
  10824. <summary>
  10825. Creates a new repository with the name specified.
  10826. </summary>
  10827. <param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10828. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10829. <returns>The repository created.</returns>
  10830. <remarks>
  10831. <para>
  10832. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name
  10833. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10834. same name will return the same repository instance.
  10835. </para>
  10836. </remarks>
  10837. </member>
  10838. <member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)">
  10839. <summary>
  10840. Test if a named repository exists
  10841. </summary>
  10842. <param name="repositoryName">the named repository to check</param>
  10843. <returns><c>true</c> if the repository exists</returns>
  10844. <remarks>
  10845. <para>
  10846. Test if a named repository exists. Use <see cref="M:CreateRepository(Assembly, Type)"/>
  10847. to create a new repository and <see cref="M:GetRepository(Assembly)"/> to retrieve
  10848. a repository.
  10849. </para>
  10850. </remarks>
  10851. </member>
  10852. <member name="M:log4net.Core.IRepositorySelector.GetAllRepositories">
  10853. <summary>
  10854. Gets an array of all currently defined repositories.
  10855. </summary>
  10856. <returns>
  10857. An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by
  10858. this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns>
  10859. <remarks>
  10860. <para>
  10861. Gets an array of all of the repositories created by this selector.
  10862. </para>
  10863. </remarks>
  10864. </member>
  10865. <member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent">
  10866. <summary>
  10867. Event to notify that a logger repository has been created.
  10868. </summary>
  10869. <value>
  10870. Event to notify that a logger repository has been created.
  10871. </value>
  10872. <remarks>
  10873. <para>
  10874. Event raised when a new repository is created.
  10875. The event source will be this selector. The event args will
  10876. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  10877. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10878. </para>
  10879. </remarks>
  10880. </member>
  10881. <member name="T:log4net.Core.ITriggeringEventEvaluator">
  10882. <summary>
  10883. Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action
  10884. </summary>
  10885. <remarks>
  10886. <para>
  10887. Implementations of this interface allow certain appenders to decide
  10888. when to perform an appender specific action.
  10889. </para>
  10890. <para>
  10891. The action or behavior triggered is defined by the implementation.
  10892. </para>
  10893. </remarks>
  10894. <author>Nicko Cadell</author>
  10895. </member>
  10896. <member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10897. <summary>
  10898. Test if this event triggers the action
  10899. </summary>
  10900. <param name="loggingEvent">The event to check</param>
  10901. <returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns>
  10902. <remarks>
  10903. <para>
  10904. Return <c>true</c> if this event triggers the action
  10905. </para>
  10906. </remarks>
  10907. </member>
  10908. <member name="T:log4net.Core.Level">
  10909. <summary>
  10910. Defines the default set of levels recognized by the system.
  10911. </summary>
  10912. <remarks>
  10913. <para>
  10914. Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>.
  10915. </para>
  10916. <para>
  10917. Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative
  10918. ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/>
  10919. are deemed to be equivalent.
  10920. </para>
  10921. <para>
  10922. The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/>
  10923. and each repository can have different levels defined. The levels are stored
  10924. in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are
  10925. looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>.
  10926. </para>
  10927. <para>
  10928. When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but
  10929. the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is
  10930. <see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map.
  10931. </para>
  10932. <para>
  10933. Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The
  10934. <see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default
  10935. the display name is the same as the level name, but this can be used to alias levels
  10936. or to localize the log output.
  10937. </para>
  10938. <para>
  10939. Some of the predefined levels recognized by the system are:
  10940. </para>
  10941. <list type="bullet">
  10942. <item>
  10943. <description><see cref="F:log4net.Core.Level.Off"/>.</description>
  10944. </item>
  10945. <item>
  10946. <description><see cref="F:log4net.Core.Level.Fatal"/>.</description>
  10947. </item>
  10948. <item>
  10949. <description><see cref="F:log4net.Core.Level.Error"/>.</description>
  10950. </item>
  10951. <item>
  10952. <description><see cref="F:log4net.Core.Level.Warn"/>.</description>
  10953. </item>
  10954. <item>
  10955. <description><see cref="F:log4net.Core.Level.Info"/>.</description>
  10956. </item>
  10957. <item>
  10958. <description><see cref="F:log4net.Core.Level.Debug"/>.</description>
  10959. </item>
  10960. <item>
  10961. <description><see cref="F:log4net.Core.Level.All"/>.</description>
  10962. </item>
  10963. </list>
  10964. </remarks>
  10965. <author>Nicko Cadell</author>
  10966. <author>Gert Driesen</author>
  10967. </member>
  10968. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)">
  10969. <summary>
  10970. Constructor
  10971. </summary>
  10972. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  10973. <param name="levelName">The string name of this level.</param>
  10974. <param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param>
  10975. <remarks>
  10976. <para>
  10977. Initializes a new instance of the <see cref="T:log4net.Core.Level" /> class with
  10978. the specified level name and value.
  10979. </para>
  10980. </remarks>
  10981. </member>
  10982. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)">
  10983. <summary>
  10984. Constructor
  10985. </summary>
  10986. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  10987. <param name="levelName">The string name of this level.</param>
  10988. <remarks>
  10989. <para>
  10990. Initializes a new instance of the <see cref="T:log4net.Core.Level" /> class with
  10991. the specified level name and value.
  10992. </para>
  10993. </remarks>
  10994. </member>
  10995. <member name="P:log4net.Core.Level.Name">
  10996. <summary>
  10997. Gets the name of this level.
  10998. </summary>
  10999. <value>
  11000. The name of this level.
  11001. </value>
  11002. <remarks>
  11003. <para>
  11004. Gets the name of this level.
  11005. </para>
  11006. </remarks>
  11007. </member>
  11008. <member name="P:log4net.Core.Level.Value">
  11009. <summary>
  11010. Gets the value of this level.
  11011. </summary>
  11012. <value>
  11013. The value of this level.
  11014. </value>
  11015. <remarks>
  11016. <para>
  11017. Gets the value of this level.
  11018. </para>
  11019. </remarks>
  11020. </member>
  11021. <member name="P:log4net.Core.Level.DisplayName">
  11022. <summary>
  11023. Gets the display name of this level.
  11024. </summary>
  11025. <value>
  11026. The display name of this level.
  11027. </value>
  11028. <remarks>
  11029. <para>
  11030. Gets the display name of this level.
  11031. </para>
  11032. </remarks>
  11033. </member>
  11034. <member name="M:log4net.Core.Level.ToString">
  11035. <summary>
  11036. Returns the <see cref="T:System.String" /> representation of the current
  11037. <see cref="T:log4net.Core.Level" />.
  11038. </summary>
  11039. <returns>
  11040. A <see cref="T:System.String" /> representation of the current <see cref="T:log4net.Core.Level" />.
  11041. </returns>
  11042. <remarks>
  11043. <para>
  11044. Returns the level <see cref="P:log4net.Core.Level.Name"/>.
  11045. </para>
  11046. </remarks>
  11047. </member>
  11048. <member name="M:log4net.Core.Level.Equals(System.Object)">
  11049. <summary>
  11050. Compares levels.
  11051. </summary>
  11052. <param name="o">The object to compare against.</param>
  11053. <returns><c>true</c> if the objects are equal.</returns>
  11054. <remarks>
  11055. <para>
  11056. Compares the levels of <see cref="T:log4net.Core.Level" /> instances, and
  11057. defers to base class if the target object is not a <see cref="T:log4net.Core.Level" />
  11058. instance.
  11059. </para>
  11060. </remarks>
  11061. </member>
  11062. <member name="M:log4net.Core.Level.GetHashCode">
  11063. <summary>
  11064. Returns a hash code
  11065. </summary>
  11066. <returns>A hash code for the current <see cref="T:log4net.Core.Level" />.</returns>
  11067. <remarks>
  11068. <para>
  11069. Returns a hash code suitable for use in hashing algorithms and data
  11070. structures like a hash table.
  11071. </para>
  11072. <para>
  11073. Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>.
  11074. </para>
  11075. </remarks>
  11076. </member>
  11077. <member name="M:log4net.Core.Level.CompareTo(System.Object)">
  11078. <summary>
  11079. Compares this instance to a specified object and returns an
  11080. indication of their relative values.
  11081. </summary>
  11082. <param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null" /> to compare with this instance.</param>
  11083. <returns>
  11084. A 32-bit signed integer that indicates the relative order of the
  11085. values compared. The return value has these meanings:
  11086. <list type="table">
  11087. <listheader>
  11088. <term>Value</term>
  11089. <description>Meaning</description>
  11090. </listheader>
  11091. <item>
  11092. <term>Less than zero</term>
  11093. <description>This instance is less than <paramref name="r" />.</description>
  11094. </item>
  11095. <item>
  11096. <term>Zero</term>
  11097. <description>This instance is equal to <paramref name="r" />.</description>
  11098. </item>
  11099. <item>
  11100. <term>Greater than zero</term>
  11101. <description>
  11102. <para>This instance is greater than <paramref name="r" />.</para>
  11103. <para>-or-</para>
  11104. <para><paramref name="r" /> is <see langword="null" />.</para>
  11105. </description>
  11106. </item>
  11107. </list>
  11108. </returns>
  11109. <remarks>
  11110. <para>
  11111. <paramref name="r" /> must be an instance of <see cref="T:log4net.Core.Level" />
  11112. or <see langword="null" />; otherwise, an exception is thrown.
  11113. </para>
  11114. </remarks>
  11115. <exception cref="T:System.ArgumentException"><paramref name="r" /> is not a <see cref="T:log4net.Core.Level" />.</exception>
  11116. </member>
  11117. <member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)">
  11118. <summary>
  11119. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  11120. is greater than another specified <see cref="T:log4net.Core.Level" />.
  11121. </summary>
  11122. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  11123. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  11124. <returns>
  11125. <c>true</c> if <paramref name="l" /> is greater than
  11126. <paramref name="r" />; otherwise, <c>false</c>.
  11127. </returns>
  11128. <remarks>
  11129. <para>
  11130. Compares two levels.
  11131. </para>
  11132. </remarks>
  11133. </member>
  11134. <member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)">
  11135. <summary>
  11136. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  11137. is less than another specified <see cref="T:log4net.Core.Level" />.
  11138. </summary>
  11139. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  11140. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  11141. <returns>
  11142. <c>true</c> if <paramref name="l" /> is less than
  11143. <paramref name="r" />; otherwise, <c>false</c>.
  11144. </returns>
  11145. <remarks>
  11146. <para>
  11147. Compares two levels.
  11148. </para>
  11149. </remarks>
  11150. </member>
  11151. <member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  11152. <summary>
  11153. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  11154. is greater than or equal to another specified <see cref="T:log4net.Core.Level" />.
  11155. </summary>
  11156. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  11157. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  11158. <returns>
  11159. <c>true</c> if <paramref name="l" /> is greater than or equal to
  11160. <paramref name="r" />; otherwise, <c>false</c>.
  11161. </returns>
  11162. <remarks>
  11163. <para>
  11164. Compares two levels.
  11165. </para>
  11166. </remarks>
  11167. </member>
  11168. <member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  11169. <summary>
  11170. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  11171. is less than or equal to another specified <see cref="T:log4net.Core.Level" />.
  11172. </summary>
  11173. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  11174. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  11175. <returns>
  11176. <c>true</c> if <paramref name="l" /> is less than or equal to
  11177. <paramref name="r" />; otherwise, <c>false</c>.
  11178. </returns>
  11179. <remarks>
  11180. <para>
  11181. Compares two levels.
  11182. </para>
  11183. </remarks>
  11184. </member>
  11185. <member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)">
  11186. <summary>
  11187. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level" />
  11188. objects have the same value.
  11189. </summary>
  11190. <param name="l">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  11191. <param name="r">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  11192. <returns>
  11193. <c>true</c> if the value of <paramref name="l" /> is the same as the
  11194. value of <paramref name="r" />; otherwise, <c>false</c>.
  11195. </returns>
  11196. <remarks>
  11197. <para>
  11198. Compares two levels.
  11199. </para>
  11200. </remarks>
  11201. </member>
  11202. <member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)">
  11203. <summary>
  11204. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level" />
  11205. objects have different values.
  11206. </summary>
  11207. <param name="l">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  11208. <param name="r">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  11209. <returns>
  11210. <c>true</c> if the value of <paramref name="l" /> is different from
  11211. the value of <paramref name="r" />; otherwise, <c>false</c>.
  11212. </returns>
  11213. <remarks>
  11214. <para>
  11215. Compares two levels.
  11216. </para>
  11217. </remarks>
  11218. </member>
  11219. <member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)">
  11220. <summary>
  11221. Compares two specified <see cref="T:log4net.Core.Level"/> instances.
  11222. </summary>
  11223. <param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param>
  11224. <param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param>
  11225. <returns>
  11226. A 32-bit signed integer that indicates the relative order of the
  11227. two values compared. The return value has these meanings:
  11228. <list type="table">
  11229. <listheader>
  11230. <term>Value</term>
  11231. <description>Meaning</description>
  11232. </listheader>
  11233. <item>
  11234. <term>Less than zero</term>
  11235. <description><paramref name="l" /> is less than <paramref name="r" />.</description>
  11236. </item>
  11237. <item>
  11238. <term>Zero</term>
  11239. <description><paramref name="l" /> is equal to <paramref name="r" />.</description>
  11240. </item>
  11241. <item>
  11242. <term>Greater than zero</term>
  11243. <description><paramref name="l" /> is greater than <paramref name="r" />.</description>
  11244. </item>
  11245. </list>
  11246. </returns>
  11247. <remarks>
  11248. <para>
  11249. Compares two levels.
  11250. </para>
  11251. </remarks>
  11252. </member>
  11253. <member name="F:log4net.Core.Level.Off">
  11254. <summary>
  11255. The <see cref="F:log4net.Core.Level.Off" /> level designates a higher level than all the rest.
  11256. </summary>
  11257. </member>
  11258. <member name="F:log4net.Core.Level.Log4Net_Debug">
  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.Emergency">
  11265. <summary>
  11266. The <see cref="F:log4net.Core.Level.Emergency" /> level designates very severe error events.
  11267. System unusable, emergencies.
  11268. </summary>
  11269. </member>
  11270. <member name="F:log4net.Core.Level.Fatal">
  11271. <summary>
  11272. The <see cref="F:log4net.Core.Level.Fatal" /> level designates very severe error events
  11273. that will presumably lead the application to abort.
  11274. </summary>
  11275. </member>
  11276. <member name="F:log4net.Core.Level.Alert">
  11277. <summary>
  11278. The <see cref="F:log4net.Core.Level.Alert" /> level designates very severe error events.
  11279. Take immediate action, alerts.
  11280. </summary>
  11281. </member>
  11282. <member name="F:log4net.Core.Level.Critical">
  11283. <summary>
  11284. The <see cref="F:log4net.Core.Level.Critical" /> level designates very severe error events.
  11285. Critical condition, critical.
  11286. </summary>
  11287. </member>
  11288. <member name="F:log4net.Core.Level.Severe">
  11289. <summary>
  11290. The <see cref="F:log4net.Core.Level.Severe" /> level designates very severe error events.
  11291. </summary>
  11292. </member>
  11293. <member name="F:log4net.Core.Level.Error">
  11294. <summary>
  11295. The <see cref="F:log4net.Core.Level.Error" /> level designates error events that might
  11296. still allow the application to continue running.
  11297. </summary>
  11298. </member>
  11299. <member name="F:log4net.Core.Level.Warn">
  11300. <summary>
  11301. The <see cref="F:log4net.Core.Level.Warn" /> level designates potentially harmful
  11302. situations.
  11303. </summary>
  11304. </member>
  11305. <member name="F:log4net.Core.Level.Notice">
  11306. <summary>
  11307. The <see cref="F:log4net.Core.Level.Notice" /> level designates informational messages
  11308. that highlight the progress of the application at the highest level.
  11309. </summary>
  11310. </member>
  11311. <member name="F:log4net.Core.Level.Info">
  11312. <summary>
  11313. The <see cref="F:log4net.Core.Level.Info" /> level designates informational messages that
  11314. highlight the progress of the application at coarse-grained level.
  11315. </summary>
  11316. </member>
  11317. <member name="F:log4net.Core.Level.Debug">
  11318. <summary>
  11319. The <see cref="F:log4net.Core.Level.Debug" /> 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.Fine">
  11324. <summary>
  11325. The <see cref="F:log4net.Core.Level.Fine" /> 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.Trace">
  11330. <summary>
  11331. The <see cref="F:log4net.Core.Level.Trace" /> 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.Finer">
  11336. <summary>
  11337. The <see cref="F:log4net.Core.Level.Finer" /> 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.Verbose">
  11342. <summary>
  11343. The <see cref="F:log4net.Core.Level.Verbose" /> 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.Finest">
  11348. <summary>
  11349. The <see cref="F:log4net.Core.Level.Finest" /> level designates fine-grained informational
  11350. events that are most useful to debug an application.
  11351. </summary>
  11352. </member>
  11353. <member name="F:log4net.Core.Level.All">
  11354. <summary>
  11355. The <see cref="F:log4net.Core.Level.All" /> level designates the lowest level possible.
  11356. </summary>
  11357. </member>
  11358. <member name="T:log4net.Core.LevelCollection">
  11359. <summary>
  11360. A strongly-typed collection of <see cref="T:log4net.Core.Level"/> objects.
  11361. </summary>
  11362. <author>Nicko Cadell</author>
  11363. </member>
  11364. <member name="T:log4net.Core.LevelCollection.ILevelCollectionEnumerator">
  11365. <summary>
  11366. Supports type-safe iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  11367. </summary>
  11368. </member>
  11369. <member name="P:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Current">
  11370. <summary>
  11371. Gets the current element in the collection.
  11372. </summary>
  11373. </member>
  11374. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.MoveNext">
  11375. <summary>
  11376. Advances the enumerator to the next element in the collection.
  11377. </summary>
  11378. <returns>
  11379. <c>true</c> if the enumerator was successfully advanced to the next element;
  11380. <c>false</c> if the enumerator has passed the end of the collection.
  11381. </returns>
  11382. <exception cref="T:System.InvalidOperationException">
  11383. The collection was modified after the enumerator was created.
  11384. </exception>
  11385. </member>
  11386. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Reset">
  11387. <summary>
  11388. Sets the enumerator to its initial position, before the first element in the collection.
  11389. </summary>
  11390. </member>
  11391. <member name="M:log4net.Core.LevelCollection.ReadOnly(log4net.Core.LevelCollection)">
  11392. <summary>
  11393. Creates a read-only wrapper for a <c>LevelCollection</c> instance.
  11394. </summary>
  11395. <param name="list">list to create a readonly wrapper arround</param>
  11396. <returns>
  11397. A <c>LevelCollection</c> wrapper that is read-only.
  11398. </returns>
  11399. </member>
  11400. <member name="M:log4net.Core.LevelCollection.#ctor">
  11401. <summary>
  11402. Initializes a new instance of the <c>LevelCollection</c> class
  11403. that is empty and has the default initial capacity.
  11404. </summary>
  11405. </member>
  11406. <member name="M:log4net.Core.LevelCollection.#ctor(System.Int32)">
  11407. <summary>
  11408. Initializes a new instance of the <c>LevelCollection</c> class
  11409. that has the specified initial capacity.
  11410. </summary>
  11411. <param name="capacity">
  11412. The number of elements that the new <c>LevelCollection</c> is initially capable of storing.
  11413. </param>
  11414. </member>
  11415. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection)">
  11416. <summary>
  11417. Initializes a new instance of the <c>LevelCollection</c> class
  11418. that contains elements copied from the specified <c>LevelCollection</c>.
  11419. </summary>
  11420. <param name="c">The <c>LevelCollection</c> whose elements are copied to the new collection.</param>
  11421. </member>
  11422. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.Level[])">
  11423. <summary>
  11424. Initializes a new instance of the <c>LevelCollection</c> class
  11425. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> array.
  11426. </summary>
  11427. <param name="a">The <see cref="T:log4net.Core.Level"/> array whose elements are copied to the new list.</param>
  11428. </member>
  11429. <member name="M:log4net.Core.LevelCollection.#ctor(System.Collections.ICollection)">
  11430. <summary>
  11431. Initializes a new instance of the <c>LevelCollection</c> class
  11432. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> collection.
  11433. </summary>
  11434. <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements are copied to the new list.</param>
  11435. </member>
  11436. <member name="T:log4net.Core.LevelCollection.Tag">
  11437. <summary>
  11438. Type visible only to our subclasses
  11439. Used to access protected constructor
  11440. </summary>
  11441. </member>
  11442. <member name="F:log4net.Core.LevelCollection.Tag.Default">
  11443. <summary>
  11444. A value
  11445. </summary>
  11446. </member>
  11447. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection.Tag)">
  11448. <summary>
  11449. Allow subclasses to avoid our default constructors
  11450. </summary>
  11451. <param name="tag"></param>
  11452. </member>
  11453. <member name="P:log4net.Core.LevelCollection.Count">
  11454. <summary>
  11455. Gets the number of elements actually contained in the <c>LevelCollection</c>.
  11456. </summary>
  11457. </member>
  11458. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[])">
  11459. <summary>
  11460. Copies the entire <c>LevelCollection</c> to a one-dimensional
  11461. <see cref="T:log4net.Core.Level"/> array.
  11462. </summary>
  11463. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  11464. </member>
  11465. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[],System.Int32)">
  11466. <summary>
  11467. Copies the entire <c>LevelCollection</c> to a one-dimensional
  11468. <see cref="T:log4net.Core.Level"/> array, starting at the specified index of the target array.
  11469. </summary>
  11470. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  11471. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  11472. </member>
  11473. <member name="P:log4net.Core.LevelCollection.IsSynchronized">
  11474. <summary>
  11475. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  11476. </summary>
  11477. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  11478. </member>
  11479. <member name="P:log4net.Core.LevelCollection.SyncRoot">
  11480. <summary>
  11481. Gets an object that can be used to synchronize access to the collection.
  11482. </summary>
  11483. </member>
  11484. <member name="P:log4net.Core.LevelCollection.Item(System.Int32)">
  11485. <summary>
  11486. Gets or sets the <see cref="T:log4net.Core.Level"/> at the specified index.
  11487. </summary>
  11488. <param name="index">The zero-based index of the element to get or set.</param>
  11489. <exception cref="T:System.ArgumentOutOfRangeException">
  11490. <para><paramref name="index"/> is less than zero</para>
  11491. <para>-or-</para>
  11492. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11493. </exception>
  11494. </member>
  11495. <member name="M:log4net.Core.LevelCollection.Add(log4net.Core.Level)">
  11496. <summary>
  11497. Adds a <see cref="T:log4net.Core.Level"/> to the end of the <c>LevelCollection</c>.
  11498. </summary>
  11499. <param name="item">The <see cref="T:log4net.Core.Level"/> to be added to the end of the <c>LevelCollection</c>.</param>
  11500. <returns>The index at which the value has been added.</returns>
  11501. </member>
  11502. <member name="M:log4net.Core.LevelCollection.Clear">
  11503. <summary>
  11504. Removes all elements from the <c>LevelCollection</c>.
  11505. </summary>
  11506. </member>
  11507. <member name="M:log4net.Core.LevelCollection.Clone">
  11508. <summary>
  11509. Creates a shallow copy of the <see cref="T:log4net.Core.LevelCollection"/>.
  11510. </summary>
  11511. <returns>A new <see cref="T:log4net.Core.LevelCollection"/> with a shallow copy of the collection data.</returns>
  11512. </member>
  11513. <member name="M:log4net.Core.LevelCollection.Contains(log4net.Core.Level)">
  11514. <summary>
  11515. Determines whether a given <see cref="T:log4net.Core.Level"/> is in the <c>LevelCollection</c>.
  11516. </summary>
  11517. <param name="item">The <see cref="T:log4net.Core.Level"/> to check for.</param>
  11518. <returns><c>true</c> if <paramref name="item"/> is found in the <c>LevelCollection</c>; otherwise, <c>false</c>.</returns>
  11519. </member>
  11520. <member name="M:log4net.Core.LevelCollection.IndexOf(log4net.Core.Level)">
  11521. <summary>
  11522. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Core.Level"/>
  11523. in the <c>LevelCollection</c>.
  11524. </summary>
  11525. <param name="item">The <see cref="T:log4net.Core.Level"/> to locate in the <c>LevelCollection</c>.</param>
  11526. <returns>
  11527. The zero-based index of the first occurrence of <paramref name="item"/>
  11528. in the entire <c>LevelCollection</c>, if found; otherwise, -1.
  11529. </returns>
  11530. </member>
  11531. <member name="M:log4net.Core.LevelCollection.Insert(System.Int32,log4net.Core.Level)">
  11532. <summary>
  11533. Inserts an element into the <c>LevelCollection</c> at the specified index.
  11534. </summary>
  11535. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  11536. <param name="item">The <see cref="T:log4net.Core.Level"/> to insert.</param>
  11537. <exception cref="T:System.ArgumentOutOfRangeException">
  11538. <para><paramref name="index"/> is less than zero</para>
  11539. <para>-or-</para>
  11540. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11541. </exception>
  11542. </member>
  11543. <member name="M:log4net.Core.LevelCollection.Remove(log4net.Core.Level)">
  11544. <summary>
  11545. Removes the first occurrence of a specific <see cref="T:log4net.Core.Level"/> from the <c>LevelCollection</c>.
  11546. </summary>
  11547. <param name="item">The <see cref="T:log4net.Core.Level"/> to remove from the <c>LevelCollection</c>.</param>
  11548. <exception cref="T:System.ArgumentException">
  11549. The specified <see cref="T:log4net.Core.Level"/> was not found in the <c>LevelCollection</c>.
  11550. </exception>
  11551. </member>
  11552. <member name="M:log4net.Core.LevelCollection.RemoveAt(System.Int32)">
  11553. <summary>
  11554. Removes the element at the specified index of the <c>LevelCollection</c>.
  11555. </summary>
  11556. <param name="index">The zero-based index of the element to remove.</param>
  11557. <exception cref="T:System.ArgumentOutOfRangeException">
  11558. <para><paramref name="index"/> is less than zero</para>
  11559. <para>-or-</para>
  11560. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11561. </exception>
  11562. </member>
  11563. <member name="P:log4net.Core.LevelCollection.IsFixedSize">
  11564. <summary>
  11565. Gets a value indicating whether the collection has a fixed size.
  11566. </summary>
  11567. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  11568. </member>
  11569. <member name="P:log4net.Core.LevelCollection.IsReadOnly">
  11570. <summary>
  11571. Gets a value indicating whether the IList is read-only.
  11572. </summary>
  11573. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  11574. </member>
  11575. <member name="M:log4net.Core.LevelCollection.GetEnumerator">
  11576. <summary>
  11577. Returns an enumerator that can iterate through the <c>LevelCollection</c>.
  11578. </summary>
  11579. <returns>An <see cref="T:log4net.Core.LevelCollection.Enumerator"/> for the entire <c>LevelCollection</c>.</returns>
  11580. </member>
  11581. <member name="P:log4net.Core.LevelCollection.Capacity">
  11582. <summary>
  11583. Gets or sets the number of elements the <c>LevelCollection</c> can contain.
  11584. </summary>
  11585. </member>
  11586. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.LevelCollection)">
  11587. <summary>
  11588. Adds the elements of another <c>LevelCollection</c> to the current <c>LevelCollection</c>.
  11589. </summary>
  11590. <param name="x">The <c>LevelCollection</c> whose elements should be added to the end of the current <c>LevelCollection</c>.</param>
  11591. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11592. </member>
  11593. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.Level[])">
  11594. <summary>
  11595. Adds the elements of a <see cref="T:log4net.Core.Level"/> array to the current <c>LevelCollection</c>.
  11596. </summary>
  11597. <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>
  11598. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11599. </member>
  11600. <member name="M:log4net.Core.LevelCollection.AddRange(System.Collections.ICollection)">
  11601. <summary>
  11602. Adds the elements of a <see cref="T:log4net.Core.Level"/> collection to the current <c>LevelCollection</c>.
  11603. </summary>
  11604. <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>
  11605. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11606. </member>
  11607. <member name="M:log4net.Core.LevelCollection.TrimToSize">
  11608. <summary>
  11609. Sets the capacity to the actual number of elements.
  11610. </summary>
  11611. </member>
  11612. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32)">
  11613. <exception cref="T:System.ArgumentOutOfRangeException">
  11614. <para><paramref name="i"/> is less than zero</para>
  11615. <para>-or-</para>
  11616. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11617. </exception>
  11618. </member>
  11619. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32,System.Boolean)">
  11620. <exception cref="T:System.ArgumentOutOfRangeException">
  11621. <para><paramref name="i"/> is less than zero</para>
  11622. <para>-or-</para>
  11623. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11624. </exception>
  11625. </member>
  11626. <member name="T:log4net.Core.LevelCollection.Enumerator">
  11627. <summary>
  11628. Supports simple iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  11629. </summary>
  11630. </member>
  11631. <member name="M:log4net.Core.LevelCollection.Enumerator.#ctor(log4net.Core.LevelCollection)">
  11632. <summary>
  11633. Initializes a new instance of the <c>Enumerator</c> class.
  11634. </summary>
  11635. <param name="tc"></param>
  11636. </member>
  11637. <member name="P:log4net.Core.LevelCollection.Enumerator.Current">
  11638. <summary>
  11639. Gets the current element in the collection.
  11640. </summary>
  11641. </member>
  11642. <member name="M:log4net.Core.LevelCollection.Enumerator.MoveNext">
  11643. <summary>
  11644. Advances the enumerator to the next element in the collection.
  11645. </summary>
  11646. <returns>
  11647. <c>true</c> if the enumerator was successfully advanced to the next element;
  11648. <c>false</c> if the enumerator has passed the end of the collection.
  11649. </returns>
  11650. <exception cref="T:System.InvalidOperationException">
  11651. The collection was modified after the enumerator was created.
  11652. </exception>
  11653. </member>
  11654. <member name="M:log4net.Core.LevelCollection.Enumerator.Reset">
  11655. <summary>
  11656. Sets the enumerator to its initial position, before the first element in the collection.
  11657. </summary>
  11658. </member>
  11659. <member name="T:log4net.Core.LevelEvaluator">
  11660. <summary>
  11661. An evaluator that triggers at a threshold level
  11662. </summary>
  11663. <remarks>
  11664. <para>
  11665. This evaluator will trigger if the level of the event
  11666. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11667. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11668. level.
  11669. </para>
  11670. </remarks>
  11671. <author>Nicko Cadell</author>
  11672. </member>
  11673. <member name="F:log4net.Core.LevelEvaluator.m_threshold">
  11674. <summary>
  11675. The threshold for triggering
  11676. </summary>
  11677. </member>
  11678. <member name="M:log4net.Core.LevelEvaluator.#ctor">
  11679. <summary>
  11680. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  11681. </summary>
  11682. <remarks>
  11683. <para>
  11684. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  11685. </para>
  11686. <para>
  11687. This evaluator will trigger if the level of the event
  11688. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11689. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11690. level.
  11691. </para>
  11692. </remarks>
  11693. </member>
  11694. <member name="M:log4net.Core.LevelEvaluator.#ctor(log4net.Core.Level)">
  11695. <summary>
  11696. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  11697. </summary>
  11698. <param name="threshold">the threshold to trigger at</param>
  11699. <remarks>
  11700. <para>
  11701. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  11702. </para>
  11703. <para>
  11704. This evaluator will trigger if the level of the event
  11705. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11706. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11707. level.
  11708. </para>
  11709. </remarks>
  11710. </member>
  11711. <member name="P:log4net.Core.LevelEvaluator.Threshold">
  11712. <summary>
  11713. the threshold to trigger at
  11714. </summary>
  11715. <value>
  11716. The <see cref="T:log4net.Core.Level"/> that will cause this evaluator to trigger
  11717. </value>
  11718. <remarks>
  11719. <para>
  11720. This evaluator will trigger if the level of the event
  11721. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11722. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11723. level.
  11724. </para>
  11725. </remarks>
  11726. </member>
  11727. <member name="M:log4net.Core.LevelEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  11728. <summary>
  11729. Is this <paramref name="loggingEvent"/> the triggering event?
  11730. </summary>
  11731. <param name="loggingEvent">The event to check</param>
  11732. <returns>This method returns <c>true</c>, if the event level
  11733. is equal or higher than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>.
  11734. Otherwise it returns <c>false</c></returns>
  11735. <remarks>
  11736. <para>
  11737. This evaluator will trigger if the level of the event
  11738. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11739. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11740. level.
  11741. </para>
  11742. </remarks>
  11743. </member>
  11744. <member name="T:log4net.Core.LevelMap">
  11745. <summary>
  11746. Mapping between string name and Level object
  11747. </summary>
  11748. <remarks>
  11749. <para>
  11750. Mapping between string name and <see cref="T:log4net.Core.Level"/> object.
  11751. This mapping is held separately for each <see cref="T:log4net.Repository.ILoggerRepository"/>.
  11752. The level name is case insensitive.
  11753. </para>
  11754. </remarks>
  11755. <author>Nicko Cadell</author>
  11756. </member>
  11757. <member name="F:log4net.Core.LevelMap.m_mapName2Level">
  11758. <summary>
  11759. Mapping from level name to Level object. The
  11760. level name is case insensitive
  11761. </summary>
  11762. </member>
  11763. <member name="M:log4net.Core.LevelMap.#ctor">
  11764. <summary>
  11765. Construct the level map
  11766. </summary>
  11767. <remarks>
  11768. <para>
  11769. Construct the level map.
  11770. </para>
  11771. </remarks>
  11772. </member>
  11773. <member name="M:log4net.Core.LevelMap.Clear">
  11774. <summary>
  11775. Clear the internal maps of all levels
  11776. </summary>
  11777. <remarks>
  11778. <para>
  11779. Clear the internal maps of all levels
  11780. </para>
  11781. </remarks>
  11782. </member>
  11783. <member name="P:log4net.Core.LevelMap.Item(System.String)">
  11784. <summary>
  11785. Lookup a <see cref="T:log4net.Core.Level"/> by name
  11786. </summary>
  11787. <param name="name">The name of the Level to lookup</param>
  11788. <returns>a Level from the map with the name specified</returns>
  11789. <remarks>
  11790. <para>
  11791. Returns the <see cref="T:log4net.Core.Level"/> from the
  11792. map with the name specified. If the no level is
  11793. found then <c>null</c> is returned.
  11794. </para>
  11795. </remarks>
  11796. </member>
  11797. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32)">
  11798. <summary>
  11799. Create a new Level and add it to the map
  11800. </summary>
  11801. <param name="name">the string to display for the Level</param>
  11802. <param name="value">the level value to give to the Level</param>
  11803. <remarks>
  11804. <para>
  11805. Create a new Level and add it to the map
  11806. </para>
  11807. </remarks>
  11808. <seealso cref="M:Add(string,int,string)"/>
  11809. </member>
  11810. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32,System.String)">
  11811. <summary>
  11812. Create a new Level and add it to the map
  11813. </summary>
  11814. <param name="name">the string to display for the Level</param>
  11815. <param name="value">the level value to give to the Level</param>
  11816. <param name="displayName">the display name to give to the Level</param>
  11817. <remarks>
  11818. <para>
  11819. Create a new Level and add it to the map
  11820. </para>
  11821. </remarks>
  11822. </member>
  11823. <member name="M:log4net.Core.LevelMap.Add(log4net.Core.Level)">
  11824. <summary>
  11825. Add a Level to the map
  11826. </summary>
  11827. <param name="level">the Level to add</param>
  11828. <remarks>
  11829. <para>
  11830. Add a Level to the map
  11831. </para>
  11832. </remarks>
  11833. </member>
  11834. <member name="P:log4net.Core.LevelMap.AllLevels">
  11835. <summary>
  11836. Return all possible levels as a list of Level objects.
  11837. </summary>
  11838. <returns>all possible levels as a list of Level objects</returns>
  11839. <remarks>
  11840. <para>
  11841. Return all possible levels as a list of Level objects.
  11842. </para>
  11843. </remarks>
  11844. </member>
  11845. <member name="M:log4net.Core.LevelMap.LookupWithDefault(log4net.Core.Level)">
  11846. <summary>
  11847. Lookup a named level from the map
  11848. </summary>
  11849. <param name="defaultLevel">the name of the level to lookup is taken from this level.
  11850. If the level is not set on the map then this level is added</param>
  11851. <returns>the level in the map with the name specified</returns>
  11852. <remarks>
  11853. <para>
  11854. Lookup a named level from the map. The name of the level to lookup is taken
  11855. from the <see cref="P:log4net.Core.Level.Name"/> property of the <paramref name="defaultLevel"/>
  11856. argument.
  11857. </para>
  11858. <para>
  11859. If no level with the specified name is found then the
  11860. <paramref name="defaultLevel"/> argument is added to the level map
  11861. and returned.
  11862. </para>
  11863. </remarks>
  11864. </member>
  11865. <member name="T:log4net.Core.LocationInfo">
  11866. <summary>
  11867. The internal representation of caller location information.
  11868. </summary>
  11869. <remarks>
  11870. <para>
  11871. This class uses the <c>System.Diagnostics.StackTrace</c> class to generate
  11872. a call stack. The caller's information is then extracted from this stack.
  11873. </para>
  11874. <para>
  11875. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  11876. .NET Compact Framework 1.0 therefore caller location information is not
  11877. available on that framework.
  11878. </para>
  11879. <para>
  11880. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  11881. </para>
  11882. <para>
  11883. "StackTrace information will be most informative with Debug build configurations.
  11884. By default, Debug builds include debug symbols, while Release builds do not. The
  11885. debug symbols contain most of the file, method name, line number, and column
  11886. information used in constructing StackFrame and StackTrace objects. StackTrace
  11887. might not report as many method calls as expected, due to code transformations
  11888. that occur during optimization."
  11889. </para>
  11890. <para>
  11891. This means that in a Release build the caller information may be incomplete or may
  11892. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  11893. </para>
  11894. </remarks>
  11895. <author>Nicko Cadell</author>
  11896. <author>Gert Driesen</author>
  11897. </member>
  11898. <member name="M:log4net.Core.LocationInfo.#ctor(System.Type)">
  11899. <summary>
  11900. Constructor
  11901. </summary>
  11902. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  11903. the stack boundary into the logging system for this call.</param>
  11904. <remarks>
  11905. <para>
  11906. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo" />
  11907. class based on the current thread.
  11908. </para>
  11909. </remarks>
  11910. </member>
  11911. <member name="M:log4net.Core.LocationInfo.#ctor(System.String,System.String,System.String,System.String)">
  11912. <summary>
  11913. Constructor
  11914. </summary>
  11915. <param name="className">The fully qualified class name.</param>
  11916. <param name="methodName">The method name.</param>
  11917. <param name="fileName">The file name.</param>
  11918. <param name="lineNumber">The line number of the method within the file.</param>
  11919. <remarks>
  11920. <para>
  11921. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo" />
  11922. class with the specified data.
  11923. </para>
  11924. </remarks>
  11925. </member>
  11926. <member name="P:log4net.Core.LocationInfo.ClassName">
  11927. <summary>
  11928. Gets the fully qualified class name of the caller making the logging
  11929. request.
  11930. </summary>
  11931. <value>
  11932. The fully qualified class name of the caller making the logging
  11933. request.
  11934. </value>
  11935. <remarks>
  11936. <para>
  11937. Gets the fully qualified class name of the caller making the logging
  11938. request.
  11939. </para>
  11940. </remarks>
  11941. </member>
  11942. <member name="P:log4net.Core.LocationInfo.FileName">
  11943. <summary>
  11944. Gets the file name of the caller.
  11945. </summary>
  11946. <value>
  11947. The file name of the caller.
  11948. </value>
  11949. <remarks>
  11950. <para>
  11951. Gets the file name of the caller.
  11952. </para>
  11953. </remarks>
  11954. </member>
  11955. <member name="P:log4net.Core.LocationInfo.LineNumber">
  11956. <summary>
  11957. Gets the line number of the caller.
  11958. </summary>
  11959. <value>
  11960. The line number of the caller.
  11961. </value>
  11962. <remarks>
  11963. <para>
  11964. Gets the line number of the caller.
  11965. </para>
  11966. </remarks>
  11967. </member>
  11968. <member name="P:log4net.Core.LocationInfo.MethodName">
  11969. <summary>
  11970. Gets the method name of the caller.
  11971. </summary>
  11972. <value>
  11973. The method name of the caller.
  11974. </value>
  11975. <remarks>
  11976. <para>
  11977. Gets the method name of the caller.
  11978. </para>
  11979. </remarks>
  11980. </member>
  11981. <member name="P:log4net.Core.LocationInfo.FullInfo">
  11982. <summary>
  11983. Gets all available caller information
  11984. </summary>
  11985. <value>
  11986. All available caller information, in the format
  11987. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  11988. </value>
  11989. <remarks>
  11990. <para>
  11991. Gets all available caller information, in the format
  11992. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  11993. </para>
  11994. </remarks>
  11995. </member>
  11996. <member name="P:log4net.Core.LocationInfo.StackFrames">
  11997. <summary>
  11998. Gets the stack frames from the stack trace of the caller making the log request
  11999. </summary>
  12000. </member>
  12001. <member name="F:log4net.Core.LocationInfo.declaringType">
  12002. <summary>
  12003. The fully qualified type of the LocationInfo class.
  12004. </summary>
  12005. <remarks>
  12006. Used by the internal logger to record the Type of the
  12007. log message.
  12008. </remarks>
  12009. </member>
  12010. <member name="F:log4net.Core.LocationInfo.NA">
  12011. <summary>
  12012. When location information is not available the constant
  12013. <c>NA</c> is returned. Current value of this string
  12014. constant is <b>?</b>.
  12015. </summary>
  12016. </member>
  12017. <member name="T:log4net.Core.LogException">
  12018. <summary>
  12019. Exception base type for log4net.
  12020. </summary>
  12021. <remarks>
  12022. <para>
  12023. This type extends <see cref="T:System.ApplicationException"/>. It
  12024. does not add any new functionality but does differentiate the
  12025. type of exception being thrown.
  12026. </para>
  12027. </remarks>
  12028. <author>Nicko Cadell</author>
  12029. <author>Gert Driesen</author>
  12030. </member>
  12031. <member name="M:log4net.Core.LogException.#ctor">
  12032. <summary>
  12033. Constructor
  12034. </summary>
  12035. <remarks>
  12036. <para>
  12037. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class.
  12038. </para>
  12039. </remarks>
  12040. </member>
  12041. <member name="M:log4net.Core.LogException.#ctor(System.String)">
  12042. <summary>
  12043. Constructor
  12044. </summary>
  12045. <param name="message">A message to include with the exception.</param>
  12046. <remarks>
  12047. <para>
  12048. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class with
  12049. the specified message.
  12050. </para>
  12051. </remarks>
  12052. </member>
  12053. <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)">
  12054. <summary>
  12055. Constructor
  12056. </summary>
  12057. <param name="message">A message to include with the exception.</param>
  12058. <param name="innerException">A nested exception to include.</param>
  12059. <remarks>
  12060. <para>
  12061. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class
  12062. with the specified message and inner exception.
  12063. </para>
  12064. </remarks>
  12065. </member>
  12066. <member name="M:log4net.Core.LogException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  12067. <summary>
  12068. Serialization constructor
  12069. </summary>
  12070. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
  12071. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  12072. <remarks>
  12073. <para>
  12074. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class
  12075. with serialized data.
  12076. </para>
  12077. </remarks>
  12078. </member>
  12079. <member name="T:log4net.Core.LoggerManager">
  12080. <summary>
  12081. Static manager that controls the creation of repositories
  12082. </summary>
  12083. <remarks>
  12084. <para>
  12085. Static manager that controls the creation of repositories
  12086. </para>
  12087. <para>
  12088. This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>)
  12089. to provide access to the <see cref="T:log4net.Core.ILogger"/> objects.
  12090. </para>
  12091. <para>
  12092. This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to
  12093. lookup and create repositories. The selector can be set either programmatically using
  12094. the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c>
  12095. AppSetting in the applications config file to the fully qualified type name of the
  12096. selector to use.
  12097. </para>
  12098. </remarks>
  12099. <author>Nicko Cadell</author>
  12100. <author>Gert Driesen</author>
  12101. </member>
  12102. <member name="M:log4net.Core.LoggerManager.#ctor">
  12103. <summary>
  12104. Private constructor to prevent instances. Only static methods should be used.
  12105. </summary>
  12106. <remarks>
  12107. <para>
  12108. Private constructor to prevent instances. Only static methods should be used.
  12109. </para>
  12110. </remarks>
  12111. </member>
  12112. <member name="M:log4net.Core.LoggerManager.#cctor">
  12113. <summary>
  12114. Hook the shutdown event
  12115. </summary>
  12116. <remarks>
  12117. <para>
  12118. On the full .NET runtime, the static constructor hooks up the
  12119. <c>AppDomain.ProcessExit</c> and <c>AppDomain.DomainUnload</c>> events.
  12120. These are used to shutdown the log4net system as the application exits.
  12121. </para>
  12122. </remarks>
  12123. </member>
  12124. <member name="M:log4net.Core.LoggerManager.RegisterAppDomainEvents">
  12125. <summary>
  12126. Register for ProcessExit and DomainUnload events on the AppDomain
  12127. </summary>
  12128. <remarks>
  12129. <para>
  12130. This needs to be in a separate method because the events make
  12131. a LinkDemand for the ControlAppDomain SecurityPermission. Because
  12132. this is a LinkDemand it is demanded at JIT time. Therefore we cannot
  12133. catch the exception in the method itself, we have to catch it in the
  12134. caller.
  12135. </para>
  12136. </remarks>
  12137. </member>
  12138. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.String)">
  12139. <summary>
  12140. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12141. </summary>
  12142. <param name="repository">the repository to lookup in</param>
  12143. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  12144. <remarks>
  12145. <para>
  12146. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  12147. by the <paramref name="repository"/> argument.
  12148. </para>
  12149. </remarks>
  12150. </member>
  12151. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.Reflection.Assembly)">
  12152. <summary>
  12153. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12154. </summary>
  12155. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12156. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  12157. </member>
  12158. <member name="M:log4net.Core.LoggerManager.GetRepository(System.String)">
  12159. <summary>
  12160. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12161. </summary>
  12162. <param name="repository">the repository to lookup in</param>
  12163. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  12164. <remarks>
  12165. <para>
  12166. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  12167. by the <paramref name="repository"/> argument.
  12168. </para>
  12169. </remarks>
  12170. </member>
  12171. <member name="M:log4net.Core.LoggerManager.GetRepository(System.Reflection.Assembly)">
  12172. <summary>
  12173. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12174. </summary>
  12175. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12176. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  12177. <remarks>
  12178. <para>
  12179. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  12180. </para>
  12181. </remarks>
  12182. </member>
  12183. <member name="M:log4net.Core.LoggerManager.Exists(System.String,System.String)">
  12184. <summary>
  12185. Returns the named logger if it exists.
  12186. </summary>
  12187. <param name="repository">The repository to lookup in.</param>
  12188. <param name="name">The fully qualified logger name to look for.</param>
  12189. <returns>
  12190. The logger found, or <c>null</c> if the named logger does not exist in the
  12191. specified repository.
  12192. </returns>
  12193. <remarks>
  12194. <para>
  12195. If the named logger exists (in the specified repository) then it
  12196. returns a reference to the logger, otherwise it returns
  12197. <c>null</c>.
  12198. </para>
  12199. </remarks>
  12200. </member>
  12201. <member name="M:log4net.Core.LoggerManager.Exists(System.Reflection.Assembly,System.String)">
  12202. <summary>
  12203. Returns the named logger if it exists.
  12204. </summary>
  12205. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12206. <param name="name">The fully qualified logger name to look for.</param>
  12207. <returns>
  12208. The logger found, or <c>null</c> if the named logger does not exist in the
  12209. specified assembly's repository.
  12210. </returns>
  12211. <remarks>
  12212. <para>
  12213. If the named logger exists (in the specified assembly's repository) then it
  12214. returns a reference to the logger, otherwise it returns
  12215. <c>null</c>.
  12216. </para>
  12217. </remarks>
  12218. </member>
  12219. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.String)">
  12220. <summary>
  12221. Returns all the currently defined loggers in the specified repository.
  12222. </summary>
  12223. <param name="repository">The repository to lookup in.</param>
  12224. <returns>All the defined loggers.</returns>
  12225. <remarks>
  12226. <para>
  12227. The root logger is <b>not</b> included in the returned array.
  12228. </para>
  12229. </remarks>
  12230. </member>
  12231. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.Reflection.Assembly)">
  12232. <summary>
  12233. Returns all the currently defined loggers in the specified assembly's repository.
  12234. </summary>
  12235. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12236. <returns>All the defined loggers.</returns>
  12237. <remarks>
  12238. <para>
  12239. The root logger is <b>not</b> included in the returned array.
  12240. </para>
  12241. </remarks>
  12242. </member>
  12243. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.String)">
  12244. <summary>
  12245. Retrieves or creates a named logger.
  12246. </summary>
  12247. <param name="repository">The repository to lookup in.</param>
  12248. <param name="name">The name of the logger to retrieve.</param>
  12249. <returns>The logger with the name specified.</returns>
  12250. <remarks>
  12251. <para>
  12252. Retrieves a logger named as the <paramref name="name"/>
  12253. parameter. If the named logger already exists, then the
  12254. existing instance will be returned. Otherwise, a new instance is
  12255. created.
  12256. </para>
  12257. <para>
  12258. By default, loggers do not have a set level but inherit
  12259. it from the hierarchy. This is one of the central features of
  12260. log4net.
  12261. </para>
  12262. </remarks>
  12263. </member>
  12264. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.String)">
  12265. <summary>
  12266. Retrieves or creates a named logger.
  12267. </summary>
  12268. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12269. <param name="name">The name of the logger to retrieve.</param>
  12270. <returns>The logger with the name specified.</returns>
  12271. <remarks>
  12272. <para>
  12273. Retrieves a logger named as the <paramref name="name"/>
  12274. parameter. If the named logger already exists, then the
  12275. existing instance will be returned. Otherwise, a new instance is
  12276. created.
  12277. </para>
  12278. <para>
  12279. By default, loggers do not have a set level but inherit
  12280. it from the hierarchy. This is one of the central features of
  12281. log4net.
  12282. </para>
  12283. </remarks>
  12284. </member>
  12285. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.Type)">
  12286. <summary>
  12287. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  12288. </summary>
  12289. <param name="repository">The repository to lookup in.</param>
  12290. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  12291. <returns>The logger with the name specified.</returns>
  12292. <remarks>
  12293. <para>
  12294. Gets the logger for the fully qualified name of the type specified.
  12295. </para>
  12296. </remarks>
  12297. </member>
  12298. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.Type)">
  12299. <summary>
  12300. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  12301. </summary>
  12302. <param name="repositoryAssembly">the assembly to use to lookup the repository</param>
  12303. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  12304. <returns>The logger with the name specified.</returns>
  12305. <remarks>
  12306. <para>
  12307. Gets the logger for the fully qualified name of the type specified.
  12308. </para>
  12309. </remarks>
  12310. </member>
  12311. <member name="M:log4net.Core.LoggerManager.Shutdown">
  12312. <summary>
  12313. Shuts down the log4net system.
  12314. </summary>
  12315. <remarks>
  12316. <para>
  12317. Calling this method will <b>safely</b> close and remove all
  12318. appenders in all the loggers including root contained in all the
  12319. default repositories.
  12320. </para>
  12321. <para>
  12322. Some appenders need to be closed before the application exists.
  12323. Otherwise, pending logging events might be lost.
  12324. </para>
  12325. <para>
  12326. The <c>shutdown</c> method is careful to close nested
  12327. appenders before closing regular appenders. This is allows
  12328. configurations where a regular appender is attached to a logger
  12329. and again to a nested appender.
  12330. </para>
  12331. </remarks>
  12332. </member>
  12333. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.String)">
  12334. <summary>
  12335. Shuts down the repository for the repository specified.
  12336. </summary>
  12337. <param name="repository">The repository to shutdown.</param>
  12338. <remarks>
  12339. <para>
  12340. Calling this method will <b>safely</b> close and remove all
  12341. appenders in all the loggers including root contained in the
  12342. repository for the <paramref name="repository"/> specified.
  12343. </para>
  12344. <para>
  12345. Some appenders need to be closed before the application exists.
  12346. Otherwise, pending logging events might be lost.
  12347. </para>
  12348. <para>
  12349. The <c>shutdown</c> method is careful to close nested
  12350. appenders before closing regular appenders. This is allows
  12351. configurations where a regular appender is attached to a logger
  12352. and again to a nested appender.
  12353. </para>
  12354. </remarks>
  12355. </member>
  12356. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.Reflection.Assembly)">
  12357. <summary>
  12358. Shuts down the repository for the repository specified.
  12359. </summary>
  12360. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12361. <remarks>
  12362. <para>
  12363. Calling this method will <b>safely</b> close and remove all
  12364. appenders in all the loggers including root contained in the
  12365. repository for the repository. The repository is looked up using
  12366. the <paramref name="repositoryAssembly"/> specified.
  12367. </para>
  12368. <para>
  12369. Some appenders need to be closed before the application exists.
  12370. Otherwise, pending logging events might be lost.
  12371. </para>
  12372. <para>
  12373. The <c>shutdown</c> method is careful to close nested
  12374. appenders before closing regular appenders. This is allows
  12375. configurations where a regular appender is attached to a logger
  12376. and again to a nested appender.
  12377. </para>
  12378. </remarks>
  12379. </member>
  12380. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.String)">
  12381. <summary>
  12382. Resets all values contained in this repository instance to their defaults.
  12383. </summary>
  12384. <param name="repository">The repository to reset.</param>
  12385. <remarks>
  12386. <para>
  12387. Resets all values contained in the repository instance to their
  12388. defaults. This removes all appenders from all loggers, sets
  12389. the level of all non-root loggers to <c>null</c>,
  12390. sets their additivity flag to <c>true</c> and sets the level
  12391. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  12392. message disabling is set its default "off" value.
  12393. </para>
  12394. </remarks>
  12395. </member>
  12396. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.Reflection.Assembly)">
  12397. <summary>
  12398. Resets all values contained in this repository instance to their defaults.
  12399. </summary>
  12400. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  12401. <remarks>
  12402. <para>
  12403. Resets all values contained in the repository instance to their
  12404. defaults. This removes all appenders from all loggers, sets
  12405. the level of all non-root loggers to <c>null</c>,
  12406. sets their additivity flag to <c>true</c> and sets the level
  12407. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  12408. message disabling is set its default "off" value.
  12409. </para>
  12410. </remarks>
  12411. </member>
  12412. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String)">
  12413. <summary>
  12414. Creates a repository with the specified name.
  12415. </summary>
  12416. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  12417. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12418. <remarks>
  12419. <para>
  12420. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12421. </para>
  12422. <para>
  12423. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  12424. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  12425. </para>
  12426. <para>
  12427. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12428. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  12429. </para>
  12430. </remarks>
  12431. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12432. </member>
  12433. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String)">
  12434. <summary>
  12435. Creates a repository with the specified name.
  12436. </summary>
  12437. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  12438. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12439. <remarks>
  12440. <para>
  12441. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  12442. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  12443. </para>
  12444. <para>
  12445. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12446. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  12447. </para>
  12448. </remarks>
  12449. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12450. </member>
  12451. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String,System.Type)">
  12452. <summary>
  12453. Creates a repository with the specified name and repository type.
  12454. </summary>
  12455. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  12456. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12457. and has a no arg constructor. An instance of this type will be created to act
  12458. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12459. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12460. <remarks>
  12461. <para>
  12462. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12463. </para>
  12464. <para>
  12465. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12466. An Exception will be thrown if the repository already exists.
  12467. </para>
  12468. </remarks>
  12469. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12470. </member>
  12471. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String,System.Type)">
  12472. <summary>
  12473. Creates a repository with the specified name and repository type.
  12474. </summary>
  12475. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  12476. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12477. and has a no arg constructor. An instance of this type will be created to act
  12478. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12479. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12480. <remarks>
  12481. <para>
  12482. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12483. An Exception will be thrown if the repository already exists.
  12484. </para>
  12485. </remarks>
  12486. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12487. </member>
  12488. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  12489. <summary>
  12490. Creates a repository for the specified assembly and repository type.
  12491. </summary>
  12492. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  12493. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12494. and has a no arg constructor. An instance of this type will be created to act
  12495. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12496. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12497. <remarks>
  12498. <para>
  12499. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12500. </para>
  12501. <para>
  12502. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  12503. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  12504. same assembly specified will return the same repository instance.
  12505. </para>
  12506. </remarks>
  12507. </member>
  12508. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  12509. <summary>
  12510. Creates a repository for the specified assembly and repository type.
  12511. </summary>
  12512. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  12513. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12514. and has a no arg constructor. An instance of this type will be created to act
  12515. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12516. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12517. <remarks>
  12518. <para>
  12519. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  12520. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  12521. same assembly specified will return the same repository instance.
  12522. </para>
  12523. </remarks>
  12524. </member>
  12525. <member name="M:log4net.Core.LoggerManager.GetAllRepositories">
  12526. <summary>
  12527. Gets an array of all currently defined repositories.
  12528. </summary>
  12529. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  12530. <remarks>
  12531. <para>
  12532. Gets an array of all currently defined repositories.
  12533. </para>
  12534. </remarks>
  12535. </member>
  12536. <member name="P:log4net.Core.LoggerManager.RepositorySelector">
  12537. <summary>
  12538. Gets or sets the repository selector used by the <see cref="T:log4net.LogManager" />.
  12539. </summary>
  12540. <value>
  12541. The repository selector used by the <see cref="T:log4net.LogManager" />.
  12542. </value>
  12543. <remarks>
  12544. <para>
  12545. The repository selector (<see cref="T:log4net.Core.IRepositorySelector"/>) is used by
  12546. the <see cref="T:log4net.LogManager"/> to create and select repositories
  12547. (<see cref="T:log4net.Repository.ILoggerRepository"/>).
  12548. </para>
  12549. <para>
  12550. The caller to <see cref="T:log4net.LogManager"/> supplies either a string name
  12551. or an assembly (if not supplied the assembly is inferred using
  12552. <see cref="M:Assembly.GetCallingAssembly()"/>).
  12553. </para>
  12554. <para>
  12555. This context is used by the selector to lookup a specific repository.
  12556. </para>
  12557. <para>
  12558. For the full .NET Framework, the default repository is <c>DefaultRepositorySelector</c>;
  12559. for the .NET Compact Framework <c>CompactRepositorySelector</c> is the default
  12560. repository.
  12561. </para>
  12562. </remarks>
  12563. </member>
  12564. <member name="M:log4net.Core.LoggerManager.GetVersionInfo">
  12565. <summary>
  12566. Internal method to get pertinent version info.
  12567. </summary>
  12568. <returns>A string of version info.</returns>
  12569. </member>
  12570. <member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)">
  12571. <summary>
  12572. Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires
  12573. </summary>
  12574. <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
  12575. <param name="e">null</param>
  12576. <remarks>
  12577. <para>
  12578. Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires.
  12579. </para>
  12580. <para>
  12581. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  12582. </para>
  12583. </remarks>
  12584. </member>
  12585. <member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)">
  12586. <summary>
  12587. Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires
  12588. </summary>
  12589. <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
  12590. <param name="e">null</param>
  12591. <remarks>
  12592. <para>
  12593. Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires.
  12594. </para>
  12595. <para>
  12596. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  12597. </para>
  12598. </remarks>
  12599. </member>
  12600. <member name="F:log4net.Core.LoggerManager.declaringType">
  12601. <summary>
  12602. The fully qualified type of the LoggerManager class.
  12603. </summary>
  12604. <remarks>
  12605. Used by the internal logger to record the Type of the
  12606. log message.
  12607. </remarks>
  12608. </member>
  12609. <member name="F:log4net.Core.LoggerManager.s_repositorySelector">
  12610. <summary>
  12611. Initialize the default repository selector
  12612. </summary>
  12613. </member>
  12614. <member name="T:log4net.Core.LoggerWrapperImpl">
  12615. <summary>
  12616. Implementation of the <see cref="T:log4net.Core.ILoggerWrapper"/> interface.
  12617. </summary>
  12618. <remarks>
  12619. <para>
  12620. This class should be used as the base for all wrapper implementations.
  12621. </para>
  12622. </remarks>
  12623. <author>Nicko Cadell</author>
  12624. <author>Gert Driesen</author>
  12625. </member>
  12626. <member name="M:log4net.Core.LoggerWrapperImpl.#ctor(log4net.Core.ILogger)">
  12627. <summary>
  12628. Constructs a new wrapper for the specified logger.
  12629. </summary>
  12630. <param name="logger">The logger to wrap.</param>
  12631. <remarks>
  12632. <para>
  12633. Constructs a new wrapper for the specified logger.
  12634. </para>
  12635. </remarks>
  12636. </member>
  12637. <member name="P:log4net.Core.LoggerWrapperImpl.Logger">
  12638. <summary>
  12639. Gets the implementation behind this wrapper object.
  12640. </summary>
  12641. <value>
  12642. The <see cref="T:log4net.Core.ILogger"/> object that this object is implementing.
  12643. </value>
  12644. <remarks>
  12645. <para>
  12646. The <c>Logger</c> object may not be the same object as this object
  12647. because of logger decorators.
  12648. </para>
  12649. <para>
  12650. This gets the actual underlying objects that is used to process
  12651. the log events.
  12652. </para>
  12653. </remarks>
  12654. </member>
  12655. <member name="F:log4net.Core.LoggerWrapperImpl.m_logger">
  12656. <summary>
  12657. The logger that this object is wrapping
  12658. </summary>
  12659. </member>
  12660. <member name="T:log4net.Core.LoggingEventData">
  12661. <summary>
  12662. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  12663. </summary>
  12664. <remarks>
  12665. <para>
  12666. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  12667. </para>
  12668. </remarks>
  12669. <author>Nicko Cadell</author>
  12670. </member>
  12671. <member name="F:log4net.Core.LoggingEventData.LoggerName">
  12672. <summary>
  12673. The logger name.
  12674. </summary>
  12675. <remarks>
  12676. <para>
  12677. The logger name.
  12678. </para>
  12679. </remarks>
  12680. </member>
  12681. <member name="F:log4net.Core.LoggingEventData.Level">
  12682. <summary>
  12683. Level of logging event.
  12684. </summary>
  12685. <remarks>
  12686. <para>
  12687. Level of logging event. Level cannot be Serializable
  12688. because it is a flyweight. Due to its special serialization it
  12689. cannot be declared final either.
  12690. </para>
  12691. </remarks>
  12692. </member>
  12693. <member name="F:log4net.Core.LoggingEventData.Message">
  12694. <summary>
  12695. The application supplied message.
  12696. </summary>
  12697. <remarks>
  12698. <para>
  12699. The application supplied message of logging event.
  12700. </para>
  12701. </remarks>
  12702. </member>
  12703. <member name="F:log4net.Core.LoggingEventData.ThreadName">
  12704. <summary>
  12705. The name of thread
  12706. </summary>
  12707. <remarks>
  12708. <para>
  12709. The name of thread in which this logging event was generated
  12710. </para>
  12711. </remarks>
  12712. </member>
  12713. <member name="F:log4net.Core.LoggingEventData.TimeStamp">
  12714. <summary>
  12715. Gets or sets the local time the event was logged
  12716. </summary>
  12717. <remarks>
  12718. <para>
  12719. Prefer using the <see cref="P:log4net.Core.LoggingEventData.TimeStampUtc"/> setter, since local time can be ambiguous.
  12720. </para>
  12721. </remarks>
  12722. </member>
  12723. <member name="P:log4net.Core.LoggingEventData.TimeStampUtc">
  12724. <summary>
  12725. Gets or sets the UTC time the event was logged
  12726. </summary>
  12727. <remarks>
  12728. <para>
  12729. The TimeStamp is stored in the UTC time zone.
  12730. </para>
  12731. </remarks>
  12732. </member>
  12733. <member name="F:log4net.Core.LoggingEventData.LocationInfo">
  12734. <summary>
  12735. Location information for the caller.
  12736. </summary>
  12737. <remarks>
  12738. <para>
  12739. Location information for the caller.
  12740. </para>
  12741. </remarks>
  12742. </member>
  12743. <member name="F:log4net.Core.LoggingEventData.UserName">
  12744. <summary>
  12745. String representation of the user
  12746. </summary>
  12747. <remarks>
  12748. <para>
  12749. String representation of the user's windows name,
  12750. like DOMAIN\username
  12751. </para>
  12752. </remarks>
  12753. </member>
  12754. <member name="F:log4net.Core.LoggingEventData.Identity">
  12755. <summary>
  12756. String representation of the identity.
  12757. </summary>
  12758. <remarks>
  12759. <para>
  12760. String representation of the current thread's principal identity.
  12761. </para>
  12762. </remarks>
  12763. </member>
  12764. <member name="F:log4net.Core.LoggingEventData.ExceptionString">
  12765. <summary>
  12766. The string representation of the exception
  12767. </summary>
  12768. <remarks>
  12769. <para>
  12770. The string representation of the exception
  12771. </para>
  12772. </remarks>
  12773. </member>
  12774. <member name="F:log4net.Core.LoggingEventData.Domain">
  12775. <summary>
  12776. String representation of the AppDomain.
  12777. </summary>
  12778. <remarks>
  12779. <para>
  12780. String representation of the AppDomain.
  12781. </para>
  12782. </remarks>
  12783. </member>
  12784. <member name="F:log4net.Core.LoggingEventData.Properties">
  12785. <summary>
  12786. Additional event specific properties
  12787. </summary>
  12788. <remarks>
  12789. <para>
  12790. A logger or an appender may attach additional
  12791. properties to specific events. These properties
  12792. have a string key and an object value.
  12793. </para>
  12794. </remarks>
  12795. </member>
  12796. <member name="T:log4net.Core.FixFlags">
  12797. <summary>
  12798. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  12799. </summary>
  12800. <remarks>
  12801. <para>
  12802. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  12803. </para>
  12804. </remarks>
  12805. <author>Nicko Cadell</author>
  12806. </member>
  12807. <member name="F:log4net.Core.FixFlags.Mdc">
  12808. <summary>
  12809. Fix the MDC
  12810. </summary>
  12811. </member>
  12812. <member name="F:log4net.Core.FixFlags.Ndc">
  12813. <summary>
  12814. Fix the NDC
  12815. </summary>
  12816. </member>
  12817. <member name="F:log4net.Core.FixFlags.Message">
  12818. <summary>
  12819. Fix the rendered message
  12820. </summary>
  12821. </member>
  12822. <member name="F:log4net.Core.FixFlags.ThreadName">
  12823. <summary>
  12824. Fix the thread name
  12825. </summary>
  12826. </member>
  12827. <member name="F:log4net.Core.FixFlags.LocationInfo">
  12828. <summary>
  12829. Fix the callers location information
  12830. </summary>
  12831. <remarks>
  12832. CAUTION: Very slow to generate
  12833. </remarks>
  12834. </member>
  12835. <member name="F:log4net.Core.FixFlags.UserName">
  12836. <summary>
  12837. Fix the callers windows user name
  12838. </summary>
  12839. <remarks>
  12840. CAUTION: Slow to generate
  12841. </remarks>
  12842. </member>
  12843. <member name="F:log4net.Core.FixFlags.Domain">
  12844. <summary>
  12845. Fix the domain friendly name
  12846. </summary>
  12847. </member>
  12848. <member name="F:log4net.Core.FixFlags.Identity">
  12849. <summary>
  12850. Fix the callers principal name
  12851. </summary>
  12852. <remarks>
  12853. CAUTION: May be slow to generate
  12854. </remarks>
  12855. </member>
  12856. <member name="F:log4net.Core.FixFlags.Exception">
  12857. <summary>
  12858. Fix the exception text
  12859. </summary>
  12860. </member>
  12861. <member name="F:log4net.Core.FixFlags.Properties">
  12862. <summary>
  12863. Fix the event properties. Active properties must implement <see cref="T:log4net.Core.IFixingRequired"/> in order to be eligible for fixing.
  12864. </summary>
  12865. </member>
  12866. <member name="F:log4net.Core.FixFlags.None">
  12867. <summary>
  12868. No fields fixed
  12869. </summary>
  12870. </member>
  12871. <member name="F:log4net.Core.FixFlags.All">
  12872. <summary>
  12873. All fields fixed
  12874. </summary>
  12875. </member>
  12876. <member name="F:log4net.Core.FixFlags.Partial">
  12877. <summary>
  12878. Partial fields fixed
  12879. </summary>
  12880. <remarks>
  12881. <para>
  12882. This set of partial fields gives good performance. The following fields are fixed:
  12883. </para>
  12884. <list type="bullet">
  12885. <item><description><see cref="F:log4net.Core.FixFlags.Message"/></description></item>
  12886. <item><description><see cref="F:log4net.Core.FixFlags.ThreadName"/></description></item>
  12887. <item><description><see cref="F:log4net.Core.FixFlags.Exception"/></description></item>
  12888. <item><description><see cref="F:log4net.Core.FixFlags.Domain"/></description></item>
  12889. <item><description><see cref="F:log4net.Core.FixFlags.Properties"/></description></item>
  12890. </list>
  12891. </remarks>
  12892. </member>
  12893. <member name="T:log4net.Core.LoggingEvent">
  12894. <summary>
  12895. The internal representation of logging events.
  12896. </summary>
  12897. <remarks>
  12898. <para>
  12899. When an affirmative decision is made to log then a
  12900. <see cref="T:log4net.Core.LoggingEvent"/> instance is created. This instance
  12901. is passed around to the different log4net components.
  12902. </para>
  12903. <para>
  12904. This class is of concern to those wishing to extend log4net.
  12905. </para>
  12906. <para>
  12907. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  12908. are considered volatile, that is the values are correct at the
  12909. time the event is delivered to appenders, but will not be consistent
  12910. at any time afterwards. If an event is to be stored and then processed
  12911. at a later time these volatile values must be fixed by calling
  12912. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  12913. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  12914. is essential to maintaining data consistency.
  12915. </para>
  12916. </remarks>
  12917. <author>Nicko Cadell</author>
  12918. <author>Gert Driesen</author>
  12919. <author>Douglas de la Torre</author>
  12920. <author>Daniel Cazzulino</author>
  12921. </member>
  12922. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,System.String,log4net.Core.Level,System.Object,System.Exception)">
  12923. <summary>
  12924. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  12925. from the supplied parameters.
  12926. </summary>
  12927. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12928. the stack boundary into the logging system for this call.</param>
  12929. <param name="repository">The repository this event is logged in.</param>
  12930. <param name="loggerName">The name of the logger of this event.</param>
  12931. <param name="level">The level of this event.</param>
  12932. <param name="message">The message of this event.</param>
  12933. <param name="exception">The exception for this event.</param>
  12934. <remarks>
  12935. <para>
  12936. Except <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>, <see cref="P:log4net.Core.LoggingEvent.Level"/> and <see cref="P:log4net.Core.LoggingEvent.LoggerName"/>,
  12937. all fields of <c>LoggingEvent</c> are filled when actually needed. Call
  12938. <see cref="M:FixVolatileData()"/> to cache all data locally
  12939. to prevent inconsistencies.
  12940. </para>
  12941. <para>This method is called by the log4net framework
  12942. to create a logging event.
  12943. </para>
  12944. </remarks>
  12945. </member>
  12946. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)">
  12947. <summary>
  12948. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  12949. using specific data.
  12950. </summary>
  12951. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12952. the stack boundary into the logging system for this call.</param>
  12953. <param name="repository">The repository this event is logged in.</param>
  12954. <param name="data">Data used to initialize the logging event.</param>
  12955. <param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param>
  12956. <remarks>
  12957. <para>
  12958. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  12959. to be created independently of the log4net framework. This can
  12960. be useful if you require a custom serialization scheme.
  12961. </para>
  12962. <para>
  12963. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  12964. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  12965. </para>
  12966. <para>
  12967. The <paramref name="fixedData"/> parameter should be used to specify which fields in the
  12968. <paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/>
  12969. will be captured from the environment if requested or fixed.
  12970. </para>
  12971. </remarks>
  12972. </member>
  12973. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)">
  12974. <summary>
  12975. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  12976. using specific data.
  12977. </summary>
  12978. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12979. the stack boundary into the logging system for this call.</param>
  12980. <param name="repository">The repository this event is logged in.</param>
  12981. <param name="data">Data used to initialize the logging event.</param>
  12982. <remarks>
  12983. <para>
  12984. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  12985. to be created independently of the log4net framework. This can
  12986. be useful if you require a custom serialization scheme.
  12987. </para>
  12988. <para>
  12989. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  12990. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  12991. </para>
  12992. <para>
  12993. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  12994. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  12995. parameter and no other data should be captured from the environment.
  12996. </para>
  12997. </remarks>
  12998. </member>
  12999. <member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)">
  13000. <summary>
  13001. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  13002. using specific data.
  13003. </summary>
  13004. <param name="data">Data used to initialize the logging event.</param>
  13005. <remarks>
  13006. <para>
  13007. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  13008. to be created independently of the log4net framework. This can
  13009. be useful if you require a custom serialization scheme.
  13010. </para>
  13011. <para>
  13012. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  13013. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  13014. </para>
  13015. <para>
  13016. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  13017. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  13018. parameter and no other data should be captured from the environment.
  13019. </para>
  13020. </remarks>
  13021. </member>
  13022. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13023. <summary>
  13024. Serialization constructor
  13025. </summary>
  13026. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  13027. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  13028. <remarks>
  13029. <para>
  13030. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  13031. with serialized data.
  13032. </para>
  13033. </remarks>
  13034. </member>
  13035. <member name="P:log4net.Core.LoggingEvent.StartTime">
  13036. <summary>
  13037. Gets the time when the current process started.
  13038. </summary>
  13039. <value>
  13040. This is the time when this process started.
  13041. </value>
  13042. <remarks>
  13043. <para>
  13044. The TimeStamp is stored internally in UTC and converted to the local time zone for this computer.
  13045. </para>
  13046. <para>
  13047. Tries to get the start time for the current process.
  13048. Failing that it returns the time of the first call to
  13049. this property.
  13050. </para>
  13051. <para>
  13052. Note that AppDomains may be loaded and unloaded within the
  13053. same process without the process terminating and therefore
  13054. without the process start time being reset.
  13055. </para>
  13056. </remarks>
  13057. </member>
  13058. <member name="P:log4net.Core.LoggingEvent.StartTimeUtc">
  13059. <summary>
  13060. Gets the UTC time when the current process started.
  13061. </summary>
  13062. <value>
  13063. This is the UTC time when this process started.
  13064. </value>
  13065. <remarks>
  13066. <para>
  13067. Tries to get the start time for the current process.
  13068. Failing that it returns the time of the first call to
  13069. this property.
  13070. </para>
  13071. <para>
  13072. Note that AppDomains may be loaded and unloaded within the
  13073. same process without the process terminating and therefore
  13074. without the process start time being reset.
  13075. </para>
  13076. </remarks>
  13077. </member>
  13078. <member name="P:log4net.Core.LoggingEvent.Level">
  13079. <summary>
  13080. Gets the <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  13081. </summary>
  13082. <value>
  13083. The <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  13084. </value>
  13085. <remarks>
  13086. <para>
  13087. Gets the <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  13088. </para>
  13089. </remarks>
  13090. </member>
  13091. <member name="P:log4net.Core.LoggingEvent.TimeStamp">
  13092. <summary>
  13093. Gets the time of the logging event.
  13094. </summary>
  13095. <value>
  13096. The time of the logging event.
  13097. </value>
  13098. <remarks>
  13099. <para>
  13100. The TimeStamp is stored in UTC and converted to the local time zone for this computer.
  13101. </para>
  13102. </remarks>
  13103. </member>
  13104. <member name="P:log4net.Core.LoggingEvent.TimeStampUtc">
  13105. <summary>
  13106. Gets UTC the time of the logging event.
  13107. </summary>
  13108. <value>
  13109. The UTC time of the logging event.
  13110. </value>
  13111. </member>
  13112. <member name="P:log4net.Core.LoggingEvent.LoggerName">
  13113. <summary>
  13114. Gets the name of the logger that logged the event.
  13115. </summary>
  13116. <value>
  13117. The name of the logger that logged the event.
  13118. </value>
  13119. <remarks>
  13120. <para>
  13121. Gets the name of the logger that logged the event.
  13122. </para>
  13123. </remarks>
  13124. </member>
  13125. <member name="P:log4net.Core.LoggingEvent.LocationInformation">
  13126. <summary>
  13127. Gets the location information for this logging event.
  13128. </summary>
  13129. <value>
  13130. The location information for this logging event.
  13131. </value>
  13132. <remarks>
  13133. <para>
  13134. The collected information is cached for future use.
  13135. </para>
  13136. <para>
  13137. See the <see cref="T:log4net.Core.LocationInfo"/> class for more information on
  13138. supported frameworks and the different behavior in Debug and
  13139. Release builds.
  13140. </para>
  13141. </remarks>
  13142. </member>
  13143. <member name="P:log4net.Core.LoggingEvent.MessageObject">
  13144. <summary>
  13145. Gets the message object used to initialize this event.
  13146. </summary>
  13147. <value>
  13148. The message object used to initialize this event.
  13149. </value>
  13150. <remarks>
  13151. <para>
  13152. Gets the message object used to initialize this event.
  13153. Note that this event may not have a valid message object.
  13154. If the event is serialized the message object will not
  13155. be transferred. To get the text of the message the
  13156. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property must be used
  13157. not this property.
  13158. </para>
  13159. <para>
  13160. If there is no defined message object for this event then
  13161. null will be returned.
  13162. </para>
  13163. </remarks>
  13164. </member>
  13165. <member name="P:log4net.Core.LoggingEvent.ExceptionObject">
  13166. <summary>
  13167. Gets the exception object used to initialize this event.
  13168. </summary>
  13169. <value>
  13170. The exception object used to initialize this event.
  13171. </value>
  13172. <remarks>
  13173. <para>
  13174. Gets the exception object used to initialize this event.
  13175. Note that this event may not have a valid exception object.
  13176. If the event is serialized the exception object will not
  13177. be transferred. To get the text of the exception the
  13178. <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> method must be used
  13179. not this property.
  13180. </para>
  13181. <para>
  13182. If there is no defined exception object for this event then
  13183. null will be returned.
  13184. </para>
  13185. </remarks>
  13186. </member>
  13187. <member name="P:log4net.Core.LoggingEvent.Repository">
  13188. <summary>
  13189. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  13190. </summary>
  13191. <remarks>
  13192. <para>
  13193. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  13194. </para>
  13195. </remarks>
  13196. </member>
  13197. <member name="M:log4net.Core.LoggingEvent.EnsureRepository(log4net.Repository.ILoggerRepository)">
  13198. <summary>
  13199. Ensure that the repository is set.
  13200. </summary>
  13201. <param name="repository">the value for the repository</param>
  13202. </member>
  13203. <member name="P:log4net.Core.LoggingEvent.RenderedMessage">
  13204. <summary>
  13205. Gets the message, rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13206. </summary>
  13207. <value>
  13208. The message rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13209. </value>
  13210. <remarks>
  13211. <para>
  13212. The collected information is cached for future use.
  13213. </para>
  13214. </remarks>
  13215. </member>
  13216. <member name="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)">
  13217. <summary>
  13218. Write the rendered message to a TextWriter
  13219. </summary>
  13220. <param name="writer">the writer to write the message to</param>
  13221. <remarks>
  13222. <para>
  13223. Unlike the <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property this method
  13224. does store the message data in the internal cache. Therefore
  13225. if called only once this method should be faster than the
  13226. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property, however if the message is
  13227. to be accessed multiple times then the property will be more efficient.
  13228. </para>
  13229. </remarks>
  13230. </member>
  13231. <member name="P:log4net.Core.LoggingEvent.ThreadName">
  13232. <summary>
  13233. Gets the name of the current thread.
  13234. </summary>
  13235. <value>
  13236. The name of the current thread, or the thread ID when
  13237. the name is not available.
  13238. </value>
  13239. <remarks>
  13240. <para>
  13241. The collected information is cached for future use.
  13242. </para>
  13243. </remarks>
  13244. </member>
  13245. <member name="P:log4net.Core.LoggingEvent.UserName">
  13246. <summary>
  13247. Gets the name of the current user.
  13248. </summary>
  13249. <value>
  13250. The name of the current user, or <c>NOT AVAILABLE</c> when the
  13251. underlying runtime has no support for retrieving the name of the
  13252. current user.
  13253. </value>
  13254. <remarks>
  13255. <para>
  13256. Calls <c>WindowsIdentity.GetCurrent().Name</c> to get the name of
  13257. the current windows user.
  13258. </para>
  13259. <para>
  13260. To improve performance, we could cache the string representation of
  13261. the name, and reuse that as long as the identity stayed constant.
  13262. Once the identity changed, we would need to re-assign and re-render
  13263. the string.
  13264. </para>
  13265. <para>
  13266. However, the <c>WindowsIdentity.GetCurrent()</c> call seems to
  13267. return different objects every time, so the current implementation
  13268. doesn't do this type of caching.
  13269. </para>
  13270. <para>
  13271. Timing for these operations:
  13272. </para>
  13273. <list type="table">
  13274. <listheader>
  13275. <term>Method</term>
  13276. <description>Results</description>
  13277. </listheader>
  13278. <item>
  13279. <term><c>WindowsIdentity.GetCurrent()</c></term>
  13280. <description>10000 loops, 00:00:00.2031250 seconds</description>
  13281. </item>
  13282. <item>
  13283. <term><c>WindowsIdentity.GetCurrent().Name</c></term>
  13284. <description>10000 loops, 00:00:08.0468750 seconds</description>
  13285. </item>
  13286. </list>
  13287. <para>
  13288. This means we could speed things up almost 40 times by caching the
  13289. value of the <c>WindowsIdentity.GetCurrent().Name</c> property, since
  13290. this takes (8.04-0.20) = 7.84375 seconds.
  13291. </para>
  13292. </remarks>
  13293. </member>
  13294. <member name="P:log4net.Core.LoggingEvent.Identity">
  13295. <summary>
  13296. Gets the identity of the current thread principal.
  13297. </summary>
  13298. <value>
  13299. The string name of the identity of the current thread principal.
  13300. </value>
  13301. <remarks>
  13302. <para>
  13303. Calls <c>System.Threading.Thread.CurrentPrincipal.Identity.Name</c> to get
  13304. the name of the current thread principal.
  13305. </para>
  13306. </remarks>
  13307. </member>
  13308. <member name="P:log4net.Core.LoggingEvent.Domain">
  13309. <summary>
  13310. Gets the AppDomain friendly name.
  13311. </summary>
  13312. <value>
  13313. The AppDomain friendly name.
  13314. </value>
  13315. <remarks>
  13316. <para>
  13317. Gets the AppDomain friendly name.
  13318. </para>
  13319. </remarks>
  13320. </member>
  13321. <member name="P:log4net.Core.LoggingEvent.Properties">
  13322. <summary>
  13323. Additional event specific properties.
  13324. </summary>
  13325. <value>
  13326. Additional event specific properties.
  13327. </value>
  13328. <remarks>
  13329. <para>
  13330. A logger or an appender may attach additional
  13331. properties to specific events. These properties
  13332. have a string key and an object value.
  13333. </para>
  13334. <para>
  13335. This property is for events that have been added directly to
  13336. this event. The aggregate properties (which include these
  13337. event properties) can be retrieved using <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/>
  13338. and <see cref="M:log4net.Core.LoggingEvent.GetProperties"/>.
  13339. </para>
  13340. <para>
  13341. Once the properties have been fixed <see cref="P:log4net.Core.LoggingEvent.Fix"/> this property
  13342. returns the combined cached properties. This ensures that updates to
  13343. this property are always reflected in the underlying storage. When
  13344. returning the combined properties there may be more keys in the
  13345. Dictionary than expected.
  13346. </para>
  13347. </remarks>
  13348. </member>
  13349. <member name="P:log4net.Core.LoggingEvent.Fix">
  13350. <summary>
  13351. The fixed fields in this event
  13352. </summary>
  13353. <value>
  13354. The set of fields that are fixed in this event
  13355. </value>
  13356. <remarks>
  13357. <para>
  13358. Fields will not be fixed if they have previously been fixed.
  13359. It is not possible to 'unfix' a field.
  13360. </para>
  13361. </remarks>
  13362. </member>
  13363. <member name="M:log4net.Core.LoggingEvent.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13364. <summary>
  13365. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  13366. </summary>
  13367. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
  13368. <param name="context">The destination for this serialization.</param>
  13369. <remarks>
  13370. <para>
  13371. The data in this event must be fixed before it can be serialized.
  13372. </para>
  13373. <para>
  13374. The <see cref="M:FixVolatileData()"/> method must be called during the
  13375. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method call if this event
  13376. is to be used outside that method.
  13377. </para>
  13378. </remarks>
  13379. </member>
  13380. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData">
  13381. <summary>
  13382. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent" />.
  13383. </summary>
  13384. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  13385. <remarks>
  13386. <para>
  13387. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  13388. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  13389. </para>
  13390. <para>
  13391. Does a <see cref="F:log4net.Core.FixFlags.Partial"/> fix of the data
  13392. in the logging event before returning the event data.
  13393. </para>
  13394. </remarks>
  13395. </member>
  13396. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)">
  13397. <summary>
  13398. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent" />.
  13399. </summary>
  13400. <param name="fixFlags">The set of data to ensure is fixed in the LoggingEventData</param>
  13401. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  13402. <remarks>
  13403. <para>
  13404. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  13405. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  13406. </para>
  13407. </remarks>
  13408. </member>
  13409. <member name="M:log4net.Core.LoggingEvent.GetExceptionStrRep">
  13410. <summary>
  13411. Returns this event's exception's rendered using the
  13412. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13413. </summary>
  13414. <returns>
  13415. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13416. </returns>
  13417. <remarks>
  13418. <para>
  13419. <b>Obsolete. Use <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> instead.</b>
  13420. </para>
  13421. </remarks>
  13422. </member>
  13423. <member name="M:log4net.Core.LoggingEvent.GetExceptionString">
  13424. <summary>
  13425. Returns this event's exception's rendered using the
  13426. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13427. </summary>
  13428. <returns>
  13429. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13430. </returns>
  13431. <remarks>
  13432. <para>
  13433. Returns this event's exception's rendered using the
  13434. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  13435. </para>
  13436. </remarks>
  13437. </member>
  13438. <member name="M:log4net.Core.LoggingEvent.FixVolatileData">
  13439. <summary>
  13440. Fix instance fields that hold volatile data.
  13441. </summary>
  13442. <remarks>
  13443. <para>
  13444. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  13445. are considered volatile, that is the values are correct at the
  13446. time the event is delivered to appenders, but will not be consistent
  13447. at any time afterwards. If an event is to be stored and then processed
  13448. at a later time these volatile values must be fixed by calling
  13449. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  13450. incurred by calling <see cref="M:FixVolatileData()"/> but it
  13451. is essential to maintaining data consistency.
  13452. </para>
  13453. <para>
  13454. Calling <see cref="M:FixVolatileData()"/> is equivalent to
  13455. calling <see cref="M:FixVolatileData(bool)"/> passing the parameter
  13456. <c>false</c>.
  13457. </para>
  13458. <para>
  13459. See <see cref="M:FixVolatileData(bool)"/> for more
  13460. information.
  13461. </para>
  13462. </remarks>
  13463. </member>
  13464. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)">
  13465. <summary>
  13466. Fixes instance fields that hold volatile data.
  13467. </summary>
  13468. <param name="fastButLoose">Set to <c>true</c> to not fix data that takes a long time to fix.</param>
  13469. <remarks>
  13470. <para>
  13471. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  13472. are considered volatile, that is the values are correct at the
  13473. time the event is delivered to appenders, but will not be consistent
  13474. at any time afterwards. If an event is to be stored and then processed
  13475. at a later time these volatile values must be fixed by calling
  13476. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  13477. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  13478. is essential to maintaining data consistency.
  13479. </para>
  13480. <para>
  13481. The <paramref name="fastButLoose"/> param controls the data that
  13482. is fixed. Some of the data that can be fixed takes a long time to
  13483. generate, therefore if you do not require those settings to be fixed
  13484. they can be ignored by setting the <paramref name="fastButLoose"/> param
  13485. to <c>true</c>. This setting will ignore the <see cref="P:log4net.Core.LoggingEvent.LocationInformation"/>
  13486. and <see cref="P:log4net.Core.LoggingEvent.UserName"/> settings.
  13487. </para>
  13488. <para>
  13489. Set <paramref name="fastButLoose"/> to <c>false</c> to ensure that all
  13490. settings are fixed.
  13491. </para>
  13492. </remarks>
  13493. </member>
  13494. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)">
  13495. <summary>
  13496. Fix the fields specified by the <see cref="T:log4net.Core.FixFlags"/> parameter
  13497. </summary>
  13498. <param name="flags">the fields to fix</param>
  13499. <remarks>
  13500. <para>
  13501. Only fields specified in the <paramref name="flags"/> will be fixed.
  13502. Fields will not be fixed if they have previously been fixed.
  13503. It is not possible to 'unfix' a field.
  13504. </para>
  13505. </remarks>
  13506. </member>
  13507. <member name="M:log4net.Core.LoggingEvent.LookupProperty(System.String)">
  13508. <summary>
  13509. Lookup a composite property in this event
  13510. </summary>
  13511. <param name="key">the key for the property to lookup</param>
  13512. <returns>the value for the property</returns>
  13513. <remarks>
  13514. <para>
  13515. This event has composite properties that combine together properties from
  13516. several different contexts in the following order:
  13517. <list type="definition">
  13518. <item>
  13519. <term>this events properties</term>
  13520. <description>
  13521. This event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  13522. properties are specific to this event only.
  13523. </description>
  13524. </item>
  13525. <item>
  13526. <term>the thread properties</term>
  13527. <description>
  13528. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  13529. thread. These properties are shared by all events logged on this thread.
  13530. </description>
  13531. </item>
  13532. <item>
  13533. <term>the global properties</term>
  13534. <description>
  13535. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  13536. properties are shared by all the threads in the AppDomain.
  13537. </description>
  13538. </item>
  13539. </list>
  13540. </para>
  13541. </remarks>
  13542. </member>
  13543. <member name="M:log4net.Core.LoggingEvent.GetProperties">
  13544. <summary>
  13545. Get all the composite properties in this event
  13546. </summary>
  13547. <returns>the <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the properties</returns>
  13548. <remarks>
  13549. <para>
  13550. See <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> for details of the composite properties
  13551. stored by the event.
  13552. </para>
  13553. <para>
  13554. This method returns a single <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the
  13555. properties defined for this event.
  13556. </para>
  13557. </remarks>
  13558. </member>
  13559. <member name="F:log4net.Core.LoggingEvent.m_data">
  13560. <summary>
  13561. The internal logging event data.
  13562. </summary>
  13563. </member>
  13564. <member name="F:log4net.Core.LoggingEvent.m_compositeProperties">
  13565. <summary>
  13566. The internal logging event data.
  13567. </summary>
  13568. </member>
  13569. <member name="F:log4net.Core.LoggingEvent.m_eventProperties">
  13570. <summary>
  13571. The internal logging event data.
  13572. </summary>
  13573. </member>
  13574. <member name="F:log4net.Core.LoggingEvent.m_callerStackBoundaryDeclaringType">
  13575. <summary>
  13576. The fully qualified Type of the calling
  13577. logger class in the stack frame (i.e. the declaring type of the method).
  13578. </summary>
  13579. </member>
  13580. <member name="F:log4net.Core.LoggingEvent.m_message">
  13581. <summary>
  13582. The application supplied message of logging event.
  13583. </summary>
  13584. </member>
  13585. <member name="F:log4net.Core.LoggingEvent.m_thrownException">
  13586. <summary>
  13587. The exception that was thrown.
  13588. </summary>
  13589. <remarks>
  13590. This is not serialized. The string representation
  13591. is serialized instead.
  13592. </remarks>
  13593. </member>
  13594. <member name="F:log4net.Core.LoggingEvent.m_repository">
  13595. <summary>
  13596. The repository that generated the logging event
  13597. </summary>
  13598. <remarks>
  13599. This is not serialized.
  13600. </remarks>
  13601. </member>
  13602. <member name="F:log4net.Core.LoggingEvent.m_fixFlags">
  13603. <summary>
  13604. The fix state for this event
  13605. </summary>
  13606. <remarks>
  13607. These flags indicate which fields have been fixed.
  13608. Not serialized.
  13609. </remarks>
  13610. </member>
  13611. <member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable">
  13612. <summary>
  13613. Indicated that the internal cache is updateable (ie not fixed)
  13614. </summary>
  13615. <remarks>
  13616. This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler
  13617. changes in the caching strategy.
  13618. </remarks>
  13619. </member>
  13620. <member name="F:log4net.Core.LoggingEvent.HostNameProperty">
  13621. <summary>
  13622. The key into the Properties map for the host name value.
  13623. </summary>
  13624. </member>
  13625. <member name="F:log4net.Core.LoggingEvent.IdentityProperty">
  13626. <summary>
  13627. The key into the Properties map for the thread identity value.
  13628. </summary>
  13629. </member>
  13630. <member name="F:log4net.Core.LoggingEvent.UserNameProperty">
  13631. <summary>
  13632. The key into the Properties map for the user name value.
  13633. </summary>
  13634. </member>
  13635. <member name="T:log4net.Core.LogImpl">
  13636. <summary>
  13637. Implementation of <see cref="T:log4net.ILog"/> wrapper interface.
  13638. </summary>
  13639. <remarks>
  13640. <para>
  13641. This implementation of the <see cref="T:log4net.ILog"/> interface
  13642. forwards to the <see cref="T:log4net.Core.ILogger"/> held by the base class.
  13643. </para>
  13644. <para>
  13645. This logger has methods to allow the caller to log at the following
  13646. levels:
  13647. </para>
  13648. <list type="definition">
  13649. <item>
  13650. <term>DEBUG</term>
  13651. <description>
  13652. The <see cref="M:Debug(object)"/> and <see cref="M:DebugFormat(string, object[])"/> methods log messages
  13653. at the <c>DEBUG</c> level. That is the level with that name defined in the
  13654. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13655. for this level is <see cref="F:log4net.Core.Level.Debug"/>. The <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  13656. property tests if this level is enabled for logging.
  13657. </description>
  13658. </item>
  13659. <item>
  13660. <term>INFO</term>
  13661. <description>
  13662. The <see cref="M:Info(object)"/> and <see cref="M:InfoFormat(string, object[])"/> methods log messages
  13663. at the <c>INFO</c> level. That is the level with that name defined in the
  13664. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13665. for this level is <see cref="F:log4net.Core.Level.Info"/>. The <see cref="P:log4net.Core.LogImpl.IsInfoEnabled"/>
  13666. property tests if this level is enabled for logging.
  13667. </description>
  13668. </item>
  13669. <item>
  13670. <term>WARN</term>
  13671. <description>
  13672. The <see cref="M:Warn(object)"/> and <see cref="M:WarnFormat(string, object[])"/> methods log messages
  13673. at the <c>WARN</c> level. That is the level with that name defined in the
  13674. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13675. for this level is <see cref="F:log4net.Core.Level.Warn"/>. The <see cref="P:log4net.Core.LogImpl.IsWarnEnabled"/>
  13676. property tests if this level is enabled for logging.
  13677. </description>
  13678. </item>
  13679. <item>
  13680. <term>ERROR</term>
  13681. <description>
  13682. The <see cref="M:Error(object)"/> and <see cref="M:ErrorFormat(string, object[])"/> methods log messages
  13683. at the <c>ERROR</c> level. That is the level with that name defined in the
  13684. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13685. for this level is <see cref="F:log4net.Core.Level.Error"/>. The <see cref="P:log4net.Core.LogImpl.IsErrorEnabled"/>
  13686. property tests if this level is enabled for logging.
  13687. </description>
  13688. </item>
  13689. <item>
  13690. <term>FATAL</term>
  13691. <description>
  13692. The <see cref="M:Fatal(object)"/> and <see cref="M:FatalFormat(string, object[])"/> methods log messages
  13693. at the <c>FATAL</c> level. That is the level with that name defined in the
  13694. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13695. for this level is <see cref="F:log4net.Core.Level.Fatal"/>. The <see cref="P:log4net.Core.LogImpl.IsFatalEnabled"/>
  13696. property tests if this level is enabled for logging.
  13697. </description>
  13698. </item>
  13699. </list>
  13700. <para>
  13701. The values for these levels and their semantic meanings can be changed by
  13702. configuring the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> for the repository.
  13703. </para>
  13704. </remarks>
  13705. <author>Nicko Cadell</author>
  13706. <author>Gert Driesen</author>
  13707. </member>
  13708. <member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)">
  13709. <summary>
  13710. Construct a new wrapper for the specified logger.
  13711. </summary>
  13712. <param name="logger">The logger to wrap.</param>
  13713. <remarks>
  13714. <para>
  13715. Construct a new wrapper for the specified logger.
  13716. </para>
  13717. </remarks>
  13718. </member>
  13719. <member name="M:log4net.Core.LogImpl.ReloadLevels(log4net.Repository.ILoggerRepository)">
  13720. <summary>
  13721. Virtual method called when the configuration of the repository changes
  13722. </summary>
  13723. <param name="repository">the repository holding the levels</param>
  13724. <remarks>
  13725. <para>
  13726. Virtual method called when the configuration of the repository changes
  13727. </para>
  13728. </remarks>
  13729. </member>
  13730. <member name="M:log4net.Core.LogImpl.Debug(System.Object)">
  13731. <summary>
  13732. Logs a message object with the <c>DEBUG</c> level.
  13733. </summary>
  13734. <param name="message">The message object to log.</param>
  13735. <remarks>
  13736. <para>
  13737. This method first checks if this logger is <c>DEBUG</c>
  13738. enabled by comparing the level of this logger with the
  13739. <c>DEBUG</c> level. If this logger is
  13740. <c>DEBUG</c> enabled, then it converts the message object
  13741. (passed as parameter) to a string by invoking the appropriate
  13742. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13743. proceeds to call all the registered appenders in this logger
  13744. and also higher in the hierarchy depending on the value of the
  13745. additivity flag.
  13746. </para>
  13747. <para>
  13748. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13749. to this method will print the name of the <see cref="T:System.Exception"/>
  13750. but no stack trace. To print a stack trace use the
  13751. <see cref="M:Debug(object,Exception)"/> form instead.
  13752. </para>
  13753. </remarks>
  13754. </member>
  13755. <member name="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)">
  13756. <summary>
  13757. Logs a message object with the <c>DEBUG</c> level
  13758. </summary>
  13759. <param name="message">The message object to log.</param>
  13760. <param name="exception">The exception to log, including its stack trace.</param>
  13761. <remarks>
  13762. <para>
  13763. Logs a message object with the <c>DEBUG</c> level including
  13764. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> passed
  13765. as a parameter.
  13766. </para>
  13767. <para>
  13768. See the <see cref="M:Debug(object)"/> form for more detailed information.
  13769. </para>
  13770. </remarks>
  13771. <seealso cref="M:Debug(object)"/>
  13772. </member>
  13773. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
  13774. <summary>
  13775. Logs a formatted message string with the <c>DEBUG</c> level.
  13776. </summary>
  13777. <param name="format">A String containing zero or more format items</param>
  13778. <param name="args">An Object array containing zero or more objects to format</param>
  13779. <remarks>
  13780. <para>
  13781. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13782. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13783. of the formatting.
  13784. </para>
  13785. <para>
  13786. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13787. format provider. To specify a localized provider use the
  13788. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  13789. </para>
  13790. <para>
  13791. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13792. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  13793. methods instead.
  13794. </para>
  13795. </remarks>
  13796. </member>
  13797. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)">
  13798. <summary>
  13799. Logs a formatted message string with the <c>DEBUG</c> level.
  13800. </summary>
  13801. <param name="format">A String containing zero or more format items</param>
  13802. <param name="arg0">An Object to format</param>
  13803. <remarks>
  13804. <para>
  13805. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13806. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13807. of the formatting.
  13808. </para>
  13809. <para>
  13810. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13811. format provider. To specify a localized provider use the
  13812. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  13813. </para>
  13814. <para>
  13815. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13816. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  13817. methods instead.
  13818. </para>
  13819. </remarks>
  13820. </member>
  13821. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)">
  13822. <summary>
  13823. Logs a formatted message string with the <c>DEBUG</c> level.
  13824. </summary>
  13825. <param name="format">A String containing zero or more format items</param>
  13826. <param name="arg0">An Object to format</param>
  13827. <param name="arg1">An Object to format</param>
  13828. <remarks>
  13829. <para>
  13830. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13831. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13832. of the formatting.
  13833. </para>
  13834. <para>
  13835. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13836. format provider. To specify a localized provider use the
  13837. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  13838. </para>
  13839. <para>
  13840. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13841. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  13842. methods instead.
  13843. </para>
  13844. </remarks>
  13845. </member>
  13846. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  13847. <summary>
  13848. Logs a formatted message string with the <c>DEBUG</c> level.
  13849. </summary>
  13850. <param name="format">A String containing zero or more format items</param>
  13851. <param name="arg0">An Object to format</param>
  13852. <param name="arg1">An Object to format</param>
  13853. <param name="arg2">An Object to format</param>
  13854. <remarks>
  13855. <para>
  13856. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13857. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13858. of the formatting.
  13859. </para>
  13860. <para>
  13861. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13862. format provider. To specify a localized provider use the
  13863. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  13864. </para>
  13865. <para>
  13866. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13867. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  13868. methods instead.
  13869. </para>
  13870. </remarks>
  13871. </member>
  13872. <member name="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  13873. <summary>
  13874. Logs a formatted message string with the <c>DEBUG</c> level.
  13875. </summary>
  13876. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  13877. <param name="format">A String containing zero or more format items</param>
  13878. <param name="args">An Object array containing zero or more objects to format</param>
  13879. <remarks>
  13880. <para>
  13881. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13882. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13883. of the formatting.
  13884. </para>
  13885. <para>
  13886. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13887. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  13888. methods instead.
  13889. </para>
  13890. </remarks>
  13891. </member>
  13892. <member name="M:log4net.Core.LogImpl.Info(System.Object)">
  13893. <summary>
  13894. Logs a message object with the <c>INFO</c> level.
  13895. </summary>
  13896. <param name="message">The message object to log.</param>
  13897. <remarks>
  13898. <para>
  13899. This method first checks if this logger is <c>INFO</c>
  13900. enabled by comparing the level of this logger with the
  13901. <c>INFO</c> level. If this logger is
  13902. <c>INFO</c> enabled, then it converts the message object
  13903. (passed as parameter) to a string by invoking the appropriate
  13904. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13905. proceeds to call all the registered appenders in this logger
  13906. and also higher in the hierarchy depending on the value of
  13907. the additivity flag.
  13908. </para>
  13909. <para>
  13910. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13911. to this method will print the name of the <see cref="T:System.Exception"/>
  13912. but no stack trace. To print a stack trace use the
  13913. <see cref="M:Info(object,Exception)"/> form instead.
  13914. </para>
  13915. </remarks>
  13916. </member>
  13917. <member name="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)">
  13918. <summary>
  13919. Logs a message object with the <c>INFO</c> level.
  13920. </summary>
  13921. <param name="message">The message object to log.</param>
  13922. <param name="exception">The exception to log, including its stack trace.</param>
  13923. <remarks>
  13924. <para>
  13925. Logs a message object with the <c>INFO</c> level including
  13926. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  13927. passed as a parameter.
  13928. </para>
  13929. <para>
  13930. See the <see cref="M:Info(object)"/> form for more detailed information.
  13931. </para>
  13932. </remarks>
  13933. <seealso cref="M:Info(object)"/>
  13934. </member>
  13935. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])">
  13936. <summary>
  13937. Logs a formatted message string with the <c>INFO</c> level.
  13938. </summary>
  13939. <param name="format">A String containing zero or more format items</param>
  13940. <param name="args">An Object array containing zero or more objects to format</param>
  13941. <remarks>
  13942. <para>
  13943. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13944. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13945. of the formatting.
  13946. </para>
  13947. <para>
  13948. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13949. format provider. To specify a localized provider use the
  13950. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  13951. </para>
  13952. <para>
  13953. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13954. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  13955. methods instead.
  13956. </para>
  13957. </remarks>
  13958. </member>
  13959. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)">
  13960. <summary>
  13961. Logs a formatted message string with the <c>INFO</c> level.
  13962. </summary>
  13963. <param name="format">A String containing zero or more format items</param>
  13964. <param name="arg0">An Object to format</param>
  13965. <remarks>
  13966. <para>
  13967. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13968. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13969. of the formatting.
  13970. </para>
  13971. <para>
  13972. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13973. format provider. To specify a localized provider use the
  13974. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  13975. </para>
  13976. <para>
  13977. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13978. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  13979. methods instead.
  13980. </para>
  13981. </remarks>
  13982. </member>
  13983. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)">
  13984. <summary>
  13985. Logs a formatted message string with the <c>INFO</c> level.
  13986. </summary>
  13987. <param name="format">A String containing zero or more format items</param>
  13988. <param name="arg0">An Object to format</param>
  13989. <param name="arg1">An Object to format</param>
  13990. <remarks>
  13991. <para>
  13992. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  13993. <c>String.Format</c> for details of the syntax of the format string and the behavior
  13994. of the formatting.
  13995. </para>
  13996. <para>
  13997. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  13998. format provider. To specify a localized provider use the
  13999. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  14000. </para>
  14001. <para>
  14002. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14003. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14004. methods instead.
  14005. </para>
  14006. </remarks>
  14007. </member>
  14008. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  14009. <summary>
  14010. Logs a formatted message string with the <c>INFO</c> level.
  14011. </summary>
  14012. <param name="format">A String containing zero or more format items</param>
  14013. <param name="arg0">An Object to format</param>
  14014. <param name="arg1">An Object to format</param>
  14015. <param name="arg2">An Object to format</param>
  14016. <remarks>
  14017. <para>
  14018. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14019. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14020. of the formatting.
  14021. </para>
  14022. <para>
  14023. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14024. format provider. To specify a localized provider use the
  14025. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  14026. </para>
  14027. <para>
  14028. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14029. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14030. methods instead.
  14031. </para>
  14032. </remarks>
  14033. </member>
  14034. <member name="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  14035. <summary>
  14036. Logs a formatted message string with the <c>INFO</c> level.
  14037. </summary>
  14038. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14039. <param name="format">A String containing zero or more format items</param>
  14040. <param name="args">An Object array containing zero or more objects to format</param>
  14041. <remarks>
  14042. <para>
  14043. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14044. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14045. of the formatting.
  14046. </para>
  14047. <para>
  14048. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14049. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14050. methods instead.
  14051. </para>
  14052. </remarks>
  14053. </member>
  14054. <member name="M:log4net.Core.LogImpl.Warn(System.Object)">
  14055. <summary>
  14056. Logs a message object with the <c>WARN</c> level.
  14057. </summary>
  14058. <param name="message">the message object to log</param>
  14059. <remarks>
  14060. <para>
  14061. This method first checks if this logger is <c>WARN</c>
  14062. enabled by comparing the level of this logger with the
  14063. <c>WARN</c> level. If this logger is
  14064. <c>WARN</c> enabled, then it converts the message object
  14065. (passed as parameter) to a string by invoking the appropriate
  14066. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14067. proceeds to call all the registered appenders in this logger and
  14068. also higher in the hierarchy depending on the value of the
  14069. additivity flag.
  14070. </para>
  14071. <para>
  14072. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  14073. method will print the name of the <see cref="T:System.Exception"/> but no
  14074. stack trace. To print a stack trace use the
  14075. <see cref="M:Warn(object,Exception)"/> form instead.
  14076. </para>
  14077. </remarks>
  14078. </member>
  14079. <member name="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)">
  14080. <summary>
  14081. Logs a message object with the <c>WARN</c> level
  14082. </summary>
  14083. <param name="message">The message object to log.</param>
  14084. <param name="exception">The exception to log, including its stack trace.</param>
  14085. <remarks>
  14086. <para>
  14087. Logs a message object with the <c>WARN</c> level including
  14088. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14089. passed as a parameter.
  14090. </para>
  14091. <para>
  14092. See the <see cref="M:Warn(object)"/> form for more detailed information.
  14093. </para>
  14094. </remarks>
  14095. <seealso cref="M:Warn(object)"/>
  14096. </member>
  14097. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])">
  14098. <summary>
  14099. Logs a formatted message string with the <c>WARN</c> level.
  14100. </summary>
  14101. <param name="format">A String containing zero or more format items</param>
  14102. <param name="args">An Object array containing zero or more objects to format</param>
  14103. <remarks>
  14104. <para>
  14105. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14106. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14107. of the formatting.
  14108. </para>
  14109. <para>
  14110. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14111. format provider. To specify a localized provider use the
  14112. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14113. </para>
  14114. <para>
  14115. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14116. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14117. methods instead.
  14118. </para>
  14119. </remarks>
  14120. </member>
  14121. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)">
  14122. <summary>
  14123. Logs a formatted message string with the <c>WARN</c> level.
  14124. </summary>
  14125. <param name="format">A String containing zero or more format items</param>
  14126. <param name="arg0">An Object to format</param>
  14127. <remarks>
  14128. <para>
  14129. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14130. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14131. of the formatting.
  14132. </para>
  14133. <para>
  14134. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14135. format provider. To specify a localized provider use the
  14136. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14137. </para>
  14138. <para>
  14139. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14140. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14141. methods instead.
  14142. </para>
  14143. </remarks>
  14144. </member>
  14145. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)">
  14146. <summary>
  14147. Logs a formatted message string with the <c>WARN</c> level.
  14148. </summary>
  14149. <param name="format">A String containing zero or more format items</param>
  14150. <param name="arg0">An Object to format</param>
  14151. <param name="arg1">An Object to format</param>
  14152. <remarks>
  14153. <para>
  14154. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14155. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14156. of the formatting.
  14157. </para>
  14158. <para>
  14159. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14160. format provider. To specify a localized provider use the
  14161. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14162. </para>
  14163. <para>
  14164. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14165. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14166. methods instead.
  14167. </para>
  14168. </remarks>
  14169. </member>
  14170. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  14171. <summary>
  14172. Logs a formatted message string with the <c>WARN</c> level.
  14173. </summary>
  14174. <param name="format">A String containing zero or more format items</param>
  14175. <param name="arg0">An Object to format</param>
  14176. <param name="arg1">An Object to format</param>
  14177. <param name="arg2">An Object to format</param>
  14178. <remarks>
  14179. <para>
  14180. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14181. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14182. of the formatting.
  14183. </para>
  14184. <para>
  14185. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14186. format provider. To specify a localized provider use the
  14187. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14188. </para>
  14189. <para>
  14190. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14191. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14192. methods instead.
  14193. </para>
  14194. </remarks>
  14195. </member>
  14196. <member name="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  14197. <summary>
  14198. Logs a formatted message string with the <c>WARN</c> level.
  14199. </summary>
  14200. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14201. <param name="format">A String containing zero or more format items</param>
  14202. <param name="args">An Object array containing zero or more objects to format</param>
  14203. <remarks>
  14204. <para>
  14205. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14206. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14207. of the formatting.
  14208. </para>
  14209. <para>
  14210. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14211. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14212. methods instead.
  14213. </para>
  14214. </remarks>
  14215. </member>
  14216. <member name="M:log4net.Core.LogImpl.Error(System.Object)">
  14217. <summary>
  14218. Logs a message object with the <c>ERROR</c> level.
  14219. </summary>
  14220. <param name="message">The message object to log.</param>
  14221. <remarks>
  14222. <para>
  14223. This method first checks if this logger is <c>ERROR</c>
  14224. enabled by comparing the level of this logger with the
  14225. <c>ERROR</c> level. If this logger is
  14226. <c>ERROR</c> enabled, then it converts the message object
  14227. (passed as parameter) to a string by invoking the appropriate
  14228. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14229. proceeds to call all the registered appenders in this logger and
  14230. also higher in the hierarchy depending on the value of the
  14231. additivity flag.
  14232. </para>
  14233. <para>
  14234. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  14235. method will print the name of the <see cref="T:System.Exception"/> but no
  14236. stack trace. To print a stack trace use the
  14237. <see cref="M:Error(object,Exception)"/> form instead.
  14238. </para>
  14239. </remarks>
  14240. </member>
  14241. <member name="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)">
  14242. <summary>
  14243. Logs a message object with the <c>ERROR</c> level
  14244. </summary>
  14245. <param name="message">The message object to log.</param>
  14246. <param name="exception">The exception to log, including its stack trace.</param>
  14247. <remarks>
  14248. <para>
  14249. Logs a message object with the <c>ERROR</c> level including
  14250. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14251. passed as a parameter.
  14252. </para>
  14253. <para>
  14254. See the <see cref="M:Error(object)"/> form for more detailed information.
  14255. </para>
  14256. </remarks>
  14257. <seealso cref="M:Error(object)"/>
  14258. </member>
  14259. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])">
  14260. <summary>
  14261. Logs a formatted message string with the <c>ERROR</c> level.
  14262. </summary>
  14263. <param name="format">A String containing zero or more format items</param>
  14264. <param name="args">An Object array containing zero or more objects to format</param>
  14265. <remarks>
  14266. <para>
  14267. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14268. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14269. of the formatting.
  14270. </para>
  14271. <para>
  14272. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14273. format provider. To specify a localized provider use the
  14274. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14275. </para>
  14276. <para>
  14277. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14278. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14279. methods instead.
  14280. </para>
  14281. </remarks>
  14282. </member>
  14283. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)">
  14284. <summary>
  14285. Logs a formatted message string with the <c>ERROR</c> level.
  14286. </summary>
  14287. <param name="format">A String containing zero or more format items</param>
  14288. <param name="arg0">An Object to format</param>
  14289. <remarks>
  14290. <para>
  14291. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14292. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14293. of the formatting.
  14294. </para>
  14295. <para>
  14296. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14297. format provider. To specify a localized provider use the
  14298. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14299. </para>
  14300. <para>
  14301. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14302. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14303. methods instead.
  14304. </para>
  14305. </remarks>
  14306. </member>
  14307. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)">
  14308. <summary>
  14309. Logs a formatted message string with the <c>ERROR</c> level.
  14310. </summary>
  14311. <param name="format">A String containing zero or more format items</param>
  14312. <param name="arg0">An Object to format</param>
  14313. <param name="arg1">An Object to format</param>
  14314. <remarks>
  14315. <para>
  14316. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14317. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14318. of the formatting.
  14319. </para>
  14320. <para>
  14321. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14322. format provider. To specify a localized provider use the
  14323. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14324. </para>
  14325. <para>
  14326. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14327. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14328. methods instead.
  14329. </para>
  14330. </remarks>
  14331. </member>
  14332. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  14333. <summary>
  14334. Logs a formatted message string with the <c>ERROR</c> level.
  14335. </summary>
  14336. <param name="format">A String containing zero or more format items</param>
  14337. <param name="arg0">An Object to format</param>
  14338. <param name="arg1">An Object to format</param>
  14339. <param name="arg2">An Object to format</param>
  14340. <remarks>
  14341. <para>
  14342. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14343. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14344. of the formatting.
  14345. </para>
  14346. <para>
  14347. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14348. format provider. To specify a localized provider use the
  14349. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14350. </para>
  14351. <para>
  14352. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14353. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14354. methods instead.
  14355. </para>
  14356. </remarks>
  14357. </member>
  14358. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  14359. <summary>
  14360. Logs a formatted message string with the <c>ERROR</c> level.
  14361. </summary>
  14362. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14363. <param name="format">A String containing zero or more format items</param>
  14364. <param name="args">An Object array containing zero or more objects to format</param>
  14365. <remarks>
  14366. <para>
  14367. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14368. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14369. of the formatting.
  14370. </para>
  14371. <para>
  14372. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14373. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14374. methods instead.
  14375. </para>
  14376. </remarks>
  14377. </member>
  14378. <member name="M:log4net.Core.LogImpl.Fatal(System.Object)">
  14379. <summary>
  14380. Logs a message object with the <c>FATAL</c> level.
  14381. </summary>
  14382. <param name="message">The message object to log.</param>
  14383. <remarks>
  14384. <para>
  14385. This method first checks if this logger is <c>FATAL</c>
  14386. enabled by comparing the level of this logger with the
  14387. <c>FATAL</c> level. If this logger is
  14388. <c>FATAL</c> enabled, then it converts the message object
  14389. (passed as parameter) to a string by invoking the appropriate
  14390. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14391. proceeds to call all the registered appenders in this logger and
  14392. also higher in the hierarchy depending on the value of the
  14393. additivity flag.
  14394. </para>
  14395. <para>
  14396. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  14397. method will print the name of the <see cref="T:System.Exception"/> but no
  14398. stack trace. To print a stack trace use the
  14399. <see cref="M:Fatal(object,Exception)"/> form instead.
  14400. </para>
  14401. </remarks>
  14402. </member>
  14403. <member name="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)">
  14404. <summary>
  14405. Logs a message object with the <c>FATAL</c> level
  14406. </summary>
  14407. <param name="message">The message object to log.</param>
  14408. <param name="exception">The exception to log, including its stack trace.</param>
  14409. <remarks>
  14410. <para>
  14411. Logs a message object with the <c>FATAL</c> level including
  14412. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14413. passed as a parameter.
  14414. </para>
  14415. <para>
  14416. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  14417. </para>
  14418. </remarks>
  14419. <seealso cref="M:Fatal(object)"/>
  14420. </member>
  14421. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
  14422. <summary>
  14423. Logs a formatted message string with the <c>FATAL</c> level.
  14424. </summary>
  14425. <param name="format">A String containing zero or more format items</param>
  14426. <param name="args">An Object array containing zero or more objects to format</param>
  14427. <remarks>
  14428. <para>
  14429. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14430. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14431. of the formatting.
  14432. </para>
  14433. <para>
  14434. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14435. format provider. To specify a localized provider use the
  14436. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  14437. </para>
  14438. <para>
  14439. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14440. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14441. methods instead.
  14442. </para>
  14443. </remarks>
  14444. </member>
  14445. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)">
  14446. <summary>
  14447. Logs a formatted message string with the <c>FATAL</c> level.
  14448. </summary>
  14449. <param name="format">A String containing zero or more format items</param>
  14450. <param name="arg0">An Object to format</param>
  14451. <remarks>
  14452. <para>
  14453. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14454. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14455. of the formatting.
  14456. </para>
  14457. <para>
  14458. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14459. format provider. To specify a localized provider use the
  14460. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  14461. </para>
  14462. <para>
  14463. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14464. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14465. methods instead.
  14466. </para>
  14467. </remarks>
  14468. </member>
  14469. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)">
  14470. <summary>
  14471. Logs a formatted message string with the <c>FATAL</c> level.
  14472. </summary>
  14473. <param name="format">A String containing zero or more format items</param>
  14474. <param name="arg0">An Object to format</param>
  14475. <param name="arg1">An Object to format</param>
  14476. <remarks>
  14477. <para>
  14478. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14479. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14480. of the formatting.
  14481. </para>
  14482. <para>
  14483. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14484. format provider. To specify a localized provider use the
  14485. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  14486. </para>
  14487. <para>
  14488. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14489. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14490. methods instead.
  14491. </para>
  14492. </remarks>
  14493. </member>
  14494. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  14495. <summary>
  14496. Logs a formatted message string with the <c>FATAL</c> level.
  14497. </summary>
  14498. <param name="format">A String containing zero or more format items</param>
  14499. <param name="arg0">An Object to format</param>
  14500. <param name="arg1">An Object to format</param>
  14501. <param name="arg2">An Object to format</param>
  14502. <remarks>
  14503. <para>
  14504. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14505. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14506. of the formatting.
  14507. </para>
  14508. <para>
  14509. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14510. format provider. To specify a localized provider use the
  14511. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  14512. </para>
  14513. <para>
  14514. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14515. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14516. methods instead.
  14517. </para>
  14518. </remarks>
  14519. </member>
  14520. <member name="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  14521. <summary>
  14522. Logs a formatted message string with the <c>FATAL</c> level.
  14523. </summary>
  14524. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14525. <param name="format">A String containing zero or more format items</param>
  14526. <param name="args">An Object array containing zero or more objects to format</param>
  14527. <remarks>
  14528. <para>
  14529. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14530. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14531. of the formatting.
  14532. </para>
  14533. <para>
  14534. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14535. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14536. methods instead.
  14537. </para>
  14538. </remarks>
  14539. </member>
  14540. <member name="P:log4net.Core.LogImpl.IsDebugEnabled">
  14541. <summary>
  14542. Checks if this logger is enabled for the <c>DEBUG</c>
  14543. level.
  14544. </summary>
  14545. <value>
  14546. <c>true</c> if this logger is enabled for <c>DEBUG</c> events,
  14547. <c>false</c> otherwise.
  14548. </value>
  14549. <remarks>
  14550. <para>
  14551. This function is intended to lessen the computational cost of
  14552. disabled log debug statements.
  14553. </para>
  14554. <para>
  14555. For some <c>log</c> Logger object, when you write:
  14556. </para>
  14557. <code lang="C#">
  14558. log.Debug("This is entry number: " + i );
  14559. </code>
  14560. <para>
  14561. You incur the cost constructing the message, concatenation in
  14562. this case, regardless of whether the message is logged or not.
  14563. </para>
  14564. <para>
  14565. If you are worried about speed, then you should write:
  14566. </para>
  14567. <code lang="C#">
  14568. if (log.IsDebugEnabled())
  14569. {
  14570. log.Debug("This is entry number: " + i );
  14571. }
  14572. </code>
  14573. <para>
  14574. This way you will not incur the cost of parameter
  14575. construction if debugging is disabled for <c>log</c>. On
  14576. the other hand, if the <c>log</c> is debug enabled, you
  14577. will incur the cost of evaluating whether the logger is debug
  14578. enabled twice. Once in <c>IsDebugEnabled</c> and once in
  14579. the <c>Debug</c>. This is an insignificant overhead
  14580. since evaluating a logger takes about 1% of the time it
  14581. takes to actually log.
  14582. </para>
  14583. </remarks>
  14584. </member>
  14585. <member name="P:log4net.Core.LogImpl.IsInfoEnabled">
  14586. <summary>
  14587. Checks if this logger is enabled for the <c>INFO</c> level.
  14588. </summary>
  14589. <value>
  14590. <c>true</c> if this logger is enabled for <c>INFO</c> events,
  14591. <c>false</c> otherwise.
  14592. </value>
  14593. <remarks>
  14594. <para>
  14595. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  14596. of using this method.
  14597. </para>
  14598. </remarks>
  14599. <seealso cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  14600. </member>
  14601. <member name="P:log4net.Core.LogImpl.IsWarnEnabled">
  14602. <summary>
  14603. Checks if this logger is enabled for the <c>WARN</c> level.
  14604. </summary>
  14605. <value>
  14606. <c>true</c> if this logger is enabled for <c>WARN</c> events,
  14607. <c>false</c> otherwise.
  14608. </value>
  14609. <remarks>
  14610. <para>
  14611. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  14612. of using this method.
  14613. </para>
  14614. </remarks>
  14615. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14616. </member>
  14617. <member name="P:log4net.Core.LogImpl.IsErrorEnabled">
  14618. <summary>
  14619. Checks if this logger is enabled for the <c>ERROR</c> level.
  14620. </summary>
  14621. <value>
  14622. <c>true</c> if this logger is enabled for <c>ERROR</c> events,
  14623. <c>false</c> otherwise.
  14624. </value>
  14625. <remarks>
  14626. <para>
  14627. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  14628. </para>
  14629. </remarks>
  14630. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14631. </member>
  14632. <member name="P:log4net.Core.LogImpl.IsFatalEnabled">
  14633. <summary>
  14634. Checks if this logger is enabled for the <c>FATAL</c> level.
  14635. </summary>
  14636. <value>
  14637. <c>true</c> if this logger is enabled for <c>FATAL</c> events,
  14638. <c>false</c> otherwise.
  14639. </value>
  14640. <remarks>
  14641. <para>
  14642. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  14643. </para>
  14644. </remarks>
  14645. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14646. </member>
  14647. <member name="M:log4net.Core.LogImpl.LoggerRepositoryConfigurationChanged(System.Object,System.EventArgs)">
  14648. <summary>
  14649. Event handler for the <see cref="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"/> event
  14650. </summary>
  14651. <param name="sender">the repository</param>
  14652. <param name="e">Empty</param>
  14653. </member>
  14654. <member name="F:log4net.Core.LogImpl.ThisDeclaringType">
  14655. <summary>
  14656. The fully qualified name of this declaring type not the type of any subclass.
  14657. </summary>
  14658. </member>
  14659. <member name="T:log4net.Core.MethodItem">
  14660. <summary>
  14661. provides method information without actually referencing a System.Reflection.MethodBase
  14662. as that would require that the containing assembly is loaded.
  14663. </summary>
  14664. </member>
  14665. <member name="M:log4net.Core.MethodItem.#ctor">
  14666. <summary>
  14667. constructs a method item for an unknown method.
  14668. </summary>
  14669. </member>
  14670. <member name="M:log4net.Core.MethodItem.#ctor(System.String)">
  14671. <summary>
  14672. constructs a method item from the name of the method.
  14673. </summary>
  14674. <param name="name"></param>
  14675. </member>
  14676. <member name="M:log4net.Core.MethodItem.#ctor(System.String,System.String[])">
  14677. <summary>
  14678. constructs a method item from the name of the method and its parameters.
  14679. </summary>
  14680. <param name="name"></param>
  14681. <param name="parameters"></param>
  14682. </member>
  14683. <member name="M:log4net.Core.MethodItem.#ctor(System.Reflection.MethodBase)">
  14684. <summary>
  14685. constructs a method item from a method base by determining the method name and its parameters.
  14686. </summary>
  14687. <param name="methodBase"></param>
  14688. </member>
  14689. <member name="P:log4net.Core.MethodItem.Name">
  14690. <summary>
  14691. Gets the method name of the caller making the logging
  14692. request.
  14693. </summary>
  14694. <value>
  14695. The method name of the caller making the logging
  14696. request.
  14697. </value>
  14698. <remarks>
  14699. <para>
  14700. Gets the method name of the caller making the logging
  14701. request.
  14702. </para>
  14703. </remarks>
  14704. </member>
  14705. <member name="P:log4net.Core.MethodItem.Parameters">
  14706. <summary>
  14707. Gets the method parameters of the caller making
  14708. the logging request.
  14709. </summary>
  14710. <value>
  14711. The method parameters of the caller making
  14712. the logging request
  14713. </value>
  14714. <remarks>
  14715. <para>
  14716. Gets the method parameters of the caller making
  14717. the logging request.
  14718. </para>
  14719. </remarks>
  14720. </member>
  14721. <member name="F:log4net.Core.MethodItem.declaringType">
  14722. <summary>
  14723. The fully qualified type of the StackFrameItem class.
  14724. </summary>
  14725. <remarks>
  14726. Used by the internal logger to record the Type of the
  14727. log message.
  14728. </remarks>
  14729. </member>
  14730. <member name="F:log4net.Core.MethodItem.NA">
  14731. <summary>
  14732. When location information is not available the constant
  14733. <c>NA</c> is returned. Current value of this string
  14734. constant is <b>?</b>.
  14735. </summary>
  14736. </member>
  14737. <member name="T:log4net.Core.SecurityContext">
  14738. <summary>
  14739. A SecurityContext used by log4net when interacting with protected resources
  14740. </summary>
  14741. <remarks>
  14742. <para>
  14743. A SecurityContext used by log4net when interacting with protected resources
  14744. for example with operating system services. This can be used to impersonate
  14745. a principal that has been granted privileges on the system resources.
  14746. </para>
  14747. </remarks>
  14748. <author>Nicko Cadell</author>
  14749. </member>
  14750. <member name="M:log4net.Core.SecurityContext.Impersonate(System.Object)">
  14751. <summary>
  14752. Impersonate this SecurityContext
  14753. </summary>
  14754. <param name="state">State supplied by the caller</param>
  14755. <returns>An <see cref="T:System.IDisposable"/> instance that will
  14756. revoke the impersonation of this SecurityContext, or <c>null</c></returns>
  14757. <remarks>
  14758. <para>
  14759. Impersonate this security context. Further calls on the current
  14760. thread should now be made in the security context provided
  14761. by this object. When the <see cref="T:System.IDisposable"/> result
  14762. <see cref="M:System.IDisposable.Dispose"/> method is called the security
  14763. context of the thread should be reverted to the state it was in
  14764. before <see cref="M:log4net.Core.SecurityContext.Impersonate(System.Object)"/> was called.
  14765. </para>
  14766. </remarks>
  14767. </member>
  14768. <member name="T:log4net.Core.SecurityContextProvider">
  14769. <summary>
  14770. The <see cref="T:log4net.Core.SecurityContextProvider"/> providers default <see cref="T:log4net.Core.SecurityContext"/> instances.
  14771. </summary>
  14772. <remarks>
  14773. <para>
  14774. A configured component that interacts with potentially protected system
  14775. resources uses a <see cref="T:log4net.Core.SecurityContext"/> to provide the elevated
  14776. privileges required. If the <see cref="T:log4net.Core.SecurityContext"/> object has
  14777. been not been explicitly provided to the component then the component
  14778. will request one from this <see cref="T:log4net.Core.SecurityContextProvider"/>.
  14779. </para>
  14780. <para>
  14781. By default the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is
  14782. an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> which returns only
  14783. <see cref="T:log4net.Util.NullSecurityContext"/> objects. This is a reasonable default
  14784. where the privileges required are not know by the system.
  14785. </para>
  14786. <para>
  14787. This default behavior can be overridden by subclassing the <see cref="T:log4net.Core.SecurityContextProvider"/>
  14788. and overriding the <see cref="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"/> method to return
  14789. the desired <see cref="T:log4net.Core.SecurityContext"/> objects. The default provider
  14790. can be replaced by programmatically setting the value of the
  14791. <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> property.
  14792. </para>
  14793. <para>
  14794. An alternative is to use the <c>log4net.Config.SecurityContextProviderAttribute</c>
  14795. This attribute can be applied to an assembly in the same way as the
  14796. <c>log4net.Config.XmlConfiguratorAttribute"</c>. The attribute takes
  14797. the type to use as the <see cref="T:log4net.Core.SecurityContextProvider"/> as an argument.
  14798. </para>
  14799. </remarks>
  14800. <author>Nicko Cadell</author>
  14801. </member>
  14802. <member name="F:log4net.Core.SecurityContextProvider.s_defaultProvider">
  14803. <summary>
  14804. The default provider
  14805. </summary>
  14806. </member>
  14807. <member name="P:log4net.Core.SecurityContextProvider.DefaultProvider">
  14808. <summary>
  14809. Gets or sets the default SecurityContextProvider
  14810. </summary>
  14811. <value>
  14812. The default SecurityContextProvider
  14813. </value>
  14814. <remarks>
  14815. <para>
  14816. The default provider is used by configured components that
  14817. require a <see cref="T:log4net.Core.SecurityContext"/> and have not had one
  14818. given to them.
  14819. </para>
  14820. <para>
  14821. By default this is an instance of <see cref="T:log4net.Core.SecurityContextProvider"/>
  14822. that returns <see cref="T:log4net.Util.NullSecurityContext"/> objects.
  14823. </para>
  14824. <para>
  14825. The default provider can be set programmatically by setting
  14826. the value of this property to a sub class of <see cref="T:log4net.Core.SecurityContextProvider"/>
  14827. that has the desired behavior.
  14828. </para>
  14829. </remarks>
  14830. </member>
  14831. <member name="M:log4net.Core.SecurityContextProvider.#ctor">
  14832. <summary>
  14833. Protected default constructor to allow subclassing
  14834. </summary>
  14835. <remarks>
  14836. <para>
  14837. Protected default constructor to allow subclassing
  14838. </para>
  14839. </remarks>
  14840. </member>
  14841. <member name="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)">
  14842. <summary>
  14843. Create a SecurityContext for a consumer
  14844. </summary>
  14845. <param name="consumer">The consumer requesting the SecurityContext</param>
  14846. <returns>An impersonation context</returns>
  14847. <remarks>
  14848. <para>
  14849. The default implementation is to return a <see cref="T:log4net.Util.NullSecurityContext"/>.
  14850. </para>
  14851. <para>
  14852. Subclasses should override this method to provide their own
  14853. behavior.
  14854. </para>
  14855. </remarks>
  14856. </member>
  14857. <member name="T:log4net.Core.StackFrameItem">
  14858. <summary>
  14859. provides stack frame information without actually referencing a System.Diagnostics.StackFrame
  14860. as that would require that the containing assembly is loaded.
  14861. </summary>
  14862. </member>
  14863. <member name="M:log4net.Core.StackFrameItem.#ctor(System.Diagnostics.StackFrame)">
  14864. <summary>
  14865. returns a stack frame item from a stack frame. This
  14866. </summary>
  14867. <param name="frame"></param>
  14868. <returns></returns>
  14869. </member>
  14870. <member name="P:log4net.Core.StackFrameItem.ClassName">
  14871. <summary>
  14872. Gets the fully qualified class name of the caller making the logging
  14873. request.
  14874. </summary>
  14875. <value>
  14876. The fully qualified class name of the caller making the logging
  14877. request.
  14878. </value>
  14879. <remarks>
  14880. <para>
  14881. Gets the fully qualified class name of the caller making the logging
  14882. request.
  14883. </para>
  14884. </remarks>
  14885. </member>
  14886. <member name="P:log4net.Core.StackFrameItem.FileName">
  14887. <summary>
  14888. Gets the file name of the caller.
  14889. </summary>
  14890. <value>
  14891. The file name of the caller.
  14892. </value>
  14893. <remarks>
  14894. <para>
  14895. Gets the file name of the caller.
  14896. </para>
  14897. </remarks>
  14898. </member>
  14899. <member name="P:log4net.Core.StackFrameItem.LineNumber">
  14900. <summary>
  14901. Gets the line number of the caller.
  14902. </summary>
  14903. <value>
  14904. The line number of the caller.
  14905. </value>
  14906. <remarks>
  14907. <para>
  14908. Gets the line number of the caller.
  14909. </para>
  14910. </remarks>
  14911. </member>
  14912. <member name="P:log4net.Core.StackFrameItem.Method">
  14913. <summary>
  14914. Gets the method name of the caller.
  14915. </summary>
  14916. <value>
  14917. The method name of the caller.
  14918. </value>
  14919. <remarks>
  14920. <para>
  14921. Gets the method name of the caller.
  14922. </para>
  14923. </remarks>
  14924. </member>
  14925. <member name="P:log4net.Core.StackFrameItem.FullInfo">
  14926. <summary>
  14927. Gets all available caller information
  14928. </summary>
  14929. <value>
  14930. All available caller information, in the format
  14931. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  14932. </value>
  14933. <remarks>
  14934. <para>
  14935. Gets all available caller information, in the format
  14936. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  14937. </para>
  14938. </remarks>
  14939. </member>
  14940. <member name="F:log4net.Core.StackFrameItem.declaringType">
  14941. <summary>
  14942. The fully qualified type of the StackFrameItem class.
  14943. </summary>
  14944. <remarks>
  14945. Used by the internal logger to record the Type of the
  14946. log message.
  14947. </remarks>
  14948. </member>
  14949. <member name="F:log4net.Core.StackFrameItem.NA">
  14950. <summary>
  14951. When location information is not available the constant
  14952. <c>NA</c> is returned. Current value of this string
  14953. constant is <b>?</b>.
  14954. </summary>
  14955. </member>
  14956. <member name="T:log4net.Core.TimeEvaluator">
  14957. <summary>
  14958. An evaluator that triggers after specified number of seconds.
  14959. </summary>
  14960. <remarks>
  14961. <para>
  14962. This evaluator will trigger if the specified time period
  14963. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  14964. </para>
  14965. </remarks>
  14966. <author>Robert Sevcik</author>
  14967. </member>
  14968. <member name="F:log4net.Core.TimeEvaluator.m_interval">
  14969. <summary>
  14970. The time threshold for triggering in seconds. Zero means it won't trigger at all.
  14971. </summary>
  14972. </member>
  14973. <member name="F:log4net.Core.TimeEvaluator.m_lastTimeUtc">
  14974. <summary>
  14975. The UTC time of last check. This gets updated when the object is created and when the evaluator triggers.
  14976. </summary>
  14977. </member>
  14978. <member name="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL">
  14979. <summary>
  14980. The default time threshold for triggering in seconds. Zero means it won't trigger at all.
  14981. </summary>
  14982. </member>
  14983. <member name="M:log4net.Core.TimeEvaluator.#ctor">
  14984. <summary>
  14985. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  14986. </summary>
  14987. <remarks>
  14988. <para>
  14989. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  14990. </para>
  14991. <para>
  14992. This evaluator will trigger if the specified time period
  14993. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  14994. </para>
  14995. </remarks>
  14996. </member>
  14997. <member name="M:log4net.Core.TimeEvaluator.#ctor(System.Int32)">
  14998. <summary>
  14999. Create a new evaluator using the specified time threshold in seconds.
  15000. </summary>
  15001. <param name="interval">
  15002. The time threshold in seconds to trigger after.
  15003. Zero means it won't trigger at all.
  15004. </param>
  15005. <remarks>
  15006. <para>
  15007. Create a new evaluator using the specified time threshold in seconds.
  15008. </para>
  15009. <para>
  15010. This evaluator will trigger if the specified time period
  15011. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15012. </para>
  15013. </remarks>
  15014. </member>
  15015. <member name="P:log4net.Core.TimeEvaluator.Interval">
  15016. <summary>
  15017. The time threshold in seconds to trigger after
  15018. </summary>
  15019. <value>
  15020. The time threshold in seconds to trigger after.
  15021. Zero means it won't trigger at all.
  15022. </value>
  15023. <remarks>
  15024. <para>
  15025. This evaluator will trigger if the specified time period
  15026. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15027. </para>
  15028. </remarks>
  15029. </member>
  15030. <member name="M:log4net.Core.TimeEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  15031. <summary>
  15032. Is this <paramref name="loggingEvent"/> the triggering event?
  15033. </summary>
  15034. <param name="loggingEvent">The event to check</param>
  15035. <returns>This method returns <c>true</c>, if the specified time period
  15036. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check..
  15037. Otherwise it returns <c>false</c></returns>
  15038. <remarks>
  15039. <para>
  15040. This evaluator will trigger if the specified time period
  15041. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15042. </para>
  15043. </remarks>
  15044. </member>
  15045. <member name="T:log4net.Core.WrapperCreationHandler">
  15046. <summary>
  15047. Delegate used to handle creation of new wrappers.
  15048. </summary>
  15049. <param name="logger">The logger to wrap in a wrapper.</param>
  15050. <remarks>
  15051. <para>
  15052. Delegate used to handle creation of new wrappers. This delegate
  15053. is called from the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  15054. method to construct the wrapper for the specified logger.
  15055. </para>
  15056. <para>
  15057. The delegate to use is supplied to the <see cref="T:log4net.Core.WrapperMap"/>
  15058. constructor.
  15059. </para>
  15060. </remarks>
  15061. </member>
  15062. <member name="T:log4net.Core.WrapperMap">
  15063. <summary>
  15064. Maps between logger objects and wrapper objects.
  15065. </summary>
  15066. <remarks>
  15067. <para>
  15068. This class maintains a mapping between <see cref="T:log4net.Core.ILogger"/> objects and
  15069. <see cref="T:log4net.Core.ILoggerWrapper"/> objects. Use the <see cref="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"/> method to
  15070. lookup the <see cref="T:log4net.Core.ILoggerWrapper"/> for the specified <see cref="T:log4net.Core.ILogger"/>.
  15071. </para>
  15072. <para>
  15073. New wrapper instances are created by the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  15074. method. The default behavior is for this method to delegate construction
  15075. of the wrapper to the <see cref="T:log4net.Core.WrapperCreationHandler"/> delegate supplied
  15076. to the constructor. This allows specialization of the behavior without
  15077. requiring subclassing of this type.
  15078. </para>
  15079. </remarks>
  15080. <author>Nicko Cadell</author>
  15081. <author>Gert Driesen</author>
  15082. </member>
  15083. <member name="M:log4net.Core.WrapperMap.#ctor(log4net.Core.WrapperCreationHandler)">
  15084. <summary>
  15085. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap" />
  15086. </summary>
  15087. <param name="createWrapperHandler">The handler to use to create the wrapper objects.</param>
  15088. <remarks>
  15089. <para>
  15090. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap" /> class with
  15091. the specified handler to create the wrapper objects.
  15092. </para>
  15093. </remarks>
  15094. </member>
  15095. <member name="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)">
  15096. <summary>
  15097. Gets the wrapper object for the specified logger.
  15098. </summary>
  15099. <returns>The wrapper object for the specified logger</returns>
  15100. <remarks>
  15101. <para>
  15102. If the logger is null then the corresponding wrapper is null.
  15103. </para>
  15104. <para>
  15105. Looks up the wrapper it it has previously been requested and
  15106. returns it. If the wrapper has never been requested before then
  15107. the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> virtual method is
  15108. called.
  15109. </para>
  15110. </remarks>
  15111. </member>
  15112. <member name="P:log4net.Core.WrapperMap.Repositories">
  15113. <summary>
  15114. Gets the map of logger repositories.
  15115. </summary>
  15116. <value>
  15117. Map of logger repositories.
  15118. </value>
  15119. <remarks>
  15120. <para>
  15121. Gets the hashtable that is keyed on <see cref="T:log4net.Repository.ILoggerRepository"/>. The
  15122. values are hashtables keyed on <see cref="T:log4net.Core.ILogger"/> with the
  15123. value being the corresponding <see cref="T:log4net.Core.ILoggerWrapper"/>.
  15124. </para>
  15125. </remarks>
  15126. </member>
  15127. <member name="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)">
  15128. <summary>
  15129. Creates the wrapper object for the specified logger.
  15130. </summary>
  15131. <param name="logger">The logger to wrap in a wrapper.</param>
  15132. <returns>The wrapper object for the logger.</returns>
  15133. <remarks>
  15134. <para>
  15135. This implementation uses the <see cref="T:log4net.Core.WrapperCreationHandler"/>
  15136. passed to the constructor to create the wrapper. This method
  15137. can be overridden in a subclass.
  15138. </para>
  15139. </remarks>
  15140. </member>
  15141. <member name="M:log4net.Core.WrapperMap.RepositoryShutdown(log4net.Repository.ILoggerRepository)">
  15142. <summary>
  15143. Called when a monitored repository shutdown event is received.
  15144. </summary>
  15145. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down</param>
  15146. <remarks>
  15147. <para>
  15148. This method is called when a <see cref="T:log4net.Repository.ILoggerRepository"/> that this
  15149. <see cref="T:log4net.Core.WrapperMap"/> is holding loggers for has signaled its shutdown
  15150. event <see cref="E:log4net.Repository.ILoggerRepository.ShutdownEvent"/>. The default
  15151. behavior of this method is to release the references to the loggers
  15152. and their wrappers generated for this repository.
  15153. </para>
  15154. </remarks>
  15155. </member>
  15156. <member name="M:log4net.Core.WrapperMap.ILoggerRepository_Shutdown(System.Object,System.EventArgs)">
  15157. <summary>
  15158. Event handler for repository shutdown event.
  15159. </summary>
  15160. <param name="sender">The sender of the event.</param>
  15161. <param name="e">The event args.</param>
  15162. </member>
  15163. <member name="F:log4net.Core.WrapperMap.m_repositories">
  15164. <summary>
  15165. Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings
  15166. </summary>
  15167. </member>
  15168. <member name="F:log4net.Core.WrapperMap.m_createWrapperHandler">
  15169. <summary>
  15170. The handler to use to create the extension wrapper objects.
  15171. </summary>
  15172. </member>
  15173. <member name="F:log4net.Core.WrapperMap.m_shutdownHandler">
  15174. <summary>
  15175. Internal reference to the delegate used to register for repository shutdown events.
  15176. </summary>
  15177. </member>
  15178. <member name="T:log4net.DateFormatter.AbsoluteTimeDateFormatter">
  15179. <summary>
  15180. Formats a <see cref="T:System.DateTime"/> as <c>"HH:mm:ss,fff"</c>.
  15181. </summary>
  15182. <remarks>
  15183. <para>
  15184. Formats a <see cref="T:System.DateTime"/> in the format <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  15185. </para>
  15186. </remarks>
  15187. <author>Nicko Cadell</author>
  15188. <author>Gert Driesen</author>
  15189. </member>
  15190. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  15191. <summary>
  15192. Renders the date into a string. Format is <c>"HH:mm:ss"</c>.
  15193. </summary>
  15194. <param name="dateToFormat">The date to render into a string.</param>
  15195. <param name="buffer">The string builder to write to.</param>
  15196. <remarks>
  15197. <para>
  15198. Subclasses should override this method to render the date
  15199. into a string using a precision up to the second. This method
  15200. will be called at most once per second and the result will be
  15201. reused if it is needed again during the same second.
  15202. </para>
  15203. </remarks>
  15204. </member>
  15205. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  15206. <summary>
  15207. Renders the date into a string. Format is "HH:mm:ss,fff".
  15208. </summary>
  15209. <param name="dateToFormat">The date to render into a string.</param>
  15210. <param name="writer">The writer to write to.</param>
  15211. <remarks>
  15212. <para>
  15213. Uses the <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> method to generate the
  15214. time string up to the seconds and then appends the current
  15215. milliseconds. The results from <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> are
  15216. cached and <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> is called at most once
  15217. per second.
  15218. </para>
  15219. <para>
  15220. Sub classes should override <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/>
  15221. rather than <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/>.
  15222. </para>
  15223. </remarks>
  15224. </member>
  15225. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.AbsoluteTimeDateFormat">
  15226. <summary>
  15227. String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is <b>ABSOLUTE</b>.
  15228. </summary>
  15229. </member>
  15230. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.DateAndTimeDateFormat">
  15231. <summary>
  15232. String constant used to specify DateTimeDateFormat in layouts. Current value is <b>DATE</b>.
  15233. </summary>
  15234. </member>
  15235. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.Iso8601TimeDateFormat">
  15236. <summary>
  15237. String constant used to specify ISO8601DateFormat in layouts. Current value is <b>ISO8601</b>.
  15238. </summary>
  15239. </member>
  15240. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeToTheSecond">
  15241. <summary>
  15242. Last stored time with precision up to the second.
  15243. </summary>
  15244. </member>
  15245. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeBuf">
  15246. <summary>
  15247. Last stored time with precision up to the second, formatted
  15248. as a string.
  15249. </summary>
  15250. </member>
  15251. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeStrings">
  15252. <summary>
  15253. Last stored time with precision up to the second, formatted
  15254. as a string.
  15255. </summary>
  15256. </member>
  15257. <member name="T:log4net.DateFormatter.DateTimeDateFormatter">
  15258. <summary>
  15259. Formats a <see cref="T:System.DateTime"/> as <c>"dd MMM yyyy HH:mm:ss,fff"</c>
  15260. </summary>
  15261. <remarks>
  15262. <para>
  15263. Formats a <see cref="T:System.DateTime"/> in the format
  15264. <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example,
  15265. <c>"06 Nov 1994 15:49:37,459"</c>.
  15266. </para>
  15267. </remarks>
  15268. <author>Nicko Cadell</author>
  15269. <author>Gert Driesen</author>
  15270. <author>Angelika Schnagl</author>
  15271. </member>
  15272. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.#ctor">
  15273. <summary>
  15274. Default constructor.
  15275. </summary>
  15276. <remarks>
  15277. <para>
  15278. Initializes a new instance of the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter" /> class.
  15279. </para>
  15280. </remarks>
  15281. </member>
  15282. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  15283. <summary>
  15284. Formats the date without the milliseconds part
  15285. </summary>
  15286. <param name="dateToFormat">The date to format.</param>
  15287. <param name="buffer">The string builder to write to.</param>
  15288. <remarks>
  15289. <para>
  15290. Formats a DateTime in the format <c>"dd MMM yyyy HH:mm:ss"</c>
  15291. for example, <c>"06 Nov 1994 15:49:37"</c>.
  15292. </para>
  15293. <para>
  15294. The base class will append the <c>",fff"</c> milliseconds section.
  15295. This method will only be called at most once per second.
  15296. </para>
  15297. </remarks>
  15298. </member>
  15299. <member name="F:log4net.DateFormatter.DateTimeDateFormatter.m_dateTimeFormatInfo">
  15300. <summary>
  15301. The format info for the invariant culture.
  15302. </summary>
  15303. </member>
  15304. <member name="T:log4net.DateFormatter.IDateFormatter">
  15305. <summary>
  15306. Render a <see cref="T:System.DateTime"/> as a string.
  15307. </summary>
  15308. <remarks>
  15309. <para>
  15310. Interface to abstract the rendering of a <see cref="T:System.DateTime"/>
  15311. instance into a string.
  15312. </para>
  15313. <para>
  15314. The <see cref="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/> method is used to render the
  15315. date to a text writer.
  15316. </para>
  15317. </remarks>
  15318. <author>Nicko Cadell</author>
  15319. <author>Gert Driesen</author>
  15320. </member>
  15321. <member name="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  15322. <summary>
  15323. Formats the specified date as a string.
  15324. </summary>
  15325. <param name="dateToFormat">The date to format.</param>
  15326. <param name="writer">The writer to write to.</param>
  15327. <remarks>
  15328. <para>
  15329. Format the <see cref="T:System.DateTime"/> as a string and write it
  15330. to the <see cref="T:System.IO.TextWriter"/> provided.
  15331. </para>
  15332. </remarks>
  15333. </member>
  15334. <member name="T:log4net.DateFormatter.Iso8601DateFormatter">
  15335. <summary>
  15336. Formats the <see cref="T:System.DateTime"/> as <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  15337. </summary>
  15338. <remarks>
  15339. <para>
  15340. Formats the <see cref="T:System.DateTime"/> specified as a string: <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  15341. </para>
  15342. </remarks>
  15343. <author>Nicko Cadell</author>
  15344. <author>Gert Driesen</author>
  15345. </member>
  15346. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.#ctor">
  15347. <summary>
  15348. Default constructor
  15349. </summary>
  15350. <remarks>
  15351. <para>
  15352. Initializes a new instance of the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter" /> class.
  15353. </para>
  15354. </remarks>
  15355. </member>
  15356. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  15357. <summary>
  15358. Formats the date without the milliseconds part
  15359. </summary>
  15360. <param name="dateToFormat">The date to format.</param>
  15361. <param name="buffer">The string builder to write to.</param>
  15362. <remarks>
  15363. <para>
  15364. Formats the date specified as a string: <c>"yyyy-MM-dd HH:mm:ss"</c>.
  15365. </para>
  15366. <para>
  15367. The base class will append the <c>",fff"</c> milliseconds section.
  15368. This method will only be called at most once per second.
  15369. </para>
  15370. </remarks>
  15371. </member>
  15372. <member name="T:log4net.DateFormatter.SimpleDateFormatter">
  15373. <summary>
  15374. Formats the <see cref="T:System.DateTime"/> using the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  15375. </summary>
  15376. <remarks>
  15377. <para>
  15378. Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  15379. </para>
  15380. </remarks>
  15381. <author>Nicko Cadell</author>
  15382. <author>Gert Driesen</author>
  15383. </member>
  15384. <member name="M:log4net.DateFormatter.SimpleDateFormatter.#ctor(System.String)">
  15385. <summary>
  15386. Constructor
  15387. </summary>
  15388. <param name="format">The format string.</param>
  15389. <remarks>
  15390. <para>
  15391. Initializes a new instance of the <see cref="T:log4net.DateFormatter.SimpleDateFormatter" /> class
  15392. with the specified format string.
  15393. </para>
  15394. <para>
  15395. The format string must be compatible with the options
  15396. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  15397. </para>
  15398. </remarks>
  15399. </member>
  15400. <member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  15401. <summary>
  15402. Formats the date using <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  15403. </summary>
  15404. <param name="dateToFormat">The date to convert to a string.</param>
  15405. <param name="writer">The writer to write to.</param>
  15406. <remarks>
  15407. <para>
  15408. Uses the date format string supplied to the constructor to call
  15409. the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method to format the date.
  15410. </para>
  15411. </remarks>
  15412. </member>
  15413. <member name="F:log4net.DateFormatter.SimpleDateFormatter.m_formatString">
  15414. <summary>
  15415. The format string used to format the <see cref="T:System.DateTime" />.
  15416. </summary>
  15417. <remarks>
  15418. <para>
  15419. The format string must be compatible with the options
  15420. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  15421. </para>
  15422. </remarks>
  15423. </member>
  15424. <member name="T:log4net.Filter.DenyAllFilter">
  15425. <summary>
  15426. This filter drops all <see cref="T:log4net.Core.LoggingEvent"/>.
  15427. </summary>
  15428. <remarks>
  15429. <para>
  15430. You can add this filter to the end of a filter chain to
  15431. switch from the default "accept all unless instructed otherwise"
  15432. filtering behavior to a "deny all unless instructed otherwise"
  15433. behavior.
  15434. </para>
  15435. </remarks>
  15436. <author>Nicko Cadell</author>
  15437. <author>Gert Driesen</author>
  15438. </member>
  15439. <member name="M:log4net.Filter.DenyAllFilter.#ctor">
  15440. <summary>
  15441. Default constructor
  15442. </summary>
  15443. </member>
  15444. <member name="M:log4net.Filter.DenyAllFilter.Decide(log4net.Core.LoggingEvent)">
  15445. <summary>
  15446. Always returns the integer constant <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  15447. </summary>
  15448. <param name="loggingEvent">the LoggingEvent to filter</param>
  15449. <returns>Always returns <see cref="F:log4net.Filter.FilterDecision.Deny"/></returns>
  15450. <remarks>
  15451. <para>
  15452. Ignores the event being logged and just returns
  15453. <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This can be used to change the default filter
  15454. chain behavior from <see cref="F:log4net.Filter.FilterDecision.Accept"/> to <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This filter
  15455. should only be used as the last filter in the chain
  15456. as any further filters will be ignored!
  15457. </para>
  15458. </remarks>
  15459. </member>
  15460. <member name="T:log4net.Filter.FilterDecision">
  15461. <summary>
  15462. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  15463. </summary>
  15464. <remarks>
  15465. <para>
  15466. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  15467. </para>
  15468. </remarks>
  15469. </member>
  15470. <member name="F:log4net.Filter.FilterDecision.Deny">
  15471. <summary>
  15472. The log event must be dropped immediately without
  15473. consulting with the remaining filters, if any, in the chain.
  15474. </summary>
  15475. </member>
  15476. <member name="F:log4net.Filter.FilterDecision.Neutral">
  15477. <summary>
  15478. This filter is neutral with respect to the log event.
  15479. The remaining filters, if any, should be consulted for a final decision.
  15480. </summary>
  15481. </member>
  15482. <member name="F:log4net.Filter.FilterDecision.Accept">
  15483. <summary>
  15484. The log event must be logged immediately without
  15485. consulting with the remaining filters, if any, in the chain.
  15486. </summary>
  15487. </member>
  15488. <member name="T:log4net.Filter.FilterSkeleton">
  15489. <summary>
  15490. Subclass this type to implement customized logging event filtering
  15491. </summary>
  15492. <remarks>
  15493. <para>
  15494. Users should extend this class to implement customized logging
  15495. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  15496. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  15497. appenders, have built-in filtering rules. It is suggested that you
  15498. first use and understand the built-in rules before rushing to write
  15499. your own custom filters.
  15500. </para>
  15501. <para>
  15502. This abstract class assumes and also imposes that filters be
  15503. organized in a linear chain. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/>
  15504. method of each filter is called sequentially, in the order of their
  15505. addition to the chain.
  15506. </para>
  15507. <para>
  15508. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> method must return one
  15509. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  15510. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  15511. </para>
  15512. <para>
  15513. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  15514. immediately without consulting with the remaining filters.
  15515. </para>
  15516. <para>
  15517. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  15518. in the chain is consulted. If there are no more filters in the
  15519. chain, then the log event is logged. Thus, in the presence of no
  15520. filters, the default behavior is to log all logging events.
  15521. </para>
  15522. <para>
  15523. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  15524. event is logged without consulting the remaining filters.
  15525. </para>
  15526. <para>
  15527. The philosophy of log4net filters is largely inspired from the
  15528. Linux ipchains.
  15529. </para>
  15530. </remarks>
  15531. <author>Nicko Cadell</author>
  15532. <author>Gert Driesen</author>
  15533. </member>
  15534. <member name="F:log4net.Filter.FilterSkeleton.m_next">
  15535. <summary>
  15536. Points to the next filter in the filter chain.
  15537. </summary>
  15538. <remarks>
  15539. <para>
  15540. See <see cref="P:log4net.Filter.FilterSkeleton.Next"/> for more information.
  15541. </para>
  15542. </remarks>
  15543. </member>
  15544. <member name="M:log4net.Filter.FilterSkeleton.ActivateOptions">
  15545. <summary>
  15546. Initialize the filter with the options set
  15547. </summary>
  15548. <remarks>
  15549. <para>
  15550. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  15551. activation scheme. The <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> method must
  15552. be called on this object after the configuration properties have
  15553. been set. Until <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> is called this
  15554. object is in an undefined state and must not be used.
  15555. </para>
  15556. <para>
  15557. If any of the configuration properties are modified then
  15558. <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> must be called again.
  15559. </para>
  15560. <para>
  15561. Typically filter's options become active immediately on set,
  15562. however this method must still be called.
  15563. </para>
  15564. </remarks>
  15565. </member>
  15566. <member name="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)">
  15567. <summary>
  15568. Decide if the <see cref="T:log4net.Core.LoggingEvent"/> should be logged through an appender.
  15569. </summary>
  15570. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> to decide upon</param>
  15571. <returns>The decision of the filter</returns>
  15572. <remarks>
  15573. <para>
  15574. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  15575. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  15576. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  15577. the event will be logged without consulting with other filters in
  15578. the chain.
  15579. </para>
  15580. <para>
  15581. This method is marked <c>abstract</c> and must be implemented
  15582. in a subclass.
  15583. </para>
  15584. </remarks>
  15585. </member>
  15586. <member name="P:log4net.Filter.FilterSkeleton.Next">
  15587. <summary>
  15588. Property to get and set the next filter
  15589. </summary>
  15590. <value>
  15591. The next filter in the chain
  15592. </value>
  15593. <remarks>
  15594. <para>
  15595. Filters are typically composed into chains. This property allows the next filter in
  15596. the chain to be accessed.
  15597. </para>
  15598. </remarks>
  15599. </member>
  15600. <member name="T:log4net.Filter.IFilter">
  15601. <summary>
  15602. Implement this interface to provide customized logging event filtering
  15603. </summary>
  15604. <remarks>
  15605. <para>
  15606. Users should implement this interface to implement customized logging
  15607. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  15608. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  15609. appenders, have built-in filtering rules. It is suggested that you
  15610. first use and understand the built-in rules before rushing to write
  15611. your own custom filters.
  15612. </para>
  15613. <para>
  15614. This abstract class assumes and also imposes that filters be
  15615. organized in a linear chain. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  15616. method of each filter is called sequentially, in the order of their
  15617. addition to the chain.
  15618. </para>
  15619. <para>
  15620. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> method must return one
  15621. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  15622. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  15623. </para>
  15624. <para>
  15625. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  15626. immediately without consulting with the remaining filters.
  15627. </para>
  15628. <para>
  15629. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  15630. in the chain is consulted. If there are no more filters in the
  15631. chain, then the log event is logged. Thus, in the presence of no
  15632. filters, the default behavior is to log all logging events.
  15633. </para>
  15634. <para>
  15635. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  15636. event is logged without consulting the remaining filters.
  15637. </para>
  15638. <para>
  15639. The philosophy of log4net filters is largely inspired from the
  15640. Linux ipchains.
  15641. </para>
  15642. </remarks>
  15643. <author>Nicko Cadell</author>
  15644. <author>Gert Driesen</author>
  15645. </member>
  15646. <member name="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)">
  15647. <summary>
  15648. Decide if the logging event should be logged through an appender.
  15649. </summary>
  15650. <param name="loggingEvent">The LoggingEvent to decide upon</param>
  15651. <returns>The decision of the filter</returns>
  15652. <remarks>
  15653. <para>
  15654. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  15655. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  15656. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  15657. the event will be logged without consulting with other filters in
  15658. the chain.
  15659. </para>
  15660. </remarks>
  15661. </member>
  15662. <member name="P:log4net.Filter.IFilter.Next">
  15663. <summary>
  15664. Property to get and set the next filter
  15665. </summary>
  15666. <value>
  15667. The next filter in the chain
  15668. </value>
  15669. <remarks>
  15670. <para>
  15671. Filters are typically composed into chains. This property allows the next filter in
  15672. the chain to be accessed.
  15673. </para>
  15674. </remarks>
  15675. </member>
  15676. <member name="T:log4net.Filter.LevelMatchFilter">
  15677. <summary>
  15678. This is a very simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  15679. </summary>
  15680. <remarks>
  15681. <para>
  15682. The filter admits two options <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> and
  15683. <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If there is an exact match between the value
  15684. of the <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> option and the <see cref="T:log4net.Core.Level"/> of the
  15685. <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
  15686. case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set
  15687. to <c>true</c>, if it is <c>false</c> then
  15688. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then
  15689. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  15690. </para>
  15691. </remarks>
  15692. <author>Nicko Cadell</author>
  15693. <author>Gert Driesen</author>
  15694. </member>
  15695. <member name="F:log4net.Filter.LevelMatchFilter.m_acceptOnMatch">
  15696. <summary>
  15697. flag to indicate if the filter should <see cref="F:log4net.Filter.FilterDecision.Accept"/> on a match
  15698. </summary>
  15699. </member>
  15700. <member name="F:log4net.Filter.LevelMatchFilter.m_levelToMatch">
  15701. <summary>
  15702. the <see cref="T:log4net.Core.Level"/> to match against
  15703. </summary>
  15704. </member>
  15705. <member name="M:log4net.Filter.LevelMatchFilter.#ctor">
  15706. <summary>
  15707. Default constructor
  15708. </summary>
  15709. </member>
  15710. <member name="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch">
  15711. <summary>
  15712. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/>
  15713. </summary>
  15714. <remarks>
  15715. <para>
  15716. The <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> property is a flag that determines
  15717. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  15718. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  15719. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  15720. </para>
  15721. <para>
  15722. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  15723. </para>
  15724. </remarks>
  15725. </member>
  15726. <member name="P:log4net.Filter.LevelMatchFilter.LevelToMatch">
  15727. <summary>
  15728. The <see cref="T:log4net.Core.Level"/> that the filter will match
  15729. </summary>
  15730. <remarks>
  15731. <para>
  15732. The level that this filter will attempt to match against the
  15733. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  15734. the result depends on the value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>.
  15735. </para>
  15736. </remarks>
  15737. </member>
  15738. <member name="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)">
  15739. <summary>
  15740. Tests if the <see cref="T:log4net.Core.Level"/> of the logging event matches that of the filter
  15741. </summary>
  15742. <param name="loggingEvent">the event to filter</param>
  15743. <returns>see remarks</returns>
  15744. <remarks>
  15745. <para>
  15746. If the <see cref="T:log4net.Core.Level"/> of the event matches the level of the
  15747. filter then the result of the function depends on the
  15748. value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then
  15749. the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it
  15750. will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then
  15751. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  15752. </para>
  15753. </remarks>
  15754. </member>
  15755. <member name="T:log4net.Filter.LevelRangeFilter">
  15756. <summary>
  15757. This is a simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  15758. </summary>
  15759. <remarks>
  15760. <para>
  15761. The filter admits three options <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  15762. that determine the range of priorities that are matched, and
  15763. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. If there is a match between the range
  15764. of priorities and the <see cref="T:log4net.Core.Level"/> of the <see cref="T:log4net.Core.LoggingEvent"/>, then the
  15765. <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"/>
  15766. option value is set to <c>true</c>, if it is <c>false</c>
  15767. then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If there is no match, <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  15768. </para>
  15769. </remarks>
  15770. <author>Nicko Cadell</author>
  15771. <author>Gert Driesen</author>
  15772. </member>
  15773. <member name="F:log4net.Filter.LevelRangeFilter.m_acceptOnMatch">
  15774. <summary>
  15775. Flag to indicate the behavior when matching a <see cref="T:log4net.Core.Level"/>
  15776. </summary>
  15777. </member>
  15778. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMin">
  15779. <summary>
  15780. the minimum <see cref="T:log4net.Core.Level"/> value to match
  15781. </summary>
  15782. </member>
  15783. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMax">
  15784. <summary>
  15785. the maximum <see cref="T:log4net.Core.Level"/> value to match
  15786. </summary>
  15787. </member>
  15788. <member name="M:log4net.Filter.LevelRangeFilter.#ctor">
  15789. <summary>
  15790. Default constructor
  15791. </summary>
  15792. </member>
  15793. <member name="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch">
  15794. <summary>
  15795. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  15796. </summary>
  15797. <remarks>
  15798. <para>
  15799. The <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> property is a flag that determines
  15800. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  15801. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  15802. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  15803. </para>
  15804. <para>
  15805. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  15806. </para>
  15807. </remarks>
  15808. </member>
  15809. <member name="P:log4net.Filter.LevelRangeFilter.LevelMin">
  15810. <summary>
  15811. Set the minimum matched <see cref="T:log4net.Core.Level"/>
  15812. </summary>
  15813. <remarks>
  15814. <para>
  15815. The minimum level that this filter will attempt to match against the
  15816. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  15817. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  15818. </para>
  15819. </remarks>
  15820. </member>
  15821. <member name="P:log4net.Filter.LevelRangeFilter.LevelMax">
  15822. <summary>
  15823. Sets the maximum matched <see cref="T:log4net.Core.Level"/>
  15824. </summary>
  15825. <remarks>
  15826. <para>
  15827. The maximum level that this filter will attempt to match against the
  15828. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  15829. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  15830. </para>
  15831. </remarks>
  15832. </member>
  15833. <member name="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)">
  15834. <summary>
  15835. Check if the event should be logged.
  15836. </summary>
  15837. <param name="loggingEvent">the logging event to check</param>
  15838. <returns>see remarks</returns>
  15839. <remarks>
  15840. <para>
  15841. If the <see cref="T:log4net.Core.Level"/> of the logging event is outside the range
  15842. matched by this filter then <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  15843. is returned. If the <see cref="T:log4net.Core.Level"/> is matched then the value of
  15844. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> is checked. If it is true then
  15845. <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, otherwise
  15846. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned.
  15847. </para>
  15848. </remarks>
  15849. </member>
  15850. <member name="T:log4net.Filter.LoggerMatchFilter">
  15851. <summary>
  15852. Simple filter to match a string in the event's logger name.
  15853. </summary>
  15854. <remarks>
  15855. <para>
  15856. The works very similar to the <see cref="T:log4net.Filter.LevelMatchFilter"/>. It admits two
  15857. options <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> and <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. If the
  15858. <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <see cref="T:log4net.Core.LoggingEvent"/> starts
  15859. with the value of the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> option, then the
  15860. <see cref="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
  15861. case the <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> option value is set to <c>true</c>,
  15862. if it is <c>false</c> then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  15863. </para>
  15864. </remarks>
  15865. <author>Daniel Cazzulino</author>
  15866. </member>
  15867. <member name="F:log4net.Filter.LoggerMatchFilter.m_acceptOnMatch">
  15868. <summary>
  15869. Flag to indicate the behavior when we have a match
  15870. </summary>
  15871. </member>
  15872. <member name="F:log4net.Filter.LoggerMatchFilter.m_loggerToMatch">
  15873. <summary>
  15874. The logger name string to substring match against the event
  15875. </summary>
  15876. </member>
  15877. <member name="M:log4net.Filter.LoggerMatchFilter.#ctor">
  15878. <summary>
  15879. Default constructor
  15880. </summary>
  15881. </member>
  15882. <member name="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch">
  15883. <summary>
  15884. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>
  15885. </summary>
  15886. <remarks>
  15887. <para>
  15888. The <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> property is a flag that determines
  15889. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  15890. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  15891. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  15892. </para>
  15893. <para>
  15894. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  15895. </para>
  15896. </remarks>
  15897. </member>
  15898. <member name="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch">
  15899. <summary>
  15900. The <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> that the filter will match
  15901. </summary>
  15902. <remarks>
  15903. <para>
  15904. This filter will attempt to match this value against logger name in
  15905. the following way. The match will be done against the beginning of the
  15906. logger name (using <see cref="M:String.StartsWith(string)"/>). The match is
  15907. case sensitive. If a match is found then
  15908. the result depends on the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>.
  15909. </para>
  15910. </remarks>
  15911. </member>
  15912. <member name="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)">
  15913. <summary>
  15914. Check if this filter should allow the event to be logged
  15915. </summary>
  15916. <param name="loggingEvent">the event being logged</param>
  15917. <returns>see remarks</returns>
  15918. <remarks>
  15919. <para>
  15920. The rendered message is matched against the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>.
  15921. If the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> equals the beginning of
  15922. the incoming <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> (<see cref="M:String.StartsWith(string)"/>)
  15923. then a match will have occurred. If no match occurs
  15924. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  15925. allowing other filters to check the event. If a match occurs then
  15926. the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> is checked. If it is
  15927. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  15928. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  15929. </para>
  15930. </remarks>
  15931. </member>
  15932. <member name="T:log4net.Filter.MdcFilter">
  15933. <summary>
  15934. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  15935. </summary>
  15936. <remarks>
  15937. <para>
  15938. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  15939. </para>
  15940. <para>
  15941. As the MDC has been replaced with layered properties the
  15942. <see cref="T:log4net.Filter.PropertyFilter"/> should be used instead.
  15943. </para>
  15944. </remarks>
  15945. <author>Nicko Cadell</author>
  15946. <author>Gert Driesen</author>
  15947. </member>
  15948. <member name="T:log4net.Filter.NdcFilter">
  15949. <summary>
  15950. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  15951. </summary>
  15952. <remarks>
  15953. <para>
  15954. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  15955. </para>
  15956. <para>
  15957. As the MDC has been replaced with named stacks stored in the
  15958. properties collections the <see cref="T:log4net.Filter.PropertyFilter"/> should
  15959. be used instead.
  15960. </para>
  15961. </remarks>
  15962. <author>Nicko Cadell</author>
  15963. <author>Gert Driesen</author>
  15964. </member>
  15965. <member name="M:log4net.Filter.NdcFilter.#ctor">
  15966. <summary>
  15967. Default constructor
  15968. </summary>
  15969. <remarks>
  15970. <para>
  15971. Sets the <see cref="P:log4net.Filter.PropertyFilter.Key"/> to <c>"NDC"</c>.
  15972. </para>
  15973. </remarks>
  15974. </member>
  15975. <member name="T:log4net.Filter.PropertyFilter">
  15976. <summary>
  15977. Simple filter to match a string an event property
  15978. </summary>
  15979. <remarks>
  15980. <para>
  15981. Simple filter to match a string in the value for a
  15982. specific event property
  15983. </para>
  15984. </remarks>
  15985. <author>Nicko Cadell</author>
  15986. </member>
  15987. <member name="F:log4net.Filter.PropertyFilter.m_key">
  15988. <summary>
  15989. The key to use to lookup the string from the event properties
  15990. </summary>
  15991. </member>
  15992. <member name="M:log4net.Filter.PropertyFilter.#ctor">
  15993. <summary>
  15994. Default constructor
  15995. </summary>
  15996. </member>
  15997. <member name="P:log4net.Filter.PropertyFilter.Key">
  15998. <summary>
  15999. The key to lookup in the event properties and then match against.
  16000. </summary>
  16001. <remarks>
  16002. <para>
  16003. The key name to use to lookup in the properties map of the
  16004. <see cref="T:log4net.Core.LoggingEvent"/>. The match will be performed against
  16005. the value of this property if it exists.
  16006. </para>
  16007. </remarks>
  16008. </member>
  16009. <member name="M:log4net.Filter.PropertyFilter.Decide(log4net.Core.LoggingEvent)">
  16010. <summary>
  16011. Check if this filter should allow the event to be logged
  16012. </summary>
  16013. <param name="loggingEvent">the event being logged</param>
  16014. <returns>see remarks</returns>
  16015. <remarks>
  16016. <para>
  16017. The event property for the <see cref="P:log4net.Filter.PropertyFilter.Key"/> is matched against
  16018. the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  16019. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  16020. the property value then a match will have occurred. If no match occurs
  16021. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  16022. allowing other filters to check the event. If a match occurs then
  16023. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  16024. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  16025. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16026. </para>
  16027. </remarks>
  16028. </member>
  16029. <member name="T:log4net.Filter.StringMatchFilter">
  16030. <summary>
  16031. Simple filter to match a string in the rendered message
  16032. </summary>
  16033. <remarks>
  16034. <para>
  16035. Simple filter to match a string in the rendered message
  16036. </para>
  16037. </remarks>
  16038. <author>Nicko Cadell</author>
  16039. <author>Gert Driesen</author>
  16040. </member>
  16041. <member name="F:log4net.Filter.StringMatchFilter.m_acceptOnMatch">
  16042. <summary>
  16043. Flag to indicate the behavior when we have a match
  16044. </summary>
  16045. </member>
  16046. <member name="F:log4net.Filter.StringMatchFilter.m_stringToMatch">
  16047. <summary>
  16048. The string to substring match against the message
  16049. </summary>
  16050. </member>
  16051. <member name="F:log4net.Filter.StringMatchFilter.m_stringRegexToMatch">
  16052. <summary>
  16053. A string regex to match
  16054. </summary>
  16055. </member>
  16056. <member name="F:log4net.Filter.StringMatchFilter.m_regexToMatch">
  16057. <summary>
  16058. A regex object to match (generated from m_stringRegexToMatch)
  16059. </summary>
  16060. </member>
  16061. <member name="M:log4net.Filter.StringMatchFilter.#ctor">
  16062. <summary>
  16063. Default constructor
  16064. </summary>
  16065. </member>
  16066. <member name="M:log4net.Filter.StringMatchFilter.ActivateOptions">
  16067. <summary>
  16068. Initialize and precompile the Regex if required
  16069. </summary>
  16070. <remarks>
  16071. <para>
  16072. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16073. activation scheme. The <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> method must
  16074. be called on this object after the configuration properties have
  16075. been set. Until <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> is called this
  16076. object is in an undefined state and must not be used.
  16077. </para>
  16078. <para>
  16079. If any of the configuration properties are modified then
  16080. <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> must be called again.
  16081. </para>
  16082. </remarks>
  16083. </member>
  16084. <member name="P:log4net.Filter.StringMatchFilter.AcceptOnMatch">
  16085. <summary>
  16086. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  16087. </summary>
  16088. <remarks>
  16089. <para>
  16090. The <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> property is a flag that determines
  16091. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16092. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16093. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  16094. </para>
  16095. <para>
  16096. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16097. </para>
  16098. </remarks>
  16099. </member>
  16100. <member name="P:log4net.Filter.StringMatchFilter.StringToMatch">
  16101. <summary>
  16102. Sets the static string to match
  16103. </summary>
  16104. <remarks>
  16105. <para>
  16106. The string that will be substring matched against
  16107. the rendered message. If the message contains this
  16108. string then the filter will match. If a match is found then
  16109. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  16110. </para>
  16111. <para>
  16112. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  16113. must be specified.
  16114. </para>
  16115. </remarks>
  16116. </member>
  16117. <member name="P:log4net.Filter.StringMatchFilter.RegexToMatch">
  16118. <summary>
  16119. Sets the regular expression to match
  16120. </summary>
  16121. <remarks>
  16122. <para>
  16123. The regular expression pattern that will be matched against
  16124. the rendered message. If the message matches this
  16125. pattern then the filter will match. If a match is found then
  16126. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  16127. </para>
  16128. <para>
  16129. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  16130. must be specified.
  16131. </para>
  16132. </remarks>
  16133. </member>
  16134. <member name="M:log4net.Filter.StringMatchFilter.Decide(log4net.Core.LoggingEvent)">
  16135. <summary>
  16136. Check if this filter should allow the event to be logged
  16137. </summary>
  16138. <param name="loggingEvent">the event being logged</param>
  16139. <returns>see remarks</returns>
  16140. <remarks>
  16141. <para>
  16142. The rendered message is matched against the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  16143. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  16144. the message then a match will have occurred. If no match occurs
  16145. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  16146. allowing other filters to check the event. If a match occurs then
  16147. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  16148. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  16149. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16150. </para>
  16151. </remarks>
  16152. </member>
  16153. <member name="T:log4net.GlobalContext">
  16154. <summary>
  16155. The log4net Global Context.
  16156. </summary>
  16157. <remarks>
  16158. <para>
  16159. The <c>GlobalContext</c> provides a location for global debugging
  16160. information to be stored.
  16161. </para>
  16162. <para>
  16163. The global context has a properties map and these properties can
  16164. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  16165. supports selecting and outputing these properties.
  16166. </para>
  16167. <para>
  16168. By default the <c>log4net:HostName</c> property is set to the name of
  16169. the current machine.
  16170. </para>
  16171. </remarks>
  16172. <example>
  16173. <code lang="C#">
  16174. GlobalContext.Properties["hostname"] = Environment.MachineName;
  16175. </code>
  16176. </example>
  16177. <threadsafety static="true" instance="true" />
  16178. <author>Nicko Cadell</author>
  16179. </member>
  16180. <member name="M:log4net.GlobalContext.#ctor">
  16181. <summary>
  16182. Private Constructor.
  16183. </summary>
  16184. <remarks>
  16185. Uses a private access modifier to prevent instantiation of this class.
  16186. </remarks>
  16187. </member>
  16188. <member name="P:log4net.GlobalContext.Properties">
  16189. <summary>
  16190. The global properties map.
  16191. </summary>
  16192. <value>
  16193. The global properties map.
  16194. </value>
  16195. <remarks>
  16196. <para>
  16197. The global properties map.
  16198. </para>
  16199. </remarks>
  16200. </member>
  16201. <member name="F:log4net.GlobalContext.s_properties">
  16202. <summary>
  16203. The global context properties instance
  16204. </summary>
  16205. </member>
  16206. <member name="T:log4net.ILog">
  16207. <summary>
  16208. The ILog interface is use by application to log messages into
  16209. the log4net framework.
  16210. </summary>
  16211. <remarks>
  16212. <para>
  16213. Use the <see cref="T:log4net.LogManager"/> to obtain logger instances
  16214. that implement this interface. The <see cref="M:LogManager.GetLogger(Assembly,Type)"/>
  16215. static method is used to get logger instances.
  16216. </para>
  16217. <para>
  16218. This class contains methods for logging at different levels and also
  16219. has properties for determining if those logging levels are
  16220. enabled in the current configuration.
  16221. </para>
  16222. <para>
  16223. This interface can be implemented in different ways. This documentation
  16224. specifies reasonable behavior that a caller can expect from the actual
  16225. implementation, however different implementations reserve the right to
  16226. do things differently.
  16227. </para>
  16228. </remarks>
  16229. <example>Simple example of logging messages
  16230. <code lang="C#">
  16231. ILog log = LogManager.GetLogger("application-log");
  16232. log.Info("Application Start");
  16233. log.Debug("This is a debug message");
  16234. if (log.IsDebugEnabled)
  16235. {
  16236. log.Debug("This is another debug message");
  16237. }
  16238. </code>
  16239. </example>
  16240. <seealso cref="T:log4net.LogManager"/>
  16241. <seealso cref="M:LogManager.GetLogger(Assembly, Type)"/>
  16242. <author>Nicko Cadell</author>
  16243. <author>Gert Driesen</author>
  16244. </member>
  16245. <member name="M:log4net.ILog.Debug(System.Object)">
  16246. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  16247. <summary>
  16248. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16249. </summary>
  16250. <param name="message">The message object to log.</param>
  16251. <remarks>
  16252. <para>
  16253. This method first checks if this logger is <c>DEBUG</c>
  16254. enabled by comparing the level of this logger with the
  16255. <see cref="F:log4net.Core.Level.Debug"/> level. If this logger is
  16256. <c>DEBUG</c> enabled, then it converts the message object
  16257. (passed as parameter) to a string by invoking the appropriate
  16258. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  16259. proceeds to call all the registered appenders in this logger
  16260. and also higher in the hierarchy depending on the value of
  16261. the additivity flag.
  16262. </para>
  16263. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  16264. to this method will print the name of the <see cref="T:System.Exception"/>
  16265. but no stack trace. To print a stack trace use the
  16266. <see cref="M:Debug(object,Exception)"/> form instead.
  16267. </para>
  16268. </remarks>
  16269. <seealso cref="M:Debug(object,Exception)"/>
  16270. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16271. </member>
  16272. <member name="M:log4net.ILog.Debug(System.Object,System.Exception)">
  16273. <summary>
  16274. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  16275. the stack trace of the <see cref="T:System.Exception"/> passed
  16276. as a parameter.
  16277. </summary>
  16278. <param name="message">The message object to log.</param>
  16279. <param name="exception">The exception to log, including its stack trace.</param>
  16280. <remarks>
  16281. <para>
  16282. See the <see cref="M:Debug(object)"/> form for more detailed information.
  16283. </para>
  16284. </remarks>
  16285. <seealso cref="M:Debug(object)"/>
  16286. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16287. </member>
  16288. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object[])">
  16289. <overloads>Log a formatted string with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  16290. <summary>
  16291. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16292. </summary>
  16293. <param name="format">A String containing zero or more format items</param>
  16294. <param name="args">An Object array containing zero or more objects to format</param>
  16295. <remarks>
  16296. <para>
  16297. The message is formatted using the <c>String.Format</c> method. See
  16298. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16299. of the formatting.
  16300. </para>
  16301. <para>
  16302. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16303. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  16304. methods instead.
  16305. </para>
  16306. </remarks>
  16307. <seealso cref="M:Debug(object)"/>
  16308. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16309. </member>
  16310. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object)">
  16311. <summary>
  16312. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16313. </summary>
  16314. <param name="format">A String containing zero or more format items</param>
  16315. <param name="arg0">An Object to format</param>
  16316. <remarks>
  16317. <para>
  16318. The message is formatted using the <c>String.Format</c> method. See
  16319. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16320. of the formatting.
  16321. </para>
  16322. <para>
  16323. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16324. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  16325. methods instead.
  16326. </para>
  16327. </remarks>
  16328. <seealso cref="M:Debug(object)"/>
  16329. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16330. </member>
  16331. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)">
  16332. <summary>
  16333. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16334. </summary>
  16335. <param name="format">A String containing zero or more format items</param>
  16336. <param name="arg0">An Object to format</param>
  16337. <param name="arg1">An Object to format</param>
  16338. <remarks>
  16339. <para>
  16340. The message is formatted using the <c>String.Format</c> method. See
  16341. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16342. of the formatting.
  16343. </para>
  16344. <para>
  16345. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16346. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  16347. methods instead.
  16348. </para>
  16349. </remarks>
  16350. <seealso cref="M:Debug(object)"/>
  16351. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16352. </member>
  16353. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  16354. <summary>
  16355. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16356. </summary>
  16357. <param name="format">A String containing zero or more format items</param>
  16358. <param name="arg0">An Object to format</param>
  16359. <param name="arg1">An Object to format</param>
  16360. <param name="arg2">An Object to format</param>
  16361. <remarks>
  16362. <para>
  16363. The message is formatted using the <c>String.Format</c> method. See
  16364. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16365. of the formatting.
  16366. </para>
  16367. <para>
  16368. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16369. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  16370. methods instead.
  16371. </para>
  16372. </remarks>
  16373. <seealso cref="M:Debug(object)"/>
  16374. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16375. </member>
  16376. <member name="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  16377. <summary>
  16378. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  16379. </summary>
  16380. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  16381. <param name="format">A String containing zero or more format items</param>
  16382. <param name="args">An Object array containing zero or more objects to format</param>
  16383. <remarks>
  16384. <para>
  16385. The message is formatted using the <c>String.Format</c> method. See
  16386. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16387. of the formatting.
  16388. </para>
  16389. <para>
  16390. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16391. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  16392. methods instead.
  16393. </para>
  16394. </remarks>
  16395. <seealso cref="M:Debug(object)"/>
  16396. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  16397. </member>
  16398. <member name="M:log4net.ILog.Info(System.Object)">
  16399. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  16400. <summary>
  16401. Logs a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  16402. </summary>
  16403. <remarks>
  16404. <para>
  16405. This method first checks if this logger is <c>INFO</c>
  16406. enabled by comparing the level of this logger with the
  16407. <see cref="F:log4net.Core.Level.Info"/> level. If this logger is
  16408. <c>INFO</c> enabled, then it converts the message object
  16409. (passed as parameter) to a string by invoking the appropriate
  16410. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  16411. proceeds to call all the registered appenders in this logger
  16412. and also higher in the hierarchy depending on the value of the
  16413. additivity flag.
  16414. </para>
  16415. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  16416. to this method will print the name of the <see cref="T:System.Exception"/>
  16417. but no stack trace. To print a stack trace use the
  16418. <see cref="M:Info(object,Exception)"/> form instead.
  16419. </para>
  16420. </remarks>
  16421. <param name="message">The message object to log.</param>
  16422. <seealso cref="M:Info(object,Exception)"/>
  16423. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16424. </member>
  16425. <member name="M:log4net.ILog.Info(System.Object,System.Exception)">
  16426. <summary>
  16427. Logs a message object with the <c>INFO</c> level including
  16428. the stack trace of the <see cref="T:System.Exception"/> passed
  16429. as a parameter.
  16430. </summary>
  16431. <param name="message">The message object to log.</param>
  16432. <param name="exception">The exception to log, including its stack trace.</param>
  16433. <remarks>
  16434. <para>
  16435. See the <see cref="M:Info(object)"/> form for more detailed information.
  16436. </para>
  16437. </remarks>
  16438. <seealso cref="M:Info(object)"/>
  16439. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16440. </member>
  16441. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
  16442. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  16443. <summary>
  16444. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  16445. </summary>
  16446. <param name="format">A String containing zero or more format items</param>
  16447. <param name="args">An Object array containing zero or more objects to format</param>
  16448. <remarks>
  16449. <para>
  16450. The message is formatted using the <c>String.Format</c> method. See
  16451. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16452. of the formatting.
  16453. </para>
  16454. <para>
  16455. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16456. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  16457. methods instead.
  16458. </para>
  16459. </remarks>
  16460. <seealso cref="M:Info(object,Exception)"/>
  16461. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16462. </member>
  16463. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object)">
  16464. <summary>
  16465. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  16466. </summary>
  16467. <param name="format">A String containing zero or more format items</param>
  16468. <param name="arg0">An Object to format</param>
  16469. <remarks>
  16470. <para>
  16471. The message is formatted using the <c>String.Format</c> method. See
  16472. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16473. of the formatting.
  16474. </para>
  16475. <para>
  16476. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16477. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  16478. methods instead.
  16479. </para>
  16480. </remarks>
  16481. <seealso cref="M:Info(object)"/>
  16482. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16483. </member>
  16484. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)">
  16485. <summary>
  16486. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  16487. </summary>
  16488. <param name="format">A String containing zero or more format items</param>
  16489. <param name="arg0">An Object to format</param>
  16490. <param name="arg1">An Object to format</param>
  16491. <remarks>
  16492. <para>
  16493. The message is formatted using the <c>String.Format</c> method. See
  16494. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16495. of the formatting.
  16496. </para>
  16497. <para>
  16498. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16499. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  16500. methods instead.
  16501. </para>
  16502. </remarks>
  16503. <seealso cref="M:Info(object)"/>
  16504. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16505. </member>
  16506. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  16507. <summary>
  16508. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  16509. </summary>
  16510. <param name="format">A String containing zero or more format items</param>
  16511. <param name="arg0">An Object to format</param>
  16512. <param name="arg1">An Object to format</param>
  16513. <param name="arg2">An Object to format</param>
  16514. <remarks>
  16515. <para>
  16516. The message is formatted using the <c>String.Format</c> method. See
  16517. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16518. of the formatting.
  16519. </para>
  16520. <para>
  16521. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16522. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  16523. methods instead.
  16524. </para>
  16525. </remarks>
  16526. <seealso cref="M:Info(object)"/>
  16527. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16528. </member>
  16529. <member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  16530. <summary>
  16531. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  16532. </summary>
  16533. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  16534. <param name="format">A String containing zero or more format items</param>
  16535. <param name="args">An Object array containing zero or more objects to format</param>
  16536. <remarks>
  16537. <para>
  16538. The message is formatted using the <c>String.Format</c> method. See
  16539. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16540. of the formatting.
  16541. </para>
  16542. <para>
  16543. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16544. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  16545. methods instead.
  16546. </para>
  16547. </remarks>
  16548. <seealso cref="M:Info(object,Exception)"/>
  16549. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  16550. </member>
  16551. <member name="M:log4net.ILog.Warn(System.Object)">
  16552. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  16553. <summary>
  16554. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16555. </summary>
  16556. <remarks>
  16557. <para>
  16558. This method first checks if this logger is <c>WARN</c>
  16559. enabled by comparing the level of this logger with the
  16560. <see cref="F:log4net.Core.Level.Warn"/> level. If this logger is
  16561. <c>WARN</c> enabled, then it converts the message object
  16562. (passed as parameter) to a string by invoking the appropriate
  16563. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  16564. proceeds to call all the registered appenders in this logger
  16565. and also higher in the hierarchy depending on the value of the
  16566. additivity flag.
  16567. </para>
  16568. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  16569. to this method will print the name of the <see cref="T:System.Exception"/>
  16570. but no stack trace. To print a stack trace use the
  16571. <see cref="M:Warn(object,Exception)"/> form instead.
  16572. </para>
  16573. </remarks>
  16574. <param name="message">The message object to log.</param>
  16575. <seealso cref="M:Warn(object,Exception)"/>
  16576. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16577. </member>
  16578. <member name="M:log4net.ILog.Warn(System.Object,System.Exception)">
  16579. <summary>
  16580. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  16581. the stack trace of the <see cref="T:System.Exception"/> passed
  16582. as a parameter.
  16583. </summary>
  16584. <param name="message">The message object to log.</param>
  16585. <param name="exception">The exception to log, including its stack trace.</param>
  16586. <remarks>
  16587. <para>
  16588. See the <see cref="M:Warn(object)"/> form for more detailed information.
  16589. </para>
  16590. </remarks>
  16591. <seealso cref="M:Warn(object)"/>
  16592. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16593. </member>
  16594. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object[])">
  16595. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  16596. <summary>
  16597. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16598. </summary>
  16599. <param name="format">A String containing zero or more format items</param>
  16600. <param name="args">An Object array containing zero or more objects to format</param>
  16601. <remarks>
  16602. <para>
  16603. The message is formatted using the <c>String.Format</c> method. See
  16604. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16605. of the formatting.
  16606. </para>
  16607. <para>
  16608. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16609. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  16610. methods instead.
  16611. </para>
  16612. </remarks>
  16613. <seealso cref="M:Warn(object,Exception)"/>
  16614. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16615. </member>
  16616. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object)">
  16617. <summary>
  16618. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16619. </summary>
  16620. <param name="format">A String containing zero or more format items</param>
  16621. <param name="arg0">An Object to format</param>
  16622. <remarks>
  16623. <para>
  16624. The message is formatted using the <c>String.Format</c> method. See
  16625. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16626. of the formatting.
  16627. </para>
  16628. <para>
  16629. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16630. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  16631. methods instead.
  16632. </para>
  16633. </remarks>
  16634. <seealso cref="M:Warn(object)"/>
  16635. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16636. </member>
  16637. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)">
  16638. <summary>
  16639. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16640. </summary>
  16641. <param name="format">A String containing zero or more format items</param>
  16642. <param name="arg0">An Object to format</param>
  16643. <param name="arg1">An Object to format</param>
  16644. <remarks>
  16645. <para>
  16646. The message is formatted using the <c>String.Format</c> method. See
  16647. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16648. of the formatting.
  16649. </para>
  16650. <para>
  16651. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16652. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  16653. methods instead.
  16654. </para>
  16655. </remarks>
  16656. <seealso cref="M:Warn(object)"/>
  16657. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16658. </member>
  16659. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  16660. <summary>
  16661. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16662. </summary>
  16663. <param name="format">A String containing zero or more format items</param>
  16664. <param name="arg0">An Object to format</param>
  16665. <param name="arg1">An Object to format</param>
  16666. <param name="arg2">An Object to format</param>
  16667. <remarks>
  16668. <para>
  16669. The message is formatted using the <c>String.Format</c> method. See
  16670. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16671. of the formatting.
  16672. </para>
  16673. <para>
  16674. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16675. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  16676. methods instead.
  16677. </para>
  16678. </remarks>
  16679. <seealso cref="M:Warn(object)"/>
  16680. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16681. </member>
  16682. <member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  16683. <summary>
  16684. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  16685. </summary>
  16686. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  16687. <param name="format">A String containing zero or more format items</param>
  16688. <param name="args">An Object array containing zero or more objects to format</param>
  16689. <remarks>
  16690. <para>
  16691. The message is formatted using the <c>String.Format</c> method. See
  16692. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16693. of the formatting.
  16694. </para>
  16695. <para>
  16696. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16697. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  16698. methods instead.
  16699. </para>
  16700. </remarks>
  16701. <seealso cref="M:Warn(object,Exception)"/>
  16702. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  16703. </member>
  16704. <member name="M:log4net.ILog.Error(System.Object)">
  16705. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  16706. <summary>
  16707. Logs a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  16708. </summary>
  16709. <param name="message">The message object to log.</param>
  16710. <remarks>
  16711. <para>
  16712. This method first checks if this logger is <c>ERROR</c>
  16713. enabled by comparing the level of this logger with the
  16714. <see cref="F:log4net.Core.Level.Error"/> level. If this logger is
  16715. <c>ERROR</c> enabled, then it converts the message object
  16716. (passed as parameter) to a string by invoking the appropriate
  16717. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  16718. proceeds to call all the registered appenders in this logger
  16719. and also higher in the hierarchy depending on the value of the
  16720. additivity flag.
  16721. </para>
  16722. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  16723. to this method will print the name of the <see cref="T:System.Exception"/>
  16724. but no stack trace. To print a stack trace use the
  16725. <see cref="M:Error(object,Exception)"/> form instead.
  16726. </para>
  16727. </remarks>
  16728. <seealso cref="M:Error(object,Exception)"/>
  16729. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16730. </member>
  16731. <member name="M:log4net.ILog.Error(System.Object,System.Exception)">
  16732. <summary>
  16733. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  16734. the stack trace of the <see cref="T:System.Exception"/> passed
  16735. as a parameter.
  16736. </summary>
  16737. <param name="message">The message object to log.</param>
  16738. <param name="exception">The exception to log, including its stack trace.</param>
  16739. <remarks>
  16740. <para>
  16741. See the <see cref="M:Error(object)"/> form for more detailed information.
  16742. </para>
  16743. </remarks>
  16744. <seealso cref="M:Error(object)"/>
  16745. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16746. </member>
  16747. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object[])">
  16748. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  16749. <summary>
  16750. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  16751. </summary>
  16752. <param name="format">A String containing zero or more format items</param>
  16753. <param name="args">An Object array containing zero or more objects to format</param>
  16754. <remarks>
  16755. <para>
  16756. The message is formatted using the <c>String.Format</c> method. See
  16757. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16758. of the formatting.
  16759. </para>
  16760. <para>
  16761. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16762. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  16763. methods instead.
  16764. </para>
  16765. </remarks>
  16766. <seealso cref="M:Error(object,Exception)"/>
  16767. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16768. </member>
  16769. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)">
  16770. <summary>
  16771. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  16772. </summary>
  16773. <param name="format">A String containing zero or more format items</param>
  16774. <param name="arg0">An Object to format</param>
  16775. <remarks>
  16776. <para>
  16777. The message is formatted using the <c>String.Format</c> method. See
  16778. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16779. of the formatting.
  16780. </para>
  16781. <para>
  16782. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16783. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  16784. methods instead.
  16785. </para>
  16786. </remarks>
  16787. <seealso cref="M:Error(object)"/>
  16788. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16789. </member>
  16790. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)">
  16791. <summary>
  16792. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  16793. </summary>
  16794. <param name="format">A String containing zero or more format items</param>
  16795. <param name="arg0">An Object to format</param>
  16796. <param name="arg1">An Object to format</param>
  16797. <remarks>
  16798. <para>
  16799. The message is formatted using the <c>String.Format</c> method. See
  16800. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16801. of the formatting.
  16802. </para>
  16803. <para>
  16804. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16805. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  16806. methods instead.
  16807. </para>
  16808. </remarks>
  16809. <seealso cref="M:Error(object)"/>
  16810. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16811. </member>
  16812. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  16813. <summary>
  16814. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  16815. </summary>
  16816. <param name="format">A String containing zero or more format items</param>
  16817. <param name="arg0">An Object to format</param>
  16818. <param name="arg1">An Object to format</param>
  16819. <param name="arg2">An Object to format</param>
  16820. <remarks>
  16821. <para>
  16822. The message is formatted using the <c>String.Format</c> method. See
  16823. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16824. of the formatting.
  16825. </para>
  16826. <para>
  16827. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16828. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  16829. methods instead.
  16830. </para>
  16831. </remarks>
  16832. <seealso cref="M:Error(object)"/>
  16833. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16834. </member>
  16835. <member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  16836. <summary>
  16837. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  16838. </summary>
  16839. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  16840. <param name="format">A String containing zero or more format items</param>
  16841. <param name="args">An Object array containing zero or more objects to format</param>
  16842. <remarks>
  16843. <para>
  16844. The message is formatted using the <c>String.Format</c> method. See
  16845. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16846. of the formatting.
  16847. </para>
  16848. <para>
  16849. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16850. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  16851. methods instead.
  16852. </para>
  16853. </remarks>
  16854. <seealso cref="M:Error(object,Exception)"/>
  16855. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  16856. </member>
  16857. <member name="M:log4net.ILog.Fatal(System.Object)">
  16858. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  16859. <summary>
  16860. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16861. </summary>
  16862. <remarks>
  16863. <para>
  16864. This method first checks if this logger is <c>FATAL</c>
  16865. enabled by comparing the level of this logger with the
  16866. <see cref="F:log4net.Core.Level.Fatal"/> level. If this logger is
  16867. <c>FATAL</c> enabled, then it converts the message object
  16868. (passed as parameter) to a string by invoking the appropriate
  16869. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  16870. proceeds to call all the registered appenders in this logger
  16871. and also higher in the hierarchy depending on the value of the
  16872. additivity flag.
  16873. </para>
  16874. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  16875. to this method will print the name of the <see cref="T:System.Exception"/>
  16876. but no stack trace. To print a stack trace use the
  16877. <see cref="M:Fatal(object,Exception)"/> form instead.
  16878. </para>
  16879. </remarks>
  16880. <param name="message">The message object to log.</param>
  16881. <seealso cref="M:Fatal(object,Exception)"/>
  16882. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16883. </member>
  16884. <member name="M:log4net.ILog.Fatal(System.Object,System.Exception)">
  16885. <summary>
  16886. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  16887. the stack trace of the <see cref="T:System.Exception"/> passed
  16888. as a parameter.
  16889. </summary>
  16890. <param name="message">The message object to log.</param>
  16891. <param name="exception">The exception to log, including its stack trace.</param>
  16892. <remarks>
  16893. <para>
  16894. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  16895. </para>
  16896. </remarks>
  16897. <seealso cref="M:Fatal(object)"/>
  16898. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16899. </member>
  16900. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object[])">
  16901. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  16902. <summary>
  16903. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16904. </summary>
  16905. <param name="format">A String containing zero or more format items</param>
  16906. <param name="args">An Object array containing zero or more objects to format</param>
  16907. <remarks>
  16908. <para>
  16909. The message is formatted using the <c>String.Format</c> method. See
  16910. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16911. of the formatting.
  16912. </para>
  16913. <para>
  16914. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16915. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  16916. methods instead.
  16917. </para>
  16918. </remarks>
  16919. <seealso cref="M:Fatal(object,Exception)"/>
  16920. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16921. </member>
  16922. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object)">
  16923. <summary>
  16924. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16925. </summary>
  16926. <param name="format">A String containing zero or more format items</param>
  16927. <param name="arg0">An Object to format</param>
  16928. <remarks>
  16929. <para>
  16930. The message is formatted using the <c>String.Format</c> method. See
  16931. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16932. of the formatting.
  16933. </para>
  16934. <para>
  16935. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16936. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  16937. methods instead.
  16938. </para>
  16939. </remarks>
  16940. <seealso cref="M:Fatal(object)"/>
  16941. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16942. </member>
  16943. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)">
  16944. <summary>
  16945. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16946. </summary>
  16947. <param name="format">A String containing zero or more format items</param>
  16948. <param name="arg0">An Object to format</param>
  16949. <param name="arg1">An Object to format</param>
  16950. <remarks>
  16951. <para>
  16952. The message is formatted using the <c>String.Format</c> method. See
  16953. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16954. of the formatting.
  16955. </para>
  16956. <para>
  16957. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16958. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  16959. methods instead.
  16960. </para>
  16961. </remarks>
  16962. <seealso cref="M:Fatal(object)"/>
  16963. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16964. </member>
  16965. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  16966. <summary>
  16967. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16968. </summary>
  16969. <param name="format">A String containing zero or more format items</param>
  16970. <param name="arg0">An Object to format</param>
  16971. <param name="arg1">An Object to format</param>
  16972. <param name="arg2">An Object to format</param>
  16973. <remarks>
  16974. <para>
  16975. The message is formatted using the <c>String.Format</c> method. See
  16976. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16977. of the formatting.
  16978. </para>
  16979. <para>
  16980. This method does not take an <see cref="T:System.Exception"/> object to include in the
  16981. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  16982. methods instead.
  16983. </para>
  16984. </remarks>
  16985. <seealso cref="M:Fatal(object)"/>
  16986. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  16987. </member>
  16988. <member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  16989. <summary>
  16990. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  16991. </summary>
  16992. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  16993. <param name="format">A String containing zero or more format items</param>
  16994. <param name="args">An Object array containing zero or more objects to format</param>
  16995. <remarks>
  16996. <para>
  16997. The message is formatted using the <c>String.Format</c> method. See
  16998. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  16999. of the formatting.
  17000. </para>
  17001. <para>
  17002. This method does not take an <see cref="T:System.Exception"/> object to include in the
  17003. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  17004. methods instead.
  17005. </para>
  17006. </remarks>
  17007. <seealso cref="M:Fatal(object,Exception)"/>
  17008. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  17009. </member>
  17010. <member name="P:log4net.ILog.IsDebugEnabled">
  17011. <summary>
  17012. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Debug"/> level.
  17013. </summary>
  17014. <value>
  17015. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Debug"/> events, <c>false</c> otherwise.
  17016. </value>
  17017. <remarks>
  17018. <para>
  17019. This function is intended to lessen the computational cost of
  17020. disabled log debug statements.
  17021. </para>
  17022. <para> For some ILog interface <c>log</c>, when you write:</para>
  17023. <code lang="C#">
  17024. log.Debug("This is entry number: " + i );
  17025. </code>
  17026. <para>
  17027. You incur the cost constructing the message, string construction and concatenation in
  17028. this case, regardless of whether the message is logged or not.
  17029. </para>
  17030. <para>
  17031. If you are worried about speed (who isn't), then you should write:
  17032. </para>
  17033. <code lang="C#">
  17034. if (log.IsDebugEnabled)
  17035. {
  17036. log.Debug("This is entry number: " + i );
  17037. }
  17038. </code>
  17039. <para>
  17040. This way you will not incur the cost of parameter
  17041. construction if debugging is disabled for <c>log</c>. On
  17042. the other hand, if the <c>log</c> is debug enabled, you
  17043. will incur the cost of evaluating whether the logger is debug
  17044. enabled twice. Once in <see cref="P:log4net.ILog.IsDebugEnabled"/> and once in
  17045. the <see cref="M:Debug(object)"/>. This is an insignificant overhead
  17046. since evaluating a logger takes about 1% of the time it
  17047. takes to actually log. This is the preferred style of logging.
  17048. </para>
  17049. <para>Alternatively if your logger is available statically then the is debug
  17050. enabled state can be stored in a static variable like this:
  17051. </para>
  17052. <code lang="C#">
  17053. private static readonly bool isDebugEnabled = log.IsDebugEnabled;
  17054. </code>
  17055. <para>
  17056. Then when you come to log you can write:
  17057. </para>
  17058. <code lang="C#">
  17059. if (isDebugEnabled)
  17060. {
  17061. log.Debug("This is entry number: " + i );
  17062. }
  17063. </code>
  17064. <para>
  17065. This way the debug enabled state is only queried once
  17066. when the class is loaded. Using a <c>private static readonly</c>
  17067. variable is the most efficient because it is a run time constant
  17068. and can be heavily optimized by the JIT compiler.
  17069. </para>
  17070. <para>
  17071. Of course if you use a static readonly variable to
  17072. hold the enabled state of the logger then you cannot
  17073. change the enabled state at runtime to vary the logging
  17074. that is produced. You have to decide if you need absolute
  17075. speed or runtime flexibility.
  17076. </para>
  17077. </remarks>
  17078. <seealso cref="M:Debug(object)"/>
  17079. <seealso cref="M:DebugFormat(IFormatProvider, string, object[])"/>
  17080. </member>
  17081. <member name="P:log4net.ILog.IsInfoEnabled">
  17082. <summary>
  17083. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Info"/> level.
  17084. </summary>
  17085. <value>
  17086. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Info"/> events, <c>false</c> otherwise.
  17087. </value>
  17088. <remarks>
  17089. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  17090. </remarks>
  17091. <seealso cref="M:Info(object)"/>
  17092. <seealso cref="M:InfoFormat(IFormatProvider, string, object[])"/>
  17093. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  17094. </member>
  17095. <member name="P:log4net.ILog.IsWarnEnabled">
  17096. <summary>
  17097. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Warn"/> level.
  17098. </summary>
  17099. <value>
  17100. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Warn"/> events, <c>false</c> otherwise.
  17101. </value>
  17102. <remarks>
  17103. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  17104. </remarks>
  17105. <seealso cref="M:Warn(object)"/>
  17106. <seealso cref="M:WarnFormat(IFormatProvider, string, object[])"/>
  17107. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  17108. </member>
  17109. <member name="P:log4net.ILog.IsErrorEnabled">
  17110. <summary>
  17111. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Error"/> level.
  17112. </summary>
  17113. <value>
  17114. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Error"/> events, <c>false</c> otherwise.
  17115. </value>
  17116. <remarks>
  17117. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  17118. </remarks>
  17119. <seealso cref="M:Error(object)"/>
  17120. <seealso cref="M:ErrorFormat(IFormatProvider, string, object[])"/>
  17121. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  17122. </member>
  17123. <member name="P:log4net.ILog.IsFatalEnabled">
  17124. <summary>
  17125. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Fatal"/> level.
  17126. </summary>
  17127. <value>
  17128. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Fatal"/> events, <c>false</c> otherwise.
  17129. </value>
  17130. <remarks>
  17131. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  17132. </remarks>
  17133. <seealso cref="M:Fatal(object)"/>
  17134. <seealso cref="M:FatalFormat(IFormatProvider, string, object[])"/>
  17135. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  17136. </member>
  17137. <member name="T:log4net.Layout.DynamicPatternLayout">
  17138. <summary>
  17139. A flexible layout configurable with pattern string that re-evaluates on each call.
  17140. </summary>
  17141. <remarks>
  17142. <para>This class is built on <see cref="T:log4net.Layout.PatternLayout"></see> and provides all the
  17143. features and capabilities of PatternLayout. PatternLayout is a 'static' class
  17144. in that its layout is done once at configuration time. This class will recreate
  17145. the layout on each reference.</para>
  17146. <para>One important difference between PatternLayout and DynamicPatternLayout is the
  17147. treatment of the Header and Footer parameters in the configuration. The Header and Footer
  17148. parameters for DynamicPatternLayout must be syntactically in the form of a PatternString,
  17149. but should not be marked as type log4net.Util.PatternString. Doing so causes the
  17150. pattern to be statically converted at configuration time and causes DynamicPatternLayout
  17151. to perform the same as PatternLayout.</para>
  17152. <para>Please see <see cref="T:log4net.Layout.PatternLayout"/> for complete documentation.</para>
  17153. <example>
  17154. &lt;layout type="log4net.Layout.DynamicPatternLayout"&gt;
  17155. &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;
  17156. &lt;param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /&gt;
  17157. &lt;/layout&gt;
  17158. </example>
  17159. </remarks>
  17160. </member>
  17161. <member name="F:log4net.Layout.DynamicPatternLayout.m_headerPatternString">
  17162. <summary>
  17163. The header PatternString
  17164. </summary>
  17165. </member>
  17166. <member name="F:log4net.Layout.DynamicPatternLayout.m_footerPatternString">
  17167. <summary>
  17168. The footer PatternString
  17169. </summary>
  17170. </member>
  17171. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor">
  17172. <summary>
  17173. Constructs a DynamicPatternLayout using the DefaultConversionPattern
  17174. </summary>
  17175. <remarks>
  17176. <para>
  17177. The default pattern just produces the application supplied message.
  17178. </para>
  17179. </remarks>
  17180. </member>
  17181. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor(System.String)">
  17182. <summary>
  17183. Constructs a DynamicPatternLayout using the supplied conversion pattern
  17184. </summary>
  17185. <param name="pattern">the pattern to use</param>
  17186. <remarks>
  17187. </remarks>
  17188. </member>
  17189. <member name="P:log4net.Layout.DynamicPatternLayout.Header">
  17190. <summary>
  17191. The header for the layout format.
  17192. </summary>
  17193. <value>the layout header</value>
  17194. <remarks>
  17195. <para>
  17196. The Header text will be appended before any logging events
  17197. are formatted and appended.
  17198. </para>
  17199. The pattern will be formatted on each get operation.
  17200. </remarks>
  17201. </member>
  17202. <member name="P:log4net.Layout.DynamicPatternLayout.Footer">
  17203. <summary>
  17204. The footer for the layout format.
  17205. </summary>
  17206. <value>the layout footer</value>
  17207. <remarks>
  17208. <para>
  17209. The Footer text will be appended after all the logging events
  17210. have been formatted and appended.
  17211. </para>
  17212. The pattern will be formatted on each get operation.
  17213. </remarks>
  17214. </member>
  17215. <member name="T:log4net.Layout.ExceptionLayout">
  17216. <summary>
  17217. A Layout that renders only the Exception text from the logging event
  17218. </summary>
  17219. <remarks>
  17220. <para>
  17221. A Layout that renders only the Exception text from the logging event.
  17222. </para>
  17223. <para>
  17224. This Layout should only be used with appenders that utilize multiple
  17225. layouts (e.g. <see cref="T:log4net.Appender.AdoNetAppender"/>).
  17226. </para>
  17227. </remarks>
  17228. <author>Nicko Cadell</author>
  17229. <author>Gert Driesen</author>
  17230. </member>
  17231. <member name="M:log4net.Layout.ExceptionLayout.#ctor">
  17232. <summary>
  17233. Default constructor
  17234. </summary>
  17235. <remarks>
  17236. <para>
  17237. Constructs a ExceptionLayout
  17238. </para>
  17239. </remarks>
  17240. </member>
  17241. <member name="M:log4net.Layout.ExceptionLayout.ActivateOptions">
  17242. <summary>
  17243. Activate component options
  17244. </summary>
  17245. <remarks>
  17246. <para>
  17247. Part of the <see cref="T:log4net.Core.IOptionHandler"/> component activation
  17248. framework.
  17249. </para>
  17250. <para>
  17251. This method does nothing as options become effective immediately.
  17252. </para>
  17253. </remarks>
  17254. </member>
  17255. <member name="M:log4net.Layout.ExceptionLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17256. <summary>
  17257. Gets the exception text from the logging event
  17258. </summary>
  17259. <param name="writer">The TextWriter to write the formatted event to</param>
  17260. <param name="loggingEvent">the event being logged</param>
  17261. <remarks>
  17262. <para>
  17263. Write the exception string to the <see cref="T:System.IO.TextWriter"/>.
  17264. The exception string is retrieved from <see cref="M:LoggingEvent.GetExceptionString()"/>.
  17265. </para>
  17266. </remarks>
  17267. </member>
  17268. <member name="T:log4net.Layout.ILayout">
  17269. <summary>
  17270. Interface implemented by layout objects
  17271. </summary>
  17272. <remarks>
  17273. <para>
  17274. An <see cref="T:log4net.Layout.ILayout"/> object is used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  17275. as text. The <see cref="M:Format(TextWriter,LoggingEvent)"/> method is called by an
  17276. appender to transform the <see cref="T:log4net.Core.LoggingEvent"/> into a string.
  17277. </para>
  17278. <para>
  17279. The layout can also supply <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  17280. text that is appender before any events and after all the events respectively.
  17281. </para>
  17282. </remarks>
  17283. <author>Nicko Cadell</author>
  17284. <author>Gert Driesen</author>
  17285. </member>
  17286. <member name="M:log4net.Layout.ILayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17287. <summary>
  17288. Implement this method to create your own layout format.
  17289. </summary>
  17290. <param name="writer">The TextWriter to write the formatted event to</param>
  17291. <param name="loggingEvent">The event to format</param>
  17292. <remarks>
  17293. <para>
  17294. This method is called by an appender to format
  17295. the <paramref name="loggingEvent"/> as text and output to a writer.
  17296. </para>
  17297. <para>
  17298. If the caller does not have a <see cref="T:System.IO.TextWriter"/> and prefers the
  17299. event to be formatted as a <see cref="T:System.String"/> then the following
  17300. code can be used to format the event into a <see cref="T:System.IO.StringWriter"/>.
  17301. </para>
  17302. <code lang="C#">
  17303. StringWriter writer = new StringWriter();
  17304. Layout.Format(writer, loggingEvent);
  17305. string formattedEvent = writer.ToString();
  17306. </code>
  17307. </remarks>
  17308. </member>
  17309. <member name="P:log4net.Layout.ILayout.ContentType">
  17310. <summary>
  17311. The content type output by this layout.
  17312. </summary>
  17313. <value>The content type</value>
  17314. <remarks>
  17315. <para>
  17316. The content type output by this layout.
  17317. </para>
  17318. <para>
  17319. This is a MIME type e.g. <c>"text/plain"</c>.
  17320. </para>
  17321. </remarks>
  17322. </member>
  17323. <member name="P:log4net.Layout.ILayout.Header">
  17324. <summary>
  17325. The header for the layout format.
  17326. </summary>
  17327. <value>the layout header</value>
  17328. <remarks>
  17329. <para>
  17330. The Header text will be appended before any logging events
  17331. are formatted and appended.
  17332. </para>
  17333. </remarks>
  17334. </member>
  17335. <member name="P:log4net.Layout.ILayout.Footer">
  17336. <summary>
  17337. The footer for the layout format.
  17338. </summary>
  17339. <value>the layout footer</value>
  17340. <remarks>
  17341. <para>
  17342. The Footer text will be appended after all the logging events
  17343. have been formatted and appended.
  17344. </para>
  17345. </remarks>
  17346. </member>
  17347. <member name="P:log4net.Layout.ILayout.IgnoresException">
  17348. <summary>
  17349. Flag indicating if this layout handle exceptions
  17350. </summary>
  17351. <value><c>false</c> if this layout handles exceptions</value>
  17352. <remarks>
  17353. <para>
  17354. If this layout handles the exception object contained within
  17355. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  17356. <c>false</c>. Otherwise, if the layout ignores the exception
  17357. object, then the layout should return <c>true</c>.
  17358. </para>
  17359. </remarks>
  17360. </member>
  17361. <member name="T:log4net.Layout.IRawLayout">
  17362. <summary>
  17363. Interface for raw layout objects
  17364. </summary>
  17365. <remarks>
  17366. <para>
  17367. Interface used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  17368. to an object.
  17369. </para>
  17370. <para>
  17371. This interface should not be confused with the
  17372. <see cref="T:log4net.Layout.ILayout"/> interface. This interface is used in
  17373. only certain specialized situations where a raw object is
  17374. required rather than a formatted string. The <see cref="T:log4net.Layout.ILayout"/>
  17375. is not generally useful than this interface.
  17376. </para>
  17377. </remarks>
  17378. <author>Nicko Cadell</author>
  17379. <author>Gert Driesen</author>
  17380. </member>
  17381. <member name="M:log4net.Layout.IRawLayout.Format(log4net.Core.LoggingEvent)">
  17382. <summary>
  17383. Implement this method to create your own layout format.
  17384. </summary>
  17385. <param name="loggingEvent">The event to format</param>
  17386. <returns>returns the formatted event</returns>
  17387. <remarks>
  17388. <para>
  17389. Implement this method to create your own layout format.
  17390. </para>
  17391. </remarks>
  17392. </member>
  17393. <member name="T:log4net.Layout.Layout2RawLayoutAdapter">
  17394. <summary>
  17395. Adapts any <see cref="T:log4net.Layout.ILayout"/> to a <see cref="T:log4net.Layout.IRawLayout"/>
  17396. </summary>
  17397. <remarks>
  17398. <para>
  17399. Where an <see cref="T:log4net.Layout.IRawLayout"/> is required this adapter
  17400. allows a <see cref="T:log4net.Layout.ILayout"/> to be specified.
  17401. </para>
  17402. </remarks>
  17403. <author>Nicko Cadell</author>
  17404. <author>Gert Driesen</author>
  17405. </member>
  17406. <member name="F:log4net.Layout.Layout2RawLayoutAdapter.m_layout">
  17407. <summary>
  17408. The layout to adapt
  17409. </summary>
  17410. </member>
  17411. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.#ctor(log4net.Layout.ILayout)">
  17412. <summary>
  17413. Construct a new adapter
  17414. </summary>
  17415. <param name="layout">the layout to adapt</param>
  17416. <remarks>
  17417. <para>
  17418. Create the adapter for the specified <paramref name="layout"/>.
  17419. </para>
  17420. </remarks>
  17421. </member>
  17422. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.Format(log4net.Core.LoggingEvent)">
  17423. <summary>
  17424. Format the logging event as an object.
  17425. </summary>
  17426. <param name="loggingEvent">The event to format</param>
  17427. <returns>returns the formatted event</returns>
  17428. <remarks>
  17429. <para>
  17430. Format the logging event as an object.
  17431. </para>
  17432. <para>
  17433. Uses the <see cref="T:log4net.Layout.ILayout"/> object supplied to
  17434. the constructor to perform the formatting.
  17435. </para>
  17436. </remarks>
  17437. </member>
  17438. <member name="T:log4net.Layout.LayoutSkeleton">
  17439. <summary>
  17440. Extend this abstract class to create your own log layout format.
  17441. </summary>
  17442. <remarks>
  17443. <para>
  17444. This is the base implementation of the <see cref="T:log4net.Layout.ILayout"/>
  17445. interface. Most layout objects should extend this class.
  17446. </para>
  17447. </remarks>
  17448. <remarks>
  17449. <note type="inheritinfo">
  17450. <para>
  17451. Subclasses must implement the <see cref="M:Format(TextWriter,LoggingEvent)"/>
  17452. method.
  17453. </para>
  17454. <para>
  17455. Subclasses should set the <see cref="P:log4net.Layout.LayoutSkeleton.IgnoresException"/> in their default
  17456. constructor.
  17457. </para>
  17458. </note>
  17459. </remarks>
  17460. <author>Nicko Cadell</author>
  17461. <author>Gert Driesen</author>
  17462. </member>
  17463. <member name="F:log4net.Layout.LayoutSkeleton.m_header">
  17464. <summary>
  17465. The header text
  17466. </summary>
  17467. <remarks>
  17468. <para>
  17469. See <see cref="P:log4net.Layout.LayoutSkeleton.Header"/> for more information.
  17470. </para>
  17471. </remarks>
  17472. </member>
  17473. <member name="F:log4net.Layout.LayoutSkeleton.m_footer">
  17474. <summary>
  17475. The footer text
  17476. </summary>
  17477. <remarks>
  17478. <para>
  17479. See <see cref="P:log4net.Layout.LayoutSkeleton.Footer"/> for more information.
  17480. </para>
  17481. </remarks>
  17482. </member>
  17483. <member name="F:log4net.Layout.LayoutSkeleton.m_ignoresException">
  17484. <summary>
  17485. Flag indicating if this layout handles exceptions
  17486. </summary>
  17487. <remarks>
  17488. <para>
  17489. <c>false</c> if this layout handles exceptions
  17490. </para>
  17491. </remarks>
  17492. </member>
  17493. <member name="M:log4net.Layout.LayoutSkeleton.#ctor">
  17494. <summary>
  17495. Empty default constructor
  17496. </summary>
  17497. <remarks>
  17498. <para>
  17499. Empty default constructor
  17500. </para>
  17501. </remarks>
  17502. </member>
  17503. <member name="M:log4net.Layout.LayoutSkeleton.ActivateOptions">
  17504. <summary>
  17505. Activate component options
  17506. </summary>
  17507. <remarks>
  17508. <para>
  17509. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17510. activation scheme. The <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> method must
  17511. be called on this object after the configuration properties have
  17512. been set. Until <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> is called this
  17513. object is in an undefined state and must not be used.
  17514. </para>
  17515. <para>
  17516. If any of the configuration properties are modified then
  17517. <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> must be called again.
  17518. </para>
  17519. <para>
  17520. This method must be implemented by the subclass.
  17521. </para>
  17522. </remarks>
  17523. </member>
  17524. <member name="M:log4net.Layout.LayoutSkeleton.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17525. <summary>
  17526. Implement this method to create your own layout format.
  17527. </summary>
  17528. <param name="writer">The TextWriter to write the formatted event to</param>
  17529. <param name="loggingEvent">The event to format</param>
  17530. <remarks>
  17531. <para>
  17532. This method is called by an appender to format
  17533. the <paramref name="loggingEvent"/> as text.
  17534. </para>
  17535. </remarks>
  17536. </member>
  17537. <member name="M:log4net.Layout.LayoutSkeleton.Format(log4net.Core.LoggingEvent)">
  17538. <summary>
  17539. Convenience method for easily formatting the logging event into a string variable.
  17540. </summary>
  17541. <param name="loggingEvent"></param>
  17542. <remarks>
  17543. Creates a new StringWriter instance to store the formatted logging event.
  17544. </remarks>
  17545. </member>
  17546. <member name="P:log4net.Layout.LayoutSkeleton.ContentType">
  17547. <summary>
  17548. The content type output by this layout.
  17549. </summary>
  17550. <value>The content type is <c>"text/plain"</c></value>
  17551. <remarks>
  17552. <para>
  17553. The content type output by this layout.
  17554. </para>
  17555. <para>
  17556. This base class uses the value <c>"text/plain"</c>.
  17557. To change this value a subclass must override this
  17558. property.
  17559. </para>
  17560. </remarks>
  17561. </member>
  17562. <member name="P:log4net.Layout.LayoutSkeleton.Header">
  17563. <summary>
  17564. The header for the layout format.
  17565. </summary>
  17566. <value>the layout header</value>
  17567. <remarks>
  17568. <para>
  17569. The Header text will be appended before any logging events
  17570. are formatted and appended.
  17571. </para>
  17572. </remarks>
  17573. </member>
  17574. <member name="P:log4net.Layout.LayoutSkeleton.Footer">
  17575. <summary>
  17576. The footer for the layout format.
  17577. </summary>
  17578. <value>the layout footer</value>
  17579. <remarks>
  17580. <para>
  17581. The Footer text will be appended after all the logging events
  17582. have been formatted and appended.
  17583. </para>
  17584. </remarks>
  17585. </member>
  17586. <member name="P:log4net.Layout.LayoutSkeleton.IgnoresException">
  17587. <summary>
  17588. Flag indicating if this layout handles exceptions
  17589. </summary>
  17590. <value><c>false</c> if this layout handles exceptions</value>
  17591. <remarks>
  17592. <para>
  17593. If this layout handles the exception object contained within
  17594. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  17595. <c>false</c>. Otherwise, if the layout ignores the exception
  17596. object, then the layout should return <c>true</c>.
  17597. </para>
  17598. <para>
  17599. Set this value to override a this default setting. The default
  17600. value is <c>true</c>, this layout does not handle the exception.
  17601. </para>
  17602. </remarks>
  17603. </member>
  17604. <member name="T:log4net.Layout.PatternLayout">
  17605. <summary>
  17606. A flexible layout configurable with pattern string.
  17607. </summary>
  17608. <remarks>
  17609. <para>
  17610. The goal of this class is to <see cref="M:PatternLayout.Format(TextWriter,LoggingEvent)"/> a
  17611. <see cref="T:log4net.Core.LoggingEvent"/> as a string. The results
  17612. depend on the <i>conversion pattern</i>.
  17613. </para>
  17614. <para>
  17615. The conversion pattern is closely related to the conversion
  17616. pattern of the printf function in C. A conversion pattern is
  17617. composed of literal text and format control expressions called
  17618. <i>conversion specifiers</i>.
  17619. </para>
  17620. <para>
  17621. <i>You are free to insert any literal text within the conversion
  17622. pattern.</i>
  17623. </para>
  17624. <para>
  17625. Each conversion specifier starts with a percent sign (%) and is
  17626. followed by optional <i>format modifiers</i> and a <i>conversion
  17627. pattern name</i>. The conversion pattern name specifies the type of
  17628. data, e.g. logger, level, date, thread name. The format
  17629. modifiers control such things as field width, padding, left and
  17630. right justification. The following is a simple example.
  17631. </para>
  17632. <para>
  17633. Let the conversion pattern be <b>"%-5level [%thread]: %message%newline"</b> and assume
  17634. that the log4net environment was set to use a PatternLayout. Then the
  17635. statements
  17636. </para>
  17637. <code lang="C#">
  17638. ILog log = LogManager.GetLogger(typeof(TestApp));
  17639. log.Debug("Message 1");
  17640. log.Warn("Message 2");
  17641. </code>
  17642. <para>would yield the output</para>
  17643. <code>
  17644. DEBUG [main]: Message 1
  17645. WARN [main]: Message 2
  17646. </code>
  17647. <para>
  17648. Note that there is no explicit separator between text and
  17649. conversion specifiers. The pattern parser knows when it has reached
  17650. the end of a conversion specifier when it reads a conversion
  17651. character. In the example above the conversion specifier
  17652. <b>%-5level</b> means the level of the logging event should be left
  17653. justified to a width of five characters.
  17654. </para>
  17655. <para>
  17656. The recognized conversion pattern names are:
  17657. </para>
  17658. <list type="table">
  17659. <listheader>
  17660. <term>Conversion Pattern Name</term>
  17661. <description>Effect</description>
  17662. </listheader>
  17663. <item>
  17664. <term>a</term>
  17665. <description>Equivalent to <b>appdomain</b></description>
  17666. </item>
  17667. <item>
  17668. <term>appdomain</term>
  17669. <description>
  17670. Used to output the friendly name of the AppDomain where the
  17671. logging event was generated.
  17672. </description>
  17673. </item>
  17674. <item>
  17675. <term>aspnet-cache</term>
  17676. <description>
  17677. <para>
  17678. 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>
  17679. </para>
  17680. <para>
  17681. This pattern is not available for Compact Framework or Client Profile assemblies.
  17682. </para>
  17683. </description>
  17684. </item>
  17685. <item>
  17686. <term>aspnet-context</term>
  17687. <description>
  17688. <para>
  17689. 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>
  17690. </para>
  17691. <para>
  17692. This pattern is not available for Compact Framework or Client Profile assemblies.
  17693. </para>
  17694. </description>
  17695. </item>
  17696. <item>
  17697. <term>aspnet-request</term>
  17698. <description>
  17699. <para>
  17700. 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>
  17701. </para>
  17702. <para>
  17703. This pattern is not available for Compact Framework or Client Profile assemblies.
  17704. </para>
  17705. </description>
  17706. </item>
  17707. <item>
  17708. <term>aspnet-session</term>
  17709. <description>
  17710. <para>
  17711. 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>
  17712. </para>
  17713. <para>
  17714. This pattern is not available for Compact Framework or Client Profile assemblies.
  17715. </para>
  17716. </description>
  17717. </item>
  17718. <item>
  17719. <term>c</term>
  17720. <description>Equivalent to <b>logger</b></description>
  17721. </item>
  17722. <item>
  17723. <term>C</term>
  17724. <description>Equivalent to <b>type</b></description>
  17725. </item>
  17726. <item>
  17727. <term>class</term>
  17728. <description>Equivalent to <b>type</b></description>
  17729. </item>
  17730. <item>
  17731. <term>d</term>
  17732. <description>Equivalent to <b>date</b></description>
  17733. </item>
  17734. <item>
  17735. <term>date</term>
  17736. <description>
  17737. <para>
  17738. Used to output the date of the logging event in the local time zone.
  17739. To output the date in universal time use the <c>%utcdate</c> pattern.
  17740. The date conversion
  17741. specifier may be followed by a <i>date format specifier</i> enclosed
  17742. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  17743. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  17744. given then ISO8601 format is
  17745. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  17746. </para>
  17747. <para>
  17748. The date format specifier admits the same syntax as the
  17749. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  17750. </para>
  17751. <para>
  17752. For better results it is recommended to use the log4net date
  17753. formatters. These can be specified using one of the strings
  17754. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  17755. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  17756. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  17757. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  17758. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  17759. </para>
  17760. <para>
  17761. These dedicated date formatters perform significantly
  17762. better than <see cref="M:DateTime.ToString(string)"/>.
  17763. </para>
  17764. </description>
  17765. </item>
  17766. <item>
  17767. <term>exception</term>
  17768. <description>
  17769. <para>
  17770. Used to output the exception passed in with the log message.
  17771. </para>
  17772. <para>
  17773. If an exception object is stored in the logging event
  17774. it will be rendered into the pattern output with a
  17775. trailing newline.
  17776. If there is no exception then nothing will be output
  17777. and no trailing newline will be appended.
  17778. It is typical to put a newline before the exception
  17779. and to have the exception as the last data in the pattern.
  17780. </para>
  17781. </description>
  17782. </item>
  17783. <item>
  17784. <term>F</term>
  17785. <description>Equivalent to <b>file</b></description>
  17786. </item>
  17787. <item>
  17788. <term>file</term>
  17789. <description>
  17790. <para>
  17791. Used to output the file name where the logging request was
  17792. issued.
  17793. </para>
  17794. <para>
  17795. <b>WARNING</b> Generating caller location information is
  17796. extremely slow. Its use should be avoided unless execution speed
  17797. is not an issue.
  17798. </para>
  17799. <para>
  17800. See the note below on the availability of caller location information.
  17801. </para>
  17802. </description>
  17803. </item>
  17804. <item>
  17805. <term>identity</term>
  17806. <description>
  17807. <para>
  17808. Used to output the user name for the currently active user
  17809. (Principal.Identity.Name).
  17810. </para>
  17811. <para>
  17812. <b>WARNING</b> Generating caller information is
  17813. extremely slow. Its use should be avoided unless execution speed
  17814. is not an issue.
  17815. </para>
  17816. </description>
  17817. </item>
  17818. <item>
  17819. <term>l</term>
  17820. <description>Equivalent to <b>location</b></description>
  17821. </item>
  17822. <item>
  17823. <term>L</term>
  17824. <description>Equivalent to <b>line</b></description>
  17825. </item>
  17826. <item>
  17827. <term>location</term>
  17828. <description>
  17829. <para>
  17830. Used to output location information of the caller which generated
  17831. the logging event.
  17832. </para>
  17833. <para>
  17834. The location information depends on the CLI implementation but
  17835. usually consists of the fully qualified name of the calling
  17836. method followed by the callers source the file name and line
  17837. number between parentheses.
  17838. </para>
  17839. <para>
  17840. The location information can be very useful. However, its
  17841. generation is <b>extremely</b> slow. Its use should be avoided
  17842. unless execution speed is not an issue.
  17843. </para>
  17844. <para>
  17845. See the note below on the availability of caller location information.
  17846. </para>
  17847. </description>
  17848. </item>
  17849. <item>
  17850. <term>level</term>
  17851. <description>
  17852. <para>
  17853. Used to output the level of the logging event.
  17854. </para>
  17855. </description>
  17856. </item>
  17857. <item>
  17858. <term>line</term>
  17859. <description>
  17860. <para>
  17861. Used to output the line number from where the logging request
  17862. was issued.
  17863. </para>
  17864. <para>
  17865. <b>WARNING</b> Generating caller location information is
  17866. extremely slow. Its use should be avoided unless execution speed
  17867. is not an issue.
  17868. </para>
  17869. <para>
  17870. See the note below on the availability of caller location information.
  17871. </para>
  17872. </description>
  17873. </item>
  17874. <item>
  17875. <term>logger</term>
  17876. <description>
  17877. <para>
  17878. Used to output the logger of the logging event. The
  17879. logger conversion specifier can be optionally followed by
  17880. <i>precision specifier</i>, that is a decimal constant in
  17881. brackets.
  17882. </para>
  17883. <para>
  17884. If a precision specifier is given, then only the corresponding
  17885. number of right most components of the logger name will be
  17886. printed. By default the logger name is printed in full.
  17887. </para>
  17888. <para>
  17889. For example, for the logger name "a.b.c" the pattern
  17890. <b>%logger{2}</b> will output "b.c".
  17891. </para>
  17892. </description>
  17893. </item>
  17894. <item>
  17895. <term>m</term>
  17896. <description>Equivalent to <b>message</b></description>
  17897. </item>
  17898. <item>
  17899. <term>M</term>
  17900. <description>Equivalent to <b>method</b></description>
  17901. </item>
  17902. <item>
  17903. <term>message</term>
  17904. <description>
  17905. <para>
  17906. Used to output the application supplied message associated with
  17907. the logging event.
  17908. </para>
  17909. </description>
  17910. </item>
  17911. <item>
  17912. <term>mdc</term>
  17913. <description>
  17914. <para>
  17915. The MDC (old name for the ThreadContext.Properties) is now part of the
  17916. combined event properties. This pattern is supported for compatibility
  17917. but is equivalent to <b>property</b>.
  17918. </para>
  17919. </description>
  17920. </item>
  17921. <item>
  17922. <term>method</term>
  17923. <description>
  17924. <para>
  17925. Used to output the method name where the logging request was
  17926. issued.
  17927. </para>
  17928. <para>
  17929. <b>WARNING</b> Generating caller location information is
  17930. extremely slow. Its use should be avoided unless execution speed
  17931. is not an issue.
  17932. </para>
  17933. <para>
  17934. See the note below on the availability of caller location information.
  17935. </para>
  17936. </description>
  17937. </item>
  17938. <item>
  17939. <term>n</term>
  17940. <description>Equivalent to <b>newline</b></description>
  17941. </item>
  17942. <item>
  17943. <term>newline</term>
  17944. <description>
  17945. <para>
  17946. Outputs the platform dependent line separator character or
  17947. characters.
  17948. </para>
  17949. <para>
  17950. This conversion pattern offers the same performance as using
  17951. non-portable line separator strings such as "\n", or "\r\n".
  17952. Thus, it is the preferred way of specifying a line separator.
  17953. </para>
  17954. </description>
  17955. </item>
  17956. <item>
  17957. <term>ndc</term>
  17958. <description>
  17959. <para>
  17960. Used to output the NDC (nested diagnostic context) associated
  17961. with the thread that generated the logging event.
  17962. </para>
  17963. </description>
  17964. </item>
  17965. <item>
  17966. <term>p</term>
  17967. <description>Equivalent to <b>level</b></description>
  17968. </item>
  17969. <item>
  17970. <term>P</term>
  17971. <description>Equivalent to <b>property</b></description>
  17972. </item>
  17973. <item>
  17974. <term>properties</term>
  17975. <description>Equivalent to <b>property</b></description>
  17976. </item>
  17977. <item>
  17978. <term>property</term>
  17979. <description>
  17980. <para>
  17981. Used to output the an event specific property. The key to
  17982. lookup must be specified within braces and directly following the
  17983. pattern specifier, e.g. <b>%property{user}</b> would include the value
  17984. from the property that is keyed by the string 'user'. Each property value
  17985. that is to be included in the log must be specified separately.
  17986. Properties are added to events by loggers or appenders. By default
  17987. the <c>log4net:HostName</c> property is set to the name of machine on
  17988. which the event was originally logged.
  17989. </para>
  17990. <para>
  17991. If no key is specified, e.g. <b>%property</b> then all the keys and their
  17992. values are printed in a comma separated list.
  17993. </para>
  17994. <para>
  17995. The properties of an event are combined from a number of different
  17996. contexts. These are listed below in the order in which they are searched.
  17997. </para>
  17998. <list type="definition">
  17999. <item>
  18000. <term>the event properties</term>
  18001. <description>
  18002. The event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  18003. properties are specific to this event only.
  18004. </description>
  18005. </item>
  18006. <item>
  18007. <term>the thread properties</term>
  18008. <description>
  18009. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  18010. thread. These properties are shared by all events logged on this thread.
  18011. </description>
  18012. </item>
  18013. <item>
  18014. <term>the global properties</term>
  18015. <description>
  18016. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  18017. properties are shared by all the threads in the AppDomain.
  18018. </description>
  18019. </item>
  18020. </list>
  18021. </description>
  18022. </item>
  18023. <item>
  18024. <term>r</term>
  18025. <description>Equivalent to <b>timestamp</b></description>
  18026. </item>
  18027. <item>
  18028. <term>stacktrace</term>
  18029. <description>
  18030. <para>
  18031. Used to output the stack trace of the logging event
  18032. The stack trace level specifier may be enclosed
  18033. between braces. For example, <b>%stacktrace{level}</b>.
  18034. If no stack trace level specifier is given then 1 is assumed
  18035. </para>
  18036. <para>
  18037. Output uses the format:
  18038. type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1
  18039. </para>
  18040. <para>
  18041. This pattern is not available for Compact Framework assemblies.
  18042. </para>
  18043. </description>
  18044. </item>
  18045. <item>
  18046. <term>stacktracedetail</term>
  18047. <description>
  18048. <para>
  18049. Used to output the stack trace of the logging event
  18050. The stack trace level specifier may be enclosed
  18051. between braces. For example, <b>%stacktracedetail{level}</b>.
  18052. If no stack trace level specifier is given then 1 is assumed
  18053. </para>
  18054. <para>
  18055. Output uses the format:
  18056. type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...)
  18057. </para>
  18058. <para>
  18059. This pattern is not available for Compact Framework assemblies.
  18060. </para>
  18061. </description>
  18062. </item>
  18063. <item>
  18064. <term>t</term>
  18065. <description>Equivalent to <b>thread</b></description>
  18066. </item>
  18067. <item>
  18068. <term>timestamp</term>
  18069. <description>
  18070. <para>
  18071. Used to output the number of milliseconds elapsed since the start
  18072. of the application until the creation of the logging event.
  18073. </para>
  18074. </description>
  18075. </item>
  18076. <item>
  18077. <term>thread</term>
  18078. <description>
  18079. <para>
  18080. Used to output the name of the thread that generated the
  18081. logging event. Uses the thread number if no name is available.
  18082. </para>
  18083. </description>
  18084. </item>
  18085. <item>
  18086. <term>type</term>
  18087. <description>
  18088. <para>
  18089. Used to output the fully qualified type name of the caller
  18090. issuing the logging request. This conversion specifier
  18091. can be optionally followed by <i>precision specifier</i>, that
  18092. is a decimal constant in brackets.
  18093. </para>
  18094. <para>
  18095. If a precision specifier is given, then only the corresponding
  18096. number of right most components of the class name will be
  18097. printed. By default the class name is output in fully qualified form.
  18098. </para>
  18099. <para>
  18100. For example, for the class name "log4net.Layout.PatternLayout", the
  18101. pattern <b>%type{1}</b> will output "PatternLayout".
  18102. </para>
  18103. <para>
  18104. <b>WARNING</b> Generating the caller class information is
  18105. slow. Thus, its use should be avoided unless execution speed is
  18106. not an issue.
  18107. </para>
  18108. <para>
  18109. See the note below on the availability of caller location information.
  18110. </para>
  18111. </description>
  18112. </item>
  18113. <item>
  18114. <term>u</term>
  18115. <description>Equivalent to <b>identity</b></description>
  18116. </item>
  18117. <item>
  18118. <term>username</term>
  18119. <description>
  18120. <para>
  18121. Used to output the WindowsIdentity for the currently
  18122. active user.
  18123. </para>
  18124. <para>
  18125. <b>WARNING</b> Generating caller WindowsIdentity information is
  18126. extremely slow. Its use should be avoided unless execution speed
  18127. is not an issue.
  18128. </para>
  18129. </description>
  18130. </item>
  18131. <item>
  18132. <term>utcdate</term>
  18133. <description>
  18134. <para>
  18135. Used to output the date of the logging event in universal time.
  18136. The date conversion
  18137. specifier may be followed by a <i>date format specifier</i> enclosed
  18138. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  18139. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  18140. given then ISO8601 format is
  18141. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  18142. </para>
  18143. <para>
  18144. The date format specifier admits the same syntax as the
  18145. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  18146. </para>
  18147. <para>
  18148. For better results it is recommended to use the log4net date
  18149. formatters. These can be specified using one of the strings
  18150. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  18151. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  18152. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  18153. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  18154. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  18155. </para>
  18156. <para>
  18157. These dedicated date formatters perform significantly
  18158. better than <see cref="M:DateTime.ToString(string)"/>.
  18159. </para>
  18160. </description>
  18161. </item>
  18162. <item>
  18163. <term>w</term>
  18164. <description>Equivalent to <b>username</b></description>
  18165. </item>
  18166. <item>
  18167. <term>x</term>
  18168. <description>Equivalent to <b>ndc</b></description>
  18169. </item>
  18170. <item>
  18171. <term>X</term>
  18172. <description>Equivalent to <b>mdc</b></description>
  18173. </item>
  18174. <item>
  18175. <term>%</term>
  18176. <description>
  18177. <para>
  18178. The sequence %% outputs a single percent sign.
  18179. </para>
  18180. </description>
  18181. </item>
  18182. </list>
  18183. <para>
  18184. The single letter patterns are deprecated in favor of the
  18185. longer more descriptive pattern names.
  18186. </para>
  18187. <para>
  18188. By default the relevant information is output as is. However,
  18189. with the aid of format modifiers it is possible to change the
  18190. minimum field width, the maximum field width and justification.
  18191. </para>
  18192. <para>
  18193. The optional format modifier is placed between the percent sign
  18194. and the conversion pattern name.
  18195. </para>
  18196. <para>
  18197. The first optional format modifier is the <i>left justification
  18198. flag</i> which is just the minus (-) character. Then comes the
  18199. optional <i>minimum field width</i> modifier. This is a decimal
  18200. constant that represents the minimum number of characters to
  18201. output. If the data item requires fewer characters, it is padded on
  18202. either the left or the right until the minimum width is
  18203. reached. The default is to pad on the left (right justify) but you
  18204. can specify right padding with the left justification flag. The
  18205. padding character is space. If the data item is larger than the
  18206. minimum field width, the field is expanded to accommodate the
  18207. data. The value is never truncated.
  18208. </para>
  18209. <para>
  18210. This behavior can be changed using the <i>maximum field
  18211. width</i> modifier which is designated by a period followed by a
  18212. decimal constant. If the data item is longer than the maximum
  18213. field, then the extra characters are removed from the
  18214. <i>beginning</i> of the data item and not from the end. For
  18215. example, it the maximum field width is eight and the data item is
  18216. ten characters long, then the first two characters of the data item
  18217. are dropped. This behavior deviates from the printf function in C
  18218. where truncation is done from the end.
  18219. </para>
  18220. <para>
  18221. Below are various format modifier examples for the logger
  18222. conversion specifier.
  18223. </para>
  18224. <div class="tablediv">
  18225. <table class="dtTABLE" cellspacing="0">
  18226. <tr>
  18227. <th>Format modifier</th>
  18228. <th>left justify</th>
  18229. <th>minimum width</th>
  18230. <th>maximum width</th>
  18231. <th>comment</th>
  18232. </tr>
  18233. <tr>
  18234. <td align="center">%20logger</td>
  18235. <td align="center">false</td>
  18236. <td align="center">20</td>
  18237. <td align="center">none</td>
  18238. <td>
  18239. <para>
  18240. Left pad with spaces if the logger name is less than 20
  18241. characters long.
  18242. </para>
  18243. </td>
  18244. </tr>
  18245. <tr>
  18246. <td align="center">%-20logger</td>
  18247. <td align="center">true</td>
  18248. <td align="center">20</td>
  18249. <td align="center">none</td>
  18250. <td>
  18251. <para>
  18252. Right pad with spaces if the logger
  18253. name is less than 20 characters long.
  18254. </para>
  18255. </td>
  18256. </tr>
  18257. <tr>
  18258. <td align="center">%.30logger</td>
  18259. <td align="center">NA</td>
  18260. <td align="center">none</td>
  18261. <td align="center">30</td>
  18262. <td>
  18263. <para>
  18264. Truncate from the beginning if the logger
  18265. name is longer than 30 characters.
  18266. </para>
  18267. </td>
  18268. </tr>
  18269. <tr>
  18270. <td align="center"><nobr>%20.30logger</nobr></td>
  18271. <td align="center">false</td>
  18272. <td align="center">20</td>
  18273. <td align="center">30</td>
  18274. <td>
  18275. <para>
  18276. Left pad with spaces if the logger name is shorter than 20
  18277. characters. However, if logger name is longer than 30 characters,
  18278. then truncate from the beginning.
  18279. </para>
  18280. </td>
  18281. </tr>
  18282. <tr>
  18283. <td align="center">%-20.30logger</td>
  18284. <td align="center">true</td>
  18285. <td align="center">20</td>
  18286. <td align="center">30</td>
  18287. <td>
  18288. <para>
  18289. Right pad with spaces if the logger name is shorter than 20
  18290. characters. However, if logger name is longer than 30 characters,
  18291. then truncate from the beginning.
  18292. </para>
  18293. </td>
  18294. </tr>
  18295. </table>
  18296. </div>
  18297. <para>
  18298. <b>Note about caller location information.</b><br />
  18299. The following patterns <c>%type %file %line %method %location %class %C %F %L %l %M</c>
  18300. all generate caller location information.
  18301. Location information uses the <c>System.Diagnostics.StackTrace</c> class to generate
  18302. a call stack. The caller's information is then extracted from this stack.
  18303. </para>
  18304. <note type="caution">
  18305. <para>
  18306. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  18307. .NET Compact Framework 1.0 therefore caller location information is not
  18308. available on that framework.
  18309. </para>
  18310. </note>
  18311. <note type="caution">
  18312. <para>
  18313. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  18314. </para>
  18315. <para>
  18316. "StackTrace information will be most informative with Debug build configurations.
  18317. By default, Debug builds include debug symbols, while Release builds do not. The
  18318. debug symbols contain most of the file, method name, line number, and column
  18319. information used in constructing StackFrame and StackTrace objects. StackTrace
  18320. might not report as many method calls as expected, due to code transformations
  18321. that occur during optimization."
  18322. </para>
  18323. <para>
  18324. This means that in a Release build the caller information may be incomplete or may
  18325. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  18326. </para>
  18327. </note>
  18328. <para>
  18329. Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/>
  18330. instance using the <see cref="M:AddConverter(string, Type)"/> method.
  18331. </para>
  18332. </remarks>
  18333. <example>
  18334. This is a more detailed pattern.
  18335. <code><b>%timestamp [%thread] %level %logger %ndc - %message%newline</b></code>
  18336. </example>
  18337. <example>
  18338. A similar pattern except that the relative time is
  18339. right padded if less than 6 digits, thread name is right padded if
  18340. less than 15 characters and truncated if longer and the logger
  18341. name is left padded if shorter than 30 characters and truncated if
  18342. longer.
  18343. <code><b>%-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline</b></code>
  18344. </example>
  18345. <author>Nicko Cadell</author>
  18346. <author>Gert Driesen</author>
  18347. <author>Douglas de la Torre</author>
  18348. <author>Daniel Cazzulino</author>
  18349. </member>
  18350. <member name="F:log4net.Layout.PatternLayout.DefaultConversionPattern">
  18351. <summary>
  18352. Default pattern string for log output.
  18353. </summary>
  18354. <remarks>
  18355. <para>
  18356. Default pattern string for log output.
  18357. Currently set to the string <b>"%message%newline"</b>
  18358. which just prints the application supplied message.
  18359. </para>
  18360. </remarks>
  18361. </member>
  18362. <member name="F:log4net.Layout.PatternLayout.DetailConversionPattern">
  18363. <summary>
  18364. A detailed conversion pattern
  18365. </summary>
  18366. <remarks>
  18367. <para>
  18368. A conversion pattern which includes Time, Thread, Logger, and Nested Context.
  18369. Current value is <b>%timestamp [%thread] %level %logger %ndc - %message%newline</b>.
  18370. </para>
  18371. </remarks>
  18372. </member>
  18373. <member name="F:log4net.Layout.PatternLayout.s_globalRulesRegistry">
  18374. <summary>
  18375. Internal map of converter identifiers to converter types.
  18376. </summary>
  18377. <remarks>
  18378. <para>
  18379. This static map is overridden by the m_converterRegistry instance map
  18380. </para>
  18381. </remarks>
  18382. </member>
  18383. <member name="F:log4net.Layout.PatternLayout.m_pattern">
  18384. <summary>
  18385. the pattern
  18386. </summary>
  18387. </member>
  18388. <member name="F:log4net.Layout.PatternLayout.m_head">
  18389. <summary>
  18390. the head of the pattern converter chain
  18391. </summary>
  18392. </member>
  18393. <member name="F:log4net.Layout.PatternLayout.m_instanceRulesRegistry">
  18394. <summary>
  18395. patterns defined on this PatternLayout only
  18396. </summary>
  18397. </member>
  18398. <member name="M:log4net.Layout.PatternLayout.#cctor">
  18399. <summary>
  18400. Initialize the global registry
  18401. </summary>
  18402. <remarks>
  18403. <para>
  18404. Defines the builtin global rules.
  18405. </para>
  18406. </remarks>
  18407. </member>
  18408. <member name="M:log4net.Layout.PatternLayout.#ctor">
  18409. <summary>
  18410. Constructs a PatternLayout using the DefaultConversionPattern
  18411. </summary>
  18412. <remarks>
  18413. <para>
  18414. The default pattern just produces the application supplied message.
  18415. </para>
  18416. <para>
  18417. Note to Inheritors: This constructor calls the virtual method
  18418. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  18419. aware that it will be called before your is called constructor.
  18420. </para>
  18421. <para>
  18422. As per the <see cref="T:log4net.Core.IOptionHandler"/> contract the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>
  18423. method must be called after the properties on this object have been
  18424. configured.
  18425. </para>
  18426. </remarks>
  18427. </member>
  18428. <member name="M:log4net.Layout.PatternLayout.#ctor(System.String)">
  18429. <summary>
  18430. Constructs a PatternLayout using the supplied conversion pattern
  18431. </summary>
  18432. <param name="pattern">the pattern to use</param>
  18433. <remarks>
  18434. <para>
  18435. Note to Inheritors: This constructor calls the virtual method
  18436. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  18437. aware that it will be called before your is called constructor.
  18438. </para>
  18439. <para>
  18440. When using this constructor the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method
  18441. need not be called. This may not be the case when using a subclass.
  18442. </para>
  18443. </remarks>
  18444. </member>
  18445. <member name="P:log4net.Layout.PatternLayout.ConversionPattern">
  18446. <summary>
  18447. The pattern formatting string
  18448. </summary>
  18449. <remarks>
  18450. <para>
  18451. The <b>ConversionPattern</b> option. This is the string which
  18452. controls formatting and consists of a mix of literal content and
  18453. conversion specifiers.
  18454. </para>
  18455. </remarks>
  18456. </member>
  18457. <member name="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)">
  18458. <summary>
  18459. Create the pattern parser instance
  18460. </summary>
  18461. <param name="pattern">the pattern to parse</param>
  18462. <returns>The <see cref="T:log4net.Util.PatternParser"/> that will format the event</returns>
  18463. <remarks>
  18464. <para>
  18465. Creates the <see cref="T:log4net.Util.PatternParser"/> used to parse the conversion string. Sets the
  18466. global and instance rules on the <see cref="T:log4net.Util.PatternParser"/>.
  18467. </para>
  18468. </remarks>
  18469. </member>
  18470. <member name="M:log4net.Layout.PatternLayout.ActivateOptions">
  18471. <summary>
  18472. Initialize layout options
  18473. </summary>
  18474. <remarks>
  18475. <para>
  18476. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  18477. activation scheme. The <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method must
  18478. be called on this object after the configuration properties have
  18479. been set. Until <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> is called this
  18480. object is in an undefined state and must not be used.
  18481. </para>
  18482. <para>
  18483. If any of the configuration properties are modified then
  18484. <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> must be called again.
  18485. </para>
  18486. </remarks>
  18487. </member>
  18488. <member name="M:log4net.Layout.PatternLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18489. <summary>
  18490. Produces a formatted string as specified by the conversion pattern.
  18491. </summary>
  18492. <param name="loggingEvent">the event being logged</param>
  18493. <param name="writer">The TextWriter to write the formatted event to</param>
  18494. <remarks>
  18495. <para>
  18496. Parse the <see cref="T:log4net.Core.LoggingEvent"/> using the patter format
  18497. specified in the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> property.
  18498. </para>
  18499. </remarks>
  18500. </member>
  18501. <member name="M:log4net.Layout.PatternLayout.AddConverter(log4net.Util.ConverterInfo)">
  18502. <summary>
  18503. Add a converter to this PatternLayout
  18504. </summary>
  18505. <param name="converterInfo">the converter info</param>
  18506. <remarks>
  18507. <para>
  18508. This version of the method is used by the configurator.
  18509. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  18510. </para>
  18511. </remarks>
  18512. </member>
  18513. <member name="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)">
  18514. <summary>
  18515. Add a converter to this PatternLayout
  18516. </summary>
  18517. <param name="name">the name of the conversion pattern for this converter</param>
  18518. <param name="type">the type of the converter</param>
  18519. <remarks>
  18520. <para>
  18521. Add a named pattern converter to this instance. This
  18522. converter will be used in the formatting of the event.
  18523. This method must be called before <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>.
  18524. </para>
  18525. <para>
  18526. The <paramref name="type"/> specified must extend the
  18527. <see cref="T:log4net.Util.PatternConverter"/> type.
  18528. </para>
  18529. </remarks>
  18530. </member>
  18531. <member name="T:log4net.Layout.Pattern.AppDomainPatternConverter">
  18532. <summary>
  18533. Write the event appdomain name to the output
  18534. </summary>
  18535. <remarks>
  18536. <para>
  18537. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output writer.
  18538. </para>
  18539. </remarks>
  18540. <author>Daniel Cazzulino</author>
  18541. <author>Nicko Cadell</author>
  18542. </member>
  18543. <member name="M:log4net.Layout.Pattern.AppDomainPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18544. <summary>
  18545. Write the event appdomain name to the output
  18546. </summary>
  18547. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18548. <param name="loggingEvent">the event being logged</param>
  18549. <remarks>
  18550. <para>
  18551. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output <paramref name="writer"/>.
  18552. </para>
  18553. </remarks>
  18554. </member>
  18555. <member name="T:log4net.Layout.Pattern.DatePatternConverter">
  18556. <summary>
  18557. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  18558. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  18559. </summary>
  18560. <remarks>
  18561. <para>
  18562. Render the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the writer as a string.
  18563. </para>
  18564. <para>
  18565. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  18566. the formatting of the date. The following values are allowed:
  18567. <list type="definition">
  18568. <listheader>
  18569. <term>Option value</term>
  18570. <description>Output</description>
  18571. </listheader>
  18572. <item>
  18573. <term>ISO8601</term>
  18574. <description>
  18575. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  18576. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  18577. </description>
  18578. </item>
  18579. <item>
  18580. <term>DATE</term>
  18581. <description>
  18582. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  18583. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  18584. </description>
  18585. </item>
  18586. <item>
  18587. <term>ABSOLUTE</term>
  18588. <description>
  18589. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  18590. Formats using the <c>"HH:mm:ss,yyyy"</c> for example, <c>"15:49:37,459"</c>.
  18591. </description>
  18592. </item>
  18593. <item>
  18594. <term>other</term>
  18595. <description>
  18596. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  18597. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  18598. <see cref="M:DateTime.ToString(string)"/> method.
  18599. For details on valid patterns see
  18600. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  18601. </description>
  18602. </item>
  18603. </list>
  18604. </para>
  18605. <para>
  18606. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> is in the local time zone and is rendered in that zone.
  18607. To output the time in Universal time see <see cref="T:log4net.Layout.Pattern.UtcDatePatternConverter"/>.
  18608. </para>
  18609. </remarks>
  18610. <author>Nicko Cadell</author>
  18611. </member>
  18612. <member name="F:log4net.Layout.Pattern.DatePatternConverter.m_dateFormatter">
  18613. <summary>
  18614. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  18615. </summary>
  18616. <remarks>
  18617. <para>
  18618. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  18619. </para>
  18620. </remarks>
  18621. </member>
  18622. <member name="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions">
  18623. <summary>
  18624. Initialize the converter pattern based on the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  18625. </summary>
  18626. <remarks>
  18627. <para>
  18628. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  18629. activation scheme. The <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> method must
  18630. be called on this object after the configuration properties have
  18631. been set. Until <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> is called this
  18632. object is in an undefined state and must not be used.
  18633. </para>
  18634. <para>
  18635. If any of the configuration properties are modified then
  18636. <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> must be called again.
  18637. </para>
  18638. </remarks>
  18639. </member>
  18640. <member name="M:log4net.Layout.Pattern.DatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18641. <summary>
  18642. Convert the pattern into the rendered message
  18643. </summary>
  18644. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18645. <param name="loggingEvent">the event being logged</param>
  18646. <remarks>
  18647. <para>
  18648. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  18649. for it to render it to the writer.
  18650. </para>
  18651. <para>
  18652. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone.
  18653. </para>
  18654. </remarks>
  18655. </member>
  18656. <member name="F:log4net.Layout.Pattern.DatePatternConverter.declaringType">
  18657. <summary>
  18658. The fully qualified type of the DatePatternConverter class.
  18659. </summary>
  18660. <remarks>
  18661. Used by the internal logger to record the Type of the
  18662. log message.
  18663. </remarks>
  18664. </member>
  18665. <member name="T:log4net.Layout.Pattern.ExceptionPatternConverter">
  18666. <summary>
  18667. Write the exception text to the output
  18668. </summary>
  18669. <remarks>
  18670. <para>
  18671. If an exception object is stored in the logging event
  18672. it will be rendered into the pattern output with a
  18673. trailing newline.
  18674. </para>
  18675. <para>
  18676. If there is no exception then nothing will be output
  18677. and no trailing newline will be appended.
  18678. It is typical to put a newline before the exception
  18679. and to have the exception as the last data in the pattern.
  18680. </para>
  18681. </remarks>
  18682. <author>Nicko Cadell</author>
  18683. </member>
  18684. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.#ctor">
  18685. <summary>
  18686. Default constructor
  18687. </summary>
  18688. </member>
  18689. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18690. <summary>
  18691. Write the exception text to the output
  18692. </summary>
  18693. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18694. <param name="loggingEvent">the event being logged</param>
  18695. <remarks>
  18696. <para>
  18697. If an exception object is stored in the logging event
  18698. it will be rendered into the pattern output with a
  18699. trailing newline.
  18700. </para>
  18701. <para>
  18702. If there is no exception or the exception property specified
  18703. by the Option value does not exist then nothing will be output
  18704. and no trailing newline will be appended.
  18705. It is typical to put a newline before the exception
  18706. and to have the exception as the last data in the pattern.
  18707. </para>
  18708. <para>
  18709. Recognized values for the Option parameter are:
  18710. </para>
  18711. <list type="bullet">
  18712. <item>
  18713. <description>Message</description>
  18714. </item>
  18715. <item>
  18716. <description>Source</description>
  18717. </item>
  18718. <item>
  18719. <description>StackTrace</description>
  18720. </item>
  18721. <item>
  18722. <description>TargetSite</description>
  18723. </item>
  18724. <item>
  18725. <description>HelpLink</description>
  18726. </item>
  18727. </list>
  18728. </remarks>
  18729. </member>
  18730. <member name="T:log4net.Layout.Pattern.FileLocationPatternConverter">
  18731. <summary>
  18732. Writes the caller location file name to the output
  18733. </summary>
  18734. <remarks>
  18735. <para>
  18736. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  18737. the event to the output writer.
  18738. </para>
  18739. </remarks>
  18740. <author>Nicko Cadell</author>
  18741. </member>
  18742. <member name="M:log4net.Layout.Pattern.FileLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18743. <summary>
  18744. Write the caller location file name to the output
  18745. </summary>
  18746. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18747. <param name="loggingEvent">the event being logged</param>
  18748. <remarks>
  18749. <para>
  18750. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  18751. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  18752. </para>
  18753. </remarks>
  18754. </member>
  18755. <member name="T:log4net.Layout.Pattern.FullLocationPatternConverter">
  18756. <summary>
  18757. Write the caller location info to the output
  18758. </summary>
  18759. <remarks>
  18760. <para>
  18761. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  18762. </para>
  18763. </remarks>
  18764. <author>Nicko Cadell</author>
  18765. </member>
  18766. <member name="M:log4net.Layout.Pattern.FullLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18767. <summary>
  18768. Write the caller location info to the output
  18769. </summary>
  18770. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18771. <param name="loggingEvent">the event being logged</param>
  18772. <remarks>
  18773. <para>
  18774. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  18775. </para>
  18776. </remarks>
  18777. </member>
  18778. <member name="T:log4net.Layout.Pattern.IdentityPatternConverter">
  18779. <summary>
  18780. Writes the event identity to the output
  18781. </summary>
  18782. <remarks>
  18783. <para>
  18784. Writes the value of the <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  18785. the output writer.
  18786. </para>
  18787. </remarks>
  18788. <author>Daniel Cazzulino</author>
  18789. <author>Nicko Cadell</author>
  18790. </member>
  18791. <member name="M:log4net.Layout.Pattern.IdentityPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18792. <summary>
  18793. Writes the event identity to the output
  18794. </summary>
  18795. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18796. <param name="loggingEvent">the event being logged</param>
  18797. <remarks>
  18798. <para>
  18799. Writes the value of the <paramref name="loggingEvent"/>
  18800. <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  18801. the output <paramref name="writer"/>.
  18802. </para>
  18803. </remarks>
  18804. </member>
  18805. <member name="T:log4net.Layout.Pattern.LevelPatternConverter">
  18806. <summary>
  18807. Write the event level to the output
  18808. </summary>
  18809. <remarks>
  18810. <para>
  18811. Writes the display name of the event <see cref="P:log4net.Core.LoggingEvent.Level"/>
  18812. to the writer.
  18813. </para>
  18814. </remarks>
  18815. <author>Nicko Cadell</author>
  18816. </member>
  18817. <member name="M:log4net.Layout.Pattern.LevelPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18818. <summary>
  18819. Write the event level to the output
  18820. </summary>
  18821. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18822. <param name="loggingEvent">the event being logged</param>
  18823. <remarks>
  18824. <para>
  18825. Writes the <see cref="P:log4net.Core.Level.DisplayName"/> of the <paramref name="loggingEvent"/> <see cref="P:log4net.Core.LoggingEvent.Level"/>
  18826. to the <paramref name="writer"/>.
  18827. </para>
  18828. </remarks>
  18829. </member>
  18830. <member name="T:log4net.Layout.Pattern.LineLocationPatternConverter">
  18831. <summary>
  18832. Write the caller location line number to the output
  18833. </summary>
  18834. <remarks>
  18835. <para>
  18836. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  18837. the event to the output writer.
  18838. </para>
  18839. </remarks>
  18840. <author>Nicko Cadell</author>
  18841. </member>
  18842. <member name="M:log4net.Layout.Pattern.LineLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18843. <summary>
  18844. Write the caller location line number to the output
  18845. </summary>
  18846. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18847. <param name="loggingEvent">the event being logged</param>
  18848. <remarks>
  18849. <para>
  18850. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  18851. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  18852. </para>
  18853. </remarks>
  18854. </member>
  18855. <member name="T:log4net.Layout.Pattern.LoggerPatternConverter">
  18856. <summary>
  18857. Converter for logger name
  18858. </summary>
  18859. <remarks>
  18860. <para>
  18861. Outputs the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the event.
  18862. </para>
  18863. </remarks>
  18864. <author>Nicko Cadell</author>
  18865. </member>
  18866. <member name="M:log4net.Layout.Pattern.LoggerPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  18867. <summary>
  18868. Gets the fully qualified name of the logger
  18869. </summary>
  18870. <param name="loggingEvent">the event being logged</param>
  18871. <returns>The fully qualified logger name</returns>
  18872. <remarks>
  18873. <para>
  18874. Returns the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <paramref name="loggingEvent"/>.
  18875. </para>
  18876. </remarks>
  18877. </member>
  18878. <member name="T:log4net.Layout.Pattern.MessagePatternConverter">
  18879. <summary>
  18880. Writes the event message to the output
  18881. </summary>
  18882. <remarks>
  18883. <para>
  18884. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  18885. to write out the event message.
  18886. </para>
  18887. </remarks>
  18888. <author>Nicko Cadell</author>
  18889. </member>
  18890. <member name="M:log4net.Layout.Pattern.MessagePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18891. <summary>
  18892. Writes the event message to the output
  18893. </summary>
  18894. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18895. <param name="loggingEvent">the event being logged</param>
  18896. <remarks>
  18897. <para>
  18898. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  18899. to write out the event message.
  18900. </para>
  18901. </remarks>
  18902. </member>
  18903. <member name="T:log4net.Layout.Pattern.MethodLocationPatternConverter">
  18904. <summary>
  18905. Write the method name to the output
  18906. </summary>
  18907. <remarks>
  18908. <para>
  18909. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  18910. the output.
  18911. </para>
  18912. </remarks>
  18913. <author>Nicko Cadell</author>
  18914. </member>
  18915. <member name="M:log4net.Layout.Pattern.MethodLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18916. <summary>
  18917. Write the method name to the output
  18918. </summary>
  18919. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18920. <param name="loggingEvent">the event being logged</param>
  18921. <remarks>
  18922. <para>
  18923. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  18924. the output.
  18925. </para>
  18926. </remarks>
  18927. </member>
  18928. <member name="T:log4net.Layout.Pattern.NamedPatternConverter">
  18929. <summary>
  18930. Converter to output and truncate <c>'.'</c> separated strings
  18931. </summary>
  18932. <remarks>
  18933. <para>
  18934. This abstract class supports truncating a <c>'.'</c> separated string
  18935. to show a specified number of elements from the right hand side.
  18936. This is used to truncate class names that are fully qualified.
  18937. </para>
  18938. <para>
  18939. Subclasses should override the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> method to
  18940. return the fully qualified string.
  18941. </para>
  18942. </remarks>
  18943. <author>Nicko Cadell</author>
  18944. </member>
  18945. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions">
  18946. <summary>
  18947. Initialize the converter
  18948. </summary>
  18949. <remarks>
  18950. <para>
  18951. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  18952. activation scheme. The <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> method must
  18953. be called on this object after the configuration properties have
  18954. been set. Until <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> is called this
  18955. object is in an undefined state and must not be used.
  18956. </para>
  18957. <para>
  18958. If any of the configuration properties are modified then
  18959. <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> must be called again.
  18960. </para>
  18961. </remarks>
  18962. </member>
  18963. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  18964. <summary>
  18965. Get the fully qualified string data
  18966. </summary>
  18967. <param name="loggingEvent">the event being logged</param>
  18968. <returns>the fully qualified name</returns>
  18969. <remarks>
  18970. <para>
  18971. Overridden by subclasses to get the fully qualified name before the
  18972. precision is applied to it.
  18973. </para>
  18974. <para>
  18975. Return the fully qualified <c>'.'</c> (dot/period) separated string.
  18976. </para>
  18977. </remarks>
  18978. </member>
  18979. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18980. <summary>
  18981. Convert the pattern to the rendered message
  18982. </summary>
  18983. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  18984. <param name="loggingEvent">the event being logged</param>
  18985. <remarks>
  18986. Render the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> to the precision
  18987. specified by the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  18988. </remarks>
  18989. </member>
  18990. <member name="F:log4net.Layout.Pattern.NamedPatternConverter.declaringType">
  18991. <summary>
  18992. The fully qualified type of the NamedPatternConverter class.
  18993. </summary>
  18994. <remarks>
  18995. Used by the internal logger to record the Type of the
  18996. log message.
  18997. </remarks>
  18998. </member>
  18999. <member name="T:log4net.Layout.Pattern.NdcPatternConverter">
  19000. <summary>
  19001. Converter to include event NDC
  19002. </summary>
  19003. <remarks>
  19004. <para>
  19005. Outputs the value of the event property named <c>NDC</c>.
  19006. </para>
  19007. <para>
  19008. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  19009. </para>
  19010. </remarks>
  19011. <author>Nicko Cadell</author>
  19012. </member>
  19013. <member name="M:log4net.Layout.Pattern.NdcPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19014. <summary>
  19015. Write the event NDC to the output
  19016. </summary>
  19017. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19018. <param name="loggingEvent">the event being logged</param>
  19019. <remarks>
  19020. <para>
  19021. As the thread context stacks are now stored in named event properties
  19022. this converter simply looks up the value of the <c>NDC</c> property.
  19023. </para>
  19024. <para>
  19025. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  19026. </para>
  19027. </remarks>
  19028. </member>
  19029. <member name="T:log4net.Layout.Pattern.PatternLayoutConverter">
  19030. <summary>
  19031. Abstract class that provides the formatting functionality that
  19032. derived classes need.
  19033. </summary>
  19034. <remarks>
  19035. Conversion specifiers in a conversion patterns are parsed to
  19036. individual PatternConverters. Each of which is responsible for
  19037. converting a logging event in a converter specific manner.
  19038. </remarks>
  19039. <author>Nicko Cadell</author>
  19040. </member>
  19041. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.#ctor">
  19042. <summary>
  19043. Initializes a new instance of the <see cref="T:log4net.Layout.Pattern.PatternLayoutConverter" /> class.
  19044. </summary>
  19045. </member>
  19046. <member name="P:log4net.Layout.Pattern.PatternLayoutConverter.IgnoresException">
  19047. <summary>
  19048. Flag indicating if this converter handles the logging event exception
  19049. </summary>
  19050. <value><c>false</c> if this converter handles the logging event exception</value>
  19051. <remarks>
  19052. <para>
  19053. If this converter handles the exception object contained within
  19054. <see cref="T:log4net.Core.LoggingEvent"/>, then this property should be set to
  19055. <c>false</c>. Otherwise, if the layout ignores the exception
  19056. object, then the property should be set to <c>true</c>.
  19057. </para>
  19058. <para>
  19059. Set this value to override a this default setting. The default
  19060. value is <c>true</c>, this converter does not handle the exception.
  19061. </para>
  19062. </remarks>
  19063. </member>
  19064. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19065. <summary>
  19066. Derived pattern converters must override this method in order to
  19067. convert conversion specifiers in the correct way.
  19068. </summary>
  19069. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19070. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent" /> on which the pattern converter should be executed.</param>
  19071. </member>
  19072. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,System.Object)">
  19073. <summary>
  19074. Derived pattern converters must override this method in order to
  19075. convert conversion specifiers in the correct way.
  19076. </summary>
  19077. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19078. <param name="state">The state object on which the pattern converter should be executed.</param>
  19079. </member>
  19080. <member name="F:log4net.Layout.Pattern.PatternLayoutConverter.m_ignoresException">
  19081. <summary>
  19082. Flag indicating if this converter handles exceptions
  19083. </summary>
  19084. <remarks>
  19085. <c>false</c> if this converter handles exceptions
  19086. </remarks>
  19087. </member>
  19088. <member name="T:log4net.Layout.Pattern.PropertyPatternConverter">
  19089. <summary>
  19090. Property pattern converter
  19091. </summary>
  19092. <remarks>
  19093. <para>
  19094. Writes out the value of a named property. The property name
  19095. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  19096. property.
  19097. </para>
  19098. <para>
  19099. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  19100. then all the properties are written as key value pairs.
  19101. </para>
  19102. </remarks>
  19103. <author>Nicko Cadell</author>
  19104. </member>
  19105. <member name="M:log4net.Layout.Pattern.PropertyPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19106. <summary>
  19107. Write the property value to the output
  19108. </summary>
  19109. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19110. <param name="loggingEvent">the event being logged</param>
  19111. <remarks>
  19112. <para>
  19113. Writes out the value of a named property. The property name
  19114. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  19115. property.
  19116. </para>
  19117. <para>
  19118. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  19119. then all the properties are written as key value pairs.
  19120. </para>
  19121. </remarks>
  19122. </member>
  19123. <member name="T:log4net.Layout.Pattern.RelativeTimePatternConverter">
  19124. <summary>
  19125. Converter to output the relative time of the event
  19126. </summary>
  19127. <remarks>
  19128. <para>
  19129. Converter to output the time of the event relative to the start of the program.
  19130. </para>
  19131. </remarks>
  19132. <author>Nicko Cadell</author>
  19133. </member>
  19134. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19135. <summary>
  19136. Write the relative time to the output
  19137. </summary>
  19138. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19139. <param name="loggingEvent">the event being logged</param>
  19140. <remarks>
  19141. <para>
  19142. Writes out the relative time of the event in milliseconds.
  19143. That is the number of milliseconds between the event <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  19144. and the <see cref="P:log4net.Core.LoggingEvent.StartTime"/>.
  19145. </para>
  19146. </remarks>
  19147. </member>
  19148. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.TimeDifferenceInMillis(System.DateTime,System.DateTime)">
  19149. <summary>
  19150. Helper method to get the time difference between two DateTime objects
  19151. </summary>
  19152. <param name="start">start time (in the current local time zone)</param>
  19153. <param name="end">end time (in the current local time zone)</param>
  19154. <returns>the time difference in milliseconds</returns>
  19155. </member>
  19156. <member name="T:log4net.Layout.Pattern.StackTraceDetailPatternConverter">
  19157. <summary>
  19158. Write the caller stack frames to the output
  19159. </summary>
  19160. <remarks>
  19161. <para>
  19162. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
  19163. type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...)
  19164. </para>
  19165. </remarks>
  19166. <author>Adam Davies</author>
  19167. </member>
  19168. <member name="F:log4net.Layout.Pattern.StackTraceDetailPatternConverter.declaringType">
  19169. <summary>
  19170. The fully qualified type of the StackTraceDetailPatternConverter class.
  19171. </summary>
  19172. <remarks>
  19173. Used by the internal logger to record the Type of the
  19174. log message.
  19175. </remarks>
  19176. </member>
  19177. <member name="T:log4net.Layout.Pattern.StackTracePatternConverter">
  19178. <summary>
  19179. Write the caller stack frames to the output
  19180. </summary>
  19181. <remarks>
  19182. <para>
  19183. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
  19184. type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1
  19185. </para>
  19186. </remarks>
  19187. <author>Michael Cromwell</author>
  19188. </member>
  19189. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions">
  19190. <summary>
  19191. Initialize the converter
  19192. </summary>
  19193. <remarks>
  19194. <para>
  19195. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19196. activation scheme. The <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> method must
  19197. be called on this object after the configuration properties have
  19198. been set. Until <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> is called this
  19199. object is in an undefined state and must not be used.
  19200. </para>
  19201. <para>
  19202. If any of the configuration properties are modified then
  19203. <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> must be called again.
  19204. </para>
  19205. </remarks>
  19206. </member>
  19207. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19208. <summary>
  19209. Write the strack frames to the output
  19210. </summary>
  19211. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19212. <param name="loggingEvent">the event being logged</param>
  19213. <remarks>
  19214. <para>
  19215. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer.
  19216. </para>
  19217. </remarks>
  19218. </member>
  19219. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.GetMethodInformation(log4net.Core.MethodItem)">
  19220. <summary>
  19221. Returns the Name of the method
  19222. </summary>
  19223. <param name="method"></param>
  19224. <remarks>This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter</remarks>
  19225. <returns>string</returns>
  19226. </member>
  19227. <member name="F:log4net.Layout.Pattern.StackTracePatternConverter.declaringType">
  19228. <summary>
  19229. The fully qualified type of the StackTracePatternConverter class.
  19230. </summary>
  19231. <remarks>
  19232. Used by the internal logger to record the Type of the
  19233. log message.
  19234. </remarks>
  19235. </member>
  19236. <member name="T:log4net.Layout.Pattern.ThreadPatternConverter">
  19237. <summary>
  19238. Converter to include event thread name
  19239. </summary>
  19240. <remarks>
  19241. <para>
  19242. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the output.
  19243. </para>
  19244. </remarks>
  19245. <author>Nicko Cadell</author>
  19246. </member>
  19247. <member name="M:log4net.Layout.Pattern.ThreadPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19248. <summary>
  19249. Write the ThreadName to the output
  19250. </summary>
  19251. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19252. <param name="loggingEvent">the event being logged</param>
  19253. <remarks>
  19254. <para>
  19255. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the <paramref name="writer" />.
  19256. </para>
  19257. </remarks>
  19258. </member>
  19259. <member name="T:log4net.Layout.Pattern.TypeNamePatternConverter">
  19260. <summary>
  19261. Pattern converter for the class name
  19262. </summary>
  19263. <remarks>
  19264. <para>
  19265. Outputs the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the event.
  19266. </para>
  19267. </remarks>
  19268. <author>Nicko Cadell</author>
  19269. </member>
  19270. <member name="M:log4net.Layout.Pattern.TypeNamePatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  19271. <summary>
  19272. Gets the fully qualified name of the class
  19273. </summary>
  19274. <param name="loggingEvent">the event being logged</param>
  19275. <returns>The fully qualified type name for the caller location</returns>
  19276. <remarks>
  19277. <para>
  19278. Returns the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the <paramref name="loggingEvent"/>.
  19279. </para>
  19280. </remarks>
  19281. </member>
  19282. <member name="T:log4net.Layout.Pattern.UserNamePatternConverter">
  19283. <summary>
  19284. Converter to include event user name
  19285. </summary>
  19286. <author>Douglas de la Torre</author>
  19287. <author>Nicko Cadell</author>
  19288. </member>
  19289. <member name="M:log4net.Layout.Pattern.UserNamePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19290. <summary>
  19291. Convert the pattern to the rendered message
  19292. </summary>
  19293. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19294. <param name="loggingEvent">the event being logged</param>
  19295. </member>
  19296. <member name="T:log4net.Layout.Pattern.UtcDatePatternConverter">
  19297. <summary>
  19298. Write the TimeStamp to the output
  19299. </summary>
  19300. <remarks>
  19301. <para>
  19302. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  19303. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  19304. </para>
  19305. <para>
  19306. Uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  19307. in Universal time.
  19308. </para>
  19309. <para>
  19310. See the <see cref="T:log4net.Layout.Pattern.DatePatternConverter"/> for details on the date pattern syntax.
  19311. </para>
  19312. </remarks>
  19313. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  19314. <author>Nicko Cadell</author>
  19315. </member>
  19316. <member name="M:log4net.Layout.Pattern.UtcDatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19317. <summary>
  19318. Write the TimeStamp to the output
  19319. </summary>
  19320. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  19321. <param name="loggingEvent">the event being logged</param>
  19322. <remarks>
  19323. <para>
  19324. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  19325. for it to render it to the writer.
  19326. </para>
  19327. <para>
  19328. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone, this is converted
  19329. to Universal time before it is rendered.
  19330. </para>
  19331. </remarks>
  19332. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  19333. </member>
  19334. <member name="F:log4net.Layout.Pattern.UtcDatePatternConverter.declaringType">
  19335. <summary>
  19336. The fully qualified type of the UtcDatePatternConverter class.
  19337. </summary>
  19338. <remarks>
  19339. Used by the internal logger to record the Type of the
  19340. log message.
  19341. </remarks>
  19342. </member>
  19343. <member name="T:log4net.Layout.RawLayoutConverter">
  19344. <summary>
  19345. Type converter for the <see cref="T:log4net.Layout.IRawLayout"/> interface
  19346. </summary>
  19347. <remarks>
  19348. <para>
  19349. Used to convert objects to the <see cref="T:log4net.Layout.IRawLayout"/> interface.
  19350. Supports converting from the <see cref="T:log4net.Layout.ILayout"/> interface to
  19351. the <see cref="T:log4net.Layout.IRawLayout"/> interface using the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>.
  19352. </para>
  19353. </remarks>
  19354. <author>Nicko Cadell</author>
  19355. <author>Gert Driesen</author>
  19356. </member>
  19357. <member name="M:log4net.Layout.RawLayoutConverter.CanConvertFrom(System.Type)">
  19358. <summary>
  19359. Can the sourceType be converted to an <see cref="T:log4net.Layout.IRawLayout"/>
  19360. </summary>
  19361. <param name="sourceType">the source to be to be converted</param>
  19362. <returns><c>true</c> if the source type can be converted to <see cref="T:log4net.Layout.IRawLayout"/></returns>
  19363. <remarks>
  19364. <para>
  19365. Test if the <paramref name="sourceType"/> can be converted to a
  19366. <see cref="T:log4net.Layout.IRawLayout"/>. Only <see cref="T:log4net.Layout.ILayout"/> is supported
  19367. as the <paramref name="sourceType"/>.
  19368. </para>
  19369. </remarks>
  19370. </member>
  19371. <member name="M:log4net.Layout.RawLayoutConverter.ConvertFrom(System.Object)">
  19372. <summary>
  19373. Convert the value to a <see cref="T:log4net.Layout.IRawLayout"/> object
  19374. </summary>
  19375. <param name="source">the value to convert</param>
  19376. <returns>the <see cref="T:log4net.Layout.IRawLayout"/> object</returns>
  19377. <remarks>
  19378. <para>
  19379. Convert the <paramref name="source"/> object to a
  19380. <see cref="T:log4net.Layout.IRawLayout"/> object. If the <paramref name="source"/> object
  19381. is a <see cref="T:log4net.Layout.ILayout"/> then the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>
  19382. is used to adapt between the two interfaces, otherwise an
  19383. exception is thrown.
  19384. </para>
  19385. </remarks>
  19386. </member>
  19387. <member name="T:log4net.Layout.RawPropertyLayout">
  19388. <summary>
  19389. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  19390. </summary>
  19391. <remarks>
  19392. <para>
  19393. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  19394. </para>
  19395. </remarks>
  19396. <author>Nicko Cadell</author>
  19397. </member>
  19398. <member name="M:log4net.Layout.RawPropertyLayout.#ctor">
  19399. <summary>
  19400. Constructs a RawPropertyLayout
  19401. </summary>
  19402. </member>
  19403. <member name="P:log4net.Layout.RawPropertyLayout.Key">
  19404. <summary>
  19405. The name of the value to lookup in the LoggingEvent Properties collection.
  19406. </summary>
  19407. <value>
  19408. Value to lookup in the LoggingEvent Properties collection
  19409. </value>
  19410. <remarks>
  19411. <para>
  19412. String name of the property to lookup in the <see cref="T:log4net.Core.LoggingEvent"/>.
  19413. </para>
  19414. </remarks>
  19415. </member>
  19416. <member name="M:log4net.Layout.RawPropertyLayout.Format(log4net.Core.LoggingEvent)">
  19417. <summary>
  19418. Lookup the property for <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>
  19419. </summary>
  19420. <param name="loggingEvent">The event to format</param>
  19421. <returns>returns property value</returns>
  19422. <remarks>
  19423. <para>
  19424. Looks up and returns the object value of the property
  19425. named <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>. If there is no property defined
  19426. with than name then <c>null</c> will be returned.
  19427. </para>
  19428. </remarks>
  19429. </member>
  19430. <member name="T:log4net.Layout.RawTimeStampLayout">
  19431. <summary>
  19432. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19433. </summary>
  19434. <remarks>
  19435. <para>
  19436. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19437. </para>
  19438. </remarks>
  19439. <author>Nicko Cadell</author>
  19440. <author>Gert Driesen</author>
  19441. </member>
  19442. <member name="M:log4net.Layout.RawTimeStampLayout.#ctor">
  19443. <summary>
  19444. Constructs a RawTimeStampLayout
  19445. </summary>
  19446. </member>
  19447. <member name="M:log4net.Layout.RawTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  19448. <summary>
  19449. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19450. </summary>
  19451. <param name="loggingEvent">The event to format</param>
  19452. <returns>returns the time stamp</returns>
  19453. <remarks>
  19454. <para>
  19455. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19456. </para>
  19457. <para>
  19458. The time stamp is in local time. To format the time stamp
  19459. in universal time use <see cref="T:log4net.Layout.RawUtcTimeStampLayout"/>.
  19460. </para>
  19461. </remarks>
  19462. </member>
  19463. <member name="T:log4net.Layout.RawUtcTimeStampLayout">
  19464. <summary>
  19465. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19466. </summary>
  19467. <remarks>
  19468. <para>
  19469. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19470. </para>
  19471. </remarks>
  19472. <author>Nicko Cadell</author>
  19473. <author>Gert Driesen</author>
  19474. </member>
  19475. <member name="M:log4net.Layout.RawUtcTimeStampLayout.#ctor">
  19476. <summary>
  19477. Constructs a RawUtcTimeStampLayout
  19478. </summary>
  19479. </member>
  19480. <member name="M:log4net.Layout.RawUtcTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  19481. <summary>
  19482. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19483. </summary>
  19484. <param name="loggingEvent">The event to format</param>
  19485. <returns>returns the time stamp</returns>
  19486. <remarks>
  19487. <para>
  19488. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19489. </para>
  19490. <para>
  19491. The time stamp is in universal time. To format the time stamp
  19492. in local time use <see cref="T:log4net.Layout.RawTimeStampLayout"/>.
  19493. </para>
  19494. </remarks>
  19495. </member>
  19496. <member name="T:log4net.Layout.SimpleLayout">
  19497. <summary>
  19498. A very simple layout
  19499. </summary>
  19500. <remarks>
  19501. <para>
  19502. SimpleLayout consists of the level of the log statement,
  19503. followed by " - " and then the log message itself. For example,
  19504. <code>
  19505. DEBUG - Hello world
  19506. </code>
  19507. </para>
  19508. </remarks>
  19509. <author>Nicko Cadell</author>
  19510. <author>Gert Driesen</author>
  19511. </member>
  19512. <member name="M:log4net.Layout.SimpleLayout.#ctor">
  19513. <summary>
  19514. Constructs a SimpleLayout
  19515. </summary>
  19516. </member>
  19517. <member name="M:log4net.Layout.SimpleLayout.ActivateOptions">
  19518. <summary>
  19519. Initialize layout options
  19520. </summary>
  19521. <remarks>
  19522. <para>
  19523. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19524. activation scheme. The <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> method must
  19525. be called on this object after the configuration properties have
  19526. been set. Until <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> is called this
  19527. object is in an undefined state and must not be used.
  19528. </para>
  19529. <para>
  19530. If any of the configuration properties are modified then
  19531. <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> must be called again.
  19532. </para>
  19533. </remarks>
  19534. </member>
  19535. <member name="M:log4net.Layout.SimpleLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19536. <summary>
  19537. Produces a simple formatted output.
  19538. </summary>
  19539. <param name="loggingEvent">the event being logged</param>
  19540. <param name="writer">The TextWriter to write the formatted event to</param>
  19541. <remarks>
  19542. <para>
  19543. Formats the event as the level of the even,
  19544. followed by " - " and then the log message itself. The
  19545. output is terminated by a newline.
  19546. </para>
  19547. </remarks>
  19548. </member>
  19549. <member name="T:log4net.Layout.XmlLayout">
  19550. <summary>
  19551. Layout that formats the log events as XML elements.
  19552. </summary>
  19553. <remarks>
  19554. <para>
  19555. The output of the <see cref="T:log4net.Layout.XmlLayout" /> consists of a series of
  19556. log4net:event elements. It does not output a complete well-formed XML
  19557. file. The output is designed to be included as an <em>external entity</em>
  19558. in a separate file to form a correct XML file.
  19559. </para>
  19560. <para>
  19561. For example, if <c>abc</c> is the name of the file where
  19562. the <see cref="T:log4net.Layout.XmlLayout" /> output goes, then a well-formed XML file would
  19563. be:
  19564. </para>
  19565. <code lang="XML">
  19566. &lt;?xml version="1.0" ?&gt;
  19567. &lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
  19568. &lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
  19569. &amp;data;
  19570. &lt;/log4net:events&gt;
  19571. </code>
  19572. <para>
  19573. This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout" />
  19574. and the appender where it is embedded.
  19575. </para>
  19576. <para>
  19577. The <c>version</c> attribute helps components to correctly
  19578. interpret output generated by <see cref="T:log4net.Layout.XmlLayout" />. The value of
  19579. this attribute should be "1.2" for release 1.2 and later.
  19580. </para>
  19581. <para>
  19582. Alternatively the <c>Header</c> and <c>Footer</c> properties can be
  19583. configured to output the correct XML header, open tag and close tag.
  19584. When setting the <c>Header</c> and <c>Footer</c> properties it is essential
  19585. that the underlying data store not be appendable otherwise the data
  19586. will become invalid XML.
  19587. </para>
  19588. </remarks>
  19589. <author>Nicko Cadell</author>
  19590. <author>Gert Driesen</author>
  19591. </member>
  19592. <member name="M:log4net.Layout.XmlLayout.#ctor">
  19593. <summary>
  19594. Constructs an XmlLayout
  19595. </summary>
  19596. </member>
  19597. <member name="M:log4net.Layout.XmlLayout.#ctor(System.Boolean)">
  19598. <summary>
  19599. Constructs an XmlLayout.
  19600. </summary>
  19601. <remarks>
  19602. <para>
  19603. The <b>LocationInfo</b> option takes a boolean value. By
  19604. default, it is set to false which means there will be no location
  19605. information output by this layout. If the the option is set to
  19606. true, then the file name and line number of the statement
  19607. at the origin of the log statement will be output.
  19608. </para>
  19609. <para>
  19610. If you are embedding this layout within an SmtpAppender
  19611. then make sure to set the <b>LocationInfo</b> option of that
  19612. appender as well.
  19613. </para>
  19614. </remarks>
  19615. </member>
  19616. <member name="P:log4net.Layout.XmlLayout.Prefix">
  19617. <summary>
  19618. The prefix to use for all element names
  19619. </summary>
  19620. <remarks>
  19621. <para>
  19622. The default prefix is <b>log4net</b>. Set this property
  19623. to change the prefix. If the prefix is set to an empty string
  19624. then no prefix will be written.
  19625. </para>
  19626. </remarks>
  19627. </member>
  19628. <member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage">
  19629. <summary>
  19630. Set whether or not to base64 encode the message.
  19631. </summary>
  19632. <remarks>
  19633. <para>
  19634. By default the log message will be written as text to the xml
  19635. output. This can cause problems when the message contains binary
  19636. data. By setting this to true the contents of the message will be
  19637. base64 encoded. If this is set then invalid character replacement
  19638. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  19639. on the log message.
  19640. </para>
  19641. </remarks>
  19642. </member>
  19643. <member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties">
  19644. <summary>
  19645. Set whether or not to base64 encode the property values.
  19646. </summary>
  19647. <remarks>
  19648. <para>
  19649. By default the properties will be written as text to the xml
  19650. output. This can cause problems when one or more properties contain
  19651. binary data. By setting this to true the values of the properties
  19652. will be base64 encoded. If this is set then invalid character replacement
  19653. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  19654. on the property values.
  19655. </para>
  19656. </remarks>
  19657. </member>
  19658. <member name="M:log4net.Layout.XmlLayout.ActivateOptions">
  19659. <summary>
  19660. Initialize layout options
  19661. </summary>
  19662. <remarks>
  19663. <para>
  19664. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19665. activation scheme. The <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> method must
  19666. be called on this object after the configuration properties have
  19667. been set. Until <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> is called this
  19668. object is in an undefined state and must not be used.
  19669. </para>
  19670. <para>
  19671. If any of the configuration properties are modified then
  19672. <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> must be called again.
  19673. </para>
  19674. <para>
  19675. Builds a cache of the element names
  19676. </para>
  19677. </remarks>
  19678. </member>
  19679. <member name="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  19680. <summary>
  19681. Does the actual writing of the XML.
  19682. </summary>
  19683. <param name="writer">The writer to use to output the event to.</param>
  19684. <param name="loggingEvent">The event to write.</param>
  19685. <remarks>
  19686. <para>
  19687. Override the base class <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method
  19688. to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>.
  19689. </para>
  19690. </remarks>
  19691. </member>
  19692. <member name="F:log4net.Layout.XmlLayout.m_prefix">
  19693. <summary>
  19694. The prefix to use for all generated element names
  19695. </summary>
  19696. </member>
  19697. <member name="T:log4net.Layout.XmlLayoutBase">
  19698. <summary>
  19699. Layout that formats the log events as XML elements.
  19700. </summary>
  19701. <remarks>
  19702. <para>
  19703. This is an abstract class that must be subclassed by an implementation
  19704. to conform to a specific schema.
  19705. </para>
  19706. <para>
  19707. Deriving classes must implement the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method.
  19708. </para>
  19709. </remarks>
  19710. <author>Nicko Cadell</author>
  19711. <author>Gert Driesen</author>
  19712. </member>
  19713. <member name="M:log4net.Layout.XmlLayoutBase.#ctor">
  19714. <summary>
  19715. Protected constructor to support subclasses
  19716. </summary>
  19717. <remarks>
  19718. <para>
  19719. Initializes a new instance of the <see cref="T:log4net.Layout.XmlLayoutBase" /> class
  19720. with no location info.
  19721. </para>
  19722. </remarks>
  19723. </member>
  19724. <member name="M:log4net.Layout.XmlLayoutBase.#ctor(System.Boolean)">
  19725. <summary>
  19726. Protected constructor to support subclasses
  19727. </summary>
  19728. <remarks>
  19729. <para>
  19730. The <paramref name="locationInfo" /> parameter determines whether
  19731. location information will be output by the layout. If
  19732. <paramref name="locationInfo" /> is set to <c>true</c>, then the
  19733. file name and line number of the statement at the origin of the log
  19734. statement will be output.
  19735. </para>
  19736. <para>
  19737. If you are embedding this layout within an SMTPAppender
  19738. then make sure to set the <b>LocationInfo</b> option of that
  19739. appender as well.
  19740. </para>
  19741. </remarks>
  19742. </member>
  19743. <member name="P:log4net.Layout.XmlLayoutBase.LocationInfo">
  19744. <summary>
  19745. Gets a value indicating whether to include location information in
  19746. the XML events.
  19747. </summary>
  19748. <value>
  19749. <c>true</c> if location information should be included in the XML
  19750. events; otherwise, <c>false</c>.
  19751. </value>
  19752. <remarks>
  19753. <para>
  19754. If <see cref="P:log4net.Layout.XmlLayoutBase.LocationInfo" /> is set to <c>true</c>, then the file
  19755. name and line number of the statement at the origin of the log
  19756. statement will be output.
  19757. </para>
  19758. <para>
  19759. If you are embedding this layout within an <c>SMTPAppender</c>
  19760. then make sure to set the <b>LocationInfo</b> option of that
  19761. appender as well.
  19762. </para>
  19763. </remarks>
  19764. </member>
  19765. <member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement">
  19766. <summary>
  19767. The string to replace characters that can not be expressed in XML with.
  19768. <remarks>
  19769. <para>
  19770. Not all characters may be expressed in XML. This property contains the
  19771. string to replace those that can not with. This defaults to a ?. Set it
  19772. to the empty string to simply remove offending characters. For more
  19773. details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
  19774. Character replacement will occur in the log message, the property names
  19775. and the property values.
  19776. </para>
  19777. </remarks>
  19778. </summary>
  19779. </member>
  19780. <member name="M:log4net.Layout.XmlLayoutBase.ActivateOptions">
  19781. <summary>
  19782. Initialize layout options
  19783. </summary>
  19784. <remarks>
  19785. <para>
  19786. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19787. activation scheme. The <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> method must
  19788. be called on this object after the configuration properties have
  19789. been set. Until <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> is called this
  19790. object is in an undefined state and must not be used.
  19791. </para>
  19792. <para>
  19793. If any of the configuration properties are modified then
  19794. <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> must be called again.
  19795. </para>
  19796. </remarks>
  19797. </member>
  19798. <member name="P:log4net.Layout.XmlLayoutBase.ContentType">
  19799. <summary>
  19800. Gets the content type output by this layout.
  19801. </summary>
  19802. <value>
  19803. As this is the XML layout, the value is always <c>"text/xml"</c>.
  19804. </value>
  19805. <remarks>
  19806. <para>
  19807. As this is the XML layout, the value is always <c>"text/xml"</c>.
  19808. </para>
  19809. </remarks>
  19810. </member>
  19811. <member name="M:log4net.Layout.XmlLayoutBase.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19812. <summary>
  19813. Produces a formatted string.
  19814. </summary>
  19815. <param name="loggingEvent">The event being logged.</param>
  19816. <param name="writer">The TextWriter to write the formatted event to</param>
  19817. <remarks>
  19818. <para>
  19819. Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>.
  19820. </para>
  19821. <para>
  19822. This method creates an <see cref="T:System.Xml.XmlTextWriter"/> that writes to the
  19823. <paramref name="writer"/>. The <see cref="T:System.Xml.XmlTextWriter"/> is passed
  19824. to the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the
  19825. <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method.
  19826. </para>
  19827. </remarks>
  19828. </member>
  19829. <member name="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  19830. <summary>
  19831. Does the actual writing of the XML.
  19832. </summary>
  19833. <param name="writer">The writer to use to output the event to.</param>
  19834. <param name="loggingEvent">The event to write.</param>
  19835. <remarks>
  19836. <para>
  19837. Subclasses should override this method to format
  19838. the <see cref="T:log4net.Core.LoggingEvent"/> as XML.
  19839. </para>
  19840. </remarks>
  19841. </member>
  19842. <member name="F:log4net.Layout.XmlLayoutBase.m_locationInfo">
  19843. <summary>
  19844. Flag to indicate if location information should be included in
  19845. the XML events.
  19846. </summary>
  19847. </member>
  19848. <member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement">
  19849. <summary>
  19850. The string to replace invalid chars with
  19851. </summary>
  19852. </member>
  19853. <member name="T:log4net.Layout.XmlLayoutSchemaLog4j">
  19854. <summary>
  19855. Layout that formats the log events as XML elements compatible with the log4j schema
  19856. </summary>
  19857. <remarks>
  19858. <para>
  19859. Formats the log events according to the http://logging.apache.org/log4j schema.
  19860. </para>
  19861. </remarks>
  19862. <author>Nicko Cadell</author>
  19863. </member>
  19864. <member name="F:log4net.Layout.XmlLayoutSchemaLog4j.s_date1970">
  19865. <summary>
  19866. The 1st of January 1970 in UTC
  19867. </summary>
  19868. </member>
  19869. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor">
  19870. <summary>
  19871. Constructs an XMLLayoutSchemaLog4j
  19872. </summary>
  19873. </member>
  19874. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor(System.Boolean)">
  19875. <summary>
  19876. Constructs an XMLLayoutSchemaLog4j.
  19877. </summary>
  19878. <remarks>
  19879. <para>
  19880. The <b>LocationInfo</b> option takes a boolean value. By
  19881. default, it is set to false which means there will be no location
  19882. information output by this layout. If the the option is set to
  19883. true, then the file name and line number of the statement
  19884. at the origin of the log statement will be output.
  19885. </para>
  19886. <para>
  19887. If you are embedding this layout within an SMTPAppender
  19888. then make sure to set the <b>LocationInfo</b> option of that
  19889. appender as well.
  19890. </para>
  19891. </remarks>
  19892. </member>
  19893. <member name="P:log4net.Layout.XmlLayoutSchemaLog4j.Version">
  19894. <summary>
  19895. The version of the log4j schema to use.
  19896. </summary>
  19897. <remarks>
  19898. <para>
  19899. Only version 1.2 of the log4j schema is supported.
  19900. </para>
  19901. </remarks>
  19902. </member>
  19903. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  19904. <summary>
  19905. Actually do the writing of the xml
  19906. </summary>
  19907. <param name="writer">the writer to use</param>
  19908. <param name="loggingEvent">the event to write</param>
  19909. <remarks>
  19910. <para>
  19911. Generate XML that is compatible with the log4j schema.
  19912. </para>
  19913. </remarks>
  19914. </member>
  19915. <member name="T:log4net.LogicalThreadContext">
  19916. <summary>
  19917. The log4net Logical Thread Context.
  19918. </summary>
  19919. <remarks>
  19920. <para>
  19921. The <c>LogicalThreadContext</c> provides a location for <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> specific debugging
  19922. information to be stored.
  19923. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> or <see cref="T:log4net.GlobalContext"/>
  19924. properties with the same name.
  19925. </para>
  19926. <para>
  19927. For .NET Standard 1.3 this class uses
  19928. System.Threading.AsyncLocal rather than <see
  19929. cref="T:System.Runtime.Remoting.Messaging.CallContext"/>.
  19930. </para>
  19931. <para>
  19932. The Logical Thread Context has a properties map and a stack.
  19933. The properties and stack can
  19934. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  19935. supports selecting and outputting these properties.
  19936. </para>
  19937. <para>
  19938. The Logical Thread Context provides a diagnostic context for the current call context.
  19939. This is an instrument for distinguishing interleaved log
  19940. output from different sources. Log output is typically interleaved
  19941. when a server handles multiple clients near-simultaneously.
  19942. </para>
  19943. <para>
  19944. The Logical Thread Context is managed on a per <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> basis.
  19945. </para>
  19946. <para>
  19947. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  19948. <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
  19949. <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  19950. If the calling code does not have this permission then this context will be disabled.
  19951. It will not store any property values set on it.
  19952. </para>
  19953. </remarks>
  19954. <example>Example of using the thread context properties to store a username.
  19955. <code lang="C#">
  19956. LogicalThreadContext.Properties["user"] = userName;
  19957. log.Info("This log message has a LogicalThreadContext Property called 'user'");
  19958. </code>
  19959. </example>
  19960. <example>Example of how to push a message into the context stack
  19961. <code lang="C#">
  19962. using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
  19963. {
  19964. log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
  19965. } // at the end of the using block the message is automatically popped
  19966. </code>
  19967. </example>
  19968. <threadsafety static="true" instance="true" />
  19969. <author>Nicko Cadell</author>
  19970. </member>
  19971. <member name="M:log4net.LogicalThreadContext.#ctor">
  19972. <summary>
  19973. Private Constructor.
  19974. </summary>
  19975. <remarks>
  19976. <para>
  19977. Uses a private access modifier to prevent instantiation of this class.
  19978. </para>
  19979. </remarks>
  19980. </member>
  19981. <member name="P:log4net.LogicalThreadContext.Properties">
  19982. <summary>
  19983. The thread properties map
  19984. </summary>
  19985. <value>
  19986. The thread properties map
  19987. </value>
  19988. <remarks>
  19989. <para>
  19990. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/>
  19991. or <see cref="T:log4net.GlobalContext"/> properties with the same name.
  19992. </para>
  19993. </remarks>
  19994. </member>
  19995. <member name="P:log4net.LogicalThreadContext.Stacks">
  19996. <summary>
  19997. The thread stacks
  19998. </summary>
  19999. <value>
  20000. stack map
  20001. </value>
  20002. <remarks>
  20003. <para>
  20004. The logical thread stacks.
  20005. </para>
  20006. </remarks>
  20007. </member>
  20008. <member name="F:log4net.LogicalThreadContext.s_properties">
  20009. <summary>
  20010. The thread context properties instance
  20011. </summary>
  20012. </member>
  20013. <member name="F:log4net.LogicalThreadContext.s_stacks">
  20014. <summary>
  20015. The thread context stacks instance
  20016. </summary>
  20017. </member>
  20018. <member name="T:log4net.LogManager">
  20019. <summary>
  20020. This class is used by client applications to request logger instances.
  20021. </summary>
  20022. <remarks>
  20023. <para>
  20024. This class has static methods that are used by a client to request
  20025. a logger instance. The <see cref="M:GetLogger(string)"/> method is
  20026. used to retrieve a logger.
  20027. </para>
  20028. <para>
  20029. See the <see cref="T:log4net.ILog"/> interface for more details.
  20030. </para>
  20031. </remarks>
  20032. <example>Simple example of logging messages
  20033. <code lang="C#">
  20034. ILog log = LogManager.GetLogger("application-log");
  20035. log.Info("Application Start");
  20036. log.Debug("This is a debug message");
  20037. if (log.IsDebugEnabled)
  20038. {
  20039. log.Debug("This is another debug message");
  20040. }
  20041. </code>
  20042. </example>
  20043. <threadsafety static="true" instance="true" />
  20044. <seealso cref="T:log4net.ILog"/>
  20045. <author>Nicko Cadell</author>
  20046. <author>Gert Driesen</author>
  20047. </member>
  20048. <member name="M:log4net.LogManager.#ctor">
  20049. <summary>
  20050. Initializes a new instance of the <see cref="T:log4net.LogManager" /> class.
  20051. </summary>
  20052. <remarks>
  20053. Uses a private access modifier to prevent instantiation of this class.
  20054. </remarks>
  20055. </member>
  20056. <member name="M:log4net.LogManager.Exists(System.String)">
  20057. <overloads>Returns the named logger if it exists.</overloads>
  20058. <summary>
  20059. Returns the named logger if it exists.
  20060. </summary>
  20061. <remarks>
  20062. <para>
  20063. If the named logger exists (in the default repository) then it
  20064. returns a reference to the logger, otherwise it returns <c>null</c>.
  20065. </para>
  20066. </remarks>
  20067. <param name="name">The fully qualified logger name to look for.</param>
  20068. <returns>The logger found, or <c>null</c> if no logger could be found.</returns>
  20069. </member>
  20070. <member name="M:log4net.LogManager.GetCurrentLoggers">
  20071. <overloads>Get the currently defined loggers.</overloads>
  20072. <summary>
  20073. Returns all the currently defined loggers in the default repository.
  20074. </summary>
  20075. <remarks>
  20076. <para>The root logger is <b>not</b> included in the returned array.</para>
  20077. </remarks>
  20078. <returns>All the defined loggers.</returns>
  20079. </member>
  20080. <member name="M:log4net.LogManager.GetLogger(System.String)">
  20081. <overloads>Get or create a logger.</overloads>
  20082. <summary>
  20083. Retrieves or creates a named logger.
  20084. </summary>
  20085. <remarks>
  20086. <para>
  20087. Retrieves a logger named as the <paramref name="name"/>
  20088. parameter. If the named logger already exists, then the
  20089. existing instance will be returned. Otherwise, a new instance is
  20090. created.
  20091. </para>
  20092. <para>By default, loggers do not have a set level but inherit
  20093. it from the hierarchy. This is one of the central features of
  20094. log4net.
  20095. </para>
  20096. </remarks>
  20097. <param name="name">The name of the logger to retrieve.</param>
  20098. <returns>The logger with the name specified.</returns>
  20099. </member>
  20100. <member name="M:log4net.LogManager.Exists(System.String,System.String)">
  20101. <summary>
  20102. Returns the named logger if it exists.
  20103. </summary>
  20104. <remarks>
  20105. <para>
  20106. If the named logger exists (in the specified repository) then it
  20107. returns a reference to the logger, otherwise it returns
  20108. <c>null</c>.
  20109. </para>
  20110. </remarks>
  20111. <param name="repository">The repository to lookup in.</param>
  20112. <param name="name">The fully qualified logger name to look for.</param>
  20113. <returns>
  20114. The logger found, or <c>null</c> if the logger doesn't exist in the specified
  20115. repository.
  20116. </returns>
  20117. </member>
  20118. <member name="M:log4net.LogManager.Exists(System.Reflection.Assembly,System.String)">
  20119. <summary>
  20120. Returns the named logger if it exists.
  20121. </summary>
  20122. <remarks>
  20123. <para>
  20124. If the named logger exists (in the repository for the specified assembly) then it
  20125. returns a reference to the logger, otherwise it returns
  20126. <c>null</c>.
  20127. </para>
  20128. </remarks>
  20129. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20130. <param name="name">The fully qualified logger name to look for.</param>
  20131. <returns>
  20132. The logger, or <c>null</c> if the logger doesn't exist in the specified
  20133. assembly's repository.
  20134. </returns>
  20135. </member>
  20136. <member name="M:log4net.LogManager.GetCurrentLoggers(System.String)">
  20137. <summary>
  20138. Returns all the currently defined loggers in the specified repository.
  20139. </summary>
  20140. <param name="repository">The repository to lookup in.</param>
  20141. <remarks>
  20142. The root logger is <b>not</b> included in the returned array.
  20143. </remarks>
  20144. <returns>All the defined loggers.</returns>
  20145. </member>
  20146. <member name="M:log4net.LogManager.GetCurrentLoggers(System.Reflection.Assembly)">
  20147. <summary>
  20148. Returns all the currently defined loggers in the specified assembly's repository.
  20149. </summary>
  20150. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20151. <remarks>
  20152. The root logger is <b>not</b> included in the returned array.
  20153. </remarks>
  20154. <returns>All the defined loggers.</returns>
  20155. </member>
  20156. <member name="M:log4net.LogManager.GetLogger(System.String,System.String)">
  20157. <summary>
  20158. Retrieves or creates a named logger.
  20159. </summary>
  20160. <remarks>
  20161. <para>
  20162. Retrieve a logger named as the <paramref name="name"/>
  20163. parameter. If the named logger already exists, then the
  20164. existing instance will be returned. Otherwise, a new instance is
  20165. created.
  20166. </para>
  20167. <para>
  20168. By default, loggers do not have a set level but inherit
  20169. it from the hierarchy. This is one of the central features of
  20170. log4net.
  20171. </para>
  20172. </remarks>
  20173. <param name="repository">The repository to lookup in.</param>
  20174. <param name="name">The name of the logger to retrieve.</param>
  20175. <returns>The logger with the name specified.</returns>
  20176. </member>
  20177. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.String)">
  20178. <summary>
  20179. Retrieves or creates a named logger.
  20180. </summary>
  20181. <remarks>
  20182. <para>
  20183. Retrieve a logger named as the <paramref name="name"/>
  20184. parameter. If the named logger already exists, then the
  20185. existing instance will be returned. Otherwise, a new instance is
  20186. created.
  20187. </para>
  20188. <para>
  20189. By default, loggers do not have a set level but inherit
  20190. it from the hierarchy. This is one of the central features of
  20191. log4net.
  20192. </para>
  20193. </remarks>
  20194. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20195. <param name="name">The name of the logger to retrieve.</param>
  20196. <returns>The logger with the name specified.</returns>
  20197. </member>
  20198. <member name="M:log4net.LogManager.GetLogger(System.Type)">
  20199. <summary>
  20200. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  20201. </summary>
  20202. <remarks>
  20203. Get the logger for the fully qualified name of the type specified.
  20204. </remarks>
  20205. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  20206. <returns>The logger with the name specified.</returns>
  20207. </member>
  20208. <member name="M:log4net.LogManager.GetLogger(System.String,System.Type)">
  20209. <summary>
  20210. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  20211. </summary>
  20212. <remarks>
  20213. Gets the logger for the fully qualified name of the type specified.
  20214. </remarks>
  20215. <param name="repository">The repository to lookup in.</param>
  20216. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  20217. <returns>The logger with the name specified.</returns>
  20218. </member>
  20219. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)">
  20220. <summary>
  20221. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  20222. </summary>
  20223. <remarks>
  20224. Gets the logger for the fully qualified name of the type specified.
  20225. </remarks>
  20226. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20227. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  20228. <returns>The logger with the name specified.</returns>
  20229. </member>
  20230. <member name="M:log4net.LogManager.Shutdown">
  20231. <summary>
  20232. Shuts down the log4net system.
  20233. </summary>
  20234. <remarks>
  20235. <para>
  20236. Calling this method will <b>safely</b> close and remove all
  20237. appenders in all the loggers including root contained in all the
  20238. default repositories.
  20239. </para>
  20240. <para>
  20241. Some appenders need to be closed before the application exists.
  20242. Otherwise, pending logging events might be lost.
  20243. </para>
  20244. <para>The <c>shutdown</c> method is careful to close nested
  20245. appenders before closing regular appenders. This is allows
  20246. configurations where a regular appender is attached to a logger
  20247. and again to a nested appender.
  20248. </para>
  20249. </remarks>
  20250. </member>
  20251. <member name="M:log4net.LogManager.ShutdownRepository">
  20252. <overloads>Shutdown a logger repository.</overloads>
  20253. <summary>
  20254. Shuts down the default repository.
  20255. </summary>
  20256. <remarks>
  20257. <para>
  20258. Calling this method will <b>safely</b> close and remove all
  20259. appenders in all the loggers including root contained in the
  20260. default repository.
  20261. </para>
  20262. <para>Some appenders need to be closed before the application exists.
  20263. Otherwise, pending logging events might be lost.
  20264. </para>
  20265. <para>The <c>shutdown</c> method is careful to close nested
  20266. appenders before closing regular appenders. This is allows
  20267. configurations where a regular appender is attached to a logger
  20268. and again to a nested appender.
  20269. </para>
  20270. </remarks>
  20271. </member>
  20272. <member name="M:log4net.LogManager.ShutdownRepository(System.String)">
  20273. <summary>
  20274. Shuts down the repository for the repository specified.
  20275. </summary>
  20276. <remarks>
  20277. <para>
  20278. Calling this method will <b>safely</b> close and remove all
  20279. appenders in all the loggers including root contained in the
  20280. <paramref name="repository"/> specified.
  20281. </para>
  20282. <para>
  20283. Some appenders need to be closed before the application exists.
  20284. Otherwise, pending logging events might be lost.
  20285. </para>
  20286. <para>The <c>shutdown</c> method is careful to close nested
  20287. appenders before closing regular appenders. This is allows
  20288. configurations where a regular appender is attached to a logger
  20289. and again to a nested appender.
  20290. </para>
  20291. </remarks>
  20292. <param name="repository">The repository to shutdown.</param>
  20293. </member>
  20294. <member name="M:log4net.LogManager.ShutdownRepository(System.Reflection.Assembly)">
  20295. <summary>
  20296. Shuts down the repository specified.
  20297. </summary>
  20298. <remarks>
  20299. <para>
  20300. Calling this method will <b>safely</b> close and remove all
  20301. appenders in all the loggers including root contained in the
  20302. repository. The repository is looked up using
  20303. the <paramref name="repositoryAssembly"/> specified.
  20304. </para>
  20305. <para>
  20306. Some appenders need to be closed before the application exists.
  20307. Otherwise, pending logging events might be lost.
  20308. </para>
  20309. <para>
  20310. The <c>shutdown</c> method is careful to close nested
  20311. appenders before closing regular appenders. This is allows
  20312. configurations where a regular appender is attached to a logger
  20313. and again to a nested appender.
  20314. </para>
  20315. </remarks>
  20316. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20317. </member>
  20318. <member name="M:log4net.LogManager.ResetConfiguration">
  20319. <overloads>Reset the configuration of a repository</overloads>
  20320. <summary>
  20321. Resets all values contained in this repository instance to their defaults.
  20322. </summary>
  20323. <remarks>
  20324. <para>
  20325. Resets all values contained in the repository instance to their
  20326. defaults. This removes all appenders from all loggers, sets
  20327. the level of all non-root loggers to <c>null</c>,
  20328. sets their additivity flag to <c>true</c> and sets the level
  20329. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  20330. message disabling is set to its default "off" value.
  20331. </para>
  20332. </remarks>
  20333. </member>
  20334. <member name="M:log4net.LogManager.ResetConfiguration(System.String)">
  20335. <summary>
  20336. Resets all values contained in this repository instance to their defaults.
  20337. </summary>
  20338. <remarks>
  20339. <para>
  20340. Reset all values contained in the repository instance to their
  20341. defaults. This removes all appenders from all loggers, sets
  20342. the level of all non-root loggers to <c>null</c>,
  20343. sets their additivity flag to <c>true</c> and sets the level
  20344. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  20345. message disabling is set to its default "off" value.
  20346. </para>
  20347. </remarks>
  20348. <param name="repository">The repository to reset.</param>
  20349. </member>
  20350. <member name="M:log4net.LogManager.ResetConfiguration(System.Reflection.Assembly)">
  20351. <summary>
  20352. Resets all values contained in this repository instance to their defaults.
  20353. </summary>
  20354. <remarks>
  20355. <para>
  20356. Reset all values contained in the repository instance to their
  20357. defaults. This removes all appenders from all loggers, sets
  20358. the level of all non-root loggers to <c>null</c>,
  20359. sets their additivity flag to <c>true</c> and sets the level
  20360. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  20361. message disabling is set to its default "off" value.
  20362. </para>
  20363. </remarks>
  20364. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  20365. </member>
  20366. <member name="M:log4net.LogManager.GetLoggerRepository">
  20367. <overloads>Get the logger repository.</overloads>
  20368. <summary>
  20369. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20370. </summary>
  20371. <remarks>
  20372. <para>
  20373. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20374. by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
  20375. </para>
  20376. </remarks>
  20377. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
  20378. </member>
  20379. <member name="M:log4net.LogManager.GetLoggerRepository(System.String)">
  20380. <summary>
  20381. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20382. </summary>
  20383. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  20384. <remarks>
  20385. <para>
  20386. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20387. by the <paramref name="repository"/> argument.
  20388. </para>
  20389. </remarks>
  20390. <param name="repository">The repository to lookup in.</param>
  20391. </member>
  20392. <member name="M:log4net.LogManager.GetLoggerRepository(System.Reflection.Assembly)">
  20393. <summary>
  20394. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20395. </summary>
  20396. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  20397. <remarks>
  20398. <para>
  20399. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20400. by the <paramref name="repositoryAssembly"/> argument.
  20401. </para>
  20402. </remarks>
  20403. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20404. </member>
  20405. <member name="M:log4net.LogManager.GetRepository">
  20406. <overloads>Get a logger repository.</overloads>
  20407. <summary>
  20408. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20409. </summary>
  20410. <remarks>
  20411. <para>
  20412. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20413. by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
  20414. </para>
  20415. </remarks>
  20416. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
  20417. </member>
  20418. <member name="M:log4net.LogManager.GetRepository(System.String)">
  20419. <summary>
  20420. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20421. </summary>
  20422. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  20423. <remarks>
  20424. <para>
  20425. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20426. by the <paramref name="repository"/> argument.
  20427. </para>
  20428. </remarks>
  20429. <param name="repository">The repository to lookup in.</param>
  20430. </member>
  20431. <member name="M:log4net.LogManager.GetRepository(System.Reflection.Assembly)">
  20432. <summary>
  20433. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  20434. </summary>
  20435. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  20436. <remarks>
  20437. <para>
  20438. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  20439. by the <paramref name="repositoryAssembly"/> argument.
  20440. </para>
  20441. </remarks>
  20442. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  20443. </member>
  20444. <member name="M:log4net.LogManager.CreateDomain(System.Type)">
  20445. <overloads>Create a domain</overloads>
  20446. <summary>
  20447. Creates a repository with the specified repository type.
  20448. </summary>
  20449. <remarks>
  20450. <para>
  20451. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  20452. </para>
  20453. <para>
  20454. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  20455. specified such that a call to <see cref="M:GetRepository()"/> will return
  20456. the same repository instance.
  20457. </para>
  20458. </remarks>
  20459. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20460. and has a no arg constructor. An instance of this type will be created to act
  20461. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20462. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20463. </member>
  20464. <member name="M:log4net.LogManager.CreateRepository(System.Type)">
  20465. <overloads>Create a logger repository.</overloads>
  20466. <summary>
  20467. Creates a repository with the specified repository type.
  20468. </summary>
  20469. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20470. and has a no arg constructor. An instance of this type will be created to act
  20471. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20472. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20473. <remarks>
  20474. <para>
  20475. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  20476. specified such that a call to <see cref="M:GetRepository()"/> will return
  20477. the same repository instance.
  20478. </para>
  20479. </remarks>
  20480. </member>
  20481. <member name="M:log4net.LogManager.CreateDomain(System.String)">
  20482. <summary>
  20483. Creates a repository with the specified name.
  20484. </summary>
  20485. <remarks>
  20486. <para>
  20487. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  20488. </para>
  20489. <para>
  20490. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  20491. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  20492. </para>
  20493. <para>
  20494. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  20495. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  20496. </para>
  20497. </remarks>
  20498. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  20499. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20500. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  20501. </member>
  20502. <member name="M:log4net.LogManager.CreateRepository(System.String)">
  20503. <summary>
  20504. Creates a repository with the specified name.
  20505. </summary>
  20506. <remarks>
  20507. <para>
  20508. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  20509. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  20510. </para>
  20511. <para>
  20512. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  20513. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  20514. </para>
  20515. </remarks>
  20516. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  20517. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20518. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  20519. </member>
  20520. <member name="M:log4net.LogManager.CreateDomain(System.String,System.Type)">
  20521. <summary>
  20522. Creates a repository with the specified name and repository type.
  20523. </summary>
  20524. <remarks>
  20525. <para>
  20526. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  20527. </para>
  20528. <para>
  20529. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  20530. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  20531. </para>
  20532. </remarks>
  20533. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  20534. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20535. and has a no arg constructor. An instance of this type will be created to act
  20536. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20537. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20538. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  20539. </member>
  20540. <member name="M:log4net.LogManager.CreateRepository(System.String,System.Type)">
  20541. <summary>
  20542. Creates a repository with the specified name and repository type.
  20543. </summary>
  20544. <remarks>
  20545. <para>
  20546. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  20547. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  20548. </para>
  20549. </remarks>
  20550. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  20551. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20552. and has a no arg constructor. An instance of this type will be created to act
  20553. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20554. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20555. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  20556. </member>
  20557. <member name="M:log4net.LogManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  20558. <summary>
  20559. Creates a repository for the specified assembly and repository type.
  20560. </summary>
  20561. <remarks>
  20562. <para>
  20563. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  20564. </para>
  20565. <para>
  20566. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  20567. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  20568. same assembly specified will return the same repository instance.
  20569. </para>
  20570. </remarks>
  20571. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  20572. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20573. and has a no arg constructor. An instance of this type will be created to act
  20574. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20575. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20576. </member>
  20577. <member name="M:log4net.LogManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  20578. <summary>
  20579. Creates a repository for the specified assembly and repository type.
  20580. </summary>
  20581. <remarks>
  20582. <para>
  20583. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  20584. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  20585. same assembly specified will return the same repository instance.
  20586. </para>
  20587. </remarks>
  20588. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  20589. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  20590. and has a no arg constructor. An instance of this type will be created to act
  20591. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  20592. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  20593. </member>
  20594. <member name="M:log4net.LogManager.GetAllRepositories">
  20595. <summary>
  20596. Gets the list of currently defined repositories.
  20597. </summary>
  20598. <remarks>
  20599. <para>
  20600. Get an array of all the <see cref="T:log4net.Repository.ILoggerRepository"/> objects that have been created.
  20601. </para>
  20602. </remarks>
  20603. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  20604. </member>
  20605. <member name="M:log4net.LogManager.Flush(System.Int32)">
  20606. <summary>
  20607. Flushes logging events buffered in all configured appenders in the default repository.
  20608. </summary>
  20609. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed.</param>
  20610. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  20611. </member>
  20612. <member name="M:log4net.LogManager.WrapLogger(log4net.Core.ILogger)">
  20613. <summary>
  20614. Looks up the wrapper object for the logger specified.
  20615. </summary>
  20616. <param name="logger">The logger to get the wrapper for.</param>
  20617. <returns>The wrapper for the logger specified.</returns>
  20618. </member>
  20619. <member name="M:log4net.LogManager.WrapLoggers(log4net.Core.ILogger[])">
  20620. <summary>
  20621. Looks up the wrapper objects for the loggers specified.
  20622. </summary>
  20623. <param name="loggers">The loggers to get the wrappers for.</param>
  20624. <returns>The wrapper objects for the loggers specified.</returns>
  20625. </member>
  20626. <member name="M:log4net.LogManager.WrapperCreationHandler(log4net.Core.ILogger)">
  20627. <summary>
  20628. Create the <see cref="T:log4net.Core.ILoggerWrapper"/> objects used by
  20629. this manager.
  20630. </summary>
  20631. <param name="logger">The logger to wrap.</param>
  20632. <returns>The wrapper for the logger specified.</returns>
  20633. </member>
  20634. <member name="F:log4net.LogManager.s_wrapperMap">
  20635. <summary>
  20636. The wrapper map to use to hold the <see cref="T:log4net.Core.LogImpl"/> objects.
  20637. </summary>
  20638. </member>
  20639. <member name="T:log4net.MDC">
  20640. <summary>
  20641. Implementation of Mapped Diagnostic Contexts.
  20642. </summary>
  20643. <remarks>
  20644. <note>
  20645. <para>
  20646. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  20647. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  20648. </para>
  20649. </note>
  20650. <para>
  20651. The MDC class is similar to the <see cref="T:log4net.NDC"/> class except that it is
  20652. based on a map instead of a stack. It provides <i>mapped
  20653. diagnostic contexts</i>. A <i>Mapped Diagnostic Context</i>, or
  20654. MDC in short, is an instrument for distinguishing interleaved log
  20655. output from different sources. Log output is typically interleaved
  20656. when a server handles multiple clients near-simultaneously.
  20657. </para>
  20658. <para>
  20659. The MDC is managed on a per thread basis.
  20660. </para>
  20661. </remarks>
  20662. <threadsafety static="true" instance="true" />
  20663. <author>Nicko Cadell</author>
  20664. <author>Gert Driesen</author>
  20665. </member>
  20666. <member name="M:log4net.MDC.#ctor">
  20667. <summary>
  20668. Initializes a new instance of the <see cref="T:log4net.MDC" /> class.
  20669. </summary>
  20670. <remarks>
  20671. Uses a private access modifier to prevent instantiation of this class.
  20672. </remarks>
  20673. </member>
  20674. <member name="M:log4net.MDC.Get(System.String)">
  20675. <summary>
  20676. Gets the context value identified by the <paramref name="key" /> parameter.
  20677. </summary>
  20678. <param name="key">The key to lookup in the MDC.</param>
  20679. <returns>The string value held for the key, or a <c>null</c> reference if no corresponding value is found.</returns>
  20680. <remarks>
  20681. <note>
  20682. <para>
  20683. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  20684. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  20685. </para>
  20686. </note>
  20687. <para>
  20688. If the <paramref name="key" /> parameter does not look up to a
  20689. previously defined context then <c>null</c> will be returned.
  20690. </para>
  20691. </remarks>
  20692. </member>
  20693. <member name="M:log4net.MDC.Set(System.String,System.String)">
  20694. <summary>
  20695. Add an entry to the MDC
  20696. </summary>
  20697. <param name="key">The key to store the value under.</param>
  20698. <param name="value">The value to store.</param>
  20699. <remarks>
  20700. <note>
  20701. <para>
  20702. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  20703. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  20704. </para>
  20705. </note>
  20706. <para>
  20707. Puts a context value (the <paramref name="value" /> parameter) as identified
  20708. with the <paramref name="key" /> parameter into the current thread's
  20709. context map.
  20710. </para>
  20711. <para>
  20712. If a value is already defined for the <paramref name="key" />
  20713. specified then the value will be replaced. If the <paramref name="value" />
  20714. is specified as <c>null</c> then the key value mapping will be removed.
  20715. </para>
  20716. </remarks>
  20717. </member>
  20718. <member name="M:log4net.MDC.Remove(System.String)">
  20719. <summary>
  20720. Removes the key value mapping for the key specified.
  20721. </summary>
  20722. <param name="key">The key to remove.</param>
  20723. <remarks>
  20724. <note>
  20725. <para>
  20726. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  20727. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  20728. </para>
  20729. </note>
  20730. <para>
  20731. Remove the specified entry from this thread's MDC
  20732. </para>
  20733. </remarks>
  20734. </member>
  20735. <member name="M:log4net.MDC.Clear">
  20736. <summary>
  20737. Clear all entries in the MDC
  20738. </summary>
  20739. <remarks>
  20740. <note>
  20741. <para>
  20742. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  20743. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  20744. </para>
  20745. </note>
  20746. <para>
  20747. Remove all the entries from this thread's MDC
  20748. </para>
  20749. </remarks>
  20750. </member>
  20751. <member name="T:log4net.NDC">
  20752. <summary>
  20753. Implementation of Nested Diagnostic Contexts.
  20754. </summary>
  20755. <remarks>
  20756. <note>
  20757. <para>
  20758. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20759. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20760. </para>
  20761. </note>
  20762. <para>
  20763. A Nested Diagnostic Context, or NDC in short, is an instrument
  20764. to distinguish interleaved log output from different sources. Log
  20765. output is typically interleaved when a server handles multiple
  20766. clients near-simultaneously.
  20767. </para>
  20768. <para>
  20769. Interleaved log output can still be meaningful if each log entry
  20770. from different contexts had a distinctive stamp. This is where NDCs
  20771. come into play.
  20772. </para>
  20773. <para>
  20774. Note that NDCs are managed on a per thread basis. The NDC class
  20775. is made up of static methods that operate on the context of the
  20776. calling thread.
  20777. </para>
  20778. </remarks>
  20779. <example>How to push a message into the context
  20780. <code lang="C#">
  20781. using(NDC.Push("my context message"))
  20782. {
  20783. ... all log calls will have 'my context message' included ...
  20784. } // at the end of the using block the message is automatically removed
  20785. </code>
  20786. </example>
  20787. <threadsafety static="true" instance="true" />
  20788. <author>Nicko Cadell</author>
  20789. <author>Gert Driesen</author>
  20790. </member>
  20791. <member name="M:log4net.NDC.#ctor">
  20792. <summary>
  20793. Initializes a new instance of the <see cref="T:log4net.NDC" /> class.
  20794. </summary>
  20795. <remarks>
  20796. Uses a private access modifier to prevent instantiation of this class.
  20797. </remarks>
  20798. </member>
  20799. <member name="P:log4net.NDC.Depth">
  20800. <summary>
  20801. Gets the current context depth.
  20802. </summary>
  20803. <value>The current context depth.</value>
  20804. <remarks>
  20805. <note>
  20806. <para>
  20807. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20808. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20809. </para>
  20810. </note>
  20811. <para>
  20812. The number of context values pushed onto the context stack.
  20813. </para>
  20814. <para>
  20815. Used to record the current depth of the context. This can then
  20816. be restored using the <see cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> method.
  20817. </para>
  20818. </remarks>
  20819. <seealso cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/>
  20820. </member>
  20821. <member name="M:log4net.NDC.Clear">
  20822. <summary>
  20823. Clears all the contextual information held on the current thread.
  20824. </summary>
  20825. <remarks>
  20826. <note>
  20827. <para>
  20828. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20829. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20830. </para>
  20831. </note>
  20832. <para>
  20833. Clears the stack of NDC data held on the current thread.
  20834. </para>
  20835. </remarks>
  20836. </member>
  20837. <member name="M:log4net.NDC.CloneStack">
  20838. <summary>
  20839. Creates a clone of the stack of context information.
  20840. </summary>
  20841. <returns>A clone of the context info for this thread.</returns>
  20842. <remarks>
  20843. <note>
  20844. <para>
  20845. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20846. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20847. </para>
  20848. </note>
  20849. <para>
  20850. The results of this method can be passed to the <see cref="M:log4net.NDC.Inherit(System.Collections.Stack)"/>
  20851. method to allow child threads to inherit the context of their
  20852. parent thread.
  20853. </para>
  20854. </remarks>
  20855. </member>
  20856. <member name="M:log4net.NDC.Inherit(System.Collections.Stack)">
  20857. <summary>
  20858. Inherits the contextual information from another thread.
  20859. </summary>
  20860. <param name="stack">The context stack to inherit.</param>
  20861. <remarks>
  20862. <note>
  20863. <para>
  20864. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20865. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20866. </para>
  20867. </note>
  20868. <para>
  20869. This thread will use the context information from the stack
  20870. supplied. This can be used to initialize child threads with
  20871. the same contextual information as their parent threads. These
  20872. contexts will <b>NOT</b> be shared. Any further contexts that
  20873. are pushed onto the stack will not be visible to the other.
  20874. Call <see cref="M:log4net.NDC.CloneStack"/> to obtain a stack to pass to
  20875. this method.
  20876. </para>
  20877. </remarks>
  20878. </member>
  20879. <member name="M:log4net.NDC.Pop">
  20880. <summary>
  20881. Removes the top context from the stack.
  20882. </summary>
  20883. <returns>
  20884. The message in the context that was removed from the top
  20885. of the stack.
  20886. </returns>
  20887. <remarks>
  20888. <note>
  20889. <para>
  20890. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20891. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20892. </para>
  20893. </note>
  20894. <para>
  20895. Remove the top context from the stack, and return
  20896. it to the caller. If the stack is empty then an
  20897. empty string (not <c>null</c>) is returned.
  20898. </para>
  20899. </remarks>
  20900. </member>
  20901. <member name="M:log4net.NDC.Push(System.String)">
  20902. <summary>
  20903. Pushes a new context message.
  20904. </summary>
  20905. <param name="message">The new context message.</param>
  20906. <returns>
  20907. An <see cref="T:System.IDisposable"/> that can be used to clean up
  20908. the context stack.
  20909. </returns>
  20910. <remarks>
  20911. <note>
  20912. <para>
  20913. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20914. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20915. </para>
  20916. </note>
  20917. <para>
  20918. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  20919. is returned that can be used to clean up the context stack. This
  20920. can be easily combined with the <c>using</c> keyword to scope the
  20921. context.
  20922. </para>
  20923. </remarks>
  20924. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  20925. <code lang="C#">
  20926. using(log4net.NDC.Push("NDC_Message"))
  20927. {
  20928. log.Warn("This should have an NDC message");
  20929. }
  20930. </code>
  20931. </example>
  20932. </member>
  20933. <member name="M:log4net.NDC.PushFormat(System.String,System.Object[])">
  20934. <summary>
  20935. Pushes a new context message.
  20936. </summary>
  20937. <param name="messageFormat">The new context message string format.</param>
  20938. <param name="args">Arguments to be passed into messageFormat.</param>
  20939. <returns>
  20940. An <see cref="T:System.IDisposable"/> that can be used to clean up
  20941. the context stack.
  20942. </returns>
  20943. <remarks>
  20944. <note>
  20945. <para>
  20946. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20947. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20948. </para>
  20949. </note>
  20950. <para>
  20951. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  20952. is returned that can be used to clean up the context stack. This
  20953. can be easily combined with the <c>using</c> keyword to scope the
  20954. context.
  20955. </para>
  20956. </remarks>
  20957. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  20958. <code lang="C#">
  20959. var someValue = "ExampleContext"
  20960. using(log4net.NDC.PushFormat("NDC_Message {0}", someValue))
  20961. {
  20962. log.Warn("This should have an NDC message");
  20963. }
  20964. </code>
  20965. </example>
  20966. </member>
  20967. <member name="M:log4net.NDC.Remove">
  20968. <summary>
  20969. Removes the context information for this thread. It is
  20970. not required to call this method.
  20971. </summary>
  20972. <remarks>
  20973. <note>
  20974. <para>
  20975. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20976. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20977. </para>
  20978. </note>
  20979. <para>
  20980. This method is not implemented.
  20981. </para>
  20982. </remarks>
  20983. </member>
  20984. <member name="M:log4net.NDC.SetMaxDepth(System.Int32)">
  20985. <summary>
  20986. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  20987. </summary>
  20988. <param name="maxDepth">The maximum depth of the stack</param>
  20989. <remarks>
  20990. <note>
  20991. <para>
  20992. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  20993. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  20994. </para>
  20995. </note>
  20996. <para>
  20997. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  20998. This may truncate the head of the stack. This only affects the
  20999. stack in the current thread. Also it does not prevent it from
  21000. growing, it only sets the maximum depth at the time of the
  21001. call. This can be used to return to a known context depth.
  21002. </para>
  21003. </remarks>
  21004. </member>
  21005. <member name="T:log4net.ObjectRenderer.DefaultRenderer">
  21006. <summary>
  21007. The default object Renderer.
  21008. </summary>
  21009. <remarks>
  21010. <para>
  21011. The default renderer supports rendering objects and collections to strings.
  21012. </para>
  21013. <para>
  21014. See the <see cref="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"/> method for details of the output.
  21015. </para>
  21016. </remarks>
  21017. <author>Nicko Cadell</author>
  21018. <author>Gert Driesen</author>
  21019. </member>
  21020. <member name="M:log4net.ObjectRenderer.DefaultRenderer.#ctor">
  21021. <summary>
  21022. Default constructor
  21023. </summary>
  21024. <remarks>
  21025. <para>
  21026. Default constructor
  21027. </para>
  21028. </remarks>
  21029. </member>
  21030. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  21031. <summary>
  21032. Render the object <paramref name="obj"/> to a string
  21033. </summary>
  21034. <param name="rendererMap">The map used to lookup renderers</param>
  21035. <param name="obj">The object to render</param>
  21036. <param name="writer">The writer to render to</param>
  21037. <remarks>
  21038. <para>
  21039. Render the object <paramref name="obj"/> to a string.
  21040. </para>
  21041. <para>
  21042. The <paramref name="rendererMap"/> parameter is
  21043. provided to lookup and render other objects. This is
  21044. very useful where <paramref name="obj"/> contains
  21045. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object)"/>
  21046. method can be used to render these objects.
  21047. </para>
  21048. <para>
  21049. The default renderer supports rendering objects to strings as follows:
  21050. </para>
  21051. <list type="table">
  21052. <listheader>
  21053. <term>Value</term>
  21054. <description>Rendered String</description>
  21055. </listheader>
  21056. <item>
  21057. <term><c>null</c></term>
  21058. <description>
  21059. <para>"(null)"</para>
  21060. </description>
  21061. </item>
  21062. <item>
  21063. <term><see cref="T:System.Array"/></term>
  21064. <description>
  21065. <para>
  21066. For a one dimensional array this is the
  21067. array type name, an open brace, followed by a comma
  21068. separated list of the elements (using the appropriate
  21069. renderer), followed by a close brace.
  21070. </para>
  21071. <para>
  21072. For example: <c>int[] {1, 2, 3}</c>.
  21073. </para>
  21074. <para>
  21075. If the array is not one dimensional the
  21076. <c>Array.ToString()</c> is returned.
  21077. </para>
  21078. </description>
  21079. </item>
  21080. <item>
  21081. <term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> &amp; <see cref="T:System.Collections.IEnumerator"/></term>
  21082. <description>
  21083. <para>
  21084. Rendered as an open brace, followed by a comma
  21085. separated list of the elements (using the appropriate
  21086. renderer), followed by a close brace.
  21087. </para>
  21088. <para>
  21089. For example: <c>{a, b, c}</c>.
  21090. </para>
  21091. <para>
  21092. All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses,
  21093. or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface.
  21094. </para>
  21095. </description>
  21096. </item>
  21097. <item>
  21098. <term><see cref="T:System.Collections.DictionaryEntry"/></term>
  21099. <description>
  21100. <para>
  21101. Rendered as the key, an equals sign ('='), and the value (using the appropriate
  21102. renderer).
  21103. </para>
  21104. <para>
  21105. For example: <c>key=value</c>.
  21106. </para>
  21107. </description>
  21108. </item>
  21109. <item>
  21110. <term>other</term>
  21111. <description>
  21112. <para><c>Object.ToString()</c></para>
  21113. </description>
  21114. </item>
  21115. </list>
  21116. </remarks>
  21117. </member>
  21118. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderArray(log4net.ObjectRenderer.RendererMap,System.Array,System.IO.TextWriter)">
  21119. <summary>
  21120. Render the array argument into a string
  21121. </summary>
  21122. <param name="rendererMap">The map used to lookup renderers</param>
  21123. <param name="array">the array to render</param>
  21124. <param name="writer">The writer to render to</param>
  21125. <remarks>
  21126. <para>
  21127. For a one dimensional array this is the
  21128. array type name, an open brace, followed by a comma
  21129. separated list of the elements (using the appropriate
  21130. renderer), followed by a close brace. For example:
  21131. <c>int[] {1, 2, 3}</c>.
  21132. </para>
  21133. <para>
  21134. If the array is not one dimensional the
  21135. <c>Array.ToString()</c> is returned.
  21136. </para>
  21137. </remarks>
  21138. </member>
  21139. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)">
  21140. <summary>
  21141. Render the enumerator argument into a string
  21142. </summary>
  21143. <param name="rendererMap">The map used to lookup renderers</param>
  21144. <param name="enumerator">the enumerator to render</param>
  21145. <param name="writer">The writer to render to</param>
  21146. <remarks>
  21147. <para>
  21148. Rendered as an open brace, followed by a comma
  21149. separated list of the elements (using the appropriate
  21150. renderer), followed by a close brace. For example:
  21151. <c>{a, b, c}</c>.
  21152. </para>
  21153. </remarks>
  21154. </member>
  21155. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderDictionaryEntry(log4net.ObjectRenderer.RendererMap,System.Collections.DictionaryEntry,System.IO.TextWriter)">
  21156. <summary>
  21157. Render the DictionaryEntry argument into a string
  21158. </summary>
  21159. <param name="rendererMap">The map used to lookup renderers</param>
  21160. <param name="entry">the DictionaryEntry to render</param>
  21161. <param name="writer">The writer to render to</param>
  21162. <remarks>
  21163. <para>
  21164. Render the key, an equals sign ('='), and the value (using the appropriate
  21165. renderer). For example: <c>key=value</c>.
  21166. </para>
  21167. </remarks>
  21168. </member>
  21169. <member name="T:log4net.ObjectRenderer.IObjectRenderer">
  21170. <summary>
  21171. Implement this interface in order to render objects as strings
  21172. </summary>
  21173. <remarks>
  21174. <para>
  21175. Certain types require special case conversion to
  21176. string form. This conversion is done by an object renderer.
  21177. Object renderers implement the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>
  21178. interface.
  21179. </para>
  21180. </remarks>
  21181. <author>Nicko Cadell</author>
  21182. <author>Gert Driesen</author>
  21183. </member>
  21184. <member name="M:log4net.ObjectRenderer.IObjectRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  21185. <summary>
  21186. Render the object <paramref name="obj"/> to a string
  21187. </summary>
  21188. <param name="rendererMap">The map used to lookup renderers</param>
  21189. <param name="obj">The object to render</param>
  21190. <param name="writer">The writer to render to</param>
  21191. <remarks>
  21192. <para>
  21193. Render the object <paramref name="obj"/> to a
  21194. string.
  21195. </para>
  21196. <para>
  21197. The <paramref name="rendererMap"/> parameter is
  21198. provided to lookup and render other objects. This is
  21199. very useful where <paramref name="obj"/> contains
  21200. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object, TextWriter)"/>
  21201. method can be used to render these objects.
  21202. </para>
  21203. </remarks>
  21204. </member>
  21205. <member name="T:log4net.ObjectRenderer.RendererMap">
  21206. <summary>
  21207. Map class objects to an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  21208. </summary>
  21209. <remarks>
  21210. <para>
  21211. Maintains a mapping between types that require special
  21212. rendering and the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> that
  21213. is used to render them.
  21214. </para>
  21215. <para>
  21216. The <see cref="M:FindAndRender(object)"/> method is used to render an
  21217. <c>object</c> using the appropriate renderers defined in this map.
  21218. </para>
  21219. </remarks>
  21220. <author>Nicko Cadell</author>
  21221. <author>Gert Driesen</author>
  21222. </member>
  21223. <member name="M:log4net.ObjectRenderer.RendererMap.#ctor">
  21224. <summary>
  21225. Default Constructor
  21226. </summary>
  21227. <remarks>
  21228. <para>
  21229. Default constructor.
  21230. </para>
  21231. </remarks>
  21232. </member>
  21233. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)">
  21234. <summary>
  21235. Render <paramref name="obj"/> using the appropriate renderer.
  21236. </summary>
  21237. <param name="obj">the object to render to a string</param>
  21238. <returns>the object rendered as a string</returns>
  21239. <remarks>
  21240. <para>
  21241. This is a convenience method used to render an object to a string.
  21242. The alternative method <see cref="M:FindAndRender(object,TextWriter)"/>
  21243. should be used when streaming output to a <see cref="T:System.IO.TextWriter"/>.
  21244. </para>
  21245. </remarks>
  21246. </member>
  21247. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)">
  21248. <summary>
  21249. Render <paramref name="obj"/> using the appropriate renderer.
  21250. </summary>
  21251. <param name="obj">the object to render to a string</param>
  21252. <param name="writer">The writer to render to</param>
  21253. <remarks>
  21254. <para>
  21255. Find the appropriate renderer for the type of the
  21256. <paramref name="obj"/> parameter. This is accomplished by calling the
  21257. <see cref="M:Get(Type)"/> method. Once a renderer is found, it is
  21258. applied on the object <paramref name="obj"/> and the result is returned
  21259. as a <see cref="T:System.String"/>.
  21260. </para>
  21261. </remarks>
  21262. </member>
  21263. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)">
  21264. <summary>
  21265. Gets the renderer for the specified object type
  21266. </summary>
  21267. <param name="obj">the object to lookup the renderer for</param>
  21268. <returns>the renderer for <paramref name="obj"/></returns>
  21269. <remarks>
  21270. <param>
  21271. Gets the renderer for the specified object type.
  21272. </param>
  21273. <param>
  21274. Syntactic sugar method that calls <see cref="M:Get(Type)"/>
  21275. with the type of the object parameter.
  21276. </param>
  21277. </remarks>
  21278. </member>
  21279. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)">
  21280. <summary>
  21281. Gets the renderer for the specified type
  21282. </summary>
  21283. <param name="type">the type to lookup the renderer for</param>
  21284. <returns>the renderer for the specified type</returns>
  21285. <remarks>
  21286. <para>
  21287. Returns the renderer for the specified type.
  21288. If no specific renderer has been defined the
  21289. <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> will be returned.
  21290. </para>
  21291. </remarks>
  21292. </member>
  21293. <member name="M:log4net.ObjectRenderer.RendererMap.SearchTypeAndInterfaces(System.Type)">
  21294. <summary>
  21295. Internal function to recursively search interfaces
  21296. </summary>
  21297. <param name="type">the type to lookup the renderer for</param>
  21298. <returns>the renderer for the specified type</returns>
  21299. </member>
  21300. <member name="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer">
  21301. <summary>
  21302. Get the default renderer instance
  21303. </summary>
  21304. <value>the default renderer</value>
  21305. <remarks>
  21306. <para>
  21307. Get the default renderer
  21308. </para>
  21309. </remarks>
  21310. </member>
  21311. <member name="M:log4net.ObjectRenderer.RendererMap.Clear">
  21312. <summary>
  21313. Clear the map of renderers
  21314. </summary>
  21315. <remarks>
  21316. <para>
  21317. Clear the custom renderers defined by using
  21318. <see cref="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"/>. The <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/>
  21319. cannot be removed.
  21320. </para>
  21321. </remarks>
  21322. </member>
  21323. <member name="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  21324. <summary>
  21325. Register an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> for <paramref name="typeToRender"/>.
  21326. </summary>
  21327. <param name="typeToRender">the type that will be rendered by <paramref name="renderer"/></param>
  21328. <param name="renderer">the renderer for <paramref name="typeToRender"/></param>
  21329. <remarks>
  21330. <para>
  21331. Register an object renderer for a specific source type.
  21332. This renderer will be returned from a call to <see cref="M:Get(Type)"/>
  21333. specifying the same <paramref name="typeToRender"/> as an argument.
  21334. </para>
  21335. </remarks>
  21336. </member>
  21337. <member name="T:log4net.Plugin.IPlugin">
  21338. <summary>
  21339. Interface implemented by logger repository plugins.
  21340. </summary>
  21341. <remarks>
  21342. <para>
  21343. Plugins define additional behavior that can be associated
  21344. with a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21345. The <see cref="T:log4net.Plugin.PluginMap"/> held by the <see cref="P:log4net.Repository.ILoggerRepository.PluginMap"/>
  21346. property is used to store the plugins for a repository.
  21347. </para>
  21348. <para>
  21349. The <c>log4net.Config.PluginAttribute</c> can be used to
  21350. attach plugins to repositories created using configuration
  21351. attributes.
  21352. </para>
  21353. </remarks>
  21354. <author>Nicko Cadell</author>
  21355. <author>Gert Driesen</author>
  21356. </member>
  21357. <member name="P:log4net.Plugin.IPlugin.Name">
  21358. <summary>
  21359. Gets the name of the plugin.
  21360. </summary>
  21361. <value>
  21362. The name of the plugin.
  21363. </value>
  21364. <remarks>
  21365. <para>
  21366. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  21367. keyed by name. Each plugin instance attached to a
  21368. repository must be a unique name.
  21369. </para>
  21370. </remarks>
  21371. </member>
  21372. <member name="M:log4net.Plugin.IPlugin.Attach(log4net.Repository.ILoggerRepository)">
  21373. <summary>
  21374. Attaches the plugin to the specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21375. </summary>
  21376. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  21377. <remarks>
  21378. <para>
  21379. A plugin may only be attached to a single repository.
  21380. </para>
  21381. <para>
  21382. This method is called when the plugin is attached to the repository.
  21383. </para>
  21384. </remarks>
  21385. </member>
  21386. <member name="M:log4net.Plugin.IPlugin.Shutdown">
  21387. <summary>
  21388. Is called when the plugin is to shutdown.
  21389. </summary>
  21390. <remarks>
  21391. <para>
  21392. This method is called to notify the plugin that
  21393. it should stop operating and should detach from
  21394. the repository.
  21395. </para>
  21396. </remarks>
  21397. </member>
  21398. <member name="T:log4net.Plugin.IPluginFactory">
  21399. <summary>
  21400. Interface used to create plugins.
  21401. </summary>
  21402. <remarks>
  21403. <para>
  21404. Interface used to create a plugin.
  21405. </para>
  21406. </remarks>
  21407. <author>Nicko Cadell</author>
  21408. <author>Gert Driesen</author>
  21409. </member>
  21410. <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin">
  21411. <summary>
  21412. Creates the plugin object.
  21413. </summary>
  21414. <returns>the new plugin instance</returns>
  21415. <remarks>
  21416. <para>
  21417. Create and return a new plugin instance.
  21418. </para>
  21419. </remarks>
  21420. </member>
  21421. <member name="T:log4net.Plugin.PluginCollection">
  21422. <summary>
  21423. A strongly-typed collection of <see cref="T:log4net.Plugin.IPlugin"/> objects.
  21424. </summary>
  21425. <author>Nicko Cadell</author>
  21426. </member>
  21427. <member name="T:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator">
  21428. <summary>
  21429. Supports type-safe iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  21430. </summary>
  21431. <exclude/>
  21432. </member>
  21433. <member name="P:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Current">
  21434. <summary>
  21435. Gets the current element in the collection.
  21436. </summary>
  21437. </member>
  21438. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.MoveNext">
  21439. <summary>
  21440. Advances the enumerator to the next element in the collection.
  21441. </summary>
  21442. <returns>
  21443. <c>true</c> if the enumerator was successfully advanced to the next element;
  21444. <c>false</c> if the enumerator has passed the end of the collection.
  21445. </returns>
  21446. <exception cref="T:System.InvalidOperationException">
  21447. The collection was modified after the enumerator was created.
  21448. </exception>
  21449. </member>
  21450. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Reset">
  21451. <summary>
  21452. Sets the enumerator to its initial position, before the first element in the collection.
  21453. </summary>
  21454. </member>
  21455. <member name="M:log4net.Plugin.PluginCollection.ReadOnly(log4net.Plugin.PluginCollection)">
  21456. <summary>
  21457. Creates a read-only wrapper for a <c>PluginCollection</c> instance.
  21458. </summary>
  21459. <param name="list">list to create a readonly wrapper arround</param>
  21460. <returns>
  21461. A <c>PluginCollection</c> wrapper that is read-only.
  21462. </returns>
  21463. </member>
  21464. <member name="M:log4net.Plugin.PluginCollection.#ctor">
  21465. <summary>
  21466. Initializes a new instance of the <c>PluginCollection</c> class
  21467. that is empty and has the default initial capacity.
  21468. </summary>
  21469. </member>
  21470. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Int32)">
  21471. <summary>
  21472. Initializes a new instance of the <c>PluginCollection</c> class
  21473. that has the specified initial capacity.
  21474. </summary>
  21475. <param name="capacity">
  21476. The number of elements that the new <c>PluginCollection</c> is initially capable of storing.
  21477. </param>
  21478. </member>
  21479. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection)">
  21480. <summary>
  21481. Initializes a new instance of the <c>PluginCollection</c> class
  21482. that contains elements copied from the specified <c>PluginCollection</c>.
  21483. </summary>
  21484. <param name="c">The <c>PluginCollection</c> whose elements are copied to the new collection.</param>
  21485. </member>
  21486. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.IPlugin[])">
  21487. <summary>
  21488. Initializes a new instance of the <c>PluginCollection</c> class
  21489. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> array.
  21490. </summary>
  21491. <param name="a">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements are copied to the new list.</param>
  21492. </member>
  21493. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Collections.ICollection)">
  21494. <summary>
  21495. Initializes a new instance of the <c>PluginCollection</c> class
  21496. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> collection.
  21497. </summary>
  21498. <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements are copied to the new list.</param>
  21499. </member>
  21500. <member name="T:log4net.Plugin.PluginCollection.Tag">
  21501. <summary>
  21502. Type visible only to our subclasses
  21503. Used to access protected constructor
  21504. </summary>
  21505. <exclude/>
  21506. </member>
  21507. <member name="F:log4net.Plugin.PluginCollection.Tag.Default">
  21508. <summary>
  21509. A value
  21510. </summary>
  21511. </member>
  21512. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection.Tag)">
  21513. <summary>
  21514. Allow subclasses to avoid our default constructors
  21515. </summary>
  21516. <param name="tag"></param>
  21517. <exclude/>
  21518. </member>
  21519. <member name="P:log4net.Plugin.PluginCollection.Count">
  21520. <summary>
  21521. Gets the number of elements actually contained in the <c>PluginCollection</c>.
  21522. </summary>
  21523. </member>
  21524. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[])">
  21525. <summary>
  21526. Copies the entire <c>PluginCollection</c> to a one-dimensional
  21527. <see cref="T:log4net.Plugin.IPlugin"/> array.
  21528. </summary>
  21529. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  21530. </member>
  21531. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[],System.Int32)">
  21532. <summary>
  21533. Copies the entire <c>PluginCollection</c> to a one-dimensional
  21534. <see cref="T:log4net.Plugin.IPlugin"/> array, starting at the specified index of the target array.
  21535. </summary>
  21536. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  21537. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  21538. </member>
  21539. <member name="P:log4net.Plugin.PluginCollection.IsSynchronized">
  21540. <summary>
  21541. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  21542. </summary>
  21543. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  21544. </member>
  21545. <member name="P:log4net.Plugin.PluginCollection.SyncRoot">
  21546. <summary>
  21547. Gets an object that can be used to synchronize access to the collection.
  21548. </summary>
  21549. <value>
  21550. An object that can be used to synchronize access to the collection.
  21551. </value>
  21552. </member>
  21553. <member name="P:log4net.Plugin.PluginCollection.Item(System.Int32)">
  21554. <summary>
  21555. Gets or sets the <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  21556. </summary>
  21557. <value>
  21558. The <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  21559. </value>
  21560. <param name="index">The zero-based index of the element to get or set.</param>
  21561. <exception cref="T:System.ArgumentOutOfRangeException">
  21562. <para><paramref name="index"/> is less than zero.</para>
  21563. <para>-or-</para>
  21564. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  21565. </exception>
  21566. </member>
  21567. <member name="M:log4net.Plugin.PluginCollection.Add(log4net.Plugin.IPlugin)">
  21568. <summary>
  21569. Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the end of the <c>PluginCollection</c>.
  21570. </summary>
  21571. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to be added to the end of the <c>PluginCollection</c>.</param>
  21572. <returns>The index at which the value has been added.</returns>
  21573. </member>
  21574. <member name="M:log4net.Plugin.PluginCollection.Clear">
  21575. <summary>
  21576. Removes all elements from the <c>PluginCollection</c>.
  21577. </summary>
  21578. </member>
  21579. <member name="M:log4net.Plugin.PluginCollection.Clone">
  21580. <summary>
  21581. Creates a shallow copy of the <see cref="T:log4net.Plugin.PluginCollection"/>.
  21582. </summary>
  21583. <returns>A new <see cref="T:log4net.Plugin.PluginCollection"/> with a shallow copy of the collection data.</returns>
  21584. </member>
  21585. <member name="M:log4net.Plugin.PluginCollection.Contains(log4net.Plugin.IPlugin)">
  21586. <summary>
  21587. Determines whether a given <see cref="T:log4net.Plugin.IPlugin"/> is in the <c>PluginCollection</c>.
  21588. </summary>
  21589. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to check for.</param>
  21590. <returns><c>true</c> if <paramref name="item"/> is found in the <c>PluginCollection</c>; otherwise, <c>false</c>.</returns>
  21591. </member>
  21592. <member name="M:log4net.Plugin.PluginCollection.IndexOf(log4net.Plugin.IPlugin)">
  21593. <summary>
  21594. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Plugin.IPlugin"/>
  21595. in the <c>PluginCollection</c>.
  21596. </summary>
  21597. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to locate in the <c>PluginCollection</c>.</param>
  21598. <returns>
  21599. The zero-based index of the first occurrence of <paramref name="item"/>
  21600. in the entire <c>PluginCollection</c>, if found; otherwise, -1.
  21601. </returns>
  21602. </member>
  21603. <member name="M:log4net.Plugin.PluginCollection.Insert(System.Int32,log4net.Plugin.IPlugin)">
  21604. <summary>
  21605. Inserts an element into the <c>PluginCollection</c> at the specified index.
  21606. </summary>
  21607. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  21608. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to insert.</param>
  21609. <exception cref="T:System.ArgumentOutOfRangeException">
  21610. <para><paramref name="index"/> is less than zero</para>
  21611. <para>-or-</para>
  21612. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  21613. </exception>
  21614. </member>
  21615. <member name="M:log4net.Plugin.PluginCollection.Remove(log4net.Plugin.IPlugin)">
  21616. <summary>
  21617. Removes the first occurrence of a specific <see cref="T:log4net.Plugin.IPlugin"/> from the <c>PluginCollection</c>.
  21618. </summary>
  21619. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the <c>PluginCollection</c>.</param>
  21620. <exception cref="T:System.ArgumentException">
  21621. The specified <see cref="T:log4net.Plugin.IPlugin"/> was not found in the <c>PluginCollection</c>.
  21622. </exception>
  21623. </member>
  21624. <member name="M:log4net.Plugin.PluginCollection.RemoveAt(System.Int32)">
  21625. <summary>
  21626. Removes the element at the specified index of the <c>PluginCollection</c>.
  21627. </summary>
  21628. <param name="index">The zero-based index of the element to remove.</param>
  21629. <exception cref="T:System.ArgumentOutOfRangeException">
  21630. <para><paramref name="index"/> is less than zero.</para>
  21631. <para>-or-</para>
  21632. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  21633. </exception>
  21634. </member>
  21635. <member name="P:log4net.Plugin.PluginCollection.IsFixedSize">
  21636. <summary>
  21637. Gets a value indicating whether the collection has a fixed size.
  21638. </summary>
  21639. <value><c>true</c> if the collection has a fixed size; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  21640. </member>
  21641. <member name="P:log4net.Plugin.PluginCollection.IsReadOnly">
  21642. <summary>
  21643. Gets a value indicating whether the IList is read-only.
  21644. </summary>
  21645. <value><c>true</c> if the collection is read-only; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  21646. </member>
  21647. <member name="M:log4net.Plugin.PluginCollection.GetEnumerator">
  21648. <summary>
  21649. Returns an enumerator that can iterate through the <c>PluginCollection</c>.
  21650. </summary>
  21651. <returns>An <see cref="T:log4net.Plugin.PluginCollection.Enumerator"/> for the entire <c>PluginCollection</c>.</returns>
  21652. </member>
  21653. <member name="P:log4net.Plugin.PluginCollection.Capacity">
  21654. <summary>
  21655. Gets or sets the number of elements the <c>PluginCollection</c> can contain.
  21656. </summary>
  21657. <value>
  21658. The number of elements the <c>PluginCollection</c> can contain.
  21659. </value>
  21660. </member>
  21661. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.PluginCollection)">
  21662. <summary>
  21663. Adds the elements of another <c>PluginCollection</c> to the current <c>PluginCollection</c>.
  21664. </summary>
  21665. <param name="x">The <c>PluginCollection</c> whose elements should be added to the end of the current <c>PluginCollection</c>.</param>
  21666. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  21667. </member>
  21668. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.IPlugin[])">
  21669. <summary>
  21670. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> array to the current <c>PluginCollection</c>.
  21671. </summary>
  21672. <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>
  21673. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  21674. </member>
  21675. <member name="M:log4net.Plugin.PluginCollection.AddRange(System.Collections.ICollection)">
  21676. <summary>
  21677. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> collection to the current <c>PluginCollection</c>.
  21678. </summary>
  21679. <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>
  21680. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  21681. </member>
  21682. <member name="M:log4net.Plugin.PluginCollection.TrimToSize">
  21683. <summary>
  21684. Sets the capacity to the actual number of elements.
  21685. </summary>
  21686. </member>
  21687. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32)">
  21688. <exception cref="T:System.ArgumentOutOfRangeException">
  21689. <para><paramref name="i"/> is less than zero.</para>
  21690. <para>-or-</para>
  21691. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  21692. </exception>
  21693. </member>
  21694. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32,System.Boolean)">
  21695. <exception cref="T:System.ArgumentOutOfRangeException">
  21696. <para><paramref name="i"/> is less than zero.</para>
  21697. <para>-or-</para>
  21698. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  21699. </exception>
  21700. </member>
  21701. <member name="T:log4net.Plugin.PluginCollection.Enumerator">
  21702. <summary>
  21703. Supports simple iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  21704. </summary>
  21705. <exclude/>
  21706. </member>
  21707. <member name="M:log4net.Plugin.PluginCollection.Enumerator.#ctor(log4net.Plugin.PluginCollection)">
  21708. <summary>
  21709. Initializes a new instance of the <c>Enumerator</c> class.
  21710. </summary>
  21711. <param name="tc"></param>
  21712. </member>
  21713. <member name="P:log4net.Plugin.PluginCollection.Enumerator.Current">
  21714. <summary>
  21715. Gets the current element in the collection.
  21716. </summary>
  21717. <value>
  21718. The current element in the collection.
  21719. </value>
  21720. </member>
  21721. <member name="M:log4net.Plugin.PluginCollection.Enumerator.MoveNext">
  21722. <summary>
  21723. Advances the enumerator to the next element in the collection.
  21724. </summary>
  21725. <returns>
  21726. <c>true</c> if the enumerator was successfully advanced to the next element;
  21727. <c>false</c> if the enumerator has passed the end of the collection.
  21728. </returns>
  21729. <exception cref="T:System.InvalidOperationException">
  21730. The collection was modified after the enumerator was created.
  21731. </exception>
  21732. </member>
  21733. <member name="M:log4net.Plugin.PluginCollection.Enumerator.Reset">
  21734. <summary>
  21735. Sets the enumerator to its initial position, before the first element in the collection.
  21736. </summary>
  21737. </member>
  21738. <member name="T:log4net.Plugin.PluginCollection.ReadOnlyPluginCollection">
  21739. <exclude/>
  21740. </member>
  21741. <member name="T:log4net.Plugin.PluginMap">
  21742. <summary>
  21743. Map of repository plugins.
  21744. </summary>
  21745. <remarks>
  21746. <para>
  21747. This class is a name keyed map of the plugins that are
  21748. attached to a repository.
  21749. </para>
  21750. </remarks>
  21751. <author>Nicko Cadell</author>
  21752. <author>Gert Driesen</author>
  21753. </member>
  21754. <member name="M:log4net.Plugin.PluginMap.#ctor(log4net.Repository.ILoggerRepository)">
  21755. <summary>
  21756. Constructor
  21757. </summary>
  21758. <param name="repository">The repository that the plugins should be attached to.</param>
  21759. <remarks>
  21760. <para>
  21761. Initialize a new instance of the <see cref="T:log4net.Plugin.PluginMap" /> class with a
  21762. repository that the plugins should be attached to.
  21763. </para>
  21764. </remarks>
  21765. </member>
  21766. <member name="P:log4net.Plugin.PluginMap.Item(System.String)">
  21767. <summary>
  21768. Gets a <see cref="T:log4net.Plugin.IPlugin" /> by name.
  21769. </summary>
  21770. <param name="name">The name of the <see cref="T:log4net.Plugin.IPlugin" /> to lookup.</param>
  21771. <returns>
  21772. The <see cref="T:log4net.Plugin.IPlugin" /> from the map with the name specified, or
  21773. <c>null</c> if no plugin is found.
  21774. </returns>
  21775. <remarks>
  21776. <para>
  21777. Lookup a plugin by name. If the plugin is not found <c>null</c>
  21778. will be returned.
  21779. </para>
  21780. </remarks>
  21781. </member>
  21782. <member name="P:log4net.Plugin.PluginMap.AllPlugins">
  21783. <summary>
  21784. Gets all possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin" /> objects.
  21785. </summary>
  21786. <value>All possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin" /> objects.</value>
  21787. <remarks>
  21788. <para>
  21789. Get a collection of all the plugins defined in this map.
  21790. </para>
  21791. </remarks>
  21792. </member>
  21793. <member name="M:log4net.Plugin.PluginMap.Add(log4net.Plugin.IPlugin)">
  21794. <summary>
  21795. Adds a <see cref="T:log4net.Plugin.IPlugin" /> to the map.
  21796. </summary>
  21797. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin" /> to add to the map.</param>
  21798. <remarks>
  21799. <para>
  21800. The <see cref="T:log4net.Plugin.IPlugin" /> will be attached to the repository when added.
  21801. </para>
  21802. <para>
  21803. If there already exists a plugin with the same name
  21804. attached to the repository then the old plugin will
  21805. be <see cref="M:log4net.Plugin.IPlugin.Shutdown"/> and replaced with
  21806. the new plugin.
  21807. </para>
  21808. </remarks>
  21809. </member>
  21810. <member name="M:log4net.Plugin.PluginMap.Remove(log4net.Plugin.IPlugin)">
  21811. <summary>
  21812. Removes a <see cref="T:log4net.Plugin.IPlugin" /> from the map.
  21813. </summary>
  21814. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin" /> to remove from the map.</param>
  21815. <remarks>
  21816. <para>
  21817. Remove a specific plugin from this map.
  21818. </para>
  21819. </remarks>
  21820. </member>
  21821. <member name="T:log4net.Plugin.PluginSkeleton">
  21822. <summary>
  21823. Base implementation of <see cref="T:log4net.Plugin.IPlugin"/>
  21824. </summary>
  21825. <remarks>
  21826. <para>
  21827. Default abstract implementation of the <see cref="T:log4net.Plugin.IPlugin"/>
  21828. interface. This base class can be used by implementors
  21829. of the <see cref="T:log4net.Plugin.IPlugin"/> interface.
  21830. </para>
  21831. </remarks>
  21832. <author>Nicko Cadell</author>
  21833. <author>Gert Driesen</author>
  21834. </member>
  21835. <member name="M:log4net.Plugin.PluginSkeleton.#ctor(System.String)">
  21836. <summary>
  21837. Constructor
  21838. </summary>
  21839. <param name="name">the name of the plugin</param>
  21840. <remarks>
  21841. Initializes a new Plugin with the specified name.
  21842. </remarks>
  21843. </member>
  21844. <member name="P:log4net.Plugin.PluginSkeleton.Name">
  21845. <summary>
  21846. Gets or sets the name of the plugin.
  21847. </summary>
  21848. <value>
  21849. The name of the plugin.
  21850. </value>
  21851. <remarks>
  21852. <para>
  21853. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  21854. keyed by name. Each plugin instance attached to a
  21855. repository must be a unique name.
  21856. </para>
  21857. <para>
  21858. The name of the plugin must not change one the
  21859. plugin has been attached to a repository.
  21860. </para>
  21861. </remarks>
  21862. </member>
  21863. <member name="M:log4net.Plugin.PluginSkeleton.Attach(log4net.Repository.ILoggerRepository)">
  21864. <summary>
  21865. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21866. </summary>
  21867. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  21868. <remarks>
  21869. <para>
  21870. A plugin may only be attached to a single repository.
  21871. </para>
  21872. <para>
  21873. This method is called when the plugin is attached to the repository.
  21874. </para>
  21875. </remarks>
  21876. </member>
  21877. <member name="M:log4net.Plugin.PluginSkeleton.Shutdown">
  21878. <summary>
  21879. Is called when the plugin is to shutdown.
  21880. </summary>
  21881. <remarks>
  21882. <para>
  21883. This method is called to notify the plugin that
  21884. it should stop operating and should detach from
  21885. the repository.
  21886. </para>
  21887. </remarks>
  21888. </member>
  21889. <member name="P:log4net.Plugin.PluginSkeleton.LoggerRepository">
  21890. <summary>
  21891. The repository for this plugin
  21892. </summary>
  21893. <value>
  21894. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this plugin is attached to.
  21895. </value>
  21896. <remarks>
  21897. <para>
  21898. Gets or sets the <see cref="T:log4net.Repository.ILoggerRepository" /> that this plugin is
  21899. attached to.
  21900. </para>
  21901. </remarks>
  21902. </member>
  21903. <member name="F:log4net.Plugin.PluginSkeleton.m_name">
  21904. <summary>
  21905. The name of this plugin.
  21906. </summary>
  21907. </member>
  21908. <member name="F:log4net.Plugin.PluginSkeleton.m_repository">
  21909. <summary>
  21910. The repository this plugin is attached to.
  21911. </summary>
  21912. </member>
  21913. <member name="T:log4net.Plugin.RemoteLoggingServerPlugin">
  21914. <summary>
  21915. Plugin that listens for events from the <see cref="T:log4net.Appender.RemotingAppender"/>
  21916. </summary>
  21917. <remarks>
  21918. <para>
  21919. This plugin publishes an instance of <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  21920. on a specified <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/>. This listens for logging events delivered from
  21921. a remote <see cref="T:log4net.Appender.RemotingAppender"/>.
  21922. </para>
  21923. <para>
  21924. When an event is received it is relogged within the attached repository
  21925. as if it had been raised locally.
  21926. </para>
  21927. </remarks>
  21928. <author>Nicko Cadell</author>
  21929. <author>Gert Driesen</author>
  21930. </member>
  21931. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor">
  21932. <summary>
  21933. Default constructor
  21934. </summary>
  21935. <remarks>
  21936. <para>
  21937. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin" /> class.
  21938. </para>
  21939. <para>
  21940. The <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> property must be set.
  21941. </para>
  21942. </remarks>
  21943. </member>
  21944. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor(System.String)">
  21945. <summary>
  21946. Construct with sink Uri.
  21947. </summary>
  21948. <param name="sinkUri">The name to publish the sink under in the remoting infrastructure.
  21949. See <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> for more details.</param>
  21950. <remarks>
  21951. <para>
  21952. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin" /> class
  21953. with specified name.
  21954. </para>
  21955. </remarks>
  21956. </member>
  21957. <member name="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri">
  21958. <summary>
  21959. Gets or sets the URI of this sink.
  21960. </summary>
  21961. <value>
  21962. The URI of this sink.
  21963. </value>
  21964. <remarks>
  21965. <para>
  21966. This is the name under which the object is marshaled.
  21967. <see cref="M:RemotingServices.Marshal(MarshalByRefObject,String,Type)"/>
  21968. </para>
  21969. </remarks>
  21970. </member>
  21971. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Attach(log4net.Repository.ILoggerRepository)">
  21972. <summary>
  21973. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21974. </summary>
  21975. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  21976. <remarks>
  21977. <para>
  21978. A plugin may only be attached to a single repository.
  21979. </para>
  21980. <para>
  21981. This method is called when the plugin is attached to the repository.
  21982. </para>
  21983. </remarks>
  21984. </member>
  21985. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Shutdown">
  21986. <summary>
  21987. Is called when the plugin is to shutdown.
  21988. </summary>
  21989. <remarks>
  21990. <para>
  21991. When the plugin is shutdown the remote logging
  21992. sink is disconnected.
  21993. </para>
  21994. </remarks>
  21995. </member>
  21996. <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.declaringType">
  21997. <summary>
  21998. The fully qualified type of the RemoteLoggingServerPlugin class.
  21999. </summary>
  22000. <remarks>
  22001. Used by the internal logger to record the Type of the
  22002. log message.
  22003. </remarks>
  22004. </member>
  22005. <member name="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl">
  22006. <summary>
  22007. Delivers <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  22008. </summary>
  22009. <remarks>
  22010. <para>
  22011. Internal class used to listen for logging events
  22012. and deliver them to the local repository.
  22013. </para>
  22014. </remarks>
  22015. </member>
  22016. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.#ctor(log4net.Repository.ILoggerRepository)">
  22017. <summary>
  22018. Constructor
  22019. </summary>
  22020. <param name="repository">The repository to log to.</param>
  22021. <remarks>
  22022. <para>
  22023. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl"/> for the
  22024. specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  22025. </para>
  22026. </remarks>
  22027. </member>
  22028. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.LogEvents(log4net.Core.LoggingEvent[])">
  22029. <summary>
  22030. Logs the events to the repository.
  22031. </summary>
  22032. <param name="events">The events to log.</param>
  22033. <remarks>
  22034. <para>
  22035. The events passed are logged to the <see cref="T:log4net.Repository.ILoggerRepository"/>
  22036. </para>
  22037. </remarks>
  22038. </member>
  22039. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.InitializeLifetimeService">
  22040. <summary>
  22041. Obtains a lifetime service object to control the lifetime
  22042. policy for this instance.
  22043. </summary>
  22044. <returns><c>null</c> to indicate that this instance should live forever.</returns>
  22045. <remarks>
  22046. <para>
  22047. Obtains a lifetime service object to control the lifetime
  22048. policy for this instance. This object should live forever
  22049. therefore this implementation returns <c>null</c>.
  22050. </para>
  22051. </remarks>
  22052. </member>
  22053. <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.m_repository">
  22054. <summary>
  22055. The underlying <see cref="T:log4net.Repository.ILoggerRepository" /> that events should
  22056. be logged to.
  22057. </summary>
  22058. </member>
  22059. <member name="T:log4net.Repository.ConfigurationChangedEventArgs">
  22060. <summary>
  22061. </summary>
  22062. </member>
  22063. <member name="M:log4net.Repository.ConfigurationChangedEventArgs.#ctor(System.Collections.ICollection)">
  22064. <summary>
  22065. </summary>
  22066. <param name="configurationMessages"></param>
  22067. </member>
  22068. <member name="P:log4net.Repository.ConfigurationChangedEventArgs.ConfigurationMessages">
  22069. <summary>
  22070. </summary>
  22071. </member>
  22072. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory">
  22073. <summary>
  22074. Default implementation of <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  22075. </summary>
  22076. <remarks>
  22077. <para>
  22078. This default implementation of the <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  22079. interface is used to create the default subclass
  22080. of the <see cref="T:log4net.Repository.Hierarchy.Logger"/> object.
  22081. </para>
  22082. </remarks>
  22083. <author>Nicko Cadell</author>
  22084. <author>Gert Driesen</author>
  22085. </member>
  22086. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.#ctor">
  22087. <summary>
  22088. Default constructor
  22089. </summary>
  22090. <remarks>
  22091. <para>
  22092. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory" /> class.
  22093. </para>
  22094. </remarks>
  22095. </member>
  22096. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  22097. <summary>
  22098. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance
  22099. </summary>
  22100. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository" /> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  22101. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  22102. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance for the specified name.</returns>
  22103. <remarks>
  22104. <para>
  22105. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance with the
  22106. specified name.
  22107. </para>
  22108. <para>
  22109. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  22110. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  22111. </para>
  22112. <para>
  22113. If the <paramref name="name"/> is <c>null</c> then the root logger
  22114. must be returned.
  22115. </para>
  22116. </remarks>
  22117. </member>
  22118. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl">
  22119. <summary>
  22120. Default internal subclass of <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  22121. </summary>
  22122. <remarks>
  22123. <para>
  22124. This subclass has no additional behavior over the
  22125. <see cref="T:log4net.Repository.Hierarchy.Logger"/> class but does allow instances
  22126. to be created.
  22127. </para>
  22128. </remarks>
  22129. </member>
  22130. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl.#ctor(System.String)">
  22131. <summary>
  22132. Construct a new Logger
  22133. </summary>
  22134. <param name="name">the name of the logger</param>
  22135. <remarks>
  22136. <para>
  22137. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl" /> class
  22138. with the specified name.
  22139. </para>
  22140. </remarks>
  22141. </member>
  22142. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventHandler">
  22143. <summary>
  22144. Delegate used to handle logger creation event notifications.
  22145. </summary>
  22146. <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>
  22147. <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>
  22148. <remarks>
  22149. <para>
  22150. Delegate used to handle logger creation event notifications.
  22151. </para>
  22152. </remarks>
  22153. </member>
  22154. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs">
  22155. <summary>
  22156. Provides data for the <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event.
  22157. </summary>
  22158. <remarks>
  22159. <para>
  22160. A <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event is raised every time a
  22161. <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> is created.
  22162. </para>
  22163. </remarks>
  22164. </member>
  22165. <member name="F:log4net.Repository.Hierarchy.LoggerCreationEventArgs.m_log">
  22166. <summary>
  22167. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> created
  22168. </summary>
  22169. </member>
  22170. <member name="M:log4net.Repository.Hierarchy.LoggerCreationEventArgs.#ctor(log4net.Repository.Hierarchy.Logger)">
  22171. <summary>
  22172. Constructor
  22173. </summary>
  22174. <param name="log">The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.</param>
  22175. <remarks>
  22176. <para>
  22177. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs" /> event argument
  22178. class,with the specified <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/>.
  22179. </para>
  22180. </remarks>
  22181. </member>
  22182. <member name="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger">
  22183. <summary>
  22184. Gets the <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  22185. </summary>
  22186. <value>
  22187. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  22188. </value>
  22189. <remarks>
  22190. <para>
  22191. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  22192. </para>
  22193. </remarks>
  22194. </member>
  22195. <member name="T:log4net.Repository.Hierarchy.Hierarchy">
  22196. <summary>
  22197. Hierarchical organization of loggers
  22198. </summary>
  22199. <remarks>
  22200. <para>
  22201. <i>The casual user should not have to deal with this class
  22202. directly.</i>
  22203. </para>
  22204. <para>
  22205. This class is specialized in retrieving loggers by name and
  22206. also maintaining the logger hierarchy. Implements the
  22207. <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  22208. </para>
  22209. <para>
  22210. The structure of the logger hierarchy is maintained by the
  22211. <see cref="M:GetLogger(string)"/> method. The hierarchy is such that children
  22212. link to their parent but parents do not have any references to their
  22213. children. Moreover, loggers can be instantiated in any order, in
  22214. particular descendant before ancestor.
  22215. </para>
  22216. <para>
  22217. In case a descendant is created before a particular ancestor,
  22218. then it creates a provision node for the ancestor and adds itself
  22219. to the provision node. Other descendants of the same ancestor add
  22220. themselves to the previously created provision node.
  22221. </para>
  22222. </remarks>
  22223. <author>Nicko Cadell</author>
  22224. <author>Gert Driesen</author>
  22225. </member>
  22226. <member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent">
  22227. <summary>
  22228. Event used to notify that a logger has been created.
  22229. </summary>
  22230. <remarks>
  22231. <para>
  22232. Event raised when a logger is created.
  22233. </para>
  22234. </remarks>
  22235. </member>
  22236. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor">
  22237. <summary>
  22238. Default constructor
  22239. </summary>
  22240. <remarks>
  22241. <para>
  22242. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class.
  22243. </para>
  22244. </remarks>
  22245. </member>
  22246. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary)">
  22247. <summary>
  22248. Construct with properties
  22249. </summary>
  22250. <param name="properties">The properties to pass to this repository.</param>
  22251. <remarks>
  22252. <para>
  22253. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class.
  22254. </para>
  22255. </remarks>
  22256. </member>
  22257. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Repository.Hierarchy.ILoggerFactory)">
  22258. <summary>
  22259. Construct with a logger factory
  22260. </summary>
  22261. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  22262. <remarks>
  22263. <para>
  22264. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class with
  22265. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" />.
  22266. </para>
  22267. </remarks>
  22268. </member>
  22269. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary,log4net.Repository.Hierarchy.ILoggerFactory)">
  22270. <summary>
  22271. Construct with properties and a logger factory
  22272. </summary>
  22273. <param name="properties">The properties to pass to this repository.</param>
  22274. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  22275. <remarks>
  22276. <para>
  22277. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class with
  22278. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" />.
  22279. </para>
  22280. </remarks>
  22281. </member>
  22282. <member name="P:log4net.Repository.Hierarchy.Hierarchy.EmittedNoAppenderWarning">
  22283. <summary>
  22284. Has no appender warning been emitted
  22285. </summary>
  22286. <remarks>
  22287. <para>
  22288. Flag to indicate if we have already issued a warning
  22289. about not having an appender warning.
  22290. </para>
  22291. </remarks>
  22292. </member>
  22293. <member name="P:log4net.Repository.Hierarchy.Hierarchy.Root">
  22294. <summary>
  22295. Get the root of this hierarchy
  22296. </summary>
  22297. <remarks>
  22298. <para>
  22299. Get the root of this hierarchy.
  22300. </para>
  22301. </remarks>
  22302. </member>
  22303. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LoggerFactory">
  22304. <summary>
  22305. Gets or sets the default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" /> instance.
  22306. </summary>
  22307. <value>The default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" /></value>
  22308. <remarks>
  22309. <para>
  22310. The logger factory is used to create logger instances.
  22311. </para>
  22312. </remarks>
  22313. </member>
  22314. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Exists(System.String)">
  22315. <summary>
  22316. Test if a logger exists
  22317. </summary>
  22318. <param name="name">The name of the logger to lookup</param>
  22319. <returns>The Logger object with the name specified</returns>
  22320. <remarks>
  22321. <para>
  22322. Check if the named logger exists in the hierarchy. If so return
  22323. its reference, otherwise returns <c>null</c>.
  22324. </para>
  22325. </remarks>
  22326. </member>
  22327. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetCurrentLoggers">
  22328. <summary>
  22329. Returns all the currently defined loggers in the hierarchy as an Array
  22330. </summary>
  22331. <returns>All the defined loggers</returns>
  22332. <remarks>
  22333. <para>
  22334. Returns all the currently defined loggers in the hierarchy as an Array.
  22335. The root logger is <b>not</b> included in the returned
  22336. enumeration.
  22337. </para>
  22338. </remarks>
  22339. </member>
  22340. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String)">
  22341. <summary>
  22342. Return a new logger instance named as the first parameter using
  22343. the default factory.
  22344. </summary>
  22345. <remarks>
  22346. <para>
  22347. Return a new logger instance named as the first parameter using
  22348. the default factory.
  22349. </para>
  22350. <para>
  22351. If a logger of that name already exists, then it will be
  22352. returned. Otherwise, a new logger will be instantiated and
  22353. then linked with its existing ancestors as well as children.
  22354. </para>
  22355. </remarks>
  22356. <param name="name">The name of the logger to retrieve</param>
  22357. <returns>The logger object with the name specified</returns>
  22358. </member>
  22359. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Shutdown">
  22360. <summary>
  22361. Shutting down a hierarchy will <i>safely</i> close and remove
  22362. all appenders in all loggers including the root logger.
  22363. </summary>
  22364. <remarks>
  22365. <para>
  22366. Shutting down a hierarchy will <i>safely</i> close and remove
  22367. all appenders in all loggers including the root logger.
  22368. </para>
  22369. <para>
  22370. Some appenders need to be closed before the
  22371. application exists. Otherwise, pending logging events might be
  22372. lost.
  22373. </para>
  22374. <para>
  22375. The <c>Shutdown</c> method is careful to close nested
  22376. appenders before closing regular appenders. This is allows
  22377. configurations where a regular appender is attached to a logger
  22378. and again to a nested appender.
  22379. </para>
  22380. </remarks>
  22381. </member>
  22382. <member name="M:log4net.Repository.Hierarchy.Hierarchy.ResetConfiguration">
  22383. <summary>
  22384. Reset all values contained in this hierarchy instance to their default.
  22385. </summary>
  22386. <remarks>
  22387. <para>
  22388. Reset all values contained in this hierarchy instance to their
  22389. default. This removes all appenders from all loggers, sets
  22390. the level of all non-root loggers to <c>null</c>,
  22391. sets their additivity flag to <c>true</c> and sets the level
  22392. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  22393. message disabling is set its default "off" value.
  22394. </para>
  22395. <para>
  22396. Existing loggers are not removed. They are just reset.
  22397. </para>
  22398. <para>
  22399. This method should be used sparingly and with care as it will
  22400. block all logging until it is completed.
  22401. </para>
  22402. </remarks>
  22403. </member>
  22404. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Log(log4net.Core.LoggingEvent)">
  22405. <summary>
  22406. Log the logEvent through this hierarchy.
  22407. </summary>
  22408. <param name="logEvent">the event to log</param>
  22409. <remarks>
  22410. <para>
  22411. This method should not normally be used to log.
  22412. The <see cref="T:log4net.ILog"/> interface should be used
  22413. for routine logging. This interface can be obtained
  22414. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  22415. </para>
  22416. <para>
  22417. The <c>logEvent</c> is delivered to the appropriate logger and
  22418. that logger is then responsible for logging the event.
  22419. </para>
  22420. </remarks>
  22421. </member>
  22422. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetAppenders">
  22423. <summary>
  22424. Returns all the Appenders that are currently configured
  22425. </summary>
  22426. <returns>An array containing all the currently configured appenders</returns>
  22427. <remarks>
  22428. <para>
  22429. Returns all the <see cref="T:log4net.Appender.IAppender"/> instances that are currently configured.
  22430. All the loggers are searched for appenders. The appenders may also be containers
  22431. for appenders and these are also searched for additional loggers.
  22432. </para>
  22433. <para>
  22434. The list returned is unordered but does not contain duplicates.
  22435. </para>
  22436. </remarks>
  22437. </member>
  22438. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppender(System.Collections.ArrayList,log4net.Appender.IAppender)">
  22439. <summary>
  22440. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/>.
  22441. The appender may also be a container.
  22442. </summary>
  22443. <param name="appenderList"></param>
  22444. <param name="appender"></param>
  22445. </member>
  22446. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppenders(System.Collections.ArrayList,log4net.Core.IAppenderAttachable)">
  22447. <summary>
  22448. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/> container
  22449. </summary>
  22450. <param name="appenderList"></param>
  22451. <param name="container"></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 appender
  22456. </summary>
  22457. <param name="appender">the appender to use to log all logging events</param>
  22458. </member>
  22459. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(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. </member>
  22465. <member name="M:log4net.Repository.Hierarchy.Hierarchy.BasicRepositoryConfigure(log4net.Appender.IAppender[])">
  22466. <summary>
  22467. Initialize the log4net system using the specified appenders
  22468. </summary>
  22469. <param name="appenders">the appenders to use to log all logging events</param>
  22470. <remarks>
  22471. <para>
  22472. This method provides the same functionality as the
  22473. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  22474. on this object, but it is protected and therefore can be called by subclasses.
  22475. </para>
  22476. </remarks>
  22477. </member>
  22478. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IXmlRepositoryConfigurator#Configure(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. </member>
  22484. <member name="M:log4net.Repository.Hierarchy.Hierarchy.XmlRepositoryConfigure(System.Xml.XmlElement)">
  22485. <summary>
  22486. Initialize the log4net system using the specified config
  22487. </summary>
  22488. <param name="element">the element containing the root of the config</param>
  22489. <remarks>
  22490. <para>
  22491. This method provides the same functionality as the
  22492. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  22493. on this object, but it is protected and therefore can be called by subclasses.
  22494. </para>
  22495. </remarks>
  22496. </member>
  22497. <member name="M:log4net.Repository.Hierarchy.Hierarchy.IsDisabled(log4net.Core.Level)">
  22498. <summary>
  22499. Test if this hierarchy is disabled for the specified <see cref="T:log4net.Core.Level"/>.
  22500. </summary>
  22501. <param name="level">The level to check against.</param>
  22502. <returns>
  22503. <c>true</c> if the repository is disabled for the level argument, <c>false</c> otherwise.
  22504. </returns>
  22505. <remarks>
  22506. <para>
  22507. If this hierarchy has not been configured then this method will
  22508. always return <c>true</c>.
  22509. </para>
  22510. <para>
  22511. This method will return <c>true</c> if this repository is
  22512. disabled for <c>level</c> object passed as parameter and
  22513. <c>false</c> otherwise.
  22514. </para>
  22515. <para>
  22516. See also the <see cref="P:log4net.Repository.ILoggerRepository.Threshold"/> property.
  22517. </para>
  22518. </remarks>
  22519. </member>
  22520. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Clear">
  22521. <summary>
  22522. Clear all logger definitions from the internal hashtable
  22523. </summary>
  22524. <remarks>
  22525. <para>
  22526. This call will clear all logger definitions from the internal
  22527. hashtable. Invoking this method will irrevocably mess up the
  22528. logger hierarchy.
  22529. </para>
  22530. <para>
  22531. You should <b>really</b> know what you are doing before
  22532. invoking this method.
  22533. </para>
  22534. </remarks>
  22535. </member>
  22536. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String,log4net.Repository.Hierarchy.ILoggerFactory)">
  22537. <summary>
  22538. Return a new logger instance named as the first parameter using
  22539. <paramref name="factory"/>.
  22540. </summary>
  22541. <param name="name">The name of the logger to retrieve</param>
  22542. <param name="factory">The factory that will make the new logger instance</param>
  22543. <returns>The logger object with the name specified</returns>
  22544. <remarks>
  22545. <para>
  22546. If a logger of that name already exists, then it will be
  22547. returned. Otherwise, a new logger will be instantiated by the
  22548. <paramref name="factory"/> parameter and linked with its existing
  22549. ancestors as well as children.
  22550. </para>
  22551. </remarks>
  22552. </member>
  22553. <member name="M:log4net.Repository.Hierarchy.Hierarchy.OnLoggerCreationEvent(log4net.Repository.Hierarchy.Logger)">
  22554. <summary>
  22555. Sends a logger creation event to all registered listeners
  22556. </summary>
  22557. <param name="logger">The newly created logger</param>
  22558. <remarks>
  22559. Raises the logger creation event.
  22560. </remarks>
  22561. </member>
  22562. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateParents(log4net.Repository.Hierarchy.Logger)">
  22563. <summary>
  22564. Updates all the parents of the specified logger
  22565. </summary>
  22566. <param name="log">The logger to update the parents for</param>
  22567. <remarks>
  22568. <para>
  22569. This method loops through all the <i>potential</i> parents of
  22570. <paramref name="log"/>. There 3 possible cases:
  22571. </para>
  22572. <list type="number">
  22573. <item>
  22574. <term>No entry for the potential parent of <paramref name="log"/> exists</term>
  22575. <description>
  22576. We create a ProvisionNode for this potential
  22577. parent and insert <paramref name="log"/> in that provision node.
  22578. </description>
  22579. </item>
  22580. <item>
  22581. <term>The entry is of type Logger for the potential parent.</term>
  22582. <description>
  22583. The entry is <paramref name="log"/>'s nearest existing parent. We
  22584. update <paramref name="log"/>'s parent field with this entry. We also break from
  22585. he loop because updating our parent's parent is our parent's
  22586. responsibility.
  22587. </description>
  22588. </item>
  22589. <item>
  22590. <term>The entry is of type ProvisionNode for this potential parent.</term>
  22591. <description>
  22592. We add <paramref name="log"/> to the list of children for this
  22593. potential parent.
  22594. </description>
  22595. </item>
  22596. </list>
  22597. </remarks>
  22598. </member>
  22599. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateChildren(log4net.Repository.Hierarchy.ProvisionNode,log4net.Repository.Hierarchy.Logger)">
  22600. <summary>
  22601. Replace a <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> with a <see cref="T:log4net.Repository.Hierarchy.Logger"/> in the hierarchy.
  22602. </summary>
  22603. <param name="pn"></param>
  22604. <param name="log"></param>
  22605. <remarks>
  22606. <para>
  22607. We update the links for all the children that placed themselves
  22608. in the provision node 'pn'. The second argument 'log' is a
  22609. reference for the newly created Logger, parent of all the
  22610. children in 'pn'.
  22611. </para>
  22612. <para>
  22613. We loop on all the children 'c' in 'pn'.
  22614. </para>
  22615. <para>
  22616. If the child 'c' has been already linked to a child of
  22617. 'log' then there is no need to update 'c'.
  22618. </para>
  22619. <para>
  22620. Otherwise, we set log's parent field to c's parent and set
  22621. c's parent field to log.
  22622. </para>
  22623. </remarks>
  22624. </member>
  22625. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddLevel(log4net.Repository.Hierarchy.Hierarchy.LevelEntry)">
  22626. <summary>
  22627. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22628. </summary>
  22629. <param name="levelEntry">the level values</param>
  22630. <remarks>
  22631. <para>
  22632. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22633. </para>
  22634. <para>
  22635. Supports setting levels via the configuration file.
  22636. </para>
  22637. </remarks>
  22638. </member>
  22639. <member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry">
  22640. <summary>
  22641. A class to hold the value, name and display name for a level
  22642. </summary>
  22643. <remarks>
  22644. <para>
  22645. A class to hold the value, name and display name for a level
  22646. </para>
  22647. </remarks>
  22648. </member>
  22649. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Value">
  22650. <summary>
  22651. Value of the level
  22652. </summary>
  22653. <remarks>
  22654. <para>
  22655. If the value is not set (defaults to -1) the value will be looked
  22656. up for the current level with the same name.
  22657. </para>
  22658. </remarks>
  22659. </member>
  22660. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Name">
  22661. <summary>
  22662. Name of the level
  22663. </summary>
  22664. <value>
  22665. The name of the level
  22666. </value>
  22667. <remarks>
  22668. <para>
  22669. The name of the level.
  22670. </para>
  22671. </remarks>
  22672. </member>
  22673. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.DisplayName">
  22674. <summary>
  22675. Display name for the level
  22676. </summary>
  22677. <value>
  22678. The display name of the level
  22679. </value>
  22680. <remarks>
  22681. <para>
  22682. The display name of the level.
  22683. </para>
  22684. </remarks>
  22685. </member>
  22686. <member name="M:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.ToString">
  22687. <summary>
  22688. Override <c>Object.ToString</c> to return sensible debug info
  22689. </summary>
  22690. <returns>string info about this object</returns>
  22691. </member>
  22692. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Util.PropertyEntry)">
  22693. <summary>
  22694. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22695. </summary>
  22696. <param name="propertyEntry">the property value</param>
  22697. <remarks>
  22698. <para>
  22699. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument.
  22700. </para>
  22701. <para>
  22702. Supports setting property values via the configuration file.
  22703. </para>
  22704. </remarks>
  22705. </member>
  22706. <member name="F:log4net.Repository.Hierarchy.Hierarchy.declaringType">
  22707. <summary>
  22708. The fully qualified type of the Hierarchy class.
  22709. </summary>
  22710. <remarks>
  22711. Used by the internal logger to record the Type of the
  22712. log message.
  22713. </remarks>
  22714. </member>
  22715. <member name="T:log4net.Repository.Hierarchy.ILoggerFactory">
  22716. <summary>
  22717. Interface abstracts creation of <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances
  22718. </summary>
  22719. <remarks>
  22720. <para>
  22721. This interface is used by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to
  22722. create new <see cref="T:log4net.Repository.Hierarchy.Logger"/> objects.
  22723. </para>
  22724. <para>
  22725. The <see cref="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"/> method is called
  22726. to create a named <see cref="T:log4net.Repository.Hierarchy.Logger" />.
  22727. </para>
  22728. <para>
  22729. Implement this interface to create new subclasses of <see cref="T:log4net.Repository.Hierarchy.Logger" />.
  22730. </para>
  22731. </remarks>
  22732. <author>Nicko Cadell</author>
  22733. <author>Gert Driesen</author>
  22734. </member>
  22735. <member name="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  22736. <summary>
  22737. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance
  22738. </summary>
  22739. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository" /> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  22740. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  22741. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance for the specified name.</returns>
  22742. <remarks>
  22743. <para>
  22744. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance with the
  22745. specified name.
  22746. </para>
  22747. <para>
  22748. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  22749. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  22750. </para>
  22751. <para>
  22752. If the <paramref name="name"/> is <c>null</c> then the root logger
  22753. must be returned.
  22754. </para>
  22755. </remarks>
  22756. </member>
  22757. <member name="T:log4net.Repository.Hierarchy.Logger">
  22758. <summary>
  22759. Implementation of <see cref="T:log4net.Core.ILogger"/> used by <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>
  22760. </summary>
  22761. <remarks>
  22762. <para>
  22763. Internal class used to provide implementation of <see cref="T:log4net.Core.ILogger"/>
  22764. interface. Applications should use <see cref="T:log4net.LogManager"/> to get
  22765. logger instances.
  22766. </para>
  22767. <para>
  22768. This is one of the central classes in the log4net implementation. One of the
  22769. distinctive features of log4net are hierarchical loggers and their
  22770. evaluation. The <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> organizes the <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  22771. instances into a rooted tree hierarchy.
  22772. </para>
  22773. <para>
  22774. The <see cref="T:log4net.Repository.Hierarchy.Logger"/> class is abstract. Only concrete subclasses of
  22775. <see cref="T:log4net.Repository.Hierarchy.Logger"/> can be created. The <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  22776. is used to create instances of this type for the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  22777. </para>
  22778. </remarks>
  22779. <author>Nicko Cadell</author>
  22780. <author>Gert Driesen</author>
  22781. <author>Aspi Havewala</author>
  22782. <author>Douglas de la Torre</author>
  22783. </member>
  22784. <member name="M:log4net.Repository.Hierarchy.Logger.#ctor(System.String)">
  22785. <summary>
  22786. This constructor created a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance and
  22787. sets its name.
  22788. </summary>
  22789. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  22790. <remarks>
  22791. <para>
  22792. This constructor is protected and designed to be used by
  22793. a subclass that is not abstract.
  22794. </para>
  22795. <para>
  22796. Loggers are constructed by <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  22797. objects. See <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> for the default
  22798. logger creator.
  22799. </para>
  22800. </remarks>
  22801. </member>
  22802. <member name="P:log4net.Repository.Hierarchy.Logger.Parent">
  22803. <summary>
  22804. Gets or sets the parent logger in the hierarchy.
  22805. </summary>
  22806. <value>
  22807. The parent logger in the hierarchy.
  22808. </value>
  22809. <remarks>
  22810. <para>
  22811. Part of the Composite pattern that makes the hierarchy.
  22812. The hierarchy is parent linked rather than child linked.
  22813. </para>
  22814. </remarks>
  22815. </member>
  22816. <member name="P:log4net.Repository.Hierarchy.Logger.Additivity">
  22817. <summary>
  22818. Gets or sets a value indicating if child loggers inherit their parent's appenders.
  22819. </summary>
  22820. <value>
  22821. <c>true</c> if child loggers inherit their parent's appenders.
  22822. </value>
  22823. <remarks>
  22824. <para>
  22825. Additivity is set to <c>true</c> by default, that is children inherit
  22826. the appenders of their ancestors by default. If this variable is
  22827. set to <c>false</c> then the appenders found in the
  22828. ancestors of this logger are not used. However, the children
  22829. of this logger will inherit its appenders, unless the children
  22830. have their additivity flag set to <c>false</c> too. See
  22831. the user manual for more details.
  22832. </para>
  22833. </remarks>
  22834. </member>
  22835. <member name="P:log4net.Repository.Hierarchy.Logger.EffectiveLevel">
  22836. <summary>
  22837. Gets the effective level for this logger.
  22838. </summary>
  22839. <returns>The nearest level in the logger hierarchy.</returns>
  22840. <remarks>
  22841. <para>
  22842. Starting from this logger, searches the logger hierarchy for a
  22843. non-null level and returns it. Otherwise, returns the level of the
  22844. root logger.
  22845. </para>
  22846. <para>The Logger class is designed so that this method executes as
  22847. quickly as possible.</para>
  22848. </remarks>
  22849. </member>
  22850. <member name="P:log4net.Repository.Hierarchy.Logger.Hierarchy">
  22851. <summary>
  22852. Gets or sets the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> where this
  22853. <c>Logger</c> instance is attached to.
  22854. </summary>
  22855. <value>The hierarchy that this logger belongs to.</value>
  22856. <remarks>
  22857. <para>
  22858. This logger must be attached to a single <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  22859. </para>
  22860. </remarks>
  22861. </member>
  22862. <member name="P:log4net.Repository.Hierarchy.Logger.Level">
  22863. <summary>
  22864. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>, if any, for this Logger.
  22865. </summary>
  22866. <value>
  22867. The <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> of this logger.
  22868. </value>
  22869. <remarks>
  22870. <para>
  22871. The assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> can be <c>null</c>.
  22872. </para>
  22873. </remarks>
  22874. </member>
  22875. <member name="M:log4net.Repository.Hierarchy.Logger.AddAppender(log4net.Appender.IAppender)">
  22876. <summary>
  22877. Add <paramref name="newAppender"/> to the list of appenders of this
  22878. Logger instance.
  22879. </summary>
  22880. <param name="newAppender">An appender to add to this logger</param>
  22881. <remarks>
  22882. <para>
  22883. Add <paramref name="newAppender"/> to the list of appenders of this
  22884. Logger instance.
  22885. </para>
  22886. <para>
  22887. If <paramref name="newAppender"/> is already in the list of
  22888. appenders, then it won't be added again.
  22889. </para>
  22890. </remarks>
  22891. </member>
  22892. <member name="P:log4net.Repository.Hierarchy.Logger.Appenders">
  22893. <summary>
  22894. Get the appenders contained in this logger as an
  22895. <see cref="T:System.Collections.ICollection"/>.
  22896. </summary>
  22897. <returns>A collection of the appenders in this logger</returns>
  22898. <remarks>
  22899. <para>
  22900. Get the appenders contained in this logger as an
  22901. <see cref="T:System.Collections.ICollection"/>. If no appenders
  22902. can be found, then a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  22903. </para>
  22904. </remarks>
  22905. </member>
  22906. <member name="M:log4net.Repository.Hierarchy.Logger.GetAppender(System.String)">
  22907. <summary>
  22908. Look for the appender named as <c>name</c>
  22909. </summary>
  22910. <param name="name">The name of the appender to lookup</param>
  22911. <returns>The appender with the name specified, or <c>null</c>.</returns>
  22912. <remarks>
  22913. <para>
  22914. Returns the named appender, or null if the appender is not found.
  22915. </para>
  22916. </remarks>
  22917. </member>
  22918. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAllAppenders">
  22919. <summary>
  22920. Remove all previously added appenders from this Logger instance.
  22921. </summary>
  22922. <remarks>
  22923. <para>
  22924. Remove all previously added appenders from this Logger instance.
  22925. </para>
  22926. <para>
  22927. This is useful when re-reading configuration information.
  22928. </para>
  22929. </remarks>
  22930. </member>
  22931. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(log4net.Appender.IAppender)">
  22932. <summary>
  22933. Remove the appender passed as parameter form the list of appenders.
  22934. </summary>
  22935. <param name="appender">The appender to remove</param>
  22936. <returns>The appender removed from the list</returns>
  22937. <remarks>
  22938. <para>
  22939. Remove the appender passed as parameter form the list of appenders.
  22940. The appender removed is not closed.
  22941. If you are discarding the appender you must call
  22942. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  22943. </para>
  22944. </remarks>
  22945. </member>
  22946. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(System.String)">
  22947. <summary>
  22948. Remove the appender passed as parameter form the list of appenders.
  22949. </summary>
  22950. <param name="name">The name of the appender to remove</param>
  22951. <returns>The appender removed from the list</returns>
  22952. <remarks>
  22953. <para>
  22954. Remove the named appender passed as parameter form the list of appenders.
  22955. The appender removed is not closed.
  22956. If you are discarding the appender you must call
  22957. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  22958. </para>
  22959. </remarks>
  22960. </member>
  22961. <member name="P:log4net.Repository.Hierarchy.Logger.Name">
  22962. <summary>
  22963. Gets the logger name.
  22964. </summary>
  22965. <value>
  22966. The name of the logger.
  22967. </value>
  22968. <remarks>
  22969. <para>
  22970. The name of this logger
  22971. </para>
  22972. </remarks>
  22973. </member>
  22974. <member name="M:log4net.Repository.Hierarchy.Logger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  22975. <summary>
  22976. This generic form is intended to be used by wrappers.
  22977. </summary>
  22978. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  22979. the stack boundary into the logging system for this call.</param>
  22980. <param name="level">The level of the message to be logged.</param>
  22981. <param name="message">The message object to log.</param>
  22982. <param name="exception">The exception to log, including its stack trace.</param>
  22983. <remarks>
  22984. <para>
  22985. Generate a logging event for the specified <paramref name="level"/> using
  22986. the <paramref name="message"/> and <paramref name="exception"/>.
  22987. </para>
  22988. <para>
  22989. This method must not throw any exception to the caller.
  22990. </para>
  22991. </remarks>
  22992. </member>
  22993. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)">
  22994. <summary>
  22995. This is the most generic printing method that is intended to be used
  22996. by wrappers.
  22997. </summary>
  22998. <param name="logEvent">The event being logged.</param>
  22999. <remarks>
  23000. <para>
  23001. Logs the specified logging event through this logger.
  23002. </para>
  23003. <para>
  23004. This method must not throw any exception to the caller.
  23005. </para>
  23006. </remarks>
  23007. </member>
  23008. <member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)">
  23009. <summary>
  23010. Checks if this logger is enabled for a given <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> passed as parameter.
  23011. </summary>
  23012. <param name="level">The level to check.</param>
  23013. <returns>
  23014. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  23015. </returns>
  23016. <remarks>
  23017. <para>
  23018. Test if this logger is going to log events of the specified <paramref name="level"/>.
  23019. </para>
  23020. <para>
  23021. This method must not throw any exception to the caller.
  23022. </para>
  23023. </remarks>
  23024. </member>
  23025. <member name="P:log4net.Repository.Hierarchy.Logger.Repository">
  23026. <summary>
  23027. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  23028. <c>Logger</c> instance is attached to.
  23029. </summary>
  23030. <value>
  23031. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this logger belongs to.
  23032. </value>
  23033. <remarks>
  23034. <para>
  23035. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  23036. <c>Logger</c> instance is attached to.
  23037. </para>
  23038. </remarks>
  23039. </member>
  23040. <member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)">
  23041. <summary>
  23042. Deliver the <see cref="T:log4net.Core.LoggingEvent"/> to the attached appenders.
  23043. </summary>
  23044. <param name="loggingEvent">The event to log.</param>
  23045. <remarks>
  23046. <para>
  23047. Call the appenders in the hierarchy starting at
  23048. <c>this</c>. If no appenders could be found, emit a
  23049. warning.
  23050. </para>
  23051. <para>
  23052. This method calls all the appenders inherited from the
  23053. hierarchy circumventing any evaluation of whether to log or not
  23054. to log the particular log request.
  23055. </para>
  23056. </remarks>
  23057. </member>
  23058. <member name="M:log4net.Repository.Hierarchy.Logger.CloseNestedAppenders">
  23059. <summary>
  23060. Closes all attached appenders implementing the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  23061. </summary>
  23062. <remarks>
  23063. <para>
  23064. Used to ensure that the appenders are correctly shutdown.
  23065. </para>
  23066. </remarks>
  23067. </member>
  23068. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.Level,System.Object,System.Exception)">
  23069. <summary>
  23070. This is the most generic printing method. This generic form is intended to be used by wrappers
  23071. </summary>
  23072. <param name="level">The level of the message to be logged.</param>
  23073. <param name="message">The message object to log.</param>
  23074. <param name="exception">The exception to log, including its stack trace.</param>
  23075. <remarks>
  23076. <para>
  23077. Generate a logging event for the specified <paramref name="level"/> using
  23078. the <paramref name="message"/>.
  23079. </para>
  23080. </remarks>
  23081. </member>
  23082. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  23083. <summary>
  23084. Creates a new logging event and logs the event without further checks.
  23085. </summary>
  23086. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  23087. the stack boundary into the logging system for this call.</param>
  23088. <param name="level">The level of the message to be logged.</param>
  23089. <param name="message">The message object to log.</param>
  23090. <param name="exception">The exception to log, including its stack trace.</param>
  23091. <remarks>
  23092. <para>
  23093. Generates a logging event and delivers it to the attached
  23094. appenders.
  23095. </para>
  23096. </remarks>
  23097. </member>
  23098. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(log4net.Core.LoggingEvent)">
  23099. <summary>
  23100. Creates a new logging event and logs the event without further checks.
  23101. </summary>
  23102. <param name="logEvent">The event being logged.</param>
  23103. <remarks>
  23104. <para>
  23105. Delivers the logging event to the attached appenders.
  23106. </para>
  23107. </remarks>
  23108. </member>
  23109. <member name="F:log4net.Repository.Hierarchy.Logger.declaringType">
  23110. <summary>
  23111. The fully qualified type of the Logger class.
  23112. </summary>
  23113. </member>
  23114. <member name="F:log4net.Repository.Hierarchy.Logger.m_name">
  23115. <summary>
  23116. The name of this logger.
  23117. </summary>
  23118. </member>
  23119. <member name="F:log4net.Repository.Hierarchy.Logger.m_level">
  23120. <summary>
  23121. The assigned level of this logger.
  23122. </summary>
  23123. <remarks>
  23124. <para>
  23125. The <c>level</c> variable need not be
  23126. assigned a value in which case it is inherited
  23127. form the hierarchy.
  23128. </para>
  23129. </remarks>
  23130. </member>
  23131. <member name="F:log4net.Repository.Hierarchy.Logger.m_parent">
  23132. <summary>
  23133. The parent of this logger.
  23134. </summary>
  23135. <remarks>
  23136. <para>
  23137. The parent of this logger.
  23138. All loggers have at least one ancestor which is the root logger.
  23139. </para>
  23140. </remarks>
  23141. </member>
  23142. <member name="F:log4net.Repository.Hierarchy.Logger.m_hierarchy">
  23143. <summary>
  23144. Loggers need to know what Hierarchy they are in.
  23145. </summary>
  23146. <remarks>
  23147. <para>
  23148. Loggers need to know what Hierarchy they are in.
  23149. The hierarchy that this logger is a member of is stored
  23150. here.
  23151. </para>
  23152. </remarks>
  23153. </member>
  23154. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderAttachedImpl">
  23155. <summary>
  23156. Helper implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  23157. </summary>
  23158. </member>
  23159. <member name="F:log4net.Repository.Hierarchy.Logger.m_additive">
  23160. <summary>
  23161. Flag indicating if child loggers inherit their parents appenders
  23162. </summary>
  23163. <remarks>
  23164. <para>
  23165. Additivity is set to true by default, that is children inherit
  23166. the appenders of their ancestors by default. If this variable is
  23167. set to <c>false</c> then the appenders found in the
  23168. ancestors of this logger are not used. However, the children
  23169. of this logger will inherit its appenders, unless the children
  23170. have their additivity flag set to <c>false</c> too. See
  23171. the user manual for more details.
  23172. </para>
  23173. </remarks>
  23174. </member>
  23175. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderLock">
  23176. <summary>
  23177. Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl
  23178. </summary>
  23179. </member>
  23180. <member name="T:log4net.Repository.Hierarchy.LoggerKey">
  23181. <summary>
  23182. Used internally to accelerate hash table searches.
  23183. </summary>
  23184. <remarks>
  23185. <para>
  23186. Internal class used to improve performance of
  23187. string keyed hashtables.
  23188. </para>
  23189. <para>
  23190. The hashcode of the string is cached for reuse.
  23191. The string is stored as an interned value.
  23192. When comparing two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> objects for equality
  23193. the reference equality of the interned strings is compared.
  23194. </para>
  23195. </remarks>
  23196. <author>Nicko Cadell</author>
  23197. <author>Gert Driesen</author>
  23198. </member>
  23199. <member name="M:log4net.Repository.Hierarchy.LoggerKey.#ctor(System.String)">
  23200. <summary>
  23201. Construct key with string name
  23202. </summary>
  23203. <remarks>
  23204. <para>
  23205. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerKey" /> class
  23206. with the specified name.
  23207. </para>
  23208. <para>
  23209. Stores the hashcode of the string and interns
  23210. the string key to optimize comparisons.
  23211. </para>
  23212. <note>
  23213. The Compact Framework 1.0 the <see cref="M:System.String.Intern(System.String)"/>
  23214. method does not work. On the Compact Framework
  23215. the string keys are not interned nor are they
  23216. compared by reference.
  23217. </note>
  23218. </remarks>
  23219. <param name="name">The name of the logger.</param>
  23220. </member>
  23221. <member name="M:log4net.Repository.Hierarchy.LoggerKey.GetHashCode">
  23222. <summary>
  23223. Returns a hash code for the current instance.
  23224. </summary>
  23225. <returns>A hash code for the current instance.</returns>
  23226. <remarks>
  23227. <para>
  23228. Returns the cached hashcode.
  23229. </para>
  23230. </remarks>
  23231. </member>
  23232. <member name="M:log4net.Repository.Hierarchy.LoggerKey.Equals(System.Object)">
  23233. <summary>
  23234. Determines whether two <see cref="T:log4net.Repository.Hierarchy.LoggerKey" /> instances
  23235. are equal.
  23236. </summary>
  23237. <param name="obj">The <see cref="T:System.Object" /> to compare with the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey" />.</param>
  23238. <returns>
  23239. <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>.
  23240. </returns>
  23241. <remarks>
  23242. <para>
  23243. Compares the references of the interned strings.
  23244. </para>
  23245. </remarks>
  23246. </member>
  23247. <member name="T:log4net.Repository.Hierarchy.ProvisionNode">
  23248. <summary>
  23249. Provision nodes are used where no logger instance has been specified
  23250. </summary>
  23251. <remarks>
  23252. <para>
  23253. <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> instances are used in the
  23254. <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> when there is no specified
  23255. <see cref="T:log4net.Repository.Hierarchy.Logger" /> for that node.
  23256. </para>
  23257. <para>
  23258. A provision node holds a list of child loggers on behalf of
  23259. a logger that does not exist.
  23260. </para>
  23261. </remarks>
  23262. <author>Nicko Cadell</author>
  23263. <author>Gert Driesen</author>
  23264. </member>
  23265. <member name="M:log4net.Repository.Hierarchy.ProvisionNode.#ctor(log4net.Repository.Hierarchy.Logger)">
  23266. <summary>
  23267. Create a new provision node with child node
  23268. </summary>
  23269. <param name="log">A child logger to add to this node.</param>
  23270. <remarks>
  23271. <para>
  23272. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.ProvisionNode" /> class
  23273. with the specified child logger.
  23274. </para>
  23275. </remarks>
  23276. </member>
  23277. <member name="T:log4net.Repository.Hierarchy.RootLogger">
  23278. <summary>
  23279. The <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> sits at the root of the logger hierarchy tree.
  23280. </summary>
  23281. <remarks>
  23282. <para>
  23283. The <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> is a regular <see cref="T:log4net.Repository.Hierarchy.Logger" /> except
  23284. that it provides several guarantees.
  23285. </para>
  23286. <para>
  23287. First, it cannot be assigned a <c>null</c>
  23288. level. Second, since the root logger cannot have a parent, the
  23289. <see cref="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"/> property always returns the value of the
  23290. level field without walking the hierarchy.
  23291. </para>
  23292. </remarks>
  23293. <author>Nicko Cadell</author>
  23294. <author>Gert Driesen</author>
  23295. </member>
  23296. <member name="M:log4net.Repository.Hierarchy.RootLogger.#ctor(log4net.Core.Level)">
  23297. <summary>
  23298. Construct a <see cref="T:log4net.Repository.Hierarchy.RootLogger"/>
  23299. </summary>
  23300. <param name="level">The level to assign to the root logger.</param>
  23301. <remarks>
  23302. <para>
  23303. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> class with
  23304. the specified logging level.
  23305. </para>
  23306. <para>
  23307. The root logger names itself as "root". However, the root
  23308. logger cannot be retrieved by name.
  23309. </para>
  23310. </remarks>
  23311. </member>
  23312. <member name="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel">
  23313. <summary>
  23314. Gets the assigned level value without walking the logger hierarchy.
  23315. </summary>
  23316. <value>The assigned level value without walking the logger hierarchy.</value>
  23317. <remarks>
  23318. <para>
  23319. Because the root logger cannot have a parent and its level
  23320. must not be <c>null</c> this property just returns the
  23321. value of <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>.
  23322. </para>
  23323. </remarks>
  23324. </member>
  23325. <member name="P:log4net.Repository.Hierarchy.RootLogger.Level">
  23326. <summary>
  23327. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> for the root logger.
  23328. </summary>
  23329. <value>
  23330. The <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> of the root logger.
  23331. </value>
  23332. <remarks>
  23333. <para>
  23334. Setting the level of the root logger to a <c>null</c> reference
  23335. may have catastrophic results. We prevent this here.
  23336. </para>
  23337. </remarks>
  23338. </member>
  23339. <member name="F:log4net.Repository.Hierarchy.RootLogger.declaringType">
  23340. <summary>
  23341. The fully qualified type of the RootLogger class.
  23342. </summary>
  23343. <remarks>
  23344. Used by the internal logger to record the Type of the
  23345. log message.
  23346. </remarks>
  23347. </member>
  23348. <member name="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator">
  23349. <summary>
  23350. Initializes the log4net environment using an XML DOM.
  23351. </summary>
  23352. <remarks>
  23353. <para>
  23354. Configures a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> using an XML DOM.
  23355. </para>
  23356. </remarks>
  23357. <author>Nicko Cadell</author>
  23358. <author>Gert Driesen</author>
  23359. </member>
  23360. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.#ctor(log4net.Repository.Hierarchy.Hierarchy)">
  23361. <summary>
  23362. Construct the configurator for a hierarchy
  23363. </summary>
  23364. <param name="hierarchy">The hierarchy to build.</param>
  23365. <remarks>
  23366. <para>
  23367. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator" /> class
  23368. with the specified <see cref="T:log4net.Repository.Hierarchy.Hierarchy" />.
  23369. </para>
  23370. </remarks>
  23371. </member>
  23372. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.Configure(System.Xml.XmlElement)">
  23373. <summary>
  23374. Configure the hierarchy by parsing a DOM tree of XML elements.
  23375. </summary>
  23376. <param name="element">The root element to parse.</param>
  23377. <remarks>
  23378. <para>
  23379. Configure the hierarchy by parsing a DOM tree of XML elements.
  23380. </para>
  23381. </remarks>
  23382. </member>
  23383. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindAppenderByReference(System.Xml.XmlElement)">
  23384. <summary>
  23385. Parse appenders by IDREF.
  23386. </summary>
  23387. <param name="appenderRef">The appender ref element.</param>
  23388. <returns>The instance of the appender that the ref refers to.</returns>
  23389. <remarks>
  23390. <para>
  23391. Parse an XML element that represents an appender and return
  23392. the appender.
  23393. </para>
  23394. </remarks>
  23395. </member>
  23396. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseAppender(System.Xml.XmlElement)">
  23397. <summary>
  23398. Parses an appender element.
  23399. </summary>
  23400. <param name="appenderElement">The appender element.</param>
  23401. <returns>The appender instance or <c>null</c> when parsing failed.</returns>
  23402. <remarks>
  23403. <para>
  23404. Parse an XML element that represents an appender and return
  23405. the appender instance.
  23406. </para>
  23407. </remarks>
  23408. </member>
  23409. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLogger(System.Xml.XmlElement)">
  23410. <summary>
  23411. Parses a logger element.
  23412. </summary>
  23413. <param name="loggerElement">The logger element.</param>
  23414. <remarks>
  23415. <para>
  23416. Parse an XML element that represents a logger.
  23417. </para>
  23418. </remarks>
  23419. </member>
  23420. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRoot(System.Xml.XmlElement)">
  23421. <summary>
  23422. Parses the root logger element.
  23423. </summary>
  23424. <param name="rootElement">The root element.</param>
  23425. <remarks>
  23426. <para>
  23427. Parse an XML element that represents the root logger.
  23428. </para>
  23429. </remarks>
  23430. </member>
  23431. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseChildrenOfLoggerElement(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  23432. <summary>
  23433. Parses the children of a logger element.
  23434. </summary>
  23435. <param name="catElement">The category element.</param>
  23436. <param name="log">The logger instance.</param>
  23437. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  23438. <remarks>
  23439. <para>
  23440. Parse the child elements of a &lt;logger&gt; element.
  23441. </para>
  23442. </remarks>
  23443. </member>
  23444. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRenderer(System.Xml.XmlElement)">
  23445. <summary>
  23446. Parses an object renderer.
  23447. </summary>
  23448. <param name="element">The renderer element.</param>
  23449. <remarks>
  23450. <para>
  23451. Parse an XML element that represents a renderer.
  23452. </para>
  23453. </remarks>
  23454. </member>
  23455. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLevel(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  23456. <summary>
  23457. Parses a level element.
  23458. </summary>
  23459. <param name="element">The level element.</param>
  23460. <param name="log">The logger object to set the level on.</param>
  23461. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  23462. <remarks>
  23463. <para>
  23464. Parse an XML element that represents a level.
  23465. </para>
  23466. </remarks>
  23467. </member>
  23468. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.SetParameter(System.Xml.XmlElement,System.Object)">
  23469. <summary>
  23470. Sets a parameter on an object.
  23471. </summary>
  23472. <param name="element">The parameter element.</param>
  23473. <param name="target">The object to set the parameter on.</param>
  23474. <remarks>
  23475. The parameter name must correspond to a writable property
  23476. on the object. The value of the parameter is a string,
  23477. therefore this function will attempt to set a string
  23478. property first. If unable to set a string property it
  23479. will inspect the property and its argument type. It will
  23480. attempt to call a static method called <c>Parse</c> on the
  23481. type of the property. This method will take a single
  23482. string argument and return a value that can be used to
  23483. set the property.
  23484. </remarks>
  23485. </member>
  23486. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)">
  23487. <summary>
  23488. Test if an element has no attributes or child elements
  23489. </summary>
  23490. <param name="element">the element to inspect</param>
  23491. <returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns>
  23492. </member>
  23493. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)">
  23494. <summary>
  23495. Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>.
  23496. </summary>
  23497. <param name="type">the type to inspect</param>
  23498. <returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns>
  23499. </member>
  23500. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)">
  23501. <summary>
  23502. Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied
  23503. </summary>
  23504. <param name="targetType">the type that has the method</param>
  23505. <param name="name">the name of the method</param>
  23506. <returns>the method info found</returns>
  23507. <remarks>
  23508. <para>
  23509. The method must be a public instance method on the <paramref name="targetType"/>.
  23510. The method must be named <paramref name="name"/> or "Add" followed by <paramref name="name"/>.
  23511. The method must take a single parameter.
  23512. </para>
  23513. </remarks>
  23514. </member>
  23515. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ConvertStringTo(System.Type,System.String)">
  23516. <summary>
  23517. Converts a string value to a target type.
  23518. </summary>
  23519. <param name="type">The type of object to convert the string to.</param>
  23520. <param name="value">The string value to use as the value of the object.</param>
  23521. <returns>
  23522. <para>
  23523. An object of type <paramref name="type"/> with value <paramref name="value"/> or
  23524. <c>null</c> when the conversion could not be performed.
  23525. </para>
  23526. </returns>
  23527. </member>
  23528. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.CreateObjectFromXml(System.Xml.XmlElement,System.Type,System.Type)">
  23529. <summary>
  23530. Creates an object as specified in XML.
  23531. </summary>
  23532. <param name="element">The XML element that contains the definition of the object.</param>
  23533. <param name="defaultTargetType">The object type to use if not explicitly specified.</param>
  23534. <param name="typeConstraint">The type that the returned object must be or must inherit from.</param>
  23535. <returns>The object or <c>null</c></returns>
  23536. <remarks>
  23537. <para>
  23538. Parse an XML element and create an object instance based on the configuration
  23539. data.
  23540. </para>
  23541. <para>
  23542. The type of the instance may be specified in the XML. If not
  23543. specified then the <paramref name="defaultTargetType"/> is used
  23544. as the type. However the type is specified it must support the
  23545. <paramref name="typeConstraint"/> type.
  23546. </para>
  23547. </remarks>
  23548. </member>
  23549. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_appenderBag">
  23550. <summary>
  23551. key: appenderName, value: appender.
  23552. </summary>
  23553. </member>
  23554. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_hierarchy">
  23555. <summary>
  23556. The Hierarchy being configured.
  23557. </summary>
  23558. </member>
  23559. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.declaringType">
  23560. <summary>
  23561. The fully qualified type of the XmlHierarchyConfigurator class.
  23562. </summary>
  23563. <remarks>
  23564. Used by the internal logger to record the Type of the
  23565. log message.
  23566. </remarks>
  23567. </member>
  23568. <member name="T:log4net.Repository.IBasicRepositoryConfigurator">
  23569. <summary>
  23570. Basic Configurator interface for repositories
  23571. </summary>
  23572. <remarks>
  23573. <para>
  23574. Interface used by basic configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>
  23575. with a default <see cref="T:log4net.Appender.IAppender"/>.
  23576. </para>
  23577. <para>
  23578. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  23579. configuration by the <see cref="T:log4net.Config.BasicConfigurator"/>.
  23580. </para>
  23581. </remarks>
  23582. <author>Nicko Cadell</author>
  23583. <author>Gert Driesen</author>
  23584. </member>
  23585. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender)">
  23586. <summary>
  23587. Initialize the repository using the specified appender
  23588. </summary>
  23589. <param name="appender">the appender to use to log all logging events</param>
  23590. <remarks>
  23591. <para>
  23592. Configure the repository to route all logging events to the
  23593. specified appender.
  23594. </para>
  23595. </remarks>
  23596. </member>
  23597. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender[])">
  23598. <summary>
  23599. Initialize the repository using the specified appenders
  23600. </summary>
  23601. <param name="appenders">the appenders to use to log all logging events</param>
  23602. <remarks>
  23603. <para>
  23604. Configure the repository to route all logging events to the
  23605. specified appenders.
  23606. </para>
  23607. </remarks>
  23608. </member>
  23609. <member name="T:log4net.Repository.LoggerRepositoryShutdownEventHandler">
  23610. <summary>
  23611. Delegate used to handle logger repository shutdown event notifications
  23612. </summary>
  23613. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down.</param>
  23614. <param name="e">Empty event args</param>
  23615. <remarks>
  23616. <para>
  23617. Delegate used to handle logger repository shutdown event notifications.
  23618. </para>
  23619. </remarks>
  23620. </member>
  23621. <member name="T:log4net.Repository.LoggerRepositoryConfigurationResetEventHandler">
  23622. <summary>
  23623. Delegate used to handle logger repository configuration reset event notifications
  23624. </summary>
  23625. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration reset.</param>
  23626. <param name="e">Empty event args</param>
  23627. <remarks>
  23628. <para>
  23629. Delegate used to handle logger repository configuration reset event notifications.
  23630. </para>
  23631. </remarks>
  23632. </member>
  23633. <member name="T:log4net.Repository.LoggerRepositoryConfigurationChangedEventHandler">
  23634. <summary>
  23635. Delegate used to handle event notifications for logger repository configuration changes.
  23636. </summary>
  23637. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration changed.</param>
  23638. <param name="e">Empty event arguments.</param>
  23639. <remarks>
  23640. <para>
  23641. Delegate used to handle event notifications for logger repository configuration changes.
  23642. </para>
  23643. </remarks>
  23644. </member>
  23645. <member name="T:log4net.Repository.ILoggerRepository">
  23646. <summary>
  23647. Interface implemented by logger repositories.
  23648. </summary>
  23649. <remarks>
  23650. <para>
  23651. This interface is implemented by logger repositories. e.g.
  23652. <see cref="N:log4net.Repository.Hierarchy"/>.
  23653. </para>
  23654. <para>
  23655. This interface is used by the <see cref="T:log4net.LogManager"/>
  23656. to obtain <see cref="T:log4net.ILog"/> interfaces.
  23657. </para>
  23658. </remarks>
  23659. <author>Nicko Cadell</author>
  23660. <author>Gert Driesen</author>
  23661. </member>
  23662. <member name="P:log4net.Repository.ILoggerRepository.Name">
  23663. <summary>
  23664. The name of the repository
  23665. </summary>
  23666. <value>
  23667. The name of the repository
  23668. </value>
  23669. <remarks>
  23670. <para>
  23671. The name of the repository.
  23672. </para>
  23673. </remarks>
  23674. </member>
  23675. <member name="P:log4net.Repository.ILoggerRepository.RendererMap">
  23676. <summary>
  23677. RendererMap accesses the object renderer map for this repository.
  23678. </summary>
  23679. <value>
  23680. RendererMap accesses the object renderer map for this repository.
  23681. </value>
  23682. <remarks>
  23683. <para>
  23684. RendererMap accesses the object renderer map for this repository.
  23685. </para>
  23686. <para>
  23687. The RendererMap holds a mapping between types and
  23688. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  23689. </para>
  23690. </remarks>
  23691. </member>
  23692. <member name="P:log4net.Repository.ILoggerRepository.PluginMap">
  23693. <summary>
  23694. The plugin map for this repository.
  23695. </summary>
  23696. <value>
  23697. The plugin map for this repository.
  23698. </value>
  23699. <remarks>
  23700. <para>
  23701. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  23702. that have been attached to this repository.
  23703. </para>
  23704. </remarks>
  23705. </member>
  23706. <member name="P:log4net.Repository.ILoggerRepository.LevelMap">
  23707. <summary>
  23708. Get the level map for the Repository.
  23709. </summary>
  23710. <remarks>
  23711. <para>
  23712. Get the level map for the Repository.
  23713. </para>
  23714. <para>
  23715. The level map defines the mappings between
  23716. level names and <see cref="T:log4net.Core.Level"/> objects in
  23717. this repository.
  23718. </para>
  23719. </remarks>
  23720. </member>
  23721. <member name="P:log4net.Repository.ILoggerRepository.Threshold">
  23722. <summary>
  23723. The threshold for all events in this repository
  23724. </summary>
  23725. <value>
  23726. The threshold for all events in this repository
  23727. </value>
  23728. <remarks>
  23729. <para>
  23730. The threshold for all events in this repository.
  23731. </para>
  23732. </remarks>
  23733. </member>
  23734. <member name="M:log4net.Repository.ILoggerRepository.Exists(System.String)">
  23735. <summary>
  23736. Check if the named logger exists in the repository. If so return
  23737. its reference, otherwise returns <c>null</c>.
  23738. </summary>
  23739. <param name="name">The name of the logger to lookup</param>
  23740. <returns>The Logger object with the name specified</returns>
  23741. <remarks>
  23742. <para>
  23743. If the names logger exists it is returned, otherwise
  23744. <c>null</c> is returned.
  23745. </para>
  23746. </remarks>
  23747. </member>
  23748. <member name="M:log4net.Repository.ILoggerRepository.GetCurrentLoggers">
  23749. <summary>
  23750. Returns all the currently defined loggers as an Array.
  23751. </summary>
  23752. <returns>All the defined loggers</returns>
  23753. <remarks>
  23754. <para>
  23755. Returns all the currently defined loggers as an Array.
  23756. </para>
  23757. </remarks>
  23758. </member>
  23759. <member name="M:log4net.Repository.ILoggerRepository.GetLogger(System.String)">
  23760. <summary>
  23761. Returns a named logger instance
  23762. </summary>
  23763. <param name="name">The name of the logger to retrieve</param>
  23764. <returns>The logger object with the name specified</returns>
  23765. <remarks>
  23766. <para>
  23767. Returns a named logger instance.
  23768. </para>
  23769. <para>
  23770. If a logger of that name already exists, then it will be
  23771. returned. Otherwise, a new logger will be instantiated and
  23772. then linked with its existing ancestors as well as children.
  23773. </para>
  23774. </remarks>
  23775. </member>
  23776. <member name="M:log4net.Repository.ILoggerRepository.Shutdown">
  23777. <summary>Shutdown the repository</summary>
  23778. <remarks>
  23779. <para>
  23780. Shutting down a repository will <i>safely</i> close and remove
  23781. all appenders in all loggers including the root logger.
  23782. </para>
  23783. <para>
  23784. Some appenders need to be closed before the
  23785. application exists. Otherwise, pending logging events might be
  23786. lost.
  23787. </para>
  23788. <para>
  23789. The <see cref="M:Shutdown()"/> method is careful to close nested
  23790. appenders before closing regular appenders. This is allows
  23791. configurations where a regular appender is attached to a logger
  23792. and again to a nested appender.
  23793. </para>
  23794. </remarks>
  23795. </member>
  23796. <member name="M:log4net.Repository.ILoggerRepository.ResetConfiguration">
  23797. <summary>
  23798. Reset the repositories configuration to a default state
  23799. </summary>
  23800. <remarks>
  23801. <para>
  23802. Reset all values contained in this instance to their
  23803. default state.
  23804. </para>
  23805. <para>
  23806. Existing loggers are not removed. They are just reset.
  23807. </para>
  23808. <para>
  23809. This method should be used sparingly and with care as it will
  23810. block all logging until it is completed.
  23811. </para>
  23812. </remarks>
  23813. </member>
  23814. <member name="M:log4net.Repository.ILoggerRepository.Log(log4net.Core.LoggingEvent)">
  23815. <summary>
  23816. Log the <see cref="T:log4net.Core.LoggingEvent"/> through this repository.
  23817. </summary>
  23818. <param name="logEvent">the event to log</param>
  23819. <remarks>
  23820. <para>
  23821. This method should not normally be used to log.
  23822. The <see cref="T:log4net.ILog"/> interface should be used
  23823. for routine logging. This interface can be obtained
  23824. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  23825. </para>
  23826. <para>
  23827. The <c>logEvent</c> is delivered to the appropriate logger and
  23828. that logger is then responsible for logging the event.
  23829. </para>
  23830. </remarks>
  23831. </member>
  23832. <member name="P:log4net.Repository.ILoggerRepository.Configured">
  23833. <summary>
  23834. Flag indicates if this repository has been configured.
  23835. </summary>
  23836. <value>
  23837. Flag indicates if this repository has been configured.
  23838. </value>
  23839. <remarks>
  23840. <para>
  23841. Flag indicates if this repository has been configured.
  23842. </para>
  23843. </remarks>
  23844. </member>
  23845. <member name="P:log4net.Repository.ILoggerRepository.ConfigurationMessages">
  23846. <summary>
  23847. Collection of internal messages captured during the most
  23848. recent configuration process.
  23849. </summary>
  23850. </member>
  23851. <member name="E:log4net.Repository.ILoggerRepository.ShutdownEvent">
  23852. <summary>
  23853. Event to notify that the repository has been shutdown.
  23854. </summary>
  23855. <value>
  23856. Event to notify that the repository has been shutdown.
  23857. </value>
  23858. <remarks>
  23859. <para>
  23860. Event raised when the repository has been shutdown.
  23861. </para>
  23862. </remarks>
  23863. </member>
  23864. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationReset">
  23865. <summary>
  23866. Event to notify that the repository has had its configuration reset.
  23867. </summary>
  23868. <value>
  23869. Event to notify that the repository has had its configuration reset.
  23870. </value>
  23871. <remarks>
  23872. <para>
  23873. Event raised when the repository's configuration has been
  23874. reset to default.
  23875. </para>
  23876. </remarks>
  23877. </member>
  23878. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationChanged">
  23879. <summary>
  23880. Event to notify that the repository has had its configuration changed.
  23881. </summary>
  23882. <value>
  23883. Event to notify that the repository has had its configuration changed.
  23884. </value>
  23885. <remarks>
  23886. <para>
  23887. Event raised when the repository's configuration has been changed.
  23888. </para>
  23889. </remarks>
  23890. </member>
  23891. <member name="P:log4net.Repository.ILoggerRepository.Properties">
  23892. <summary>
  23893. Repository specific properties
  23894. </summary>
  23895. <value>
  23896. Repository specific properties
  23897. </value>
  23898. <remarks>
  23899. <para>
  23900. These properties can be specified on a repository specific basis.
  23901. </para>
  23902. </remarks>
  23903. </member>
  23904. <member name="M:log4net.Repository.ILoggerRepository.GetAppenders">
  23905. <summary>
  23906. Returns all the Appenders that are configured as an Array.
  23907. </summary>
  23908. <returns>All the Appenders</returns>
  23909. <remarks>
  23910. <para>
  23911. Returns all the Appenders that are configured as an Array.
  23912. </para>
  23913. </remarks>
  23914. </member>
  23915. <member name="T:log4net.Repository.IXmlRepositoryConfigurator">
  23916. <summary>
  23917. Configure repository using XML
  23918. </summary>
  23919. <remarks>
  23920. <para>
  23921. Interface used by Xml configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  23922. </para>
  23923. <para>
  23924. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  23925. configuration by the <see cref="T:log4net.Config.XmlConfigurator"/>.
  23926. </para>
  23927. </remarks>
  23928. <author>Nicko Cadell</author>
  23929. <author>Gert Driesen</author>
  23930. </member>
  23931. <member name="M:log4net.Repository.IXmlRepositoryConfigurator.Configure(System.Xml.XmlElement)">
  23932. <summary>
  23933. Initialize the repository using the specified config
  23934. </summary>
  23935. <param name="element">the element containing the root of the config</param>
  23936. <remarks>
  23937. <para>
  23938. The schema for the XML configuration data is defined by
  23939. the implementation.
  23940. </para>
  23941. </remarks>
  23942. </member>
  23943. <member name="T:log4net.Repository.LoggerRepositorySkeleton">
  23944. <summary>
  23945. Base implementation of <see cref="T:log4net.Repository.ILoggerRepository"/>
  23946. </summary>
  23947. <remarks>
  23948. <para>
  23949. Default abstract implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  23950. </para>
  23951. <para>
  23952. Skeleton implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  23953. All <see cref="T:log4net.Repository.ILoggerRepository"/> types can extend this type.
  23954. </para>
  23955. </remarks>
  23956. <author>Nicko Cadell</author>
  23957. <author>Gert Driesen</author>
  23958. </member>
  23959. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor">
  23960. <summary>
  23961. Default Constructor
  23962. </summary>
  23963. <remarks>
  23964. <para>
  23965. Initializes the repository with default (empty) properties.
  23966. </para>
  23967. </remarks>
  23968. </member>
  23969. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor(log4net.Util.PropertiesDictionary)">
  23970. <summary>
  23971. Construct the repository using specific properties
  23972. </summary>
  23973. <param name="properties">the properties to set for this repository</param>
  23974. <remarks>
  23975. <para>
  23976. Initializes the repository with specified properties.
  23977. </para>
  23978. </remarks>
  23979. </member>
  23980. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Name">
  23981. <summary>
  23982. The name of the repository
  23983. </summary>
  23984. <value>
  23985. The string name of the repository
  23986. </value>
  23987. <remarks>
  23988. <para>
  23989. The name of this repository. The name is
  23990. used to store and lookup the repositories
  23991. stored by the <see cref="T:log4net.Core.IRepositorySelector"/>.
  23992. </para>
  23993. </remarks>
  23994. </member>
  23995. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Threshold">
  23996. <summary>
  23997. The threshold for all events in this repository
  23998. </summary>
  23999. <value>
  24000. The threshold for all events in this repository
  24001. </value>
  24002. <remarks>
  24003. <para>
  24004. The threshold for all events in this repository
  24005. </para>
  24006. </remarks>
  24007. </member>
  24008. <member name="P:log4net.Repository.LoggerRepositorySkeleton.RendererMap">
  24009. <summary>
  24010. RendererMap accesses the object renderer map for this repository.
  24011. </summary>
  24012. <value>
  24013. RendererMap accesses the object renderer map for this repository.
  24014. </value>
  24015. <remarks>
  24016. <para>
  24017. RendererMap accesses the object renderer map for this repository.
  24018. </para>
  24019. <para>
  24020. The RendererMap holds a mapping between types and
  24021. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  24022. </para>
  24023. </remarks>
  24024. </member>
  24025. <member name="P:log4net.Repository.LoggerRepositorySkeleton.PluginMap">
  24026. <summary>
  24027. The plugin map for this repository.
  24028. </summary>
  24029. <value>
  24030. The plugin map for this repository.
  24031. </value>
  24032. <remarks>
  24033. <para>
  24034. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  24035. that have been attached to this repository.
  24036. </para>
  24037. </remarks>
  24038. </member>
  24039. <member name="P:log4net.Repository.LoggerRepositorySkeleton.LevelMap">
  24040. <summary>
  24041. Get the level map for the Repository.
  24042. </summary>
  24043. <remarks>
  24044. <para>
  24045. Get the level map for the Repository.
  24046. </para>
  24047. <para>
  24048. The level map defines the mappings between
  24049. level names and <see cref="T:log4net.Core.Level"/> objects in
  24050. this repository.
  24051. </para>
  24052. </remarks>
  24053. </member>
  24054. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Exists(System.String)">
  24055. <summary>
  24056. Test if logger exists
  24057. </summary>
  24058. <param name="name">The name of the logger to lookup</param>
  24059. <returns>The Logger object with the name specified</returns>
  24060. <remarks>
  24061. <para>
  24062. Check if the named logger exists in the repository. If so return
  24063. its reference, otherwise returns <c>null</c>.
  24064. </para>
  24065. </remarks>
  24066. </member>
  24067. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetCurrentLoggers">
  24068. <summary>
  24069. Returns all the currently defined loggers in the repository
  24070. </summary>
  24071. <returns>All the defined loggers</returns>
  24072. <remarks>
  24073. <para>
  24074. Returns all the currently defined loggers in the repository as an Array.
  24075. </para>
  24076. </remarks>
  24077. </member>
  24078. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetLogger(System.String)">
  24079. <summary>
  24080. Return a new logger instance
  24081. </summary>
  24082. <param name="name">The name of the logger to retrieve</param>
  24083. <returns>The logger object with the name specified</returns>
  24084. <remarks>
  24085. <para>
  24086. Return a new logger instance.
  24087. </para>
  24088. <para>
  24089. If a logger of that name already exists, then it will be
  24090. returned. Otherwise, a new logger will be instantiated and
  24091. then linked with its existing ancestors as well as children.
  24092. </para>
  24093. </remarks>
  24094. </member>
  24095. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Shutdown">
  24096. <summary>
  24097. Shutdown the repository
  24098. </summary>
  24099. <remarks>
  24100. <para>
  24101. Shutdown the repository. Can be overridden in a subclass.
  24102. This base class implementation notifies the <see cref="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"/>
  24103. listeners and all attached plugins of the shutdown event.
  24104. </para>
  24105. </remarks>
  24106. </member>
  24107. <member name="M:log4net.Repository.LoggerRepositorySkeleton.ResetConfiguration">
  24108. <summary>
  24109. Reset the repositories configuration to a default state
  24110. </summary>
  24111. <remarks>
  24112. <para>
  24113. Reset all values contained in this instance to their
  24114. default state.
  24115. </para>
  24116. <para>
  24117. Existing loggers are not removed. They are just reset.
  24118. </para>
  24119. <para>
  24120. This method should be used sparingly and with care as it will
  24121. block all logging until it is completed.
  24122. </para>
  24123. </remarks>
  24124. </member>
  24125. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Log(log4net.Core.LoggingEvent)">
  24126. <summary>
  24127. Log the logEvent through this repository.
  24128. </summary>
  24129. <param name="logEvent">the event to log</param>
  24130. <remarks>
  24131. <para>
  24132. This method should not normally be used to log.
  24133. The <see cref="T:log4net.ILog"/> interface should be used
  24134. for routine logging. This interface can be obtained
  24135. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  24136. </para>
  24137. <para>
  24138. The <c>logEvent</c> is delivered to the appropriate logger and
  24139. that logger is then responsible for logging the event.
  24140. </para>
  24141. </remarks>
  24142. </member>
  24143. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Configured">
  24144. <summary>
  24145. Flag indicates if this repository has been configured.
  24146. </summary>
  24147. <value>
  24148. Flag indicates if this repository has been configured.
  24149. </value>
  24150. <remarks>
  24151. <para>
  24152. Flag indicates if this repository has been configured.
  24153. </para>
  24154. </remarks>
  24155. </member>
  24156. <member name="P:log4net.Repository.LoggerRepositorySkeleton.ConfigurationMessages">
  24157. <summary>
  24158. Contains a list of internal messages captures during the
  24159. last configuration.
  24160. </summary>
  24161. </member>
  24162. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent">
  24163. <summary>
  24164. Event to notify that the repository has been shutdown.
  24165. </summary>
  24166. <value>
  24167. Event to notify that the repository has been shutdown.
  24168. </value>
  24169. <remarks>
  24170. <para>
  24171. Event raised when the repository has been shutdown.
  24172. </para>
  24173. </remarks>
  24174. </member>
  24175. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationReset">
  24176. <summary>
  24177. Event to notify that the repository has had its configuration reset.
  24178. </summary>
  24179. <value>
  24180. Event to notify that the repository has had its configuration reset.
  24181. </value>
  24182. <remarks>
  24183. <para>
  24184. Event raised when the repository's configuration has been
  24185. reset to default.
  24186. </para>
  24187. </remarks>
  24188. </member>
  24189. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationChanged">
  24190. <summary>
  24191. Event to notify that the repository has had its configuration changed.
  24192. </summary>
  24193. <value>
  24194. Event to notify that the repository has had its configuration changed.
  24195. </value>
  24196. <remarks>
  24197. <para>
  24198. Event raised when the repository's configuration has been changed.
  24199. </para>
  24200. </remarks>
  24201. </member>
  24202. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Properties">
  24203. <summary>
  24204. Repository specific properties
  24205. </summary>
  24206. <value>
  24207. Repository specific properties
  24208. </value>
  24209. <remarks>
  24210. These properties can be specified on a repository specific basis
  24211. </remarks>
  24212. </member>
  24213. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetAppenders">
  24214. <summary>
  24215. Returns all the Appenders that are configured as an Array.
  24216. </summary>
  24217. <returns>All the Appenders</returns>
  24218. <remarks>
  24219. <para>
  24220. Returns all the Appenders that are configured as an Array.
  24221. </para>
  24222. </remarks>
  24223. </member>
  24224. <member name="F:log4net.Repository.LoggerRepositorySkeleton.declaringType">
  24225. <summary>
  24226. The fully qualified type of the LoggerRepositorySkeleton class.
  24227. </summary>
  24228. <remarks>
  24229. Used by the internal logger to record the Type of the
  24230. log message.
  24231. </remarks>
  24232. </member>
  24233. <member name="M:log4net.Repository.LoggerRepositorySkeleton.AddRenderer(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  24234. <summary>
  24235. Adds an object renderer for a specific class.
  24236. </summary>
  24237. <param name="typeToRender">The type that will be rendered by the renderer supplied.</param>
  24238. <param name="rendererInstance">The object renderer used to render the object.</param>
  24239. <remarks>
  24240. <para>
  24241. Adds an object renderer for a specific class.
  24242. </para>
  24243. </remarks>
  24244. </member>
  24245. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnShutdown(System.EventArgs)">
  24246. <summary>
  24247. Notify the registered listeners that the repository is shutting down
  24248. </summary>
  24249. <param name="e">Empty EventArgs</param>
  24250. <remarks>
  24251. <para>
  24252. Notify any listeners that this repository is shutting down.
  24253. </para>
  24254. </remarks>
  24255. </member>
  24256. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationReset(System.EventArgs)">
  24257. <summary>
  24258. Notify the registered listeners that the repository has had its configuration reset
  24259. </summary>
  24260. <param name="e">Empty EventArgs</param>
  24261. <remarks>
  24262. <para>
  24263. Notify any listeners that this repository's configuration has been reset.
  24264. </para>
  24265. </remarks>
  24266. </member>
  24267. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationChanged(System.EventArgs)">
  24268. <summary>
  24269. Notify the registered listeners that the repository has had its configuration changed
  24270. </summary>
  24271. <param name="e">Empty EventArgs</param>
  24272. <remarks>
  24273. <para>
  24274. Notify any listeners that this repository's configuration has changed.
  24275. </para>
  24276. </remarks>
  24277. </member>
  24278. <member name="M:log4net.Repository.LoggerRepositorySkeleton.RaiseConfigurationChanged(System.EventArgs)">
  24279. <summary>
  24280. Raise a configuration changed event on this repository
  24281. </summary>
  24282. <param name="e">EventArgs.Empty</param>
  24283. <remarks>
  24284. <para>
  24285. Applications that programmatically change the configuration of the repository should
  24286. raise this event notification to notify listeners.
  24287. </para>
  24288. </remarks>
  24289. </member>
  24290. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Flush(System.Int32)">
  24291. <summary>
  24292. Flushes all configured Appenders that implement <see cref="T:log4net.Appender.IFlushable"/>.
  24293. </summary>
  24294. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed,
  24295. or <see cref="F:System.Threading.Timeout.Infinite"/> to wait indefinitely.</param>
  24296. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  24297. </member>
  24298. <member name="T:log4net.ThreadContext">
  24299. <summary>
  24300. The log4net Thread Context.
  24301. </summary>
  24302. <remarks>
  24303. <para>
  24304. The <c>ThreadContext</c> provides a location for thread specific debugging
  24305. information to be stored.
  24306. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  24307. properties with the same name.
  24308. </para>
  24309. <para>
  24310. The thread context has a properties map and a stack.
  24311. The properties and stack can
  24312. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  24313. supports selecting and outputting these properties.
  24314. </para>
  24315. <para>
  24316. The Thread Context provides a diagnostic context for the current thread.
  24317. This is an instrument for distinguishing interleaved log
  24318. output from different sources. Log output is typically interleaved
  24319. when a server handles multiple clients near-simultaneously.
  24320. </para>
  24321. <para>
  24322. The Thread Context is managed on a per thread basis.
  24323. </para>
  24324. </remarks>
  24325. <example>Example of using the thread context properties to store a username.
  24326. <code lang="C#">
  24327. ThreadContext.Properties["user"] = userName;
  24328. log.Info("This log message has a ThreadContext Property called 'user'");
  24329. </code>
  24330. </example>
  24331. <example>Example of how to push a message into the context stack
  24332. <code lang="C#">
  24333. using(ThreadContext.Stacks["NDC"].Push("my context message"))
  24334. {
  24335. log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
  24336. } // at the end of the using block the message is automatically popped
  24337. </code>
  24338. </example>
  24339. <threadsafety static="true" instance="true" />
  24340. <author>Nicko Cadell</author>
  24341. </member>
  24342. <member name="M:log4net.ThreadContext.#ctor">
  24343. <summary>
  24344. Private Constructor.
  24345. </summary>
  24346. <remarks>
  24347. <para>
  24348. Uses a private access modifier to prevent instantiation of this class.
  24349. </para>
  24350. </remarks>
  24351. </member>
  24352. <member name="P:log4net.ThreadContext.Properties">
  24353. <summary>
  24354. The thread properties map
  24355. </summary>
  24356. <value>
  24357. The thread properties map
  24358. </value>
  24359. <remarks>
  24360. <para>
  24361. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  24362. properties with the same name.
  24363. </para>
  24364. </remarks>
  24365. </member>
  24366. <member name="P:log4net.ThreadContext.Stacks">
  24367. <summary>
  24368. The thread stacks
  24369. </summary>
  24370. <value>
  24371. stack map
  24372. </value>
  24373. <remarks>
  24374. <para>
  24375. The thread local stacks.
  24376. </para>
  24377. </remarks>
  24378. </member>
  24379. <member name="F:log4net.ThreadContext.s_properties">
  24380. <summary>
  24381. The thread context properties instance
  24382. </summary>
  24383. </member>
  24384. <member name="F:log4net.ThreadContext.s_stacks">
  24385. <summary>
  24386. The thread context stacks instance
  24387. </summary>
  24388. </member>
  24389. <member name="T:log4net.Util.AppenderAttachedImpl">
  24390. <summary>
  24391. A straightforward implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  24392. </summary>
  24393. <remarks>
  24394. <para>
  24395. This is the default implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/>
  24396. interface. Implementors of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  24397. should aggregate an instance of this type.
  24398. </para>
  24399. </remarks>
  24400. <author>Nicko Cadell</author>
  24401. <author>Gert Driesen</author>
  24402. </member>
  24403. <member name="M:log4net.Util.AppenderAttachedImpl.#ctor">
  24404. <summary>
  24405. Constructor
  24406. </summary>
  24407. <remarks>
  24408. <para>
  24409. Initializes a new instance of the <see cref="T:log4net.Util.AppenderAttachedImpl"/> class.
  24410. </para>
  24411. </remarks>
  24412. </member>
  24413. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent)">
  24414. <summary>
  24415. Append on on all attached appenders.
  24416. </summary>
  24417. <param name="loggingEvent">The event being logged.</param>
  24418. <returns>The number of appenders called.</returns>
  24419. <remarks>
  24420. <para>
  24421. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)" /> method on all
  24422. attached appenders.
  24423. </para>
  24424. </remarks>
  24425. </member>
  24426. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])">
  24427. <summary>
  24428. Append on on all attached appenders.
  24429. </summary>
  24430. <param name="loggingEvents">The array of events being logged.</param>
  24431. <returns>The number of appenders called.</returns>
  24432. <remarks>
  24433. <para>
  24434. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)" /> method on all
  24435. attached appenders.
  24436. </para>
  24437. </remarks>
  24438. </member>
  24439. <member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])">
  24440. <summary>
  24441. Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with
  24442. the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied.
  24443. </summary>
  24444. <param name="appender">The appender</param>
  24445. <param name="loggingEvents">The events</param>
  24446. <remarks>
  24447. <para>
  24448. If the <paramref name="appender" /> supports the <see cref="T:log4net.Appender.IBulkAppender"/>
  24449. interface then the <paramref name="loggingEvents" /> will be passed
  24450. through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/>
  24451. objects in the array will be passed one at a time.
  24452. </para>
  24453. </remarks>
  24454. </member>
  24455. <member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)">
  24456. <summary>
  24457. Attaches an appender.
  24458. </summary>
  24459. <param name="newAppender">The appender to add.</param>
  24460. <remarks>
  24461. <para>
  24462. If the appender is already in the list it won't be added again.
  24463. </para>
  24464. </remarks>
  24465. </member>
  24466. <member name="P:log4net.Util.AppenderAttachedImpl.Appenders">
  24467. <summary>
  24468. Gets all attached appenders.
  24469. </summary>
  24470. <returns>
  24471. A collection of attached appenders, or <c>null</c> if there
  24472. are no attached appenders.
  24473. </returns>
  24474. <remarks>
  24475. <para>
  24476. The read only collection of all currently attached appenders.
  24477. </para>
  24478. </remarks>
  24479. </member>
  24480. <member name="M:log4net.Util.AppenderAttachedImpl.GetAppender(System.String)">
  24481. <summary>
  24482. Gets an attached appender with the specified name.
  24483. </summary>
  24484. <param name="name">The name of the appender to get.</param>
  24485. <returns>
  24486. The appender with the name specified, or <c>null</c> if no appender with the
  24487. specified name is found.
  24488. </returns>
  24489. <remarks>
  24490. <para>
  24491. Lookup an attached appender by name.
  24492. </para>
  24493. </remarks>
  24494. </member>
  24495. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAllAppenders">
  24496. <summary>
  24497. Removes all attached appenders.
  24498. </summary>
  24499. <remarks>
  24500. <para>
  24501. Removes and closes all attached appenders
  24502. </para>
  24503. </remarks>
  24504. </member>
  24505. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(log4net.Appender.IAppender)">
  24506. <summary>
  24507. Removes the specified appender from the list of attached appenders.
  24508. </summary>
  24509. <param name="appender">The appender to remove.</param>
  24510. <returns>The appender removed from the list</returns>
  24511. <remarks>
  24512. <para>
  24513. The appender removed is not closed.
  24514. If you are discarding the appender you must call
  24515. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  24516. </para>
  24517. </remarks>
  24518. </member>
  24519. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(System.String)">
  24520. <summary>
  24521. Removes the appender with the specified name from the list of appenders.
  24522. </summary>
  24523. <param name="name">The name of the appender to remove.</param>
  24524. <returns>The appender removed from the list</returns>
  24525. <remarks>
  24526. <para>
  24527. The appender removed is not closed.
  24528. If you are discarding the appender you must call
  24529. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  24530. </para>
  24531. </remarks>
  24532. </member>
  24533. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderList">
  24534. <summary>
  24535. List of appenders
  24536. </summary>
  24537. </member>
  24538. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderArray">
  24539. <summary>
  24540. Array of appenders, used to cache the m_appenderList
  24541. </summary>
  24542. </member>
  24543. <member name="F:log4net.Util.AppenderAttachedImpl.declaringType">
  24544. <summary>
  24545. The fully qualified type of the AppenderAttachedImpl class.
  24546. </summary>
  24547. <remarks>
  24548. Used by the internal logger to record the Type of the
  24549. log message.
  24550. </remarks>
  24551. </member>
  24552. <member name="T:log4net.Util.CompositeProperties">
  24553. <summary>
  24554. This class aggregates several PropertiesDictionary collections together.
  24555. </summary>
  24556. <remarks>
  24557. <para>
  24558. Provides a dictionary style lookup over an ordered list of
  24559. <see cref="T:log4net.Util.PropertiesDictionary"/> collections.
  24560. </para>
  24561. </remarks>
  24562. <author>Nicko Cadell</author>
  24563. </member>
  24564. <member name="M:log4net.Util.CompositeProperties.#ctor">
  24565. <summary>
  24566. Constructor
  24567. </summary>
  24568. <remarks>
  24569. <para>
  24570. Initializes a new instance of the <see cref="T:log4net.Util.CompositeProperties" /> class.
  24571. </para>
  24572. </remarks>
  24573. </member>
  24574. <member name="P:log4net.Util.CompositeProperties.Item(System.String)">
  24575. <summary>
  24576. Gets the value of a property
  24577. </summary>
  24578. <value>
  24579. The value for the property with the specified key
  24580. </value>
  24581. <remarks>
  24582. <para>
  24583. Looks up the value for the <paramref name="key" /> specified.
  24584. The <see cref="T:log4net.Util.PropertiesDictionary"/> collections are searched
  24585. in the order in which they were added to this collection. The value
  24586. returned is the value held by the first collection that contains
  24587. the specified key.
  24588. </para>
  24589. <para>
  24590. If none of the collections contain the specified key then
  24591. <c>null</c> is returned.
  24592. </para>
  24593. </remarks>
  24594. </member>
  24595. <member name="M:log4net.Util.CompositeProperties.Add(log4net.Util.ReadOnlyPropertiesDictionary)">
  24596. <summary>
  24597. Add a Properties Dictionary to this composite collection
  24598. </summary>
  24599. <param name="properties">the properties to add</param>
  24600. <remarks>
  24601. <para>
  24602. Properties dictionaries added first take precedence over dictionaries added
  24603. later.
  24604. </para>
  24605. </remarks>
  24606. </member>
  24607. <member name="M:log4net.Util.CompositeProperties.Flatten">
  24608. <summary>
  24609. Flatten this composite collection into a single properties dictionary
  24610. </summary>
  24611. <returns>the flattened dictionary</returns>
  24612. <remarks>
  24613. <para>
  24614. Reduces the collection of ordered dictionaries to a single dictionary
  24615. containing the resultant values for the keys.
  24616. </para>
  24617. </remarks>
  24618. </member>
  24619. <member name="T:log4net.Util.ContextPropertiesBase">
  24620. <summary>
  24621. Base class for Context Properties implementations
  24622. </summary>
  24623. <remarks>
  24624. <para>
  24625. This class defines a basic property get set accessor
  24626. </para>
  24627. </remarks>
  24628. <author>Nicko Cadell</author>
  24629. </member>
  24630. <member name="P:log4net.Util.ContextPropertiesBase.Item(System.String)">
  24631. <summary>
  24632. Gets or sets the value of a property
  24633. </summary>
  24634. <value>
  24635. The value for the property with the specified key
  24636. </value>
  24637. <remarks>
  24638. <para>
  24639. Gets or sets the value of a property
  24640. </para>
  24641. </remarks>
  24642. </member>
  24643. <member name="T:log4net.Util.ConverterInfo">
  24644. <summary>
  24645. Wrapper class used to map converter names to converter types
  24646. </summary>
  24647. <remarks>
  24648. <para>
  24649. Pattern converter info class used during configuration by custom
  24650. PatternString and PatternLayer converters.
  24651. </para>
  24652. </remarks>
  24653. </member>
  24654. <member name="M:log4net.Util.ConverterInfo.#ctor">
  24655. <summary>
  24656. default constructor
  24657. </summary>
  24658. </member>
  24659. <member name="P:log4net.Util.ConverterInfo.Name">
  24660. <summary>
  24661. Gets or sets the name of the conversion pattern
  24662. </summary>
  24663. <remarks>
  24664. <para>
  24665. The name of the pattern in the format string
  24666. </para>
  24667. </remarks>
  24668. </member>
  24669. <member name="P:log4net.Util.ConverterInfo.Type">
  24670. <summary>
  24671. Gets or sets the type of the converter
  24672. </summary>
  24673. <remarks>
  24674. <para>
  24675. The value specified must extend the
  24676. <see cref="T:log4net.Util.PatternConverter"/> type.
  24677. </para>
  24678. </remarks>
  24679. </member>
  24680. <member name="M:log4net.Util.ConverterInfo.AddProperty(log4net.Util.PropertyEntry)">
  24681. <summary>
  24682. </summary>
  24683. <param name="entry"></param>
  24684. </member>
  24685. <member name="P:log4net.Util.ConverterInfo.Properties">
  24686. <summary>
  24687. </summary>
  24688. </member>
  24689. <member name="T:log4net.Util.CountingQuietTextWriter">
  24690. <summary>
  24691. Subclass of <see cref="T:log4net.Util.QuietTextWriter"/> that maintains a count of
  24692. the number of bytes written.
  24693. </summary>
  24694. <remarks>
  24695. <para>
  24696. This writer counts the number of bytes written.
  24697. </para>
  24698. </remarks>
  24699. <author>Nicko Cadell</author>
  24700. <author>Gert Driesen</author>
  24701. </member>
  24702. <member name="M:log4net.Util.CountingQuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  24703. <summary>
  24704. Constructor
  24705. </summary>
  24706. <param name="writer">The <see cref="T:System.IO.TextWriter" /> to actually write to.</param>
  24707. <param name="errorHandler">The <see cref="T:log4net.Core.IErrorHandler" /> to report errors to.</param>
  24708. <remarks>
  24709. <para>
  24710. Creates a new instance of the <see cref="T:log4net.Util.CountingQuietTextWriter" /> class
  24711. with the specified <see cref="T:System.IO.TextWriter" /> and <see cref="T:log4net.Core.IErrorHandler" />.
  24712. </para>
  24713. </remarks>
  24714. </member>
  24715. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)">
  24716. <summary>
  24717. Writes a character to the underlying writer and counts the number of bytes written.
  24718. </summary>
  24719. <param name="value">the char to write</param>
  24720. <remarks>
  24721. <para>
  24722. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  24723. the number of bytes written.
  24724. </para>
  24725. </remarks>
  24726. </member>
  24727. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  24728. <summary>
  24729. Writes a buffer to the underlying writer and counts the number of bytes written.
  24730. </summary>
  24731. <param name="buffer">the buffer to write</param>
  24732. <param name="index">the start index to write from</param>
  24733. <param name="count">the number of characters to write</param>
  24734. <remarks>
  24735. <para>
  24736. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  24737. the number of bytes written.
  24738. </para>
  24739. </remarks>
  24740. </member>
  24741. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)">
  24742. <summary>
  24743. Writes a string to the output and counts the number of bytes written.
  24744. </summary>
  24745. <param name="str">The string data to write to the output.</param>
  24746. <remarks>
  24747. <para>
  24748. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  24749. the number of bytes written.
  24750. </para>
  24751. </remarks>
  24752. </member>
  24753. <member name="P:log4net.Util.CountingQuietTextWriter.Count">
  24754. <summary>
  24755. Gets or sets the total number of bytes written.
  24756. </summary>
  24757. <value>
  24758. The total number of bytes written.
  24759. </value>
  24760. <remarks>
  24761. <para>
  24762. Gets or sets the total number of bytes written.
  24763. </para>
  24764. </remarks>
  24765. </member>
  24766. <member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes">
  24767. <summary>
  24768. Total number of bytes written.
  24769. </summary>
  24770. </member>
  24771. <member name="T:log4net.Util.CyclicBuffer">
  24772. <summary>
  24773. A fixed size rolling buffer of logging events.
  24774. </summary>
  24775. <remarks>
  24776. <para>
  24777. An array backed fixed size leaky bucket.
  24778. </para>
  24779. </remarks>
  24780. <author>Nicko Cadell</author>
  24781. <author>Gert Driesen</author>
  24782. </member>
  24783. <member name="M:log4net.Util.CyclicBuffer.#ctor(System.Int32)">
  24784. <summary>
  24785. Constructor
  24786. </summary>
  24787. <param name="maxSize">The maximum number of logging events in the buffer.</param>
  24788. <remarks>
  24789. <para>
  24790. Initializes a new instance of the <see cref="T:log4net.Util.CyclicBuffer" /> class with
  24791. the specified maximum number of buffered logging events.
  24792. </para>
  24793. </remarks>
  24794. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="maxSize"/> argument is not a positive integer.</exception>
  24795. </member>
  24796. <member name="M:log4net.Util.CyclicBuffer.Append(log4net.Core.LoggingEvent)">
  24797. <summary>
  24798. Appends a <paramref name="loggingEvent"/> to the buffer.
  24799. </summary>
  24800. <param name="loggingEvent">The event to append to the buffer.</param>
  24801. <returns>The event discarded from the buffer, if the buffer is full, otherwise <c>null</c>.</returns>
  24802. <remarks>
  24803. <para>
  24804. Append an event to the buffer. If the buffer still contains free space then
  24805. <c>null</c> is returned. If the buffer is full then an event will be dropped
  24806. to make space for the new event, the event dropped is returned.
  24807. </para>
  24808. </remarks>
  24809. </member>
  24810. <member name="M:log4net.Util.CyclicBuffer.PopOldest">
  24811. <summary>
  24812. Get and remove the oldest event in the buffer.
  24813. </summary>
  24814. <returns>The oldest logging event in the buffer</returns>
  24815. <remarks>
  24816. <para>
  24817. Gets the oldest (first) logging event in the buffer and removes it
  24818. from the buffer.
  24819. </para>
  24820. </remarks>
  24821. </member>
  24822. <member name="M:log4net.Util.CyclicBuffer.PopAll">
  24823. <summary>
  24824. Pops all the logging events from the buffer into an array.
  24825. </summary>
  24826. <returns>An array of all the logging events in the buffer.</returns>
  24827. <remarks>
  24828. <para>
  24829. Get all the events in the buffer and clear the buffer.
  24830. </para>
  24831. </remarks>
  24832. </member>
  24833. <member name="M:log4net.Util.CyclicBuffer.Clear">
  24834. <summary>
  24835. Clear the buffer
  24836. </summary>
  24837. <remarks>
  24838. <para>
  24839. Clear the buffer of all events. The events in the buffer are lost.
  24840. </para>
  24841. </remarks>
  24842. </member>
  24843. <member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)">
  24844. <summary>
  24845. Gets the <paramref name="i"/>th oldest event currently in the buffer.
  24846. </summary>
  24847. <value>The <paramref name="i"/>th oldest event currently in the buffer.</value>
  24848. <remarks>
  24849. <para>
  24850. If <paramref name="i"/> is outside the range 0 to the number of events
  24851. currently in the buffer, then <c>null</c> is returned.
  24852. </para>
  24853. </remarks>
  24854. </member>
  24855. <member name="P:log4net.Util.CyclicBuffer.MaxSize">
  24856. <summary>
  24857. Gets the maximum size of the buffer.
  24858. </summary>
  24859. <value>The maximum size of the buffer.</value>
  24860. <remarks>
  24861. <para>
  24862. Gets the maximum size of the buffer
  24863. </para>
  24864. </remarks>
  24865. </member>
  24866. <member name="P:log4net.Util.CyclicBuffer.Length">
  24867. <summary>
  24868. Gets the number of logging events in the buffer.
  24869. </summary>
  24870. <value>The number of logging events in the buffer.</value>
  24871. <remarks>
  24872. <para>
  24873. This number is guaranteed to be in the range 0 to <see cref="P:log4net.Util.CyclicBuffer.MaxSize"/>
  24874. (inclusive).
  24875. </para>
  24876. </remarks>
  24877. </member>
  24878. <member name="T:log4net.Util.EmptyCollection">
  24879. <summary>
  24880. An always empty <see cref="T:System.Collections.ICollection"/>.
  24881. </summary>
  24882. <remarks>
  24883. <para>
  24884. A singleton implementation of the <see cref="T:System.Collections.ICollection"/>
  24885. interface that always represents an empty collection.
  24886. </para>
  24887. </remarks>
  24888. <author>Nicko Cadell</author>
  24889. <author>Gert Driesen</author>
  24890. </member>
  24891. <member name="M:log4net.Util.EmptyCollection.#ctor">
  24892. <summary>
  24893. Initializes a new instance of the <see cref="T:log4net.Util.EmptyCollection" /> class.
  24894. </summary>
  24895. <remarks>
  24896. <para>
  24897. Uses a private access modifier to enforce the singleton pattern.
  24898. </para>
  24899. </remarks>
  24900. </member>
  24901. <member name="P:log4net.Util.EmptyCollection.Instance">
  24902. <summary>
  24903. Gets the singleton instance of the empty collection.
  24904. </summary>
  24905. <returns>The singleton instance of the empty collection.</returns>
  24906. <remarks>
  24907. <para>
  24908. Gets the singleton instance of the empty collection.
  24909. </para>
  24910. </remarks>
  24911. </member>
  24912. <member name="M:log4net.Util.EmptyCollection.CopyTo(System.Array,System.Int32)">
  24913. <summary>
  24914. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  24915. <see cref="T:System.Array"/>, starting at a particular Array index.
  24916. </summary>
  24917. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  24918. that is the destination of the elements copied from
  24919. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  24920. indexing.</param>
  24921. <param name="index">The zero-based index in array at which
  24922. copying begins.</param>
  24923. <remarks>
  24924. <para>
  24925. As the collection is empty no values are copied into the array.
  24926. </para>
  24927. </remarks>
  24928. </member>
  24929. <member name="P:log4net.Util.EmptyCollection.IsSynchronized">
  24930. <summary>
  24931. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  24932. </summary>
  24933. <value>
  24934. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  24935. </value>
  24936. <remarks>
  24937. <para>
  24938. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <c>true</c>.
  24939. </para>
  24940. </remarks>
  24941. </member>
  24942. <member name="P:log4net.Util.EmptyCollection.Count">
  24943. <summary>
  24944. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  24945. </summary>
  24946. <value>
  24947. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  24948. </value>
  24949. <remarks>
  24950. <para>
  24951. As the collection is empty the <see cref="P:log4net.Util.EmptyCollection.Count"/> is always <c>0</c>.
  24952. </para>
  24953. </remarks>
  24954. </member>
  24955. <member name="P:log4net.Util.EmptyCollection.SyncRoot">
  24956. <summary>
  24957. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  24958. </summary>
  24959. <value>
  24960. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  24961. </value>
  24962. <remarks>
  24963. <para>
  24964. As the collection is empty and thread safe and synchronized this instance is also
  24965. the <see cref="P:log4net.Util.EmptyCollection.SyncRoot"/> object.
  24966. </para>
  24967. </remarks>
  24968. </member>
  24969. <member name="M:log4net.Util.EmptyCollection.GetEnumerator">
  24970. <summary>
  24971. Returns an enumerator that can iterate through a collection.
  24972. </summary>
  24973. <returns>
  24974. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  24975. iterate through the collection.
  24976. </returns>
  24977. <remarks>
  24978. <para>
  24979. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  24980. </para>
  24981. </remarks>
  24982. </member>
  24983. <member name="F:log4net.Util.EmptyCollection.s_instance">
  24984. <summary>
  24985. The singleton instance of the empty collection.
  24986. </summary>
  24987. </member>
  24988. <member name="T:log4net.Util.EmptyDictionary">
  24989. <summary>
  24990. An always empty <see cref="T:System.Collections.IDictionary"/>.
  24991. </summary>
  24992. <remarks>
  24993. <para>
  24994. A singleton implementation of the <see cref="T:System.Collections.IDictionary"/>
  24995. interface that always represents an empty collection.
  24996. </para>
  24997. </remarks>
  24998. <author>Nicko Cadell</author>
  24999. <author>Gert Driesen</author>
  25000. </member>
  25001. <member name="M:log4net.Util.EmptyDictionary.#ctor">
  25002. <summary>
  25003. Initializes a new instance of the <see cref="T:log4net.Util.EmptyDictionary" /> class.
  25004. </summary>
  25005. <remarks>
  25006. <para>
  25007. Uses a private access modifier to enforce the singleton pattern.
  25008. </para>
  25009. </remarks>
  25010. </member>
  25011. <member name="P:log4net.Util.EmptyDictionary.Instance">
  25012. <summary>
  25013. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.
  25014. </summary>
  25015. <returns>The singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.</returns>
  25016. <remarks>
  25017. <para>
  25018. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.
  25019. </para>
  25020. </remarks>
  25021. </member>
  25022. <member name="M:log4net.Util.EmptyDictionary.CopyTo(System.Array,System.Int32)">
  25023. <summary>
  25024. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  25025. <see cref="T:System.Array"/>, starting at a particular Array index.
  25026. </summary>
  25027. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  25028. that is the destination of the elements copied from
  25029. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  25030. indexing.</param>
  25031. <param name="index">The zero-based index in array at which
  25032. copying begins.</param>
  25033. <remarks>
  25034. <para>
  25035. As the collection is empty no values are copied into the array.
  25036. </para>
  25037. </remarks>
  25038. </member>
  25039. <member name="P:log4net.Util.EmptyDictionary.IsSynchronized">
  25040. <summary>
  25041. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  25042. </summary>
  25043. <value>
  25044. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  25045. </value>
  25046. <remarks>
  25047. <para>
  25048. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <b>true</b>.
  25049. </para>
  25050. </remarks>
  25051. </member>
  25052. <member name="P:log4net.Util.EmptyDictionary.Count">
  25053. <summary>
  25054. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>
  25055. </summary>
  25056. <value>
  25057. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25058. </value>
  25059. <remarks>
  25060. <para>
  25061. As the collection is empty the <see cref="P:log4net.Util.EmptyDictionary.Count"/> is always <c>0</c>.
  25062. </para>
  25063. </remarks>
  25064. </member>
  25065. <member name="P:log4net.Util.EmptyDictionary.SyncRoot">
  25066. <summary>
  25067. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25068. </summary>
  25069. <value>
  25070. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25071. </value>
  25072. <remarks>
  25073. <para>
  25074. As the collection is empty and thread safe and synchronized this instance is also
  25075. the <see cref="P:log4net.Util.EmptyDictionary.SyncRoot"/> object.
  25076. </para>
  25077. </remarks>
  25078. </member>
  25079. <member name="M:log4net.Util.EmptyDictionary.System#Collections#IEnumerable#GetEnumerator">
  25080. <summary>
  25081. Returns an enumerator that can iterate through a collection.
  25082. </summary>
  25083. <returns>
  25084. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25085. iterate through the collection.
  25086. </returns>
  25087. <remarks>
  25088. <para>
  25089. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25090. </para>
  25091. </remarks>
  25092. </member>
  25093. <member name="M:log4net.Util.EmptyDictionary.Add(System.Object,System.Object)">
  25094. <summary>
  25095. Adds an element with the provided key and value to the
  25096. <see cref="T:log4net.Util.EmptyDictionary" />.
  25097. </summary>
  25098. <param name="key">The <see cref="T:System.Object" /> to use as the key of the element to add.</param>
  25099. <param name="value">The <see cref="T:System.Object" /> to use as the value of the element to add.</param>
  25100. <remarks>
  25101. <para>
  25102. As the collection is empty no new values can be added. A <see cref="T:System.InvalidOperationException"/>
  25103. is thrown if this method is called.
  25104. </para>
  25105. </remarks>
  25106. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25107. </member>
  25108. <member name="M:log4net.Util.EmptyDictionary.Clear">
  25109. <summary>
  25110. Removes all elements from the <see cref="T:log4net.Util.EmptyDictionary" />.
  25111. </summary>
  25112. <remarks>
  25113. <para>
  25114. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  25115. is thrown if this method is called.
  25116. </para>
  25117. </remarks>
  25118. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25119. </member>
  25120. <member name="M:log4net.Util.EmptyDictionary.Contains(System.Object)">
  25121. <summary>
  25122. Determines whether the <see cref="T:log4net.Util.EmptyDictionary" /> contains an element
  25123. with the specified key.
  25124. </summary>
  25125. <param name="key">The key to locate in the <see cref="T:log4net.Util.EmptyDictionary" />.</param>
  25126. <returns><c>false</c></returns>
  25127. <remarks>
  25128. <para>
  25129. As the collection is empty the <see cref="M:log4net.Util.EmptyDictionary.Contains(System.Object)"/> method always returns <c>false</c>.
  25130. </para>
  25131. </remarks>
  25132. </member>
  25133. <member name="M:log4net.Util.EmptyDictionary.GetEnumerator">
  25134. <summary>
  25135. Returns an enumerator that can iterate through a collection.
  25136. </summary>
  25137. <returns>
  25138. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25139. iterate through the collection.
  25140. </returns>
  25141. <remarks>
  25142. <para>
  25143. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25144. </para>
  25145. </remarks>
  25146. </member>
  25147. <member name="M:log4net.Util.EmptyDictionary.Remove(System.Object)">
  25148. <summary>
  25149. Removes the element with the specified key from the <see cref="T:log4net.Util.EmptyDictionary" />.
  25150. </summary>
  25151. <param name="key">The key of the element to remove.</param>
  25152. <remarks>
  25153. <para>
  25154. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  25155. is thrown if this method is called.
  25156. </para>
  25157. </remarks>
  25158. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25159. </member>
  25160. <member name="P:log4net.Util.EmptyDictionary.IsFixedSize">
  25161. <summary>
  25162. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary" /> has a fixed size.
  25163. </summary>
  25164. <value><c>true</c></value>
  25165. <remarks>
  25166. <para>
  25167. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsFixedSize"/> always returns <c>true</c>.
  25168. </para>
  25169. </remarks>
  25170. </member>
  25171. <member name="P:log4net.Util.EmptyDictionary.IsReadOnly">
  25172. <summary>
  25173. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary" /> is read-only.
  25174. </summary>
  25175. <value><c>true</c></value>
  25176. <remarks>
  25177. <para>
  25178. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsReadOnly"/> always returns <c>true</c>.
  25179. </para>
  25180. </remarks>
  25181. </member>
  25182. <member name="P:log4net.Util.EmptyDictionary.Keys">
  25183. <summary>
  25184. Gets an <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary" />.
  25185. </summary>
  25186. <value>An <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary" />.</value>
  25187. <remarks>
  25188. <para>
  25189. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  25190. </para>
  25191. </remarks>
  25192. </member>
  25193. <member name="P:log4net.Util.EmptyDictionary.Values">
  25194. <summary>
  25195. Gets an <see cref="T:System.Collections.ICollection" /> containing the values of the <see cref="T:log4net.Util.EmptyDictionary" />.
  25196. </summary>
  25197. <value>An <see cref="T:System.Collections.ICollection" /> containing the values of the <see cref="T:log4net.Util.EmptyDictionary" />.</value>
  25198. <remarks>
  25199. <para>
  25200. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  25201. </para>
  25202. </remarks>
  25203. </member>
  25204. <member name="P:log4net.Util.EmptyDictionary.Item(System.Object)">
  25205. <summary>
  25206. Gets or sets the element with the specified key.
  25207. </summary>
  25208. <param name="key">The key of the element to get or set.</param>
  25209. <value><c>null</c></value>
  25210. <remarks>
  25211. <para>
  25212. As the collection is empty no values can be looked up or stored.
  25213. If the index getter is called then <c>null</c> is returned.
  25214. A <see cref="T:System.InvalidOperationException"/> is thrown if the setter is called.
  25215. </para>
  25216. </remarks>
  25217. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25218. </member>
  25219. <member name="F:log4net.Util.EmptyDictionary.s_instance">
  25220. <summary>
  25221. The singleton instance of the empty dictionary.
  25222. </summary>
  25223. </member>
  25224. <member name="T:log4net.Util.FormattingInfo">
  25225. <summary>
  25226. Contain the information obtained when parsing formatting modifiers
  25227. in conversion modifiers.
  25228. </summary>
  25229. <remarks>
  25230. <para>
  25231. Holds the formatting information extracted from the format string by
  25232. the <see cref="T:log4net.Util.PatternParser"/>. This is used by the <see cref="T:log4net.Util.PatternConverter"/>
  25233. objects when rendering the output.
  25234. </para>
  25235. </remarks>
  25236. <author>Nicko Cadell</author>
  25237. <author>Gert Driesen</author>
  25238. </member>
  25239. <member name="M:log4net.Util.FormattingInfo.#ctor">
  25240. <summary>
  25241. Defaut Constructor
  25242. </summary>
  25243. <remarks>
  25244. <para>
  25245. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo" /> class.
  25246. </para>
  25247. </remarks>
  25248. </member>
  25249. <member name="M:log4net.Util.FormattingInfo.#ctor(System.Int32,System.Int32,System.Boolean)">
  25250. <summary>
  25251. Constructor
  25252. </summary>
  25253. <remarks>
  25254. <para>
  25255. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo" /> class
  25256. with the specified parameters.
  25257. </para>
  25258. </remarks>
  25259. </member>
  25260. <member name="P:log4net.Util.FormattingInfo.Min">
  25261. <summary>
  25262. Gets or sets the minimum value.
  25263. </summary>
  25264. <value>
  25265. The minimum value.
  25266. </value>
  25267. <remarks>
  25268. <para>
  25269. Gets or sets the minimum value.
  25270. </para>
  25271. </remarks>
  25272. </member>
  25273. <member name="P:log4net.Util.FormattingInfo.Max">
  25274. <summary>
  25275. Gets or sets the maximum value.
  25276. </summary>
  25277. <value>
  25278. The maximum value.
  25279. </value>
  25280. <remarks>
  25281. <para>
  25282. Gets or sets the maximum value.
  25283. </para>
  25284. </remarks>
  25285. </member>
  25286. <member name="P:log4net.Util.FormattingInfo.LeftAlign">
  25287. <summary>
  25288. Gets or sets a flag indicating whether left align is enabled
  25289. or not.
  25290. </summary>
  25291. <value>
  25292. A flag indicating whether left align is enabled or not.
  25293. </value>
  25294. <remarks>
  25295. <para>
  25296. Gets or sets a flag indicating whether left align is enabled or not.
  25297. </para>
  25298. </remarks>
  25299. </member>
  25300. <member name="T:log4net.Util.GlobalContextProperties">
  25301. <summary>
  25302. Implementation of Properties collection for the <see cref="T:log4net.GlobalContext"/>
  25303. </summary>
  25304. <remarks>
  25305. <para>
  25306. This class implements a properties collection that is thread safe and supports both
  25307. storing properties and capturing a read only copy of the current propertied.
  25308. </para>
  25309. <para>
  25310. This class is optimized to the scenario where the properties are read frequently
  25311. and are modified infrequently.
  25312. </para>
  25313. </remarks>
  25314. <author>Nicko Cadell</author>
  25315. </member>
  25316. <member name="F:log4net.Util.GlobalContextProperties.m_readOnlyProperties">
  25317. <summary>
  25318. The read only copy of the properties.
  25319. </summary>
  25320. <remarks>
  25321. <para>
  25322. This variable is declared <c>volatile</c> to prevent the compiler and JIT from
  25323. reordering reads and writes of this thread performed on different threads.
  25324. </para>
  25325. </remarks>
  25326. </member>
  25327. <member name="F:log4net.Util.GlobalContextProperties.m_syncRoot">
  25328. <summary>
  25329. Lock object used to synchronize updates within this instance
  25330. </summary>
  25331. </member>
  25332. <member name="M:log4net.Util.GlobalContextProperties.#ctor">
  25333. <summary>
  25334. Constructor
  25335. </summary>
  25336. <remarks>
  25337. <para>
  25338. Initializes a new instance of the <see cref="T:log4net.Util.GlobalContextProperties" /> class.
  25339. </para>
  25340. </remarks>
  25341. </member>
  25342. <member name="P:log4net.Util.GlobalContextProperties.Item(System.String)">
  25343. <summary>
  25344. Gets or sets the value of a property
  25345. </summary>
  25346. <value>
  25347. The value for the property with the specified key
  25348. </value>
  25349. <remarks>
  25350. <para>
  25351. Reading the value for a key is faster than setting the value.
  25352. When the value is written a new read only copy of
  25353. the properties is created.
  25354. </para>
  25355. </remarks>
  25356. </member>
  25357. <member name="M:log4net.Util.GlobalContextProperties.Remove(System.String)">
  25358. <summary>
  25359. Remove a property from the global context
  25360. </summary>
  25361. <param name="key">the key for the entry to remove</param>
  25362. <remarks>
  25363. <para>
  25364. Removing an entry from the global context properties is relatively expensive compared
  25365. with reading a value.
  25366. </para>
  25367. </remarks>
  25368. </member>
  25369. <member name="M:log4net.Util.GlobalContextProperties.Clear">
  25370. <summary>
  25371. Clear the global context properties
  25372. </summary>
  25373. </member>
  25374. <member name="M:log4net.Util.GlobalContextProperties.GetReadOnlyProperties">
  25375. <summary>
  25376. Get a readonly immutable copy of the properties
  25377. </summary>
  25378. <returns>the current global context properties</returns>
  25379. <remarks>
  25380. <para>
  25381. This implementation is fast because the GlobalContextProperties class
  25382. stores a readonly copy of the properties.
  25383. </para>
  25384. </remarks>
  25385. </member>
  25386. <member name="T:log4net.Util.ILogExtensions">
  25387. <summary>
  25388. The static class ILogExtensions contains a set of widely used
  25389. methods that ease the interaction with the ILog interface implementations.
  25390. </summary>
  25391. <remarks>
  25392. <para>
  25393. This class contains methods for logging at different levels and checks the
  25394. properties for determining if those logging levels are enabled in the current
  25395. configuration.
  25396. </para>
  25397. </remarks>
  25398. <example>Simple example of logging messages
  25399. <code lang="C#">
  25400. using log4net.Util;
  25401. ILog log = LogManager.GetLogger("application-log");
  25402. log.InfoExt("Application Start");
  25403. log.DebugExt("This is a debug message");
  25404. </code>
  25405. </example>
  25406. </member>
  25407. <member name="F:log4net.Util.ILogExtensions.declaringType">
  25408. <summary>
  25409. The fully qualified type of the Logger class.
  25410. </summary>
  25411. </member>
  25412. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object})">
  25413. <summary>
  25414. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25415. </summary>
  25416. <param name="logger">The logger on which the message is logged.</param>
  25417. <param name="callback">The lambda expression that gets the object to log.</param>
  25418. <remarks>
  25419. <para>
  25420. This method first checks if this logger is <c>INFO</c>
  25421. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  25422. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25423. implementation. If this logger is <c>INFO</c> enabled, then it converts
  25424. the message object (retrieved by invocation of the provided callback) to a
  25425. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  25426. It then proceeds to call all the registered appenders in this logger
  25427. and also higher in the hierarchy depending on the value of
  25428. the additivity flag.
  25429. </para>
  25430. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25431. to this method will print the name of the <see cref="T:System.Exception"/>
  25432. but no stack trace. To print a stack trace use the
  25433. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  25434. </para>
  25435. </remarks>
  25436. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25437. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25438. </member>
  25439. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  25440. <summary>
  25441. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  25442. the stack trace of the <see cref="T:System.Exception"/> passed
  25443. as a parameter.
  25444. </summary>
  25445. <param name="logger">The logger on which the message is logged.</param>
  25446. <param name="callback">The lambda expression that gets the object to log.</param>
  25447. <param name="exception">The exception to log, including its stack trace.</param>
  25448. <remarks>
  25449. <para>
  25450. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25451. </para>
  25452. </remarks>
  25453. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25454. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25455. </member>
  25456. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)">
  25457. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> //TODO
  25458. <summary>
  25459. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25460. </summary>
  25461. <param name="logger">The logger on which the message is logged.</param>
  25462. <param name="message">The message object to log.</param>
  25463. <remarks>
  25464. <para>
  25465. This method first checks if this logger is <c>INFO</c>
  25466. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  25467. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25468. implementation. If this logger is <c>INFO</c> enabled, then it converts
  25469. the message object (passed as parameter) to a string by invoking the appropriate
  25470. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  25471. proceeds to call all the registered appenders in this logger
  25472. and also higher in the hierarchy depending on the value of
  25473. the additivity flag.
  25474. </para>
  25475. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25476. to this method will print the name of the <see cref="T:System.Exception"/>
  25477. but no stack trace. To print a stack trace use the
  25478. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  25479. </para>
  25480. </remarks>
  25481. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25482. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25483. </member>
  25484. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)">
  25485. <summary>
  25486. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  25487. the stack trace of the <see cref="T:System.Exception"/> passed
  25488. as a parameter.
  25489. </summary>
  25490. <param name="logger">The logger on which the message is logged.</param>
  25491. <param name="message">The message object to log.</param>
  25492. <param name="exception">The exception to log, including its stack trace.</param>
  25493. <remarks>
  25494. <para>
  25495. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25496. </para>
  25497. </remarks>
  25498. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25499. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25500. </member>
  25501. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object)">
  25502. <summary>
  25503. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25504. </summary>
  25505. <param name="logger">The logger on which the message is logged.</param>
  25506. <param name="format">A String containing zero or more format items</param>
  25507. <param name="arg0">An Object to format</param>
  25508. <remarks>
  25509. <para>
  25510. The message is formatted using the <c>String.Format</c> method. See
  25511. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25512. of the formatting.
  25513. </para>
  25514. <para>
  25515. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25516. 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)"/>
  25517. methods instead.
  25518. </para>
  25519. </remarks>
  25520. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25521. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25522. </member>
  25523. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object[])">
  25524. <summary>
  25525. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25526. </summary>
  25527. <param name="logger">The logger on which the message is logged.</param>
  25528. <param name="format">A String containing zero or more format items</param>
  25529. <param name="args">An Object array containing zero or more objects to format</param>
  25530. <remarks>
  25531. <para>
  25532. The message is formatted using the <c>String.Format</c> method. See
  25533. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25534. of the formatting.
  25535. </para>
  25536. <para>
  25537. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25538. 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)"/>
  25539. methods instead.
  25540. </para>
  25541. </remarks>
  25542. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25543. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25544. </member>
  25545. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  25546. <summary>
  25547. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25548. </summary>
  25549. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  25550. <param name="logger">The logger on which the message is logged.</param>
  25551. <param name="format">A String containing zero or more format items</param>
  25552. <param name="args">An Object array containing zero or more objects to format</param>
  25553. <remarks>
  25554. <para>
  25555. The message is formatted using the <c>String.Format</c> method. See
  25556. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25557. of the formatting.
  25558. </para>
  25559. <para>
  25560. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25561. 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)"/>
  25562. methods instead.
  25563. </para>
  25564. </remarks>
  25565. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25566. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25567. </member>
  25568. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  25569. <summary>
  25570. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25571. </summary>
  25572. <param name="logger">The logger on which the message is logged.</param>
  25573. <param name="format">A String containing zero or more format items</param>
  25574. <param name="arg0">An Object to format</param>
  25575. <param name="arg1">An Object to format</param>
  25576. <remarks>
  25577. <para>
  25578. The message is formatted using the <c>String.Format</c> method. See
  25579. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25580. of the formatting.
  25581. </para>
  25582. <para>
  25583. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25584. 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)"/>
  25585. methods instead.
  25586. </para>
  25587. </remarks>
  25588. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25589. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25590. </member>
  25591. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  25592. <summary>
  25593. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  25594. </summary>
  25595. <param name="logger">The logger on which the message is logged.</param>
  25596. <param name="format">A String containing zero or more format items</param>
  25597. <param name="arg0">An Object to format</param>
  25598. <param name="arg1">An Object to format</param>
  25599. <param name="arg2">An Object to format</param>
  25600. <remarks>
  25601. <para>
  25602. The message is formatted using the <c>String.Format</c> method. See
  25603. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25604. of the formatting.
  25605. </para>
  25606. <para>
  25607. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25608. 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)"/>
  25609. methods instead.
  25610. </para>
  25611. </remarks>
  25612. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  25613. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  25614. </member>
  25615. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object})">
  25616. <summary>
  25617. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  25618. </summary>
  25619. <param name="logger">The logger on which the message is logged.</param>
  25620. <param name="callback">The lambda expression that gets the object to log.</param>
  25621. <remarks>
  25622. <para>
  25623. This method first checks if this logger is <c>INFO</c>
  25624. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  25625. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25626. implementation. If this logger is <c>INFO</c> enabled, then it converts
  25627. the message object (retrieved by invocation of the provided callback) to a
  25628. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  25629. It then proceeds to call all the registered appenders in this logger
  25630. and also higher in the hierarchy depending on the value of
  25631. the additivity flag.
  25632. </para>
  25633. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25634. to this method will print the name of the <see cref="T:System.Exception"/>
  25635. but no stack trace. To print a stack trace use the
  25636. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  25637. </para>
  25638. </remarks>
  25639. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25640. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25641. </member>
  25642. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  25643. <summary>
  25644. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  25645. the stack trace of the <see cref="T:System.Exception"/> passed
  25646. as a parameter.
  25647. </summary>
  25648. <param name="logger">The logger on which the message is logged.</param>
  25649. <param name="callback">The lambda expression that gets the object to log.</param>
  25650. <param name="exception">The exception to log, including its stack trace.</param>
  25651. <remarks>
  25652. <para>
  25653. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25654. </para>
  25655. </remarks>
  25656. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25657. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25658. </member>
  25659. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)">
  25660. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> //TODO
  25661. <summary>
  25662. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  25663. </summary>
  25664. <param name="logger">The logger on which the message is logged.</param>
  25665. <param name="message">The message object to log.</param>
  25666. <remarks>
  25667. <para>
  25668. This method first checks if this logger is <c>INFO</c>
  25669. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  25670. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25671. implementation. If this logger is <c>INFO</c> enabled, then it converts
  25672. the message object (passed as parameter) to a string by invoking the appropriate
  25673. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  25674. proceeds to call all the registered appenders in this logger
  25675. and also higher in the hierarchy depending on the value of
  25676. the additivity flag.
  25677. </para>
  25678. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25679. to this method will print the name of the <see cref="T:System.Exception"/>
  25680. but no stack trace. To print a stack trace use the
  25681. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  25682. </para>
  25683. </remarks>
  25684. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25685. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25686. </member>
  25687. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)">
  25688. <summary>
  25689. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  25690. the stack trace of the <see cref="T:System.Exception"/> passed
  25691. as a parameter.
  25692. </summary>
  25693. <param name="logger">The logger on which the message is logged.</param>
  25694. <param name="message">The message object to log.</param>
  25695. <param name="exception">The exception to log, including its stack trace.</param>
  25696. <remarks>
  25697. <para>
  25698. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25699. </para>
  25700. </remarks>
  25701. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25702. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25703. </member>
  25704. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object)">
  25705. <summary>
  25706. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  25707. </summary>
  25708. <param name="logger">The logger on which the message is logged.</param>
  25709. <param name="format">A String containing zero or more format items</param>
  25710. <param name="arg0">An Object to format</param>
  25711. <remarks>
  25712. <para>
  25713. The message is formatted using the <c>String.Format</c> method. See
  25714. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25715. of the formatting.
  25716. </para>
  25717. <para>
  25718. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25719. 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)"/>
  25720. methods instead.
  25721. </para>
  25722. </remarks>
  25723. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25724. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25725. </member>
  25726. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object[])">
  25727. <summary>
  25728. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  25729. </summary>
  25730. <param name="logger">The logger on which the message is logged.</param>
  25731. <param name="format">A String containing zero or more format items</param>
  25732. <param name="args">An Object array containing zero or more objects to format</param>
  25733. <remarks>
  25734. <para>
  25735. The message is formatted using the <c>String.Format</c> method. See
  25736. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25737. of the formatting.
  25738. </para>
  25739. <para>
  25740. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25741. 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)"/>
  25742. methods instead.
  25743. </para>
  25744. </remarks>
  25745. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25746. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25747. </member>
  25748. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  25749. <summary>
  25750. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  25751. </summary>
  25752. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  25753. <param name="logger">The logger on which the message is logged.</param>
  25754. <param name="format">A String containing zero or more format items</param>
  25755. <param name="args">An Object array containing zero or more objects to format</param>
  25756. <remarks>
  25757. <para>
  25758. The message is formatted using the <c>String.Format</c> method. See
  25759. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25760. of the formatting.
  25761. </para>
  25762. <para>
  25763. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25764. 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)"/>
  25765. methods instead.
  25766. </para>
  25767. </remarks>
  25768. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25769. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25770. </member>
  25771. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  25772. <summary>
  25773. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  25774. </summary>
  25775. <param name="logger">The logger on which the message is logged.</param>
  25776. <param name="format">A String containing zero or more format items</param>
  25777. <param name="arg0">An Object to format</param>
  25778. <param name="arg1">An Object to format</param>
  25779. <remarks>
  25780. <para>
  25781. The message is formatted using the <c>String.Format</c> method. See
  25782. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25783. of the formatting.
  25784. </para>
  25785. <para>
  25786. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25787. 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)"/>
  25788. methods instead.
  25789. </para>
  25790. </remarks>
  25791. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25792. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25793. </member>
  25794. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  25795. <summary>
  25796. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  25797. </summary>
  25798. <param name="logger">The logger on which the message is logged.</param>
  25799. <param name="format">A String containing zero or more format items</param>
  25800. <param name="arg0">An Object to format</param>
  25801. <param name="arg1">An Object to format</param>
  25802. <param name="arg2">An Object to format</param>
  25803. <remarks>
  25804. <para>
  25805. The message is formatted using the <c>String.Format</c> method. See
  25806. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25807. of the formatting.
  25808. </para>
  25809. <para>
  25810. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25811. 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)"/>
  25812. methods instead.
  25813. </para>
  25814. </remarks>
  25815. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  25816. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  25817. </member>
  25818. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object})">
  25819. <summary>
  25820. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25821. </summary>
  25822. <param name="logger">The logger on which the message is logged.</param>
  25823. <param name="callback">The lambda expression that gets the object to log.</param>
  25824. <remarks>
  25825. <para>
  25826. This method first checks if this logger is <c>WARN</c>
  25827. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  25828. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25829. implementation. If this logger is <c>WARN</c> enabled, then it converts
  25830. the message object (retrieved by invocation of the provided callback) to a
  25831. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  25832. It then proceeds to call all the registered appenders in this logger
  25833. and also higher in the hierarchy depending on the value of
  25834. the additivity flag.
  25835. </para>
  25836. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25837. to this method will print the name of the <see cref="T:System.Exception"/>
  25838. but no stack trace. To print a stack trace use the
  25839. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  25840. </para>
  25841. </remarks>
  25842. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25843. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25844. </member>
  25845. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  25846. <summary>
  25847. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  25848. the stack trace of the <see cref="T:System.Exception"/> passed
  25849. as a parameter.
  25850. </summary>
  25851. <param name="logger">The logger on which the message is logged.</param>
  25852. <param name="callback">The lambda expression that gets the object to log.</param>
  25853. <param name="exception">The exception to log, including its stack trace.</param>
  25854. <remarks>
  25855. <para>
  25856. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25857. </para>
  25858. </remarks>
  25859. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25860. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25861. </member>
  25862. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)">
  25863. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> //TODO
  25864. <summary>
  25865. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25866. </summary>
  25867. <param name="logger">The logger on which the message is logged.</param>
  25868. <param name="message">The message object to log.</param>
  25869. <remarks>
  25870. <para>
  25871. This method first checks if this logger is <c>WARN</c>
  25872. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  25873. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  25874. implementation. If this logger is <c>WARN</c> enabled, then it converts
  25875. the message object (passed as parameter) to a string by invoking the appropriate
  25876. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  25877. proceeds to call all the registered appenders in this logger
  25878. and also higher in the hierarchy depending on the value of
  25879. the additivity flag.
  25880. </para>
  25881. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  25882. to this method will print the name of the <see cref="T:System.Exception"/>
  25883. but no stack trace. To print a stack trace use the
  25884. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  25885. </para>
  25886. </remarks>
  25887. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25888. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25889. </member>
  25890. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)">
  25891. <summary>
  25892. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  25893. the stack trace of the <see cref="T:System.Exception"/> passed
  25894. as a parameter.
  25895. </summary>
  25896. <param name="logger">The logger on which the message is logged.</param>
  25897. <param name="message">The message object to log.</param>
  25898. <param name="exception">The exception to log, including its stack trace.</param>
  25899. <remarks>
  25900. <para>
  25901. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  25902. </para>
  25903. </remarks>
  25904. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25905. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25906. </member>
  25907. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object)">
  25908. <summary>
  25909. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25910. </summary>
  25911. <param name="logger">The logger on which the message is logged.</param>
  25912. <param name="format">A String containing zero or more format items</param>
  25913. <param name="arg0">An Object to format</param>
  25914. <remarks>
  25915. <para>
  25916. The message is formatted using the <c>String.Format</c> method. See
  25917. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25918. of the formatting.
  25919. </para>
  25920. <para>
  25921. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25922. 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)"/>
  25923. methods instead.
  25924. </para>
  25925. </remarks>
  25926. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25927. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25928. </member>
  25929. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object[])">
  25930. <summary>
  25931. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25932. </summary>
  25933. <param name="logger">The logger on which the message is logged.</param>
  25934. <param name="format">A String containing zero or more format items</param>
  25935. <param name="args">An Object array containing zero or more objects to format</param>
  25936. <remarks>
  25937. <para>
  25938. The message is formatted using the <c>String.Format</c> method. See
  25939. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25940. of the formatting.
  25941. </para>
  25942. <para>
  25943. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25944. 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)"/>
  25945. methods instead.
  25946. </para>
  25947. </remarks>
  25948. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25949. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25950. </member>
  25951. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  25952. <summary>
  25953. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25954. </summary>
  25955. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  25956. <param name="logger">The logger on which the message is logged.</param>
  25957. <param name="format">A String containing zero or more format items</param>
  25958. <param name="args">An Object array containing zero or more objects to format</param>
  25959. <remarks>
  25960. <para>
  25961. The message is formatted using the <c>String.Format</c> method. See
  25962. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25963. of the formatting.
  25964. </para>
  25965. <para>
  25966. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25967. 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)"/>
  25968. methods instead.
  25969. </para>
  25970. </remarks>
  25971. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25972. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25973. </member>
  25974. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  25975. <summary>
  25976. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  25977. </summary>
  25978. <param name="logger">The logger on which the message is logged.</param>
  25979. <param name="format">A String containing zero or more format items</param>
  25980. <param name="arg0">An Object to format</param>
  25981. <param name="arg1">An Object to format</param>
  25982. <remarks>
  25983. <para>
  25984. The message is formatted using the <c>String.Format</c> method. See
  25985. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  25986. of the formatting.
  25987. </para>
  25988. <para>
  25989. This method does not take an <see cref="T:System.Exception"/> object to include in the
  25990. 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)"/>
  25991. methods instead.
  25992. </para>
  25993. </remarks>
  25994. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  25995. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  25996. </member>
  25997. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  25998. <summary>
  25999. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  26000. </summary>
  26001. <param name="logger">The logger on which the message is logged.</param>
  26002. <param name="format">A String containing zero or more format items</param>
  26003. <param name="arg0">An Object to format</param>
  26004. <param name="arg1">An Object to format</param>
  26005. <param name="arg2">An Object to format</param>
  26006. <remarks>
  26007. <para>
  26008. The message is formatted using the <c>String.Format</c> method. See
  26009. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26010. of the formatting.
  26011. </para>
  26012. <para>
  26013. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26014. 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)"/>
  26015. methods instead.
  26016. </para>
  26017. </remarks>
  26018. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  26019. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  26020. </member>
  26021. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object})">
  26022. <summary>
  26023. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  26024. </summary>
  26025. <param name="logger">The logger on which the message is logged.</param>
  26026. <param name="callback">The lambda expression that gets the object to log.</param>
  26027. <remarks>
  26028. <para>
  26029. This method first checks if this logger is <c>ERROR</c>
  26030. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  26031. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26032. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  26033. the message object (retrieved by invocation of the provided callback) to a
  26034. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26035. It then proceeds to call all the registered appenders in this logger
  26036. and also higher in the hierarchy depending on the value of
  26037. the additivity flag.
  26038. </para>
  26039. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26040. to this method will print the name of the <see cref="T:System.Exception"/>
  26041. but no stack trace. To print a stack trace use the
  26042. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26043. </para>
  26044. </remarks>
  26045. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26046. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26047. </member>
  26048. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26049. <summary>
  26050. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  26051. the stack trace of the <see cref="T:System.Exception"/> passed
  26052. as a parameter.
  26053. </summary>
  26054. <param name="logger">The logger on which the message is logged.</param>
  26055. <param name="callback">The lambda expression that gets the object to log.</param>
  26056. <param name="exception">The exception to log, including its stack trace.</param>
  26057. <remarks>
  26058. <para>
  26059. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26060. </para>
  26061. </remarks>
  26062. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26063. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26064. </member>
  26065. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)">
  26066. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> //TODO
  26067. <summary>
  26068. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  26069. </summary>
  26070. <param name="logger">The logger on which the message is logged.</param>
  26071. <param name="message">The message object to log.</param>
  26072. <remarks>
  26073. <para>
  26074. This method first checks if this logger is <c>ERROR</c>
  26075. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  26076. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26077. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  26078. the message object (passed as parameter) to a string by invoking the appropriate
  26079. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26080. proceeds to call all the registered appenders in this logger
  26081. and also higher in the hierarchy depending on the value of
  26082. the additivity flag.
  26083. </para>
  26084. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26085. to this method will print the name of the <see cref="T:System.Exception"/>
  26086. but no stack trace. To print a stack trace use the
  26087. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26088. </para>
  26089. </remarks>
  26090. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26091. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26092. </member>
  26093. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)">
  26094. <summary>
  26095. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  26096. the stack trace of the <see cref="T:System.Exception"/> passed
  26097. as a parameter.
  26098. </summary>
  26099. <param name="logger">The logger on which the message is logged.</param>
  26100. <param name="message">The message object to log.</param>
  26101. <param name="exception">The exception to log, including its stack trace.</param>
  26102. <remarks>
  26103. <para>
  26104. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26105. </para>
  26106. </remarks>
  26107. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26108. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26109. </member>
  26110. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object)">
  26111. <summary>
  26112. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26113. </summary>
  26114. <param name="logger">The logger on which the message is logged.</param>
  26115. <param name="format">A String containing zero or more format items</param>
  26116. <param name="arg0">An Object to format</param>
  26117. <remarks>
  26118. <para>
  26119. The message is formatted using the <c>String.Format</c> method. See
  26120. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26121. of the formatting.
  26122. </para>
  26123. <para>
  26124. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26125. 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)"/>
  26126. methods instead.
  26127. </para>
  26128. </remarks>
  26129. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26130. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26131. </member>
  26132. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object[])">
  26133. <summary>
  26134. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26135. </summary>
  26136. <param name="logger">The logger on which the message is logged.</param>
  26137. <param name="format">A String containing zero or more format items</param>
  26138. <param name="args">An Object array containing zero or more objects to format</param>
  26139. <remarks>
  26140. <para>
  26141. The message is formatted using the <c>String.Format</c> method. See
  26142. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26143. of the formatting.
  26144. </para>
  26145. <para>
  26146. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26147. 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)"/>
  26148. methods instead.
  26149. </para>
  26150. </remarks>
  26151. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26152. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26153. </member>
  26154. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26155. <summary>
  26156. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26157. </summary>
  26158. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26159. <param name="logger">The logger on which the message is logged.</param>
  26160. <param name="format">A String containing zero or more format items</param>
  26161. <param name="args">An Object array containing zero or more objects to format</param>
  26162. <remarks>
  26163. <para>
  26164. The message is formatted using the <c>String.Format</c> method. See
  26165. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26166. of the formatting.
  26167. </para>
  26168. <para>
  26169. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26170. 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)"/>
  26171. methods instead.
  26172. </para>
  26173. </remarks>
  26174. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26175. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26176. </member>
  26177. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26178. <summary>
  26179. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26180. </summary>
  26181. <param name="logger">The logger on which the message is logged.</param>
  26182. <param name="format">A String containing zero or more format items</param>
  26183. <param name="arg0">An Object to format</param>
  26184. <param name="arg1">An Object to format</param>
  26185. <remarks>
  26186. <para>
  26187. The message is formatted using the <c>String.Format</c> method. See
  26188. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26189. of the formatting.
  26190. </para>
  26191. <para>
  26192. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26193. 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)"/>
  26194. methods instead.
  26195. </para>
  26196. </remarks>
  26197. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26198. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26199. </member>
  26200. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26201. <summary>
  26202. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  26203. </summary>
  26204. <param name="logger">The logger on which the message is logged.</param>
  26205. <param name="format">A String containing zero or more format items</param>
  26206. <param name="arg0">An Object to format</param>
  26207. <param name="arg1">An Object to format</param>
  26208. <param name="arg2">An Object to format</param>
  26209. <remarks>
  26210. <para>
  26211. The message is formatted using the <c>String.Format</c> method. See
  26212. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26213. of the formatting.
  26214. </para>
  26215. <para>
  26216. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26217. 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)"/>
  26218. methods instead.
  26219. </para>
  26220. </remarks>
  26221. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  26222. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  26223. </member>
  26224. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object})">
  26225. <summary>
  26226. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26227. </summary>
  26228. <param name="logger">The logger on which the message is logged.</param>
  26229. <param name="callback">The lambda expression that gets the object to log.</param>
  26230. <remarks>
  26231. <para>
  26232. This method first checks if this logger is <c>FATAL</c>
  26233. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  26234. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26235. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  26236. the message object (retrieved by invocation of the provided callback) to a
  26237. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  26238. It then proceeds to call all the registered appenders in this logger
  26239. and also higher in the hierarchy depending on the value of
  26240. the additivity flag.
  26241. </para>
  26242. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26243. to this method will print the name of the <see cref="T:System.Exception"/>
  26244. but no stack trace. To print a stack trace use the
  26245. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  26246. </para>
  26247. </remarks>
  26248. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26249. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26250. </member>
  26251. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  26252. <summary>
  26253. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  26254. the stack trace of the <see cref="T:System.Exception"/> passed
  26255. as a parameter.
  26256. </summary>
  26257. <param name="logger">The logger on which the message is logged.</param>
  26258. <param name="callback">The lambda expression that gets the object to log.</param>
  26259. <param name="exception">The exception to log, including its stack trace.</param>
  26260. <remarks>
  26261. <para>
  26262. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26263. </para>
  26264. </remarks>
  26265. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26266. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26267. </member>
  26268. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)">
  26269. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> //TODO
  26270. <summary>
  26271. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26272. </summary>
  26273. <param name="logger">The logger on which the message is logged.</param>
  26274. <param name="message">The message object to log.</param>
  26275. <remarks>
  26276. <para>
  26277. This method first checks if this logger is <c>FATAL</c>
  26278. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  26279. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  26280. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  26281. the message object (passed as parameter) to a string by invoking the appropriate
  26282. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  26283. proceeds to call all the registered appenders in this logger
  26284. and also higher in the hierarchy depending on the value of
  26285. the additivity flag.
  26286. </para>
  26287. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  26288. to this method will print the name of the <see cref="T:System.Exception"/>
  26289. but no stack trace. To print a stack trace use the
  26290. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  26291. </para>
  26292. </remarks>
  26293. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26294. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26295. </member>
  26296. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)">
  26297. <summary>
  26298. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  26299. the stack trace of the <see cref="T:System.Exception"/> passed
  26300. as a parameter.
  26301. </summary>
  26302. <param name="logger">The logger on which the message is logged.</param>
  26303. <param name="message">The message object to log.</param>
  26304. <param name="exception">The exception to log, including its stack trace.</param>
  26305. <remarks>
  26306. <para>
  26307. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  26308. </para>
  26309. </remarks>
  26310. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26311. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26312. </member>
  26313. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object)">
  26314. <summary>
  26315. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26316. </summary>
  26317. <param name="logger">The logger on which the message is logged.</param>
  26318. <param name="format">A String containing zero or more format items</param>
  26319. <param name="arg0">An Object to format</param>
  26320. <remarks>
  26321. <para>
  26322. The message is formatted using the <c>String.Format</c> method. See
  26323. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26324. of the formatting.
  26325. </para>
  26326. <para>
  26327. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26328. 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)"/>
  26329. methods instead.
  26330. </para>
  26331. </remarks>
  26332. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26333. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26334. </member>
  26335. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object[])">
  26336. <summary>
  26337. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26338. </summary>
  26339. <param name="logger">The logger on which the message is logged.</param>
  26340. <param name="format">A String containing zero or more format items</param>
  26341. <param name="args">An Object array containing zero or more objects to format</param>
  26342. <remarks>
  26343. <para>
  26344. The message is formatted using the <c>String.Format</c> method. See
  26345. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26346. of the formatting.
  26347. </para>
  26348. <para>
  26349. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26350. 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)"/>
  26351. methods instead.
  26352. </para>
  26353. </remarks>
  26354. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26355. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26356. </member>
  26357. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  26358. <summary>
  26359. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26360. </summary>
  26361. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  26362. <param name="logger">The logger on which the message is logged.</param>
  26363. <param name="format">A String containing zero or more format items</param>
  26364. <param name="args">An Object array containing zero or more objects to format</param>
  26365. <remarks>
  26366. <para>
  26367. The message is formatted using the <c>String.Format</c> method. See
  26368. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26369. of the formatting.
  26370. </para>
  26371. <para>
  26372. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26373. 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)"/>
  26374. methods instead.
  26375. </para>
  26376. </remarks>
  26377. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26378. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26379. </member>
  26380. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  26381. <summary>
  26382. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26383. </summary>
  26384. <param name="logger">The logger on which the message is logged.</param>
  26385. <param name="format">A String containing zero or more format items</param>
  26386. <param name="arg0">An Object to format</param>
  26387. <param name="arg1">An Object to format</param>
  26388. <remarks>
  26389. <para>
  26390. The message is formatted using the <c>String.Format</c> method. See
  26391. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26392. of the formatting.
  26393. </para>
  26394. <para>
  26395. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26396. 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)"/>
  26397. methods instead.
  26398. </para>
  26399. </remarks>
  26400. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26401. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26402. </member>
  26403. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  26404. <summary>
  26405. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  26406. </summary>
  26407. <param name="logger">The logger on which the message is logged.</param>
  26408. <param name="format">A String containing zero or more format items</param>
  26409. <param name="arg0">An Object to format</param>
  26410. <param name="arg1">An Object to format</param>
  26411. <param name="arg2">An Object to format</param>
  26412. <remarks>
  26413. <para>
  26414. The message is formatted using the <c>String.Format</c> method. See
  26415. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  26416. of the formatting.
  26417. </para>
  26418. <para>
  26419. This method does not take an <see cref="T:System.Exception"/> object to include in the
  26420. 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)"/>
  26421. methods instead.
  26422. </para>
  26423. </remarks>
  26424. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  26425. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  26426. </member>
  26427. <member name="T:log4net.Util.LevelMapping">
  26428. <summary>
  26429. Manages a mapping from levels to <see cref="T:log4net.Util.LevelMappingEntry"/>
  26430. </summary>
  26431. <remarks>
  26432. <para>
  26433. Manages an ordered mapping from <see cref="T:log4net.Core.Level"/> instances
  26434. to <see cref="T:log4net.Util.LevelMappingEntry"/> subclasses.
  26435. </para>
  26436. </remarks>
  26437. <author>Nicko Cadell</author>
  26438. </member>
  26439. <member name="M:log4net.Util.LevelMapping.#ctor">
  26440. <summary>
  26441. Default constructor
  26442. </summary>
  26443. <remarks>
  26444. <para>
  26445. Initialise a new instance of <see cref="T:log4net.Util.LevelMapping"/>.
  26446. </para>
  26447. </remarks>
  26448. </member>
  26449. <member name="M:log4net.Util.LevelMapping.Add(log4net.Util.LevelMappingEntry)">
  26450. <summary>
  26451. Add a <see cref="T:log4net.Util.LevelMappingEntry"/> to this mapping
  26452. </summary>
  26453. <param name="entry">the entry to add</param>
  26454. <remarks>
  26455. <para>
  26456. If a <see cref="T:log4net.Util.LevelMappingEntry"/> has previously been added
  26457. for the same <see cref="T:log4net.Core.Level"/> then that entry will be
  26458. overwritten.
  26459. </para>
  26460. </remarks>
  26461. </member>
  26462. <member name="M:log4net.Util.LevelMapping.Lookup(log4net.Core.Level)">
  26463. <summary>
  26464. Lookup the mapping for the specified level
  26465. </summary>
  26466. <param name="level">the level to lookup</param>
  26467. <returns>the <see cref="T:log4net.Util.LevelMappingEntry"/> for the level or <c>null</c> if no mapping found</returns>
  26468. <remarks>
  26469. <para>
  26470. Lookup the value for the specified level. Finds the nearest
  26471. mapping value for the level that is equal to or less than the
  26472. <paramref name="level"/> specified.
  26473. </para>
  26474. <para>
  26475. If no mapping could be found then <c>null</c> is returned.
  26476. </para>
  26477. </remarks>
  26478. </member>
  26479. <member name="M:log4net.Util.LevelMapping.ActivateOptions">
  26480. <summary>
  26481. Initialize options
  26482. </summary>
  26483. <remarks>
  26484. <para>
  26485. Caches the sorted list of <see cref="T:log4net.Util.LevelMappingEntry"/> in an array
  26486. </para>
  26487. </remarks>
  26488. </member>
  26489. <member name="T:log4net.Util.LevelMappingEntry">
  26490. <summary>
  26491. An entry in the <see cref="T:log4net.Util.LevelMapping"/>
  26492. </summary>
  26493. <remarks>
  26494. <para>
  26495. This is an abstract base class for types that are stored in the
  26496. <see cref="T:log4net.Util.LevelMapping"/> object.
  26497. </para>
  26498. </remarks>
  26499. <author>Nicko Cadell</author>
  26500. </member>
  26501. <member name="M:log4net.Util.LevelMappingEntry.#ctor">
  26502. <summary>
  26503. Default protected constructor
  26504. </summary>
  26505. <remarks>
  26506. <para>
  26507. Default protected constructor
  26508. </para>
  26509. </remarks>
  26510. </member>
  26511. <member name="P:log4net.Util.LevelMappingEntry.Level">
  26512. <summary>
  26513. The level that is the key for this mapping
  26514. </summary>
  26515. <value>
  26516. The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping
  26517. </value>
  26518. <remarks>
  26519. <para>
  26520. Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this
  26521. mapping subclass.
  26522. </para>
  26523. </remarks>
  26524. </member>
  26525. <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions">
  26526. <summary>
  26527. Initialize any options defined on this entry
  26528. </summary>
  26529. <remarks>
  26530. <para>
  26531. Should be overridden by any classes that need to initialise based on their options
  26532. </para>
  26533. </remarks>
  26534. </member>
  26535. <member name="T:log4net.Util.LogicalThreadContextProperties">
  26536. <summary>
  26537. Implementation of Properties collection for the <see cref="T:log4net.LogicalThreadContext"/>
  26538. </summary>
  26539. <remarks>
  26540. <para>
  26541. Class implements a collection of properties that is specific to each thread.
  26542. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  26543. </para>
  26544. <para>
  26545. This class stores its properties in a slot on the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> named
  26546. <c>log4net.Util.LogicalThreadContextProperties</c>.
  26547. </para>
  26548. <para>
  26549. For .NET Standard 1.3 this class uses
  26550. System.Threading.AsyncLocal rather than <see
  26551. cref="T:System.Runtime.Remoting.Messaging.CallContext"/>.
  26552. </para>
  26553. <para>
  26554. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  26555. <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
  26556. <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  26557. If the calling code does not have this permission then this context will be disabled.
  26558. It will not store any property values set on it.
  26559. </para>
  26560. </remarks>
  26561. <author>Nicko Cadell</author>
  26562. </member>
  26563. <member name="F:log4net.Util.LogicalThreadContextProperties.m_disabled">
  26564. <summary>
  26565. Flag used to disable this context if we don't have permission to access the CallContext.
  26566. </summary>
  26567. </member>
  26568. <member name="M:log4net.Util.LogicalThreadContextProperties.#ctor">
  26569. <summary>
  26570. Constructor
  26571. </summary>
  26572. <remarks>
  26573. <para>
  26574. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextProperties" /> class.
  26575. </para>
  26576. </remarks>
  26577. </member>
  26578. <member name="P:log4net.Util.LogicalThreadContextProperties.Item(System.String)">
  26579. <summary>
  26580. Gets or sets the value of a property
  26581. </summary>
  26582. <value>
  26583. The value for the property with the specified key
  26584. </value>
  26585. <remarks>
  26586. <para>
  26587. Get or set the property value for the <paramref name="key"/> specified.
  26588. </para>
  26589. </remarks>
  26590. </member>
  26591. <member name="M:log4net.Util.LogicalThreadContextProperties.Remove(System.String)">
  26592. <summary>
  26593. Remove a property
  26594. </summary>
  26595. <param name="key">the key for the entry to remove</param>
  26596. <remarks>
  26597. <para>
  26598. Remove the value for the specified <paramref name="key"/> from the context.
  26599. </para>
  26600. </remarks>
  26601. </member>
  26602. <member name="M:log4net.Util.LogicalThreadContextProperties.Clear">
  26603. <summary>
  26604. Clear all the context properties
  26605. </summary>
  26606. <remarks>
  26607. <para>
  26608. Clear all the context properties
  26609. </para>
  26610. </remarks>
  26611. </member>
  26612. <member name="M:log4net.Util.LogicalThreadContextProperties.GetProperties(System.Boolean)">
  26613. <summary>
  26614. Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread.
  26615. </summary>
  26616. <param name="create">create the dictionary if it does not exist, otherwise return null if is does not exist</param>
  26617. <returns>the properties for this thread</returns>
  26618. <remarks>
  26619. <para>
  26620. The collection returned is only to be used on the calling thread. If the
  26621. caller needs to share the collection between different threads then the
  26622. caller must clone the collection before doings so.
  26623. </para>
  26624. </remarks>
  26625. </member>
  26626. <member name="M:log4net.Util.LogicalThreadContextProperties.GetLogicalProperties">
  26627. <summary>
  26628. Gets the call context get data.
  26629. </summary>
  26630. <returns>The peroperties dictionary stored in the call context</returns>
  26631. <remarks>
  26632. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.GetData(System.String)"/> has a
  26633. security link demand, therfore we must put the method call in a seperate method
  26634. that we can wrap in an exception handler.
  26635. </remarks>
  26636. </member>
  26637. <member name="M:log4net.Util.LogicalThreadContextProperties.SetLogicalProperties(log4net.Util.PropertiesDictionary)">
  26638. <summary>
  26639. Sets the call context data.
  26640. </summary>
  26641. <param name="properties">The properties.</param>
  26642. <remarks>
  26643. 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
  26644. security link demand, therfore we must put the method call in a seperate method
  26645. that we can wrap in an exception handler.
  26646. </remarks>
  26647. </member>
  26648. <member name="F:log4net.Util.LogicalThreadContextProperties.declaringType">
  26649. <summary>
  26650. The fully qualified type of the LogicalThreadContextProperties class.
  26651. </summary>
  26652. <remarks>
  26653. Used by the internal logger to record the Type of the
  26654. log message.
  26655. </remarks>
  26656. </member>
  26657. <member name="T:log4net.Util.TwoArgAction`2">
  26658. <summary>
  26659. Delegate type used for LogicalThreadContextStack's callbacks.
  26660. </summary>
  26661. </member>
  26662. <member name="T:log4net.Util.LogicalThreadContextStack">
  26663. <summary>
  26664. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  26665. </summary>
  26666. <remarks>
  26667. <para>
  26668. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  26669. </para>
  26670. </remarks>
  26671. <author>Nicko Cadell</author>
  26672. </member>
  26673. <member name="F:log4net.Util.LogicalThreadContextStack.m_stack">
  26674. <summary>
  26675. The stack store.
  26676. </summary>
  26677. </member>
  26678. <member name="F:log4net.Util.LogicalThreadContextStack.m_propertyKey">
  26679. <summary>
  26680. The name of this <see cref="T:log4net.Util.LogicalThreadContextStack"/> within the
  26681. <see cref="T:log4net.Util.LogicalThreadContextProperties"/>.
  26682. </summary>
  26683. </member>
  26684. <member name="F:log4net.Util.LogicalThreadContextStack.m_registerNew">
  26685. <summary>
  26686. The callback used to let the <see cref="T:log4net.Util.LogicalThreadContextStacks"/> register a
  26687. new instance of a <see cref="T:log4net.Util.LogicalThreadContextStack"/>.
  26688. </summary>
  26689. </member>
  26690. <member name="M:log4net.Util.LogicalThreadContextStack.#ctor(System.String,log4net.Util.TwoArgAction{System.String,log4net.Util.LogicalThreadContextStack})">
  26691. <summary>
  26692. Internal constructor
  26693. </summary>
  26694. <remarks>
  26695. <para>
  26696. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack" /> class.
  26697. </para>
  26698. </remarks>
  26699. </member>
  26700. <member name="P:log4net.Util.LogicalThreadContextStack.Count">
  26701. <summary>
  26702. The number of messages in the stack
  26703. </summary>
  26704. <value>
  26705. The current number of messages in the stack
  26706. </value>
  26707. <remarks>
  26708. <para>
  26709. The current number of messages in the stack. That is
  26710. the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> has been called
  26711. minus the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Pop"/> has been called.
  26712. </para>
  26713. </remarks>
  26714. </member>
  26715. <member name="M:log4net.Util.LogicalThreadContextStack.Clear">
  26716. <summary>
  26717. Clears all the contextual information held in this stack.
  26718. </summary>
  26719. <remarks>
  26720. <para>
  26721. Clears all the contextual information held in this stack.
  26722. Only call this if you think that this thread is being reused after
  26723. a previous call execution which may not have completed correctly.
  26724. You do not need to use this method if you always guarantee to call
  26725. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  26726. returned from <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  26727. for example by using the <c>using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  26728. syntax.
  26729. </para>
  26730. </remarks>
  26731. </member>
  26732. <member name="M:log4net.Util.LogicalThreadContextStack.Pop">
  26733. <summary>
  26734. Removes the top context from this stack.
  26735. </summary>
  26736. <returns>The message in the context that was removed from the top of this stack.</returns>
  26737. <remarks>
  26738. <para>
  26739. Remove the top context from this stack, and return
  26740. it to the caller. If this stack is empty then an
  26741. empty string (not <see langword="null"/>) is returned.
  26742. </para>
  26743. </remarks>
  26744. </member>
  26745. <member name="M:log4net.Util.LogicalThreadContextStack.Push(System.String)">
  26746. <summary>
  26747. Pushes a new context message into this stack.
  26748. </summary>
  26749. <param name="message">The new context message.</param>
  26750. <returns>
  26751. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  26752. </returns>
  26753. <remarks>
  26754. <para>
  26755. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  26756. is returned that can be used to clean up this stack. This
  26757. can be easily combined with the <c>using</c> keyword to scope the
  26758. context.
  26759. </para>
  26760. </remarks>
  26761. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  26762. <code lang="C#">
  26763. using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))
  26764. {
  26765. log.Warn("This should have an ThreadContext Stack message");
  26766. }
  26767. </code>
  26768. </example>
  26769. </member>
  26770. <member name="M:log4net.Util.LogicalThreadContextStack.GetFullMessage">
  26771. <summary>
  26772. Gets the current context information for this stack.
  26773. </summary>
  26774. <returns>The current context information.</returns>
  26775. </member>
  26776. <member name="P:log4net.Util.LogicalThreadContextStack.InternalStack">
  26777. <summary>
  26778. Gets and sets the internal stack used by this <see cref="T:log4net.Util.LogicalThreadContextStack"/>
  26779. </summary>
  26780. <value>The internal storage stack</value>
  26781. <remarks>
  26782. <para>
  26783. This property is provided only to support backward compatability
  26784. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  26785. be modified.
  26786. </para>
  26787. </remarks>
  26788. </member>
  26789. <member name="M:log4net.Util.LogicalThreadContextStack.ToString">
  26790. <summary>
  26791. Gets the current context information for this stack.
  26792. </summary>
  26793. <returns>Gets the current context information</returns>
  26794. <remarks>
  26795. <para>
  26796. Gets the current context information for this stack.
  26797. </para>
  26798. </remarks>
  26799. </member>
  26800. <member name="M:log4net.Util.LogicalThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  26801. <summary>
  26802. Get a portable version of this object
  26803. </summary>
  26804. <returns>the portable instance of this object</returns>
  26805. <remarks>
  26806. <para>
  26807. Get a cross thread portable version of this object
  26808. </para>
  26809. </remarks>
  26810. </member>
  26811. <member name="T:log4net.Util.LogicalThreadContextStack.StackFrame">
  26812. <summary>
  26813. Inner class used to represent a single context frame in the stack.
  26814. </summary>
  26815. <remarks>
  26816. <para>
  26817. Inner class used to represent a single context frame in the stack.
  26818. </para>
  26819. </remarks>
  26820. </member>
  26821. <member name="M:log4net.Util.LogicalThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.LogicalThreadContextStack.StackFrame)">
  26822. <summary>
  26823. Constructor
  26824. </summary>
  26825. <param name="message">The message for this context.</param>
  26826. <param name="parent">The parent context in the chain.</param>
  26827. <remarks>
  26828. <para>
  26829. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.StackFrame" /> class
  26830. with the specified message and parent context.
  26831. </para>
  26832. </remarks>
  26833. </member>
  26834. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.Message">
  26835. <summary>
  26836. Get the message.
  26837. </summary>
  26838. <value>The message.</value>
  26839. <remarks>
  26840. <para>
  26841. Get the message.
  26842. </para>
  26843. </remarks>
  26844. </member>
  26845. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.FullMessage">
  26846. <summary>
  26847. Gets the full text of the context down to the root level.
  26848. </summary>
  26849. <value>
  26850. The full text of the context down to the root level.
  26851. </value>
  26852. <remarks>
  26853. <para>
  26854. Gets the full text of the context down to the root level.
  26855. </para>
  26856. </remarks>
  26857. </member>
  26858. <member name="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame">
  26859. <summary>
  26860. Struct returned from the <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> method.
  26861. </summary>
  26862. <remarks>
  26863. <para>
  26864. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  26865. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  26866. </para>
  26867. </remarks>
  26868. </member>
  26869. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_frameDepth">
  26870. <summary>
  26871. The depth to trim the stack to when this instance is disposed
  26872. </summary>
  26873. </member>
  26874. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_logicalThreadContextStack">
  26875. <summary>
  26876. The outer LogicalThreadContextStack.
  26877. </summary>
  26878. </member>
  26879. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.#ctor(log4net.Util.LogicalThreadContextStack,System.Int32)">
  26880. <summary>
  26881. Constructor
  26882. </summary>
  26883. <param name="logicalThreadContextStack">The internal stack used by the ThreadContextStack.</param>
  26884. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  26885. <remarks>
  26886. <para>
  26887. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame" /> class with
  26888. the specified stack and return depth.
  26889. </para>
  26890. </remarks>
  26891. </member>
  26892. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.Dispose">
  26893. <summary>
  26894. Returns the stack to the correct depth.
  26895. </summary>
  26896. <remarks>
  26897. <para>
  26898. Returns the stack to the correct depth.
  26899. </para>
  26900. </remarks>
  26901. </member>
  26902. <member name="T:log4net.Util.LogicalThreadContextStacks">
  26903. <summary>
  26904. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  26905. </summary>
  26906. <remarks>
  26907. <para>
  26908. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  26909. </para>
  26910. </remarks>
  26911. <author>Nicko Cadell</author>
  26912. </member>
  26913. <member name="M:log4net.Util.LogicalThreadContextStacks.#ctor(log4net.Util.LogicalThreadContextProperties)">
  26914. <summary>
  26915. Internal constructor
  26916. </summary>
  26917. <remarks>
  26918. <para>
  26919. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks" /> class.
  26920. </para>
  26921. </remarks>
  26922. </member>
  26923. <member name="P:log4net.Util.LogicalThreadContextStacks.Item(System.String)">
  26924. <summary>
  26925. Gets the named thread context stack
  26926. </summary>
  26927. <value>
  26928. The named stack
  26929. </value>
  26930. <remarks>
  26931. <para>
  26932. Gets the named thread context stack
  26933. </para>
  26934. </remarks>
  26935. </member>
  26936. <member name="F:log4net.Util.LogicalThreadContextStacks.declaringType">
  26937. <summary>
  26938. The fully qualified type of the ThreadContextStacks class.
  26939. </summary>
  26940. <remarks>
  26941. Used by the internal logger to record the Type of the
  26942. log message.
  26943. </remarks>
  26944. </member>
  26945. <member name="T:log4net.Util.LogReceivedEventHandler">
  26946. <summary>
  26947. </summary>
  26948. <param name="source"></param>
  26949. <param name="e"></param>
  26950. </member>
  26951. <member name="T:log4net.Util.LogLog">
  26952. <summary>
  26953. Outputs log statements from within the log4net assembly.
  26954. </summary>
  26955. <remarks>
  26956. <para>
  26957. Log4net components cannot make log4net logging calls. However, it is
  26958. sometimes useful for the user to learn about what log4net is
  26959. doing.
  26960. </para>
  26961. <para>
  26962. All log4net internal debug calls go to the standard output stream
  26963. whereas internal error messages are sent to the standard error output
  26964. stream.
  26965. </para>
  26966. </remarks>
  26967. <author>Nicko Cadell</author>
  26968. <author>Gert Driesen</author>
  26969. </member>
  26970. <member name="E:log4net.Util.LogLog.LogReceived">
  26971. <summary>
  26972. The event raised when an internal message has been received.
  26973. </summary>
  26974. </member>
  26975. <member name="P:log4net.Util.LogLog.Source">
  26976. <summary>
  26977. The Type that generated the internal message.
  26978. </summary>
  26979. </member>
  26980. <member name="P:log4net.Util.LogLog.TimeStamp">
  26981. <summary>
  26982. The DateTime stamp of when the internal message was received.
  26983. </summary>
  26984. </member>
  26985. <member name="P:log4net.Util.LogLog.TimeStampUtc">
  26986. <summary>
  26987. The UTC DateTime stamp of when the internal message was received.
  26988. </summary>
  26989. </member>
  26990. <member name="P:log4net.Util.LogLog.Prefix">
  26991. <summary>
  26992. A string indicating the severity of the internal message.
  26993. </summary>
  26994. <remarks>
  26995. "log4net: ",
  26996. "log4net:ERROR ",
  26997. "log4net:WARN "
  26998. </remarks>
  26999. </member>
  27000. <member name="P:log4net.Util.LogLog.Message">
  27001. <summary>
  27002. The internal log message.
  27003. </summary>
  27004. </member>
  27005. <member name="P:log4net.Util.LogLog.Exception">
  27006. <summary>
  27007. The Exception related to the message.
  27008. </summary>
  27009. <remarks>
  27010. Optional. Will be null if no Exception was passed.
  27011. </remarks>
  27012. </member>
  27013. <member name="M:log4net.Util.LogLog.ToString">
  27014. <summary>
  27015. Formats Prefix, Source, and Message in the same format as the value
  27016. sent to Console.Out and Trace.Write.
  27017. </summary>
  27018. <returns></returns>
  27019. </member>
  27020. <member name="M:log4net.Util.LogLog.#ctor(System.Type,System.String,System.String,System.Exception)">
  27021. <summary>
  27022. Initializes a new instance of the <see cref="T:log4net.Util.LogLog" /> class.
  27023. </summary>
  27024. <param name="source"></param>
  27025. <param name="prefix"></param>
  27026. <param name="message"></param>
  27027. <param name="exception"></param>
  27028. </member>
  27029. <member name="M:log4net.Util.LogLog.#cctor">
  27030. <summary>
  27031. Static constructor that initializes logging by reading
  27032. settings from the application configuration file.
  27033. </summary>
  27034. <remarks>
  27035. <para>
  27036. The <c>log4net.Internal.Debug</c> application setting
  27037. controls internal debugging. This setting should be set
  27038. to <c>true</c> to enable debugging.
  27039. </para>
  27040. <para>
  27041. The <c>log4net.Internal.Quiet</c> application setting
  27042. suppresses all internal logging including error messages.
  27043. This setting should be set to <c>true</c> to enable message
  27044. suppression.
  27045. </para>
  27046. </remarks>
  27047. </member>
  27048. <member name="P:log4net.Util.LogLog.InternalDebugging">
  27049. <summary>
  27050. Gets or sets a value indicating whether log4net internal logging
  27051. is enabled or disabled.
  27052. </summary>
  27053. <value>
  27054. <c>true</c> if log4net internal logging is enabled, otherwise
  27055. <c>false</c>.
  27056. </value>
  27057. <remarks>
  27058. <para>
  27059. When set to <c>true</c>, internal debug level logging will be
  27060. displayed.
  27061. </para>
  27062. <para>
  27063. This value can be set by setting the application setting
  27064. <c>log4net.Internal.Debug</c> in the application configuration
  27065. file.
  27066. </para>
  27067. <para>
  27068. The default value is <c>false</c>, i.e. debugging is
  27069. disabled.
  27070. </para>
  27071. </remarks>
  27072. <example>
  27073. <para>
  27074. The following example enables internal debugging using the
  27075. application configuration file :
  27076. </para>
  27077. <code lang="XML" escaped="true">
  27078. <configuration>
  27079. <appSettings>
  27080. <add key="log4net.Internal.Debug" value="true" />
  27081. </appSettings>
  27082. </configuration>
  27083. </code>
  27084. </example>
  27085. </member>
  27086. <member name="P:log4net.Util.LogLog.QuietMode">
  27087. <summary>
  27088. Gets or sets a value indicating whether log4net should generate no output
  27089. from internal logging, not even for errors.
  27090. </summary>
  27091. <value>
  27092. <c>true</c> if log4net should generate no output at all from internal
  27093. logging, otherwise <c>false</c>.
  27094. </value>
  27095. <remarks>
  27096. <para>
  27097. When set to <c>true</c> will cause internal logging at all levels to be
  27098. suppressed. This means that no warning or error reports will be logged.
  27099. This option overrides the <see cref="P:log4net.Util.LogLog.InternalDebugging"/> setting and
  27100. disables all debug also.
  27101. </para>
  27102. <para>This value can be set by setting the application setting
  27103. <c>log4net.Internal.Quiet</c> in the application configuration file.
  27104. </para>
  27105. <para>
  27106. The default value is <c>false</c>, i.e. internal logging is not
  27107. disabled.
  27108. </para>
  27109. </remarks>
  27110. <example>
  27111. The following example disables internal logging using the
  27112. application configuration file :
  27113. <code lang="XML" escaped="true">
  27114. <configuration>
  27115. <appSettings>
  27116. <add key="log4net.Internal.Quiet" value="true" />
  27117. </appSettings>
  27118. </configuration>
  27119. </code>
  27120. </example>
  27121. </member>
  27122. <member name="P:log4net.Util.LogLog.EmitInternalMessages">
  27123. <summary>
  27124. </summary>
  27125. </member>
  27126. <member name="M:log4net.Util.LogLog.OnLogReceived(System.Type,System.String,System.String,System.Exception)">
  27127. <summary>
  27128. Raises the LogReceived event when an internal messages is received.
  27129. </summary>
  27130. <param name="source"></param>
  27131. <param name="prefix"></param>
  27132. <param name="message"></param>
  27133. <param name="exception"></param>
  27134. </member>
  27135. <member name="P:log4net.Util.LogLog.IsDebugEnabled">
  27136. <summary>
  27137. Test if LogLog.Debug is enabled for output.
  27138. </summary>
  27139. <value>
  27140. <c>true</c> if Debug is enabled
  27141. </value>
  27142. <remarks>
  27143. <para>
  27144. Test if LogLog.Debug is enabled for output.
  27145. </para>
  27146. </remarks>
  27147. </member>
  27148. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String)">
  27149. <summary>
  27150. Writes log4net internal debug messages to the
  27151. standard output stream.
  27152. </summary>
  27153. <param name="source"></param>
  27154. <param name="message">The message to log.</param>
  27155. <remarks>
  27156. <para>
  27157. All internal debug messages are prepended with
  27158. the string "log4net: ".
  27159. </para>
  27160. </remarks>
  27161. </member>
  27162. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String,System.Exception)">
  27163. <summary>
  27164. Writes log4net internal debug messages to the
  27165. standard output stream.
  27166. </summary>
  27167. <param name="source">The Type that generated this message.</param>
  27168. <param name="message">The message to log.</param>
  27169. <param name="exception">An exception to log.</param>
  27170. <remarks>
  27171. <para>
  27172. All internal debug messages are prepended with
  27173. the string "log4net: ".
  27174. </para>
  27175. </remarks>
  27176. </member>
  27177. <member name="P:log4net.Util.LogLog.IsWarnEnabled">
  27178. <summary>
  27179. Test if LogLog.Warn is enabled for output.
  27180. </summary>
  27181. <value>
  27182. <c>true</c> if Warn is enabled
  27183. </value>
  27184. <remarks>
  27185. <para>
  27186. Test if LogLog.Warn is enabled for output.
  27187. </para>
  27188. </remarks>
  27189. </member>
  27190. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String)">
  27191. <summary>
  27192. Writes log4net internal warning messages to the
  27193. standard error stream.
  27194. </summary>
  27195. <param name="source">The Type that generated this message.</param>
  27196. <param name="message">The message to log.</param>
  27197. <remarks>
  27198. <para>
  27199. All internal warning messages are prepended with
  27200. the string "log4net:WARN ".
  27201. </para>
  27202. </remarks>
  27203. </member>
  27204. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String,System.Exception)">
  27205. <summary>
  27206. Writes log4net internal warning messages to the
  27207. standard error stream.
  27208. </summary>
  27209. <param name="source">The Type that generated this message.</param>
  27210. <param name="message">The message to log.</param>
  27211. <param name="exception">An exception to log.</param>
  27212. <remarks>
  27213. <para>
  27214. All internal warning messages are prepended with
  27215. the string "log4net:WARN ".
  27216. </para>
  27217. </remarks>
  27218. </member>
  27219. <member name="P:log4net.Util.LogLog.IsErrorEnabled">
  27220. <summary>
  27221. Test if LogLog.Error is enabled for output.
  27222. </summary>
  27223. <value>
  27224. <c>true</c> if Error is enabled
  27225. </value>
  27226. <remarks>
  27227. <para>
  27228. Test if LogLog.Error is enabled for output.
  27229. </para>
  27230. </remarks>
  27231. </member>
  27232. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String)">
  27233. <summary>
  27234. Writes log4net internal error messages to the
  27235. standard error stream.
  27236. </summary>
  27237. <param name="source">The Type that generated this message.</param>
  27238. <param name="message">The message to log.</param>
  27239. <remarks>
  27240. <para>
  27241. All internal error messages are prepended with
  27242. the string "log4net:ERROR ".
  27243. </para>
  27244. </remarks>
  27245. </member>
  27246. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String,System.Exception)">
  27247. <summary>
  27248. Writes log4net internal error messages to the
  27249. standard error stream.
  27250. </summary>
  27251. <param name="source">The Type that generated this message.</param>
  27252. <param name="message">The message to log.</param>
  27253. <param name="exception">An exception to log.</param>
  27254. <remarks>
  27255. <para>
  27256. All internal debug messages are prepended with
  27257. the string "log4net:ERROR ".
  27258. </para>
  27259. </remarks>
  27260. </member>
  27261. <member name="M:log4net.Util.LogLog.EmitOutLine(System.String)">
  27262. <summary>
  27263. Writes output to the standard output stream.
  27264. </summary>
  27265. <param name="message">The message to log.</param>
  27266. <remarks>
  27267. <para>
  27268. Writes to both Console.Out and System.Diagnostics.Trace.
  27269. Note that the System.Diagnostics.Trace is not supported
  27270. on the Compact Framework.
  27271. </para>
  27272. <para>
  27273. If the AppDomain is not configured with a config file then
  27274. the call to System.Diagnostics.Trace may fail. This is only
  27275. an issue if you are programmatically creating your own AppDomains.
  27276. </para>
  27277. </remarks>
  27278. </member>
  27279. <member name="M:log4net.Util.LogLog.EmitErrorLine(System.String)">
  27280. <summary>
  27281. Writes output to the standard error stream.
  27282. </summary>
  27283. <param name="message">The message to log.</param>
  27284. <remarks>
  27285. <para>
  27286. Writes to both Console.Error and System.Diagnostics.Trace.
  27287. Note that the System.Diagnostics.Trace is not supported
  27288. on the Compact Framework.
  27289. </para>
  27290. <para>
  27291. If the AppDomain is not configured with a config file then
  27292. the call to System.Diagnostics.Trace may fail. This is only
  27293. an issue if you are programmatically creating your own AppDomains.
  27294. </para>
  27295. </remarks>
  27296. </member>
  27297. <member name="F:log4net.Util.LogLog.s_debugEnabled">
  27298. <summary>
  27299. Default debug level
  27300. </summary>
  27301. </member>
  27302. <member name="F:log4net.Util.LogLog.s_quietMode">
  27303. <summary>
  27304. In quietMode not even errors generate any output.
  27305. </summary>
  27306. </member>
  27307. <member name="T:log4net.Util.LogLog.LogReceivedAdapter">
  27308. <summary>
  27309. Subscribes to the LogLog.LogReceived event and stores messages
  27310. to the supplied IList instance.
  27311. </summary>
  27312. </member>
  27313. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.#ctor(System.Collections.IList)">
  27314. <summary>
  27315. </summary>
  27316. <param name="items"></param>
  27317. </member>
  27318. <member name="P:log4net.Util.LogLog.LogReceivedAdapter.Items">
  27319. <summary>
  27320. </summary>
  27321. </member>
  27322. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.Dispose">
  27323. <summary>
  27324. </summary>
  27325. </member>
  27326. <member name="T:log4net.Util.LogReceivedEventArgs">
  27327. <summary>
  27328. </summary>
  27329. </member>
  27330. <member name="M:log4net.Util.LogReceivedEventArgs.#ctor(log4net.Util.LogLog)">
  27331. <summary>
  27332. </summary>
  27333. <param name="loglog"></param>
  27334. </member>
  27335. <member name="P:log4net.Util.LogReceivedEventArgs.LogLog">
  27336. <summary>
  27337. </summary>
  27338. </member>
  27339. <member name="T:log4net.Util.NativeError">
  27340. <summary>
  27341. Represents a native error code and message.
  27342. </summary>
  27343. <remarks>
  27344. <para>
  27345. Represents a Win32 platform native error.
  27346. </para>
  27347. </remarks>
  27348. <author>Nicko Cadell</author>
  27349. <author>Gert Driesen</author>
  27350. </member>
  27351. <member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)">
  27352. <summary>
  27353. Create an instance of the <see cref="T:log4net.Util.NativeError" /> class with the specified
  27354. error number and message.
  27355. </summary>
  27356. <param name="number">The number of the native error.</param>
  27357. <param name="message">The message of the native error.</param>
  27358. <remarks>
  27359. <para>
  27360. Create an instance of the <see cref="T:log4net.Util.NativeError" /> class with the specified
  27361. error number and message.
  27362. </para>
  27363. </remarks>
  27364. </member>
  27365. <member name="P:log4net.Util.NativeError.Number">
  27366. <summary>
  27367. Gets the number of the native error.
  27368. </summary>
  27369. <value>
  27370. The number of the native error.
  27371. </value>
  27372. <remarks>
  27373. <para>
  27374. Gets the number of the native error.
  27375. </para>
  27376. </remarks>
  27377. </member>
  27378. <member name="P:log4net.Util.NativeError.Message">
  27379. <summary>
  27380. Gets the message of the native error.
  27381. </summary>
  27382. <value>
  27383. The message of the native error.
  27384. </value>
  27385. <remarks>
  27386. <para>
  27387. </para>
  27388. Gets the message of the native error.
  27389. </remarks>
  27390. </member>
  27391. <member name="M:log4net.Util.NativeError.GetLastError">
  27392. <summary>
  27393. Create a new instance of the <see cref="T:log4net.Util.NativeError" /> class for the last Windows error.
  27394. </summary>
  27395. <returns>
  27396. An instance of the <see cref="T:log4net.Util.NativeError" /> class for the last windows error.
  27397. </returns>
  27398. <remarks>
  27399. <para>
  27400. The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the
  27401. native Win32 <c>FormatMessage</c> function.
  27402. </para>
  27403. </remarks>
  27404. </member>
  27405. <member name="M:log4net.Util.NativeError.GetError(System.Int32)">
  27406. <summary>
  27407. Create a new instance of the <see cref="T:log4net.Util.NativeError" /> class.
  27408. </summary>
  27409. <param name="number">the error number for the native error</param>
  27410. <returns>
  27411. An instance of the <see cref="T:log4net.Util.NativeError" /> class for the specified
  27412. error number.
  27413. </returns>
  27414. <remarks>
  27415. <para>
  27416. The message for the specified error number is lookup up using the
  27417. native Win32 <c>FormatMessage</c> function.
  27418. </para>
  27419. </remarks>
  27420. </member>
  27421. <member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)">
  27422. <summary>
  27423. Retrieves the message corresponding with a Win32 message identifier.
  27424. </summary>
  27425. <param name="messageId">Message identifier for the requested message.</param>
  27426. <returns>
  27427. The message corresponding with the specified message identifier.
  27428. </returns>
  27429. <remarks>
  27430. <para>
  27431. The message will be searched for in system message-table resource(s)
  27432. using the native <c>FormatMessage</c> function.
  27433. </para>
  27434. </remarks>
  27435. </member>
  27436. <member name="M:log4net.Util.NativeError.ToString">
  27437. <summary>
  27438. Return error information string
  27439. </summary>
  27440. <returns>error information string</returns>
  27441. <remarks>
  27442. <para>
  27443. Return error information string
  27444. </para>
  27445. </remarks>
  27446. </member>
  27447. <member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)">
  27448. <summary>
  27449. Formats a message string.
  27450. </summary>
  27451. <param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource" /> parameter.</param>
  27452. <param name="lpSource">Location of the message definition.</param>
  27453. <param name="dwMessageId">Message identifier for the requested message.</param>
  27454. <param name="dwLanguageId">Language identifier for the requested message.</param>
  27455. <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>
  27456. <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>
  27457. <param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param>
  27458. <remarks>
  27459. <para>
  27460. The function requires a message definition as input. The message definition can come from a
  27461. buffer passed into the function. It can come from a message table resource in an
  27462. already-loaded module. Or the caller can ask the function to search the system's message
  27463. table resource(s) for the message definition. The function finds the message definition
  27464. in a message table resource based on a message identifier and a language identifier.
  27465. The function copies the formatted message text to an output buffer, processing any embedded
  27466. insert sequences if requested.
  27467. </para>
  27468. <para>
  27469. To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message.
  27470. </para>
  27471. </remarks>
  27472. <returns>
  27473. <para>
  27474. If the function succeeds, the return value is the number of TCHARs stored in the output
  27475. buffer, excluding the terminating null character.
  27476. </para>
  27477. <para>
  27478. If the function fails, the return value is zero. To get extended error information,
  27479. call <see cref="M:Marshal.GetLastWin32Error()" />.
  27480. </para>
  27481. </returns>
  27482. </member>
  27483. <member name="T:log4net.Util.NullDictionaryEnumerator">
  27484. <summary>
  27485. An always empty <see cref="T:System.Collections.IDictionaryEnumerator"/>.
  27486. </summary>
  27487. <remarks>
  27488. <para>
  27489. A singleton implementation of the <see cref="T:System.Collections.IDictionaryEnumerator"/> over a collection
  27490. that is empty and not modifiable.
  27491. </para>
  27492. </remarks>
  27493. <author>Nicko Cadell</author>
  27494. <author>Gert Driesen</author>
  27495. </member>
  27496. <member name="M:log4net.Util.NullDictionaryEnumerator.#ctor">
  27497. <summary>
  27498. Initializes a new instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" /> class.
  27499. </summary>
  27500. <remarks>
  27501. <para>
  27502. Uses a private access modifier to enforce the singleton pattern.
  27503. </para>
  27504. </remarks>
  27505. </member>
  27506. <member name="P:log4net.Util.NullDictionaryEnumerator.Instance">
  27507. <summary>
  27508. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  27509. </summary>
  27510. <returns>The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.</returns>
  27511. <remarks>
  27512. <para>
  27513. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  27514. </para>
  27515. </remarks>
  27516. </member>
  27517. <member name="P:log4net.Util.NullDictionaryEnumerator.Current">
  27518. <summary>
  27519. Gets the current object from the enumerator.
  27520. </summary>
  27521. <remarks>
  27522. Throws an <see cref="T:System.InvalidOperationException" /> because the
  27523. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  27524. </remarks>
  27525. <remarks>
  27526. <para>
  27527. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27528. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27529. will throw an <see cref="T:System.InvalidOperationException"/>.
  27530. </para>
  27531. </remarks>
  27532. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27533. cannot be positioned over a valid location.</exception>
  27534. </member>
  27535. <member name="M:log4net.Util.NullDictionaryEnumerator.MoveNext">
  27536. <summary>
  27537. Test if the enumerator can advance, if so advance.
  27538. </summary>
  27539. <returns><c>false</c> as the <see cref="T:log4net.Util.NullDictionaryEnumerator" /> cannot advance.</returns>
  27540. <remarks>
  27541. <para>
  27542. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27543. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullDictionaryEnumerator.MoveNext"/>
  27544. will always return <c>false</c>.
  27545. </para>
  27546. </remarks>
  27547. </member>
  27548. <member name="M:log4net.Util.NullDictionaryEnumerator.Reset">
  27549. <summary>
  27550. Resets the enumerator back to the start.
  27551. </summary>
  27552. <remarks>
  27553. <para>
  27554. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullDictionaryEnumerator.Reset"/> does nothing.
  27555. </para>
  27556. </remarks>
  27557. </member>
  27558. <member name="P:log4net.Util.NullDictionaryEnumerator.Key">
  27559. <summary>
  27560. Gets the current key from the enumerator.
  27561. </summary>
  27562. <remarks>
  27563. Throws an exception because the <see cref="T:log4net.Util.NullDictionaryEnumerator" />
  27564. never has a current value.
  27565. </remarks>
  27566. <remarks>
  27567. <para>
  27568. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27569. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Key"/>
  27570. will throw an <see cref="T:System.InvalidOperationException"/>.
  27571. </para>
  27572. </remarks>
  27573. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27574. cannot be positioned over a valid location.</exception>
  27575. </member>
  27576. <member name="P:log4net.Util.NullDictionaryEnumerator.Value">
  27577. <summary>
  27578. Gets the current value from the enumerator.
  27579. </summary>
  27580. <value>The current value from the enumerator.</value>
  27581. <remarks>
  27582. Throws an <see cref="T:System.InvalidOperationException" /> because the
  27583. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  27584. </remarks>
  27585. <remarks>
  27586. <para>
  27587. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27588. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Value"/>
  27589. will throw an <see cref="T:System.InvalidOperationException"/>.
  27590. </para>
  27591. </remarks>
  27592. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27593. cannot be positioned over a valid location.</exception>
  27594. </member>
  27595. <member name="P:log4net.Util.NullDictionaryEnumerator.Entry">
  27596. <summary>
  27597. Gets the current entry from the enumerator.
  27598. </summary>
  27599. <remarks>
  27600. Throws an <see cref="T:System.InvalidOperationException" /> because the
  27601. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current entry.
  27602. </remarks>
  27603. <remarks>
  27604. <para>
  27605. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27606. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Entry"/>
  27607. will throw an <see cref="T:System.InvalidOperationException"/>.
  27608. </para>
  27609. </remarks>
  27610. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  27611. cannot be positioned over a valid location.</exception>
  27612. </member>
  27613. <member name="F:log4net.Util.NullDictionaryEnumerator.s_instance">
  27614. <summary>
  27615. The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  27616. </summary>
  27617. </member>
  27618. <member name="T:log4net.Util.NullEnumerator">
  27619. <summary>
  27620. An always empty <see cref="T:System.Collections.IEnumerator"/>.
  27621. </summary>
  27622. <remarks>
  27623. <para>
  27624. A singleton implementation of the <see cref="T:System.Collections.IEnumerator"/> over a collection
  27625. that is empty and not modifiable.
  27626. </para>
  27627. </remarks>
  27628. <author>Nicko Cadell</author>
  27629. <author>Gert Driesen</author>
  27630. </member>
  27631. <member name="M:log4net.Util.NullEnumerator.#ctor">
  27632. <summary>
  27633. Initializes a new instance of the <see cref="T:log4net.Util.NullEnumerator" /> class.
  27634. </summary>
  27635. <remarks>
  27636. <para>
  27637. Uses a private access modifier to enforce the singleton pattern.
  27638. </para>
  27639. </remarks>
  27640. </member>
  27641. <member name="P:log4net.Util.NullEnumerator.Instance">
  27642. <summary>
  27643. Get the singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  27644. </summary>
  27645. <returns>The singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.</returns>
  27646. <remarks>
  27647. <para>
  27648. Gets the singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  27649. </para>
  27650. </remarks>
  27651. </member>
  27652. <member name="P:log4net.Util.NullEnumerator.Current">
  27653. <summary>
  27654. Gets the current object from the enumerator.
  27655. </summary>
  27656. <remarks>
  27657. Throws an <see cref="T:System.InvalidOperationException" /> because the
  27658. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  27659. </remarks>
  27660. <remarks>
  27661. <para>
  27662. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  27663. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullEnumerator.Current"/>
  27664. will throw an <see cref="T:System.InvalidOperationException"/>.
  27665. </para>
  27666. </remarks>
  27667. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullEnumerator.Current"/>
  27668. cannot be positioned over a valid location.</exception>
  27669. </member>
  27670. <member name="M:log4net.Util.NullEnumerator.MoveNext">
  27671. <summary>
  27672. Test if the enumerator can advance, if so advance
  27673. </summary>
  27674. <returns><c>false</c> as the <see cref="T:log4net.Util.NullEnumerator" /> cannot advance.</returns>
  27675. <remarks>
  27676. <para>
  27677. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  27678. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullEnumerator.MoveNext"/>
  27679. will always return <c>false</c>.
  27680. </para>
  27681. </remarks>
  27682. </member>
  27683. <member name="M:log4net.Util.NullEnumerator.Reset">
  27684. <summary>
  27685. Resets the enumerator back to the start.
  27686. </summary>
  27687. <remarks>
  27688. <para>
  27689. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullEnumerator.Reset"/> does nothing.
  27690. </para>
  27691. </remarks>
  27692. </member>
  27693. <member name="F:log4net.Util.NullEnumerator.s_instance">
  27694. <summary>
  27695. The singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  27696. </summary>
  27697. </member>
  27698. <member name="T:log4net.Util.NullSecurityContext">
  27699. <summary>
  27700. A SecurityContext used when a SecurityContext is not required
  27701. </summary>
  27702. <remarks>
  27703. <para>
  27704. The <see cref="T:log4net.Util.NullSecurityContext"/> is a no-op implementation of the
  27705. <see cref="T:log4net.Core.SecurityContext"/> base class. It is used where a <see cref="T:log4net.Core.SecurityContext"/>
  27706. is required but one has not been provided.
  27707. </para>
  27708. </remarks>
  27709. <author>Nicko Cadell</author>
  27710. </member>
  27711. <member name="F:log4net.Util.NullSecurityContext.Instance">
  27712. <summary>
  27713. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  27714. </summary>
  27715. <remarks>
  27716. <para>
  27717. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  27718. </para>
  27719. </remarks>
  27720. </member>
  27721. <member name="M:log4net.Util.NullSecurityContext.#ctor">
  27722. <summary>
  27723. Private constructor
  27724. </summary>
  27725. <remarks>
  27726. <para>
  27727. Private constructor for singleton pattern.
  27728. </para>
  27729. </remarks>
  27730. </member>
  27731. <member name="M:log4net.Util.NullSecurityContext.Impersonate(System.Object)">
  27732. <summary>
  27733. Impersonate this SecurityContext
  27734. </summary>
  27735. <param name="state">State supplied by the caller</param>
  27736. <returns><c>null</c></returns>
  27737. <remarks>
  27738. <para>
  27739. No impersonation is done and <c>null</c> is always returned.
  27740. </para>
  27741. </remarks>
  27742. </member>
  27743. <member name="T:log4net.Util.OnlyOnceErrorHandler">
  27744. <summary>
  27745. Implements log4net's default error handling policy which consists
  27746. of emitting a message for the first error in an appender and
  27747. ignoring all subsequent errors.
  27748. </summary>
  27749. <remarks>
  27750. <para>
  27751. The error message is processed using the LogLog sub-system by default.
  27752. </para>
  27753. <para>
  27754. This policy aims at protecting an otherwise working application
  27755. from being flooded with error messages when logging fails.
  27756. </para>
  27757. </remarks>
  27758. <author>Nicko Cadell</author>
  27759. <author>Gert Driesen</author>
  27760. <author>Ron Grabowski</author>
  27761. </member>
  27762. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor">
  27763. <summary>
  27764. Default Constructor
  27765. </summary>
  27766. <remarks>
  27767. <para>
  27768. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler" /> class.
  27769. </para>
  27770. </remarks>
  27771. </member>
  27772. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor(System.String)">
  27773. <summary>
  27774. Constructor
  27775. </summary>
  27776. <param name="prefix">The prefix to use for each message.</param>
  27777. <remarks>
  27778. <para>
  27779. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler" /> class
  27780. with the specified prefix.
  27781. </para>
  27782. </remarks>
  27783. </member>
  27784. <member name="M:log4net.Util.OnlyOnceErrorHandler.Reset">
  27785. <summary>
  27786. Reset the error handler back to its initial disabled state.
  27787. </summary>
  27788. </member>
  27789. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  27790. <summary>
  27791. Log an Error
  27792. </summary>
  27793. <param name="message">The error message.</param>
  27794. <param name="e">The exception.</param>
  27795. <param name="errorCode">The internal error code.</param>
  27796. <remarks>
  27797. <para>
  27798. 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.
  27799. </para>
  27800. </remarks>
  27801. </member>
  27802. <member name="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)">
  27803. <summary>
  27804. Log the very first error
  27805. </summary>
  27806. <param name="message">The error message.</param>
  27807. <param name="e">The exception.</param>
  27808. <param name="errorCode">The internal error code.</param>
  27809. <remarks>
  27810. <para>
  27811. Sends the error information to <see cref="T:log4net.Util.LogLog"/>'s Error method.
  27812. </para>
  27813. </remarks>
  27814. </member>
  27815. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception)">
  27816. <summary>
  27817. Log an Error
  27818. </summary>
  27819. <param name="message">The error message.</param>
  27820. <param name="e">The exception.</param>
  27821. <remarks>
  27822. <para>
  27823. 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.
  27824. </para>
  27825. </remarks>
  27826. </member>
  27827. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String)">
  27828. <summary>
  27829. Log an error
  27830. </summary>
  27831. <param name="message">The error message.</param>
  27832. <remarks>
  27833. <para>
  27834. 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.
  27835. </para>
  27836. </remarks>
  27837. </member>
  27838. <member name="P:log4net.Util.OnlyOnceErrorHandler.IsEnabled">
  27839. <summary>
  27840. Is error logging enabled
  27841. </summary>
  27842. <remarks>
  27843. <para>
  27844. Is error logging enabled. Logging is only enabled for the
  27845. first error delivered to the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/>.
  27846. </para>
  27847. </remarks>
  27848. </member>
  27849. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDate">
  27850. <summary>
  27851. The date the first error that trigged this error handler occurred, or <see cref="F:System.DateTime.MinValue"/> if it has not been triggered.
  27852. </summary>
  27853. </member>
  27854. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDateUtc">
  27855. <summary>
  27856. 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.
  27857. </summary>
  27858. </member>
  27859. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorMessage">
  27860. <summary>
  27861. The message from the first error that trigged this error handler.
  27862. </summary>
  27863. </member>
  27864. <member name="P:log4net.Util.OnlyOnceErrorHandler.Exception">
  27865. <summary>
  27866. The exception from the first error that trigged this error handler.
  27867. </summary>
  27868. <remarks>
  27869. May be <see langword="null" />.
  27870. </remarks>
  27871. </member>
  27872. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorCode">
  27873. <summary>
  27874. The error code from the first error that trigged this error handler.
  27875. </summary>
  27876. <remarks>
  27877. Defaults to <see cref="F:log4net.Core.ErrorCode.GenericFailure"/>
  27878. </remarks>
  27879. </member>
  27880. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_enabledDateUtc">
  27881. <summary>
  27882. The UTC date the error was recorded.
  27883. </summary>
  27884. </member>
  27885. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_firstTime">
  27886. <summary>
  27887. Flag to indicate if it is the first error
  27888. </summary>
  27889. </member>
  27890. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_message">
  27891. <summary>
  27892. The message recorded during the first error.
  27893. </summary>
  27894. </member>
  27895. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_exception">
  27896. <summary>
  27897. The exception recorded during the first error.
  27898. </summary>
  27899. </member>
  27900. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_errorCode">
  27901. <summary>
  27902. The error code recorded during the first error.
  27903. </summary>
  27904. </member>
  27905. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_prefix">
  27906. <summary>
  27907. String to prefix each message with
  27908. </summary>
  27909. </member>
  27910. <member name="F:log4net.Util.OnlyOnceErrorHandler.declaringType">
  27911. <summary>
  27912. The fully qualified type of the OnlyOnceErrorHandler class.
  27913. </summary>
  27914. <remarks>
  27915. Used by the internal logger to record the Type of the
  27916. log message.
  27917. </remarks>
  27918. </member>
  27919. <member name="T:log4net.Util.OptionConverter">
  27920. <summary>
  27921. A convenience class to convert property values to specific types.
  27922. </summary>
  27923. <remarks>
  27924. <para>
  27925. Utility functions for converting types and parsing values.
  27926. </para>
  27927. </remarks>
  27928. <author>Nicko Cadell</author>
  27929. <author>Gert Driesen</author>
  27930. </member>
  27931. <member name="M:log4net.Util.OptionConverter.#ctor">
  27932. <summary>
  27933. Initializes a new instance of the <see cref="T:log4net.Util.OptionConverter" /> class.
  27934. </summary>
  27935. <remarks>
  27936. <para>
  27937. Uses a private access modifier to prevent instantiation of this class.
  27938. </para>
  27939. </remarks>
  27940. </member>
  27941. <member name="M:log4net.Util.OptionConverter.ToBoolean(System.String,System.Boolean)">
  27942. <summary>
  27943. Converts a string to a <see cref="T:System.Boolean" /> value.
  27944. </summary>
  27945. <param name="argValue">String to convert.</param>
  27946. <param name="defaultValue">The default value.</param>
  27947. <returns>The <see cref="T:System.Boolean" /> value of <paramref name="argValue" />.</returns>
  27948. <remarks>
  27949. <para>
  27950. If <paramref name="argValue"/> is "true", then <c>true</c> is returned.
  27951. If <paramref name="argValue"/> is "false", then <c>false</c> is returned.
  27952. Otherwise, <paramref name="defaultValue"/> is returned.
  27953. </para>
  27954. </remarks>
  27955. </member>
  27956. <member name="M:log4net.Util.OptionConverter.ToFileSize(System.String,System.Int64)">
  27957. <summary>
  27958. Parses a file size into a number.
  27959. </summary>
  27960. <param name="argValue">String to parse.</param>
  27961. <param name="defaultValue">The default value.</param>
  27962. <returns>The <see cref="T:System.Int64" /> value of <paramref name="argValue" />.</returns>
  27963. <remarks>
  27964. <para>
  27965. Parses a file size of the form: number[KB|MB|GB] into a
  27966. long value. It is scaled with the appropriate multiplier.
  27967. </para>
  27968. <para>
  27969. <paramref name="defaultValue"/> is returned when <paramref name="argValue"/>
  27970. cannot be converted to a <see cref="T:System.Int64" /> value.
  27971. </para>
  27972. </remarks>
  27973. </member>
  27974. <member name="M:log4net.Util.OptionConverter.ConvertStringTo(System.Type,System.String)">
  27975. <summary>
  27976. Converts a string to an object.
  27977. </summary>
  27978. <param name="target">The target type to convert to.</param>
  27979. <param name="txt">The string to convert to an object.</param>
  27980. <returns>
  27981. The object converted from a string or <c>null</c> when the
  27982. conversion failed.
  27983. </returns>
  27984. <remarks>
  27985. <para>
  27986. Converts a string to an object. Uses the converter registry to try
  27987. to convert the string value into the specified target type.
  27988. </para>
  27989. </remarks>
  27990. </member>
  27991. <member name="M:log4net.Util.OptionConverter.CanConvertTypeTo(System.Type,System.Type)">
  27992. <summary>
  27993. Checks if there is an appropriate type conversion from the source type to the target type.
  27994. </summary>
  27995. <param name="sourceType">The type to convert from.</param>
  27996. <param name="targetType">The type to convert to.</param>
  27997. <returns><c>true</c> if there is a conversion from the source type to the target type.</returns>
  27998. <remarks>
  27999. Checks if there is an appropriate type conversion from the source type to the target type.
  28000. <para>
  28001. </para>
  28002. </remarks>
  28003. </member>
  28004. <member name="M:log4net.Util.OptionConverter.ConvertTypeTo(System.Object,System.Type)">
  28005. <summary>
  28006. Converts an object to the target type.
  28007. </summary>
  28008. <param name="sourceInstance">The object to convert to the target type.</param>
  28009. <param name="targetType">The type to convert to.</param>
  28010. <returns>The converted object.</returns>
  28011. <remarks>
  28012. <para>
  28013. Converts an object to the target type.
  28014. </para>
  28015. </remarks>
  28016. </member>
  28017. <member name="M:log4net.Util.OptionConverter.InstantiateByClassName(System.String,System.Type,System.Object)">
  28018. <summary>
  28019. Instantiates an object given a class name.
  28020. </summary>
  28021. <param name="className">The fully qualified class name of the object to instantiate.</param>
  28022. <param name="superClass">The class to which the new object should belong.</param>
  28023. <param name="defaultValue">The object to return in case of non-fulfillment.</param>
  28024. <returns>
  28025. An instance of the <paramref name="className"/> or <paramref name="defaultValue"/>
  28026. if the object could not be instantiated.
  28027. </returns>
  28028. <remarks>
  28029. <para>
  28030. Checks that the <paramref name="className"/> is a subclass of
  28031. <paramref name="superClass"/>. If that test fails or the object could
  28032. not be instantiated, then <paramref name="defaultValue"/> is returned.
  28033. </para>
  28034. </remarks>
  28035. </member>
  28036. <member name="M:log4net.Util.OptionConverter.SubstituteVariables(System.String,System.Collections.IDictionary)">
  28037. <summary>
  28038. Performs variable substitution in string <paramref name="value"/> from the
  28039. values of keys found in <paramref name="props"/>.
  28040. </summary>
  28041. <param name="value">The string on which variable substitution is performed.</param>
  28042. <param name="props">The dictionary to use to lookup variables.</param>
  28043. <returns>The result of the substitutions.</returns>
  28044. <remarks>
  28045. <para>
  28046. The variable substitution delimiters are <b>${</b> and <b>}</b>.
  28047. </para>
  28048. <para>
  28049. For example, if props contains <c>key=value</c>, then the call
  28050. </para>
  28051. <para>
  28052. <code lang="C#">
  28053. string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
  28054. </code>
  28055. </para>
  28056. <para>
  28057. will set the variable <c>s</c> to "Value of key is value.".
  28058. </para>
  28059. <para>
  28060. If no value could be found for the specified key, then substitution
  28061. defaults to an empty string.
  28062. </para>
  28063. <para>
  28064. For example, if system properties contains no value for the key
  28065. "nonExistentKey", then the call
  28066. </para>
  28067. <para>
  28068. <code lang="C#">
  28069. string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
  28070. </code>
  28071. </para>
  28072. <para>
  28073. will set <s>s</s> to "Value of nonExistentKey is []".
  28074. </para>
  28075. <para>
  28076. An Exception is thrown if <paramref name="value"/> contains a start
  28077. delimiter "${" which is not balanced by a stop delimiter "}".
  28078. </para>
  28079. </remarks>
  28080. </member>
  28081. <member name="M:log4net.Util.OptionConverter.ParseEnum(System.Type,System.String,System.Boolean)">
  28082. <summary>
  28083. Converts the string representation of the name or numeric value of one or
  28084. more enumerated constants to an equivalent enumerated object.
  28085. </summary>
  28086. <param name="enumType">The type to convert to.</param>
  28087. <param name="value">The enum string value.</param>
  28088. <param name="ignoreCase">If <c>true</c>, ignore case; otherwise, regard case.</param>
  28089. <returns>An object of type <paramref name="enumType" /> whose value is represented by <paramref name="value" />.</returns>
  28090. </member>
  28091. <member name="F:log4net.Util.OptionConverter.declaringType">
  28092. <summary>
  28093. The fully qualified type of the OptionConverter class.
  28094. </summary>
  28095. <remarks>
  28096. Used by the internal logger to record the Type of the
  28097. log message.
  28098. </remarks>
  28099. </member>
  28100. <member name="T:log4net.Util.PatternConverter">
  28101. <summary>
  28102. Abstract class that provides the formatting functionality that
  28103. derived classes need.
  28104. </summary>
  28105. <remarks>
  28106. <para>
  28107. Conversion specifiers in a conversion patterns are parsed to
  28108. individual PatternConverters. Each of which is responsible for
  28109. converting a logging event in a converter specific manner.
  28110. </para>
  28111. </remarks>
  28112. <author>Nicko Cadell</author>
  28113. <author>Gert Driesen</author>
  28114. </member>
  28115. <member name="M:log4net.Util.PatternConverter.#ctor">
  28116. <summary>
  28117. Protected constructor
  28118. </summary>
  28119. <remarks>
  28120. <para>
  28121. Initializes a new instance of the <see cref="T:log4net.Util.PatternConverter" /> class.
  28122. </para>
  28123. </remarks>
  28124. </member>
  28125. <member name="P:log4net.Util.PatternConverter.Next">
  28126. <summary>
  28127. Get the next pattern converter in the chain
  28128. </summary>
  28129. <value>
  28130. the next pattern converter in the chain
  28131. </value>
  28132. <remarks>
  28133. <para>
  28134. Get the next pattern converter in the chain
  28135. </para>
  28136. </remarks>
  28137. </member>
  28138. <member name="P:log4net.Util.PatternConverter.FormattingInfo">
  28139. <summary>
  28140. Gets or sets the formatting info for this converter
  28141. </summary>
  28142. <value>
  28143. The formatting info for this converter
  28144. </value>
  28145. <remarks>
  28146. <para>
  28147. Gets or sets the formatting info for this converter
  28148. </para>
  28149. </remarks>
  28150. </member>
  28151. <member name="P:log4net.Util.PatternConverter.Option">
  28152. <summary>
  28153. Gets or sets the option value for this converter
  28154. </summary>
  28155. <summary>
  28156. The option for this converter
  28157. </summary>
  28158. <remarks>
  28159. <para>
  28160. Gets or sets the option value for this converter
  28161. </para>
  28162. </remarks>
  28163. </member>
  28164. <member name="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)">
  28165. <summary>
  28166. Evaluate this pattern converter and write the output to a writer.
  28167. </summary>
  28168. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  28169. <param name="state">The state object on which the pattern converter should be executed.</param>
  28170. <remarks>
  28171. <para>
  28172. Derived pattern converters must override this method in order to
  28173. convert conversion specifiers in the appropriate way.
  28174. </para>
  28175. </remarks>
  28176. </member>
  28177. <member name="M:log4net.Util.PatternConverter.SetNext(log4net.Util.PatternConverter)">
  28178. <summary>
  28179. Set the next pattern converter in the chains
  28180. </summary>
  28181. <param name="patternConverter">the pattern converter that should follow this converter in the chain</param>
  28182. <returns>the next converter</returns>
  28183. <remarks>
  28184. <para>
  28185. The PatternConverter can merge with its neighbor during this method (or a sub class).
  28186. Therefore the return value may or may not be the value of the argument passed in.
  28187. </para>
  28188. </remarks>
  28189. </member>
  28190. <member name="M:log4net.Util.PatternConverter.Format(System.IO.TextWriter,System.Object)">
  28191. <summary>
  28192. Write the pattern converter to the writer with appropriate formatting
  28193. </summary>
  28194. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  28195. <param name="state">The state object on which the pattern converter should be executed.</param>
  28196. <remarks>
  28197. <para>
  28198. This method calls <see cref="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"/> to allow the subclass to perform
  28199. appropriate conversion of the pattern converter. If formatting options have
  28200. been specified via the <see cref="P:log4net.Util.PatternConverter.FormattingInfo"/> then this method will
  28201. apply those formattings before writing the output.
  28202. </para>
  28203. </remarks>
  28204. </member>
  28205. <member name="M:log4net.Util.PatternConverter.SpacePad(System.IO.TextWriter,System.Int32)">
  28206. <summary>
  28207. Fast space padding method.
  28208. </summary>
  28209. <param name="writer"><see cref="T:System.IO.TextWriter" /> to which the spaces will be appended.</param>
  28210. <param name="length">The number of spaces to be padded.</param>
  28211. <remarks>
  28212. <para>
  28213. Fast space padding method.
  28214. </para>
  28215. </remarks>
  28216. </member>
  28217. <member name="F:log4net.Util.PatternConverter.m_option">
  28218. <summary>
  28219. The option string to the converter
  28220. </summary>
  28221. </member>
  28222. <member name="F:log4net.Util.PatternConverter.c_renderBufferSize">
  28223. <summary>
  28224. Initial buffer size
  28225. </summary>
  28226. </member>
  28227. <member name="F:log4net.Util.PatternConverter.c_renderBufferMaxCapacity">
  28228. <summary>
  28229. Maximum buffer size before it is recycled
  28230. </summary>
  28231. </member>
  28232. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionary)">
  28233. <summary>
  28234. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  28235. </summary>
  28236. <param name="writer">the writer to write to</param>
  28237. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  28238. <param name="value">the value to write to the writer</param>
  28239. <remarks>
  28240. <para>
  28241. Writes the <see cref="T:System.Collections.IDictionary"/> to a writer in the form:
  28242. </para>
  28243. <code>
  28244. {key1=value1, key2=value2, key3=value3}
  28245. </code>
  28246. <para>
  28247. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  28248. is not null then it is used to render the key and value to text, otherwise
  28249. the object's ToString method is called.
  28250. </para>
  28251. </remarks>
  28252. </member>
  28253. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionaryEnumerator)">
  28254. <summary>
  28255. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  28256. </summary>
  28257. <param name="writer">the writer to write to</param>
  28258. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  28259. <param name="value">the value to write to the writer</param>
  28260. <remarks>
  28261. <para>
  28262. Writes the <see cref="T:System.Collections.IDictionaryEnumerator"/> to a writer in the form:
  28263. </para>
  28264. <code>
  28265. {key1=value1, key2=value2, key3=value3}
  28266. </code>
  28267. <para>
  28268. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  28269. is not null then it is used to render the key and value to text, otherwise
  28270. the object's ToString method is called.
  28271. </para>
  28272. </remarks>
  28273. </member>
  28274. <member name="M:log4net.Util.PatternConverter.WriteObject(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Object)">
  28275. <summary>
  28276. Write an object to a <see cref="T:System.IO.TextWriter"/>
  28277. </summary>
  28278. <param name="writer">the writer to write to</param>
  28279. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  28280. <param name="value">the value to write to the writer</param>
  28281. <remarks>
  28282. <para>
  28283. Writes the Object to a writer. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  28284. is not null then it is used to render the object to text, otherwise
  28285. the object's ToString method is called.
  28286. </para>
  28287. </remarks>
  28288. </member>
  28289. <member name="P:log4net.Util.PatternConverter.Properties">
  28290. <summary>
  28291. </summary>
  28292. </member>
  28293. <member name="T:log4net.Util.PatternParser">
  28294. <summary>
  28295. Most of the work of the <see cref="T:log4net.Layout.PatternLayout"/> class
  28296. is delegated to the PatternParser class.
  28297. </summary>
  28298. <remarks>
  28299. <para>
  28300. The <c>PatternParser</c> processes a pattern string and
  28301. returns a chain of <see cref="T:log4net.Util.PatternConverter"/> objects.
  28302. </para>
  28303. </remarks>
  28304. <author>Nicko Cadell</author>
  28305. <author>Gert Driesen</author>
  28306. </member>
  28307. <member name="M:log4net.Util.PatternParser.#ctor(System.String)">
  28308. <summary>
  28309. Constructor
  28310. </summary>
  28311. <param name="pattern">The pattern to parse.</param>
  28312. <remarks>
  28313. <para>
  28314. Initializes a new instance of the <see cref="T:log4net.Util.PatternParser" /> class
  28315. with the specified pattern string.
  28316. </para>
  28317. </remarks>
  28318. </member>
  28319. <member name="M:log4net.Util.PatternParser.Parse">
  28320. <summary>
  28321. Parses the pattern into a chain of pattern converters.
  28322. </summary>
  28323. <returns>The head of a chain of pattern converters.</returns>
  28324. <remarks>
  28325. <para>
  28326. Parses the pattern into a chain of pattern converters.
  28327. </para>
  28328. </remarks>
  28329. </member>
  28330. <member name="P:log4net.Util.PatternParser.PatternConverters">
  28331. <summary>
  28332. Get the converter registry used by this parser
  28333. </summary>
  28334. <value>
  28335. The converter registry used by this parser
  28336. </value>
  28337. <remarks>
  28338. <para>
  28339. Get the converter registry used by this parser
  28340. </para>
  28341. </remarks>
  28342. </member>
  28343. <member name="M:log4net.Util.PatternParser.BuildCache">
  28344. <summary>
  28345. Build the unified cache of converters from the static and instance maps
  28346. </summary>
  28347. <returns>the list of all the converter names</returns>
  28348. <remarks>
  28349. <para>
  28350. Build the unified cache of converters from the static and instance maps
  28351. </para>
  28352. </remarks>
  28353. </member>
  28354. <member name="T:log4net.Util.PatternParser.StringLengthComparer">
  28355. <summary>
  28356. Sort strings by length
  28357. </summary>
  28358. <remarks>
  28359. <para>
  28360. <see cref="T:System.Collections.IComparer" /> that orders strings by string length.
  28361. The longest strings are placed first
  28362. </para>
  28363. </remarks>
  28364. </member>
  28365. <member name="M:log4net.Util.PatternParser.ParseInternal(System.String,System.String[])">
  28366. <summary>
  28367. Internal method to parse the specified pattern to find specified matches
  28368. </summary>
  28369. <param name="pattern">the pattern to parse</param>
  28370. <param name="matches">the converter names to match in the pattern</param>
  28371. <remarks>
  28372. <para>
  28373. The matches param must be sorted such that longer strings come before shorter ones.
  28374. </para>
  28375. </remarks>
  28376. </member>
  28377. <member name="M:log4net.Util.PatternParser.ProcessLiteral(System.String)">
  28378. <summary>
  28379. Process a parsed literal
  28380. </summary>
  28381. <param name="text">the literal text</param>
  28382. </member>
  28383. <member name="M:log4net.Util.PatternParser.ProcessConverter(System.String,System.String,log4net.Util.FormattingInfo)">
  28384. <summary>
  28385. Process a parsed converter pattern
  28386. </summary>
  28387. <param name="converterName">the name of the converter</param>
  28388. <param name="option">the optional option for the converter</param>
  28389. <param name="formattingInfo">the formatting info for the converter</param>
  28390. </member>
  28391. <member name="M:log4net.Util.PatternParser.AddConverter(log4net.Util.PatternConverter)">
  28392. <summary>
  28393. Resets the internal state of the parser and adds the specified pattern converter
  28394. to the chain.
  28395. </summary>
  28396. <param name="pc">The pattern converter to add.</param>
  28397. </member>
  28398. <member name="F:log4net.Util.PatternParser.m_head">
  28399. <summary>
  28400. The first pattern converter in the chain
  28401. </summary>
  28402. </member>
  28403. <member name="F:log4net.Util.PatternParser.m_tail">
  28404. <summary>
  28405. the last pattern converter in the chain
  28406. </summary>
  28407. </member>
  28408. <member name="F:log4net.Util.PatternParser.m_pattern">
  28409. <summary>
  28410. The pattern
  28411. </summary>
  28412. </member>
  28413. <member name="F:log4net.Util.PatternParser.m_patternConverters">
  28414. <summary>
  28415. Internal map of converter identifiers to converter types
  28416. </summary>
  28417. <remarks>
  28418. <para>
  28419. This map overrides the static s_globalRulesRegistry map.
  28420. </para>
  28421. </remarks>
  28422. </member>
  28423. <member name="F:log4net.Util.PatternParser.declaringType">
  28424. <summary>
  28425. The fully qualified type of the PatternParser class.
  28426. </summary>
  28427. <remarks>
  28428. Used by the internal logger to record the Type of the
  28429. log message.
  28430. </remarks>
  28431. </member>
  28432. <member name="T:log4net.Util.PatternString">
  28433. <summary>
  28434. This class implements a patterned string.
  28435. </summary>
  28436. <remarks>
  28437. <para>
  28438. This string has embedded patterns that are resolved and expanded
  28439. when the string is formatted.
  28440. </para>
  28441. <para>
  28442. This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/>
  28443. in that it accepts a pattern and renders it to a string. Unlike the
  28444. <see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c>
  28445. does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
  28446. of the process in general.
  28447. </para>
  28448. <para>
  28449. The recognized conversion pattern names are:
  28450. </para>
  28451. <list type="table">
  28452. <listheader>
  28453. <term>Conversion Pattern Name</term>
  28454. <description>Effect</description>
  28455. </listheader>
  28456. <item>
  28457. <term>appdomain</term>
  28458. <description>
  28459. <para>
  28460. Used to output the friendly name of the current AppDomain.
  28461. </para>
  28462. </description>
  28463. </item>
  28464. <item>
  28465. <term>appsetting</term>
  28466. <description>
  28467. <para>
  28468. Used to output the value of a specific appSetting key in the application
  28469. configuration file.
  28470. </para>
  28471. </description>
  28472. </item>
  28473. <item>
  28474. <term>date</term>
  28475. <description>
  28476. <para>
  28477. Used to output the current date and time in the local time zone.
  28478. To output the date in universal time use the <c>%utcdate</c> pattern.
  28479. The date conversion
  28480. specifier may be followed by a <i>date format specifier</i> enclosed
  28481. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  28482. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  28483. given then ISO8601 format is
  28484. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  28485. </para>
  28486. <para>
  28487. The date format specifier admits the same syntax as the
  28488. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  28489. </para>
  28490. <para>
  28491. For better results it is recommended to use the log4net date
  28492. formatters. These can be specified using one of the strings
  28493. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  28494. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  28495. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  28496. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  28497. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  28498. </para>
  28499. <para>
  28500. These dedicated date formatters perform significantly
  28501. better than <see cref="M:DateTime.ToString(string)"/>.
  28502. </para>
  28503. </description>
  28504. </item>
  28505. <item>
  28506. <term>env</term>
  28507. <description>
  28508. <para>
  28509. Used to output the a specific environment variable. The key to
  28510. lookup must be specified within braces and directly following the
  28511. pattern specifier, e.g. <b>%env{COMPUTERNAME}</b> would include the value
  28512. of the <c>COMPUTERNAME</c> environment variable.
  28513. </para>
  28514. <para>
  28515. The <c>env</c> pattern is not supported on the .NET Compact Framework.
  28516. </para>
  28517. </description>
  28518. </item>
  28519. <item>
  28520. <term>identity</term>
  28521. <description>
  28522. <para>
  28523. Used to output the user name for the currently active user
  28524. (Principal.Identity.Name).
  28525. </para>
  28526. </description>
  28527. </item>
  28528. <item>
  28529. <term>newline</term>
  28530. <description>
  28531. <para>
  28532. Outputs the platform dependent line separator character or
  28533. characters.
  28534. </para>
  28535. <para>
  28536. This conversion pattern name offers the same performance as using
  28537. non-portable line separator strings such as "\n", or "\r\n".
  28538. Thus, it is the preferred way of specifying a line separator.
  28539. </para>
  28540. </description>
  28541. </item>
  28542. <item>
  28543. <term>processid</term>
  28544. <description>
  28545. <para>
  28546. Used to output the system process ID for the current process.
  28547. </para>
  28548. </description>
  28549. </item>
  28550. <item>
  28551. <term>property</term>
  28552. <description>
  28553. <para>
  28554. Used to output a specific context property. The key to
  28555. lookup must be specified within braces and directly following the
  28556. pattern specifier, e.g. <b>%property{user}</b> would include the value
  28557. from the property that is keyed by the string 'user'. Each property value
  28558. that is to be included in the log must be specified separately.
  28559. Properties are stored in logging contexts. By default
  28560. the <c>log4net:HostName</c> property is set to the name of machine on
  28561. which the event was originally logged.
  28562. </para>
  28563. <para>
  28564. If no key is specified, e.g. <b>%property</b> then all the keys and their
  28565. values are printed in a comma separated list.
  28566. </para>
  28567. <para>
  28568. The properties of an event are combined from a number of different
  28569. contexts. These are listed below in the order in which they are searched.
  28570. </para>
  28571. <list type="definition">
  28572. <item>
  28573. <term>the thread properties</term>
  28574. <description>
  28575. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  28576. thread. These properties are shared by all events logged on this thread.
  28577. </description>
  28578. </item>
  28579. <item>
  28580. <term>the global properties</term>
  28581. <description>
  28582. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  28583. properties are shared by all the threads in the AppDomain.
  28584. </description>
  28585. </item>
  28586. </list>
  28587. </description>
  28588. </item>
  28589. <item>
  28590. <term>random</term>
  28591. <description>
  28592. <para>
  28593. Used to output a random string of characters. The string is made up of
  28594. uppercase letters and numbers. By default the string is 4 characters long.
  28595. The length of the string can be specified within braces directly following the
  28596. pattern specifier, e.g. <b>%random{8}</b> would output an 8 character string.
  28597. </para>
  28598. </description>
  28599. </item>
  28600. <item>
  28601. <term>username</term>
  28602. <description>
  28603. <para>
  28604. Used to output the WindowsIdentity for the currently
  28605. active user.
  28606. </para>
  28607. </description>
  28608. </item>
  28609. <item>
  28610. <term>utcdate</term>
  28611. <description>
  28612. <para>
  28613. Used to output the date of the logging event in universal time.
  28614. The date conversion
  28615. specifier may be followed by a <i>date format specifier</i> enclosed
  28616. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  28617. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  28618. given then ISO8601 format is
  28619. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  28620. </para>
  28621. <para>
  28622. The date format specifier admits the same syntax as the
  28623. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  28624. </para>
  28625. <para>
  28626. For better results it is recommended to use the log4net date
  28627. formatters. These can be specified using one of the strings
  28628. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  28629. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  28630. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  28631. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  28632. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  28633. </para>
  28634. <para>
  28635. These dedicated date formatters perform significantly
  28636. better than <see cref="M:DateTime.ToString(string)"/>.
  28637. </para>
  28638. </description>
  28639. </item>
  28640. <item>
  28641. <term>%</term>
  28642. <description>
  28643. <para>
  28644. The sequence %% outputs a single percent sign.
  28645. </para>
  28646. </description>
  28647. </item>
  28648. </list>
  28649. <para>
  28650. Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/>
  28651. instance using <see cref="M:AddConverter(ConverterInfo)"/> or
  28652. <see cref="M:AddConverter(string, Type)" />.
  28653. </para>
  28654. <para>
  28655. See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the
  28656. <i>format modifiers</i> supported by the patterns.
  28657. </para>
  28658. </remarks>
  28659. <author>Nicko Cadell</author>
  28660. </member>
  28661. <member name="F:log4net.Util.PatternString.s_globalRulesRegistry">
  28662. <summary>
  28663. Internal map of converter identifiers to converter types.
  28664. </summary>
  28665. </member>
  28666. <member name="F:log4net.Util.PatternString.m_pattern">
  28667. <summary>
  28668. the pattern
  28669. </summary>
  28670. </member>
  28671. <member name="F:log4net.Util.PatternString.m_head">
  28672. <summary>
  28673. the head of the pattern converter chain
  28674. </summary>
  28675. </member>
  28676. <member name="F:log4net.Util.PatternString.m_instanceRulesRegistry">
  28677. <summary>
  28678. patterns defined on this PatternString only
  28679. </summary>
  28680. </member>
  28681. <member name="M:log4net.Util.PatternString.#cctor">
  28682. <summary>
  28683. Initialize the global registry
  28684. </summary>
  28685. </member>
  28686. <member name="M:log4net.Util.PatternString.#ctor">
  28687. <summary>
  28688. Default constructor
  28689. </summary>
  28690. <remarks>
  28691. <para>
  28692. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/>
  28693. </para>
  28694. </remarks>
  28695. </member>
  28696. <member name="M:log4net.Util.PatternString.#ctor(System.String)">
  28697. <summary>
  28698. Constructs a PatternString
  28699. </summary>
  28700. <param name="pattern">The pattern to use with this PatternString</param>
  28701. <remarks>
  28702. <para>
  28703. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> with the pattern specified.
  28704. </para>
  28705. </remarks>
  28706. </member>
  28707. <member name="P:log4net.Util.PatternString.ConversionPattern">
  28708. <summary>
  28709. Gets or sets the pattern formatting string
  28710. </summary>
  28711. <value>
  28712. The pattern formatting string
  28713. </value>
  28714. <remarks>
  28715. <para>
  28716. The <b>ConversionPattern</b> option. This is the string which
  28717. controls formatting and consists of a mix of literal content and
  28718. conversion specifiers.
  28719. </para>
  28720. </remarks>
  28721. </member>
  28722. <member name="M:log4net.Util.PatternString.ActivateOptions">
  28723. <summary>
  28724. Initialize object options
  28725. </summary>
  28726. <remarks>
  28727. <para>
  28728. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  28729. activation scheme. The <see cref="M:log4net.Util.PatternString.ActivateOptions"/> method must
  28730. be called on this object after the configuration properties have
  28731. been set. Until <see cref="M:log4net.Util.PatternString.ActivateOptions"/> is called this
  28732. object is in an undefined state and must not be used.
  28733. </para>
  28734. <para>
  28735. If any of the configuration properties are modified then
  28736. <see cref="M:log4net.Util.PatternString.ActivateOptions"/> must be called again.
  28737. </para>
  28738. </remarks>
  28739. </member>
  28740. <member name="M:log4net.Util.PatternString.CreatePatternParser(System.String)">
  28741. <summary>
  28742. Create the <see cref="T:log4net.Util.PatternParser"/> used to parse the pattern
  28743. </summary>
  28744. <param name="pattern">the pattern to parse</param>
  28745. <returns>The <see cref="T:log4net.Util.PatternParser"/></returns>
  28746. <remarks>
  28747. <para>
  28748. Returns PatternParser used to parse the conversion string. Subclasses
  28749. may override this to return a subclass of PatternParser which recognize
  28750. custom conversion pattern name.
  28751. </para>
  28752. </remarks>
  28753. </member>
  28754. <member name="M:log4net.Util.PatternString.Format(System.IO.TextWriter)">
  28755. <summary>
  28756. Produces a formatted string as specified by the conversion pattern.
  28757. </summary>
  28758. <param name="writer">The TextWriter to write the formatted event to</param>
  28759. <remarks>
  28760. <para>
  28761. Format the pattern to the <paramref name="writer"/>.
  28762. </para>
  28763. </remarks>
  28764. </member>
  28765. <member name="M:log4net.Util.PatternString.Format">
  28766. <summary>
  28767. Format the pattern as a string
  28768. </summary>
  28769. <returns>the pattern formatted as a string</returns>
  28770. <remarks>
  28771. <para>
  28772. Format the pattern to a string.
  28773. </para>
  28774. </remarks>
  28775. </member>
  28776. <member name="M:log4net.Util.PatternString.AddConverter(log4net.Util.ConverterInfo)">
  28777. <summary>
  28778. Add a converter to this PatternString
  28779. </summary>
  28780. <param name="converterInfo">the converter info</param>
  28781. <remarks>
  28782. <para>
  28783. This version of the method is used by the configurator.
  28784. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  28785. </para>
  28786. </remarks>
  28787. </member>
  28788. <member name="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)">
  28789. <summary>
  28790. Add a converter to this PatternString
  28791. </summary>
  28792. <param name="name">the name of the conversion pattern for this converter</param>
  28793. <param name="type">the type of the converter</param>
  28794. <remarks>
  28795. <para>
  28796. Add a converter to this PatternString
  28797. </para>
  28798. </remarks>
  28799. </member>
  28800. <member name="T:log4net.Util.PatternStringConverters.AppDomainPatternConverter">
  28801. <summary>
  28802. Write the name of the current AppDomain to the output
  28803. </summary>
  28804. <remarks>
  28805. <para>
  28806. Write the name of the current AppDomain to the output writer
  28807. </para>
  28808. </remarks>
  28809. <author>Nicko Cadell</author>
  28810. </member>
  28811. <member name="M:log4net.Util.PatternStringConverters.AppDomainPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  28812. <summary>
  28813. Write the name of the current AppDomain to the output
  28814. </summary>
  28815. <param name="writer">the writer to write to</param>
  28816. <param name="state">null, state is not set</param>
  28817. <remarks>
  28818. <para>
  28819. Writes name of the current AppDomain to the output <paramref name="writer"/>.
  28820. </para>
  28821. </remarks>
  28822. </member>
  28823. <member name="T:log4net.Util.PatternStringConverters.AppSettingPatternConverter">
  28824. <summary>
  28825. AppSetting pattern converter
  28826. </summary>
  28827. <remarks>
  28828. <para>
  28829. This pattern converter reads appSettings from the application configuration file.
  28830. </para>
  28831. <para>
  28832. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  28833. lookup a single appSettings value. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  28834. then all appSettings will be dumped as a list of key value pairs.
  28835. </para>
  28836. <para>
  28837. A typical use is to specify a base directory for log files, e.g.
  28838. <example>
  28839. <![CDATA[
  28840. <log4net>
  28841. <appender name="MyAppender" type="log4net.Appender.RollingFileAppender">
  28842. <file type="log4net.Util.PatternString" value="appsetting{LogDirectory}MyApp.log"/>
  28843. ...
  28844. </appender>
  28845. </log4net>
  28846. ]]>
  28847. </example>
  28848. </para>
  28849. </remarks>
  28850. </member>
  28851. <member name="M:log4net.Util.PatternStringConverters.AppSettingPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  28852. <summary>
  28853. Write the property value to the output
  28854. </summary>
  28855. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  28856. <param name="state">null, state is not set</param>
  28857. <remarks>
  28858. <para>
  28859. Writes out the value of a named property. The property name
  28860. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  28861. property.
  28862. </para>
  28863. <para>
  28864. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  28865. then all the properties are written as key value pairs.
  28866. </para>
  28867. </remarks>
  28868. </member>
  28869. <member name="T:log4net.Util.PatternStringConverters.DatePatternConverter">
  28870. <summary>
  28871. Write the current date to the output
  28872. </summary>
  28873. <remarks>
  28874. <para>
  28875. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  28876. the current date and time to the writer as a string.
  28877. </para>
  28878. <para>
  28879. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  28880. the formatting of the date. The following values are allowed:
  28881. <list type="definition">
  28882. <listheader>
  28883. <term>Option value</term>
  28884. <description>Output</description>
  28885. </listheader>
  28886. <item>
  28887. <term>ISO8601</term>
  28888. <description>
  28889. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  28890. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  28891. </description>
  28892. </item>
  28893. <item>
  28894. <term>DATE</term>
  28895. <description>
  28896. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  28897. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  28898. </description>
  28899. </item>
  28900. <item>
  28901. <term>ABSOLUTE</term>
  28902. <description>
  28903. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  28904. Formats using the <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  28905. </description>
  28906. </item>
  28907. <item>
  28908. <term>other</term>
  28909. <description>
  28910. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  28911. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  28912. <see cref="M:DateTime.ToString(string)"/> method.
  28913. For details on valid patterns see
  28914. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  28915. </description>
  28916. </item>
  28917. </list>
  28918. </para>
  28919. <para>
  28920. The date and time is in the local time zone and is rendered in that zone.
  28921. To output the time in Universal time see <see cref="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"/>.
  28922. </para>
  28923. </remarks>
  28924. <author>Nicko Cadell</author>
  28925. </member>
  28926. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.m_dateFormatter">
  28927. <summary>
  28928. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  28929. </summary>
  28930. <remarks>
  28931. <para>
  28932. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  28933. </para>
  28934. </remarks>
  28935. </member>
  28936. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions">
  28937. <summary>
  28938. Initialize the converter options
  28939. </summary>
  28940. <remarks>
  28941. <para>
  28942. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  28943. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> method must
  28944. be called on this object after the configuration properties have
  28945. been set. Until <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> is called this
  28946. object is in an undefined state and must not be used.
  28947. </para>
  28948. <para>
  28949. If any of the configuration properties are modified then
  28950. <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> must be called again.
  28951. </para>
  28952. </remarks>
  28953. </member>
  28954. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  28955. <summary>
  28956. Write the current date to the output
  28957. </summary>
  28958. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  28959. <param name="state">null, state is not set</param>
  28960. <remarks>
  28961. <para>
  28962. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  28963. for it to render it to the writer.
  28964. </para>
  28965. <para>
  28966. The date and time passed is in the local time zone.
  28967. </para>
  28968. </remarks>
  28969. </member>
  28970. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.declaringType">
  28971. <summary>
  28972. The fully qualified type of the DatePatternConverter class.
  28973. </summary>
  28974. <remarks>
  28975. Used by the internal logger to record the Type of the
  28976. log message.
  28977. </remarks>
  28978. </member>
  28979. <member name="T:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter">
  28980. <summary>
  28981. Write an <see cref="T:System.Environment.SpecialFolder" /> folder path to the output
  28982. </summary>
  28983. <remarks>
  28984. <para>
  28985. Write an special path environment folder path to the output writer.
  28986. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  28987. the name of the variable to output. <see cref="P:log4net.Util.PatternConverter.Option"/>
  28988. should be a value in the <see cref="T:System.Environment.SpecialFolder" /> enumeration.
  28989. </para>
  28990. </remarks>
  28991. <author>Ron Grabowski</author>
  28992. </member>
  28993. <member name="M:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  28994. <summary>
  28995. Write an special path environment folder path to the output
  28996. </summary>
  28997. <param name="writer">the writer to write to</param>
  28998. <param name="state">null, state is not set</param>
  28999. <remarks>
  29000. <para>
  29001. Writes the special path environment folder path to the output <paramref name="writer"/>.
  29002. The name of the special path environment folder path to output must be set
  29003. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  29004. property.
  29005. </para>
  29006. </remarks>
  29007. </member>
  29008. <member name="F:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.declaringType">
  29009. <summary>
  29010. The fully qualified type of the EnvironmentFolderPathPatternConverter class.
  29011. </summary>
  29012. <remarks>
  29013. Used by the internal logger to record the Type of the
  29014. log message.
  29015. </remarks>
  29016. </member>
  29017. <member name="T:log4net.Util.PatternStringConverters.EnvironmentPatternConverter">
  29018. <summary>
  29019. Write an environment variable to the output
  29020. </summary>
  29021. <remarks>
  29022. <para>
  29023. Write an environment variable to the output writer.
  29024. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  29025. the name of the variable to output.
  29026. </para>
  29027. </remarks>
  29028. <author>Nicko Cadell</author>
  29029. </member>
  29030. <member name="M:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29031. <summary>
  29032. Write an environment variable to the output
  29033. </summary>
  29034. <param name="writer">the writer to write to</param>
  29035. <param name="state">null, state is not set</param>
  29036. <remarks>
  29037. <para>
  29038. Writes the environment variable to the output <paramref name="writer"/>.
  29039. The name of the environment variable to output must be set
  29040. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  29041. property.
  29042. </para>
  29043. </remarks>
  29044. </member>
  29045. <member name="F:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.declaringType">
  29046. <summary>
  29047. The fully qualified type of the EnvironmentPatternConverter class.
  29048. </summary>
  29049. <remarks>
  29050. Used by the internal logger to record the Type of the
  29051. log message.
  29052. </remarks>
  29053. </member>
  29054. <member name="T:log4net.Util.PatternStringConverters.IdentityPatternConverter">
  29055. <summary>
  29056. Write the current thread identity to the output
  29057. </summary>
  29058. <remarks>
  29059. <para>
  29060. Write the current thread identity to the output writer
  29061. </para>
  29062. </remarks>
  29063. <author>Nicko Cadell</author>
  29064. </member>
  29065. <member name="M:log4net.Util.PatternStringConverters.IdentityPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29066. <summary>
  29067. Write the current thread identity to the output
  29068. </summary>
  29069. <param name="writer">the writer to write to</param>
  29070. <param name="state">null, state is not set</param>
  29071. <remarks>
  29072. <para>
  29073. Writes the current thread identity to the output <paramref name="writer"/>.
  29074. </para>
  29075. </remarks>
  29076. </member>
  29077. <member name="F:log4net.Util.PatternStringConverters.IdentityPatternConverter.declaringType">
  29078. <summary>
  29079. The fully qualified type of the IdentityPatternConverter class.
  29080. </summary>
  29081. <remarks>
  29082. Used by the internal logger to record the Type of the
  29083. log message.
  29084. </remarks>
  29085. </member>
  29086. <member name="T:log4net.Util.PatternStringConverters.LiteralPatternConverter">
  29087. <summary>
  29088. Pattern converter for literal string instances in the pattern
  29089. </summary>
  29090. <remarks>
  29091. <para>
  29092. Writes the literal string value specified in the
  29093. <see cref="P:log4net.Util.PatternConverter.Option"/> property to
  29094. the output.
  29095. </para>
  29096. </remarks>
  29097. <author>Nicko Cadell</author>
  29098. </member>
  29099. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.SetNext(log4net.Util.PatternConverter)">
  29100. <summary>
  29101. Set the next converter in the chain
  29102. </summary>
  29103. <param name="pc">The next pattern converter in the chain</param>
  29104. <returns>The next pattern converter</returns>
  29105. <remarks>
  29106. <para>
  29107. Special case the building of the pattern converter chain
  29108. for <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> instances. Two adjacent
  29109. literals in the pattern can be represented by a single combined
  29110. pattern converter. This implementation detects when a
  29111. <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> is added to the chain
  29112. after this converter and combines its value with this converter's
  29113. literal value.
  29114. </para>
  29115. </remarks>
  29116. </member>
  29117. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Format(System.IO.TextWriter,System.Object)">
  29118. <summary>
  29119. Write the literal to the output
  29120. </summary>
  29121. <param name="writer">the writer to write to</param>
  29122. <param name="state">null, not set</param>
  29123. <remarks>
  29124. <para>
  29125. Override the formatting behavior to ignore the FormattingInfo
  29126. because we have a literal instead.
  29127. </para>
  29128. <para>
  29129. Writes the value of <see cref="P:log4net.Util.PatternConverter.Option"/>
  29130. to the output <paramref name="writer"/>.
  29131. </para>
  29132. </remarks>
  29133. </member>
  29134. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29135. <summary>
  29136. Convert this pattern into the rendered message
  29137. </summary>
  29138. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  29139. <param name="state">null, not set</param>
  29140. <remarks>
  29141. <para>
  29142. This method is not used.
  29143. </para>
  29144. </remarks>
  29145. </member>
  29146. <member name="T:log4net.Util.PatternStringConverters.NewLinePatternConverter">
  29147. <summary>
  29148. Writes a newline to the output
  29149. </summary>
  29150. <remarks>
  29151. <para>
  29152. Writes the system dependent line terminator to the output.
  29153. This behavior can be overridden by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>:
  29154. </para>
  29155. <list type="definition">
  29156. <listheader>
  29157. <term>Option Value</term>
  29158. <description>Output</description>
  29159. </listheader>
  29160. <item>
  29161. <term>DOS</term>
  29162. <description>DOS or Windows line terminator <c>"\r\n"</c></description>
  29163. </item>
  29164. <item>
  29165. <term>UNIX</term>
  29166. <description>UNIX line terminator <c>"\n"</c></description>
  29167. </item>
  29168. </list>
  29169. </remarks>
  29170. <author>Nicko Cadell</author>
  29171. </member>
  29172. <member name="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions">
  29173. <summary>
  29174. Initialize the converter
  29175. </summary>
  29176. <remarks>
  29177. <para>
  29178. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  29179. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> method must
  29180. be called on this object after the configuration properties have
  29181. been set. Until <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> is called this
  29182. object is in an undefined state and must not be used.
  29183. </para>
  29184. <para>
  29185. If any of the configuration properties are modified then
  29186. <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> must be called again.
  29187. </para>
  29188. </remarks>
  29189. </member>
  29190. <member name="T:log4net.Util.PatternStringConverters.ProcessIdPatternConverter">
  29191. <summary>
  29192. Write the current process ID to the output
  29193. </summary>
  29194. <remarks>
  29195. <para>
  29196. Write the current process ID to the output writer
  29197. </para>
  29198. </remarks>
  29199. <author>Nicko Cadell</author>
  29200. </member>
  29201. <member name="M:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29202. <summary>
  29203. Write the current process ID to the output
  29204. </summary>
  29205. <param name="writer">the writer to write to</param>
  29206. <param name="state">null, state is not set</param>
  29207. <remarks>
  29208. <para>
  29209. Write the current process ID to the output <paramref name="writer"/>.
  29210. </para>
  29211. </remarks>
  29212. </member>
  29213. <member name="F:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.declaringType">
  29214. <summary>
  29215. The fully qualified type of the ProcessIdPatternConverter class.
  29216. </summary>
  29217. <remarks>
  29218. Used by the internal logger to record the Type of the
  29219. log message.
  29220. </remarks>
  29221. </member>
  29222. <member name="T:log4net.Util.PatternStringConverters.PropertyPatternConverter">
  29223. <summary>
  29224. Property pattern converter
  29225. </summary>
  29226. <remarks>
  29227. <para>
  29228. This pattern converter reads the thread and global properties.
  29229. The thread properties take priority over global properties.
  29230. See <see cref="P:log4net.ThreadContext.Properties"/> for details of the
  29231. thread properties. See <see cref="P:log4net.GlobalContext.Properties"/> for
  29232. details of the global properties.
  29233. </para>
  29234. <para>
  29235. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  29236. lookup a single property. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  29237. then all properties will be dumped as a list of key value pairs.
  29238. </para>
  29239. </remarks>
  29240. <author>Nicko Cadell</author>
  29241. </member>
  29242. <member name="M:log4net.Util.PatternStringConverters.PropertyPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29243. <summary>
  29244. Write the property value to the output
  29245. </summary>
  29246. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  29247. <param name="state">null, state is not set</param>
  29248. <remarks>
  29249. <para>
  29250. Writes out the value of a named property. The property name
  29251. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  29252. property.
  29253. </para>
  29254. <para>
  29255. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  29256. then all the properties are written as key value pairs.
  29257. </para>
  29258. </remarks>
  29259. </member>
  29260. <member name="T:log4net.Util.PatternStringConverters.RandomStringPatternConverter">
  29261. <summary>
  29262. A Pattern converter that generates a string of random characters
  29263. </summary>
  29264. <remarks>
  29265. <para>
  29266. The converter generates a string of random characters. By default
  29267. the string is length 4. This can be changed by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>
  29268. to the string value of the length required.
  29269. </para>
  29270. <para>
  29271. The random characters in the string are limited to uppercase letters
  29272. and numbers only.
  29273. </para>
  29274. <para>
  29275. The random number generator used by this class is not cryptographically secure.
  29276. </para>
  29277. </remarks>
  29278. <author>Nicko Cadell</author>
  29279. </member>
  29280. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.s_random">
  29281. <summary>
  29282. Shared random number generator
  29283. </summary>
  29284. </member>
  29285. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.m_length">
  29286. <summary>
  29287. Length of random string to generate. Default length 4.
  29288. </summary>
  29289. </member>
  29290. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions">
  29291. <summary>
  29292. Initialize the converter options
  29293. </summary>
  29294. <remarks>
  29295. <para>
  29296. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  29297. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> method must
  29298. be called on this object after the configuration properties have
  29299. been set. Until <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> is called this
  29300. object is in an undefined state and must not be used.
  29301. </para>
  29302. <para>
  29303. If any of the configuration properties are modified then
  29304. <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> must be called again.
  29305. </para>
  29306. </remarks>
  29307. </member>
  29308. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29309. <summary>
  29310. Write a randoim string to the output
  29311. </summary>
  29312. <param name="writer">the writer to write to</param>
  29313. <param name="state">null, state is not set</param>
  29314. <remarks>
  29315. <para>
  29316. Write a randoim string to the output <paramref name="writer"/>.
  29317. </para>
  29318. </remarks>
  29319. </member>
  29320. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.declaringType">
  29321. <summary>
  29322. The fully qualified type of the RandomStringPatternConverter class.
  29323. </summary>
  29324. <remarks>
  29325. Used by the internal logger to record the Type of the
  29326. log message.
  29327. </remarks>
  29328. </member>
  29329. <member name="T:log4net.Util.PatternStringConverters.UserNamePatternConverter">
  29330. <summary>
  29331. Write the current threads username to the output
  29332. </summary>
  29333. <remarks>
  29334. <para>
  29335. Write the current threads username to the output writer
  29336. </para>
  29337. </remarks>
  29338. <author>Nicko Cadell</author>
  29339. </member>
  29340. <member name="M:log4net.Util.PatternStringConverters.UserNamePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29341. <summary>
  29342. Write the current threads username to the output
  29343. </summary>
  29344. <param name="writer">the writer to write to</param>
  29345. <param name="state">null, state is not set</param>
  29346. <remarks>
  29347. <para>
  29348. Write the current threads username to the output <paramref name="writer"/>.
  29349. </para>
  29350. </remarks>
  29351. </member>
  29352. <member name="F:log4net.Util.PatternStringConverters.UserNamePatternConverter.declaringType">
  29353. <summary>
  29354. The fully qualified type of the UserNamePatternConverter class.
  29355. </summary>
  29356. <remarks>
  29357. Used by the internal logger to record the Type of the
  29358. log message.
  29359. </remarks>
  29360. </member>
  29361. <member name="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter">
  29362. <summary>
  29363. Write the UTC date time to the output
  29364. </summary>
  29365. <remarks>
  29366. <para>
  29367. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  29368. the current date and time in Universal time.
  29369. </para>
  29370. <para>
  29371. See the <see cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> for details on the date pattern syntax.
  29372. </para>
  29373. </remarks>
  29374. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  29375. <author>Nicko Cadell</author>
  29376. </member>
  29377. <member name="M:log4net.Util.PatternStringConverters.UtcDatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  29378. <summary>
  29379. Write the current date and time to the output
  29380. </summary>
  29381. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  29382. <param name="state">null, state is not set</param>
  29383. <remarks>
  29384. <para>
  29385. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  29386. for it to render it to the writer.
  29387. </para>
  29388. <para>
  29389. The date is in Universal time when it is rendered.
  29390. </para>
  29391. </remarks>
  29392. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  29393. </member>
  29394. <member name="F:log4net.Util.PatternStringConverters.UtcDatePatternConverter.declaringType">
  29395. <summary>
  29396. The fully qualified type of the UtcDatePatternConverter class.
  29397. </summary>
  29398. <remarks>
  29399. Used by the internal logger to record the Type of the
  29400. log message.
  29401. </remarks>
  29402. </member>
  29403. <member name="T:log4net.Util.PropertiesDictionary">
  29404. <summary>
  29405. String keyed object map.
  29406. </summary>
  29407. <remarks>
  29408. <para>
  29409. While this collection is serializable only member
  29410. objects that are serializable will
  29411. be serialized along with this collection.
  29412. </para>
  29413. </remarks>
  29414. <author>Nicko Cadell</author>
  29415. <author>Gert Driesen</author>
  29416. </member>
  29417. <member name="M:log4net.Util.PropertiesDictionary.#ctor">
  29418. <summary>
  29419. Constructor
  29420. </summary>
  29421. <remarks>
  29422. <para>
  29423. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class.
  29424. </para>
  29425. </remarks>
  29426. </member>
  29427. <member name="M:log4net.Util.PropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  29428. <summary>
  29429. Constructor
  29430. </summary>
  29431. <param name="propertiesDictionary">properties to copy</param>
  29432. <remarks>
  29433. <para>
  29434. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class.
  29435. </para>
  29436. </remarks>
  29437. </member>
  29438. <member name="M:log4net.Util.PropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29439. <summary>
  29440. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class
  29441. with serialized data.
  29442. </summary>
  29443. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  29444. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  29445. <remarks>
  29446. <para>
  29447. Because this class is sealed the serialization constructor is private.
  29448. </para>
  29449. </remarks>
  29450. </member>
  29451. <member name="P:log4net.Util.PropertiesDictionary.Item(System.String)">
  29452. <summary>
  29453. Gets or sets the value of the property with the specified key.
  29454. </summary>
  29455. <value>
  29456. The value of the property with the specified key.
  29457. </value>
  29458. <param name="key">The key of the property to get or set.</param>
  29459. <remarks>
  29460. <para>
  29461. The property value will only be serialized if it is serializable.
  29462. If it cannot be serialized it will be silently ignored if
  29463. a serialization operation is performed.
  29464. </para>
  29465. </remarks>
  29466. </member>
  29467. <member name="M:log4net.Util.PropertiesDictionary.Remove(System.String)">
  29468. <summary>
  29469. Remove the entry with the specified key from this dictionary
  29470. </summary>
  29471. <param name="key">the key for the entry to remove</param>
  29472. <remarks>
  29473. <para>
  29474. Remove the entry with the specified key from this dictionary
  29475. </para>
  29476. </remarks>
  29477. </member>
  29478. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  29479. <summary>
  29480. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  29481. </summary>
  29482. <returns>an enumerator</returns>
  29483. <remarks>
  29484. <para>
  29485. Returns a <see cref="T:System.Collections.IDictionaryEnumerator"/> over the contest of this collection.
  29486. </para>
  29487. </remarks>
  29488. </member>
  29489. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  29490. <summary>
  29491. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  29492. </summary>
  29493. <param name="key">the key to remove</param>
  29494. <remarks>
  29495. <para>
  29496. Remove the entry with the specified key from this dictionary
  29497. </para>
  29498. </remarks>
  29499. </member>
  29500. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  29501. <summary>
  29502. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  29503. </summary>
  29504. <param name="key">the key to lookup in the collection</param>
  29505. <returns><c>true</c> if the collection contains the specified key</returns>
  29506. <remarks>
  29507. <para>
  29508. Test if this collection contains a specified key.
  29509. </para>
  29510. </remarks>
  29511. </member>
  29512. <member name="M:log4net.Util.PropertiesDictionary.Clear">
  29513. <summary>
  29514. Remove all properties from the properties collection
  29515. </summary>
  29516. <remarks>
  29517. <para>
  29518. Remove all properties from the properties collection
  29519. </para>
  29520. </remarks>
  29521. </member>
  29522. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  29523. <summary>
  29524. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  29525. </summary>
  29526. <param name="key">the key</param>
  29527. <param name="value">the value to store for the key</param>
  29528. <remarks>
  29529. <para>
  29530. Store a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  29531. </para>
  29532. </remarks>
  29533. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  29534. </member>
  29535. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  29536. <summary>
  29537. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  29538. </summary>
  29539. <value>
  29540. <c>false</c>
  29541. </value>
  29542. <remarks>
  29543. <para>
  29544. This collection is modifiable. This property always
  29545. returns <c>false</c>.
  29546. </para>
  29547. </remarks>
  29548. </member>
  29549. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  29550. <summary>
  29551. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  29552. </summary>
  29553. <value>
  29554. The value for the key specified.
  29555. </value>
  29556. <remarks>
  29557. <para>
  29558. Get or set a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  29559. </para>
  29560. </remarks>
  29561. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  29562. </member>
  29563. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Values">
  29564. <summary>
  29565. See <see cref="P:System.Collections.IDictionary.Values"/>
  29566. </summary>
  29567. </member>
  29568. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Keys">
  29569. <summary>
  29570. See <see cref="P:System.Collections.IDictionary.Keys"/>
  29571. </summary>
  29572. </member>
  29573. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  29574. <summary>
  29575. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  29576. </summary>
  29577. </member>
  29578. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  29579. <summary>
  29580. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  29581. </summary>
  29582. <param name="array"></param>
  29583. <param name="index"></param>
  29584. </member>
  29585. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  29586. <summary>
  29587. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  29588. </summary>
  29589. </member>
  29590. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#SyncRoot">
  29591. <summary>
  29592. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  29593. </summary>
  29594. </member>
  29595. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  29596. <summary>
  29597. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  29598. </summary>
  29599. </member>
  29600. <member name="T:log4net.Util.PropertyEntry">
  29601. <summary>
  29602. A class to hold the key and data for a property set in the config file
  29603. </summary>
  29604. <remarks>
  29605. <para>
  29606. A class to hold the key and data for a property set in the config file
  29607. </para>
  29608. </remarks>
  29609. </member>
  29610. <member name="P:log4net.Util.PropertyEntry.Key">
  29611. <summary>
  29612. Property Key
  29613. </summary>
  29614. <value>
  29615. Property Key
  29616. </value>
  29617. <remarks>
  29618. <para>
  29619. Property Key.
  29620. </para>
  29621. </remarks>
  29622. </member>
  29623. <member name="P:log4net.Util.PropertyEntry.Value">
  29624. <summary>
  29625. Property Value
  29626. </summary>
  29627. <value>
  29628. Property Value
  29629. </value>
  29630. <remarks>
  29631. <para>
  29632. Property Value.
  29633. </para>
  29634. </remarks>
  29635. </member>
  29636. <member name="M:log4net.Util.PropertyEntry.ToString">
  29637. <summary>
  29638. Override <c>Object.ToString</c> to return sensible debug info
  29639. </summary>
  29640. <returns>string info about this object</returns>
  29641. </member>
  29642. <member name="T:log4net.Util.ProtectCloseTextWriter">
  29643. <summary>
  29644. A <see cref="T:System.IO.TextWriter"/> that ignores the <see cref="M:log4net.Util.ProtectCloseTextWriter.Close"/> message
  29645. </summary>
  29646. <remarks>
  29647. <para>
  29648. This writer is used in special cases where it is necessary
  29649. to protect a writer from being closed by a client.
  29650. </para>
  29651. </remarks>
  29652. <author>Nicko Cadell</author>
  29653. </member>
  29654. <member name="M:log4net.Util.ProtectCloseTextWriter.#ctor(System.IO.TextWriter)">
  29655. <summary>
  29656. Constructor
  29657. </summary>
  29658. <param name="writer">the writer to actually write to</param>
  29659. <remarks>
  29660. <para>
  29661. Create a new ProtectCloseTextWriter using a writer
  29662. </para>
  29663. </remarks>
  29664. </member>
  29665. <member name="M:log4net.Util.ProtectCloseTextWriter.Attach(System.IO.TextWriter)">
  29666. <summary>
  29667. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  29668. </summary>
  29669. <param name="writer">the writer to attach to</param>
  29670. <remarks>
  29671. <para>
  29672. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  29673. </para>
  29674. </remarks>
  29675. </member>
  29676. <member name="M:log4net.Util.ProtectCloseTextWriter.Close">
  29677. <summary>
  29678. Does not close the underlying output writer.
  29679. </summary>
  29680. <remarks>
  29681. <para>
  29682. Does not close the underlying output writer.
  29683. This method does nothing.
  29684. </para>
  29685. </remarks>
  29686. </member>
  29687. <member name="T:log4net.Util.QuietTextWriter">
  29688. <summary>
  29689. <see cref="T:System.IO.TextWriter"/> that does not leak exceptions
  29690. </summary>
  29691. <remarks>
  29692. <para>
  29693. <see cref="T:log4net.Util.QuietTextWriter"/> does not throw exceptions when things go wrong.
  29694. Instead, it delegates error handling to its <see cref="T:log4net.Core.IErrorHandler"/>.
  29695. </para>
  29696. </remarks>
  29697. <author>Nicko Cadell</author>
  29698. <author>Gert Driesen</author>
  29699. </member>
  29700. <member name="M:log4net.Util.QuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  29701. <summary>
  29702. Constructor
  29703. </summary>
  29704. <param name="writer">the writer to actually write to</param>
  29705. <param name="errorHandler">the error handler to report error to</param>
  29706. <remarks>
  29707. <para>
  29708. Create a new QuietTextWriter using a writer and error handler
  29709. </para>
  29710. </remarks>
  29711. </member>
  29712. <member name="P:log4net.Util.QuietTextWriter.ErrorHandler">
  29713. <summary>
  29714. Gets or sets the error handler that all errors are passed to.
  29715. </summary>
  29716. <value>
  29717. The error handler that all errors are passed to.
  29718. </value>
  29719. <remarks>
  29720. <para>
  29721. Gets or sets the error handler that all errors are passed to.
  29722. </para>
  29723. </remarks>
  29724. </member>
  29725. <member name="P:log4net.Util.QuietTextWriter.Closed">
  29726. <summary>
  29727. Gets a value indicating whether this writer is closed.
  29728. </summary>
  29729. <value>
  29730. <c>true</c> if this writer is closed, otherwise <c>false</c>.
  29731. </value>
  29732. <remarks>
  29733. <para>
  29734. Gets a value indicating whether this writer is closed.
  29735. </para>
  29736. </remarks>
  29737. </member>
  29738. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char)">
  29739. <summary>
  29740. Writes a character to the underlying writer
  29741. </summary>
  29742. <param name="value">the char to write</param>
  29743. <remarks>
  29744. <para>
  29745. Writes a character to the underlying writer
  29746. </para>
  29747. </remarks>
  29748. </member>
  29749. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  29750. <summary>
  29751. Writes a buffer to the underlying writer
  29752. </summary>
  29753. <param name="buffer">the buffer to write</param>
  29754. <param name="index">the start index to write from</param>
  29755. <param name="count">the number of characters to write</param>
  29756. <remarks>
  29757. <para>
  29758. Writes a buffer to the underlying writer
  29759. </para>
  29760. </remarks>
  29761. </member>
  29762. <member name="M:log4net.Util.QuietTextWriter.Write(System.String)">
  29763. <summary>
  29764. Writes a string to the output.
  29765. </summary>
  29766. <param name="value">The string data to write to the output.</param>
  29767. <remarks>
  29768. <para>
  29769. Writes a string to the output.
  29770. </para>
  29771. </remarks>
  29772. </member>
  29773. <member name="M:log4net.Util.QuietTextWriter.Close">
  29774. <summary>
  29775. Closes the underlying output writer.
  29776. </summary>
  29777. <remarks>
  29778. <para>
  29779. Closes the underlying output writer.
  29780. </para>
  29781. </remarks>
  29782. </member>
  29783. <member name="F:log4net.Util.QuietTextWriter.m_errorHandler">
  29784. <summary>
  29785. The error handler instance to pass all errors to
  29786. </summary>
  29787. </member>
  29788. <member name="F:log4net.Util.QuietTextWriter.m_closed">
  29789. <summary>
  29790. Flag to indicate if this writer is closed
  29791. </summary>
  29792. </member>
  29793. <member name="T:log4net.Util.ReaderWriterLock">
  29794. <summary>
  29795. Defines a lock that supports single writers and multiple readers
  29796. </summary>
  29797. <remarks>
  29798. <para>
  29799. <c>ReaderWriterLock</c> is used to synchronize access to a resource.
  29800. At any given time, it allows either concurrent read access for
  29801. multiple threads, or write access for a single thread. In a
  29802. situation where a resource is changed infrequently, a
  29803. <c>ReaderWriterLock</c> provides better throughput than a simple
  29804. one-at-a-time lock, such as <see cref="T:System.Threading.Monitor"/>.
  29805. </para>
  29806. <para>
  29807. If a platform does not support a <c>System.Threading.ReaderWriterLock</c>
  29808. implementation then all readers and writers are serialized. Therefore
  29809. the caller must not rely on multiple simultaneous readers.
  29810. </para>
  29811. </remarks>
  29812. <author>Nicko Cadell</author>
  29813. </member>
  29814. <member name="M:log4net.Util.ReaderWriterLock.#ctor">
  29815. <summary>
  29816. Constructor
  29817. </summary>
  29818. <remarks>
  29819. <para>
  29820. Initializes a new instance of the <see cref="T:log4net.Util.ReaderWriterLock" /> class.
  29821. </para>
  29822. </remarks>
  29823. </member>
  29824. <member name="M:log4net.Util.ReaderWriterLock.AcquireReaderLock">
  29825. <summary>
  29826. Acquires a reader lock
  29827. </summary>
  29828. <remarks>
  29829. <para>
  29830. <see cref="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"/> blocks if a different thread has the writer
  29831. lock, or if at least one thread is waiting for the writer lock.
  29832. </para>
  29833. </remarks>
  29834. </member>
  29835. <member name="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock">
  29836. <summary>
  29837. Decrements the lock count
  29838. </summary>
  29839. <remarks>
  29840. <para>
  29841. <see cref="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"/> decrements the lock count. When the count
  29842. reaches zero, the lock is released.
  29843. </para>
  29844. </remarks>
  29845. </member>
  29846. <member name="M:log4net.Util.ReaderWriterLock.AcquireWriterLock">
  29847. <summary>
  29848. Acquires the writer lock
  29849. </summary>
  29850. <remarks>
  29851. <para>
  29852. This method blocks if another thread has a reader lock or writer lock.
  29853. </para>
  29854. </remarks>
  29855. </member>
  29856. <member name="M:log4net.Util.ReaderWriterLock.ReleaseWriterLock">
  29857. <summary>
  29858. Decrements the lock count on the writer lock
  29859. </summary>
  29860. <remarks>
  29861. <para>
  29862. ReleaseWriterLock decrements the writer lock count.
  29863. When the count reaches zero, the writer lock is released.
  29864. </para>
  29865. </remarks>
  29866. </member>
  29867. <member name="T:log4net.Util.ReadOnlyPropertiesDictionary">
  29868. <summary>
  29869. String keyed object map that is read only.
  29870. </summary>
  29871. <remarks>
  29872. <para>
  29873. This collection is readonly and cannot be modified.
  29874. </para>
  29875. <para>
  29876. While this collection is serializable only member
  29877. objects that are serializable will
  29878. be serialized along with this collection.
  29879. </para>
  29880. </remarks>
  29881. <author>Nicko Cadell</author>
  29882. <author>Gert Driesen</author>
  29883. </member>
  29884. <member name="F:log4net.Util.ReadOnlyPropertiesDictionary.m_hashtable">
  29885. <summary>
  29886. The Hashtable used to store the properties data
  29887. </summary>
  29888. </member>
  29889. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor">
  29890. <summary>
  29891. Constructor
  29892. </summary>
  29893. <remarks>
  29894. <para>
  29895. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class.
  29896. </para>
  29897. </remarks>
  29898. </member>
  29899. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  29900. <summary>
  29901. Copy Constructor
  29902. </summary>
  29903. <param name="propertiesDictionary">properties to copy</param>
  29904. <remarks>
  29905. <para>
  29906. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class.
  29907. </para>
  29908. </remarks>
  29909. </member>
  29910. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29911. <summary>
  29912. Deserialization constructor
  29913. </summary>
  29914. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  29915. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  29916. <remarks>
  29917. <para>
  29918. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class
  29919. with serialized data.
  29920. </para>
  29921. </remarks>
  29922. </member>
  29923. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetKeys">
  29924. <summary>
  29925. Gets the key names.
  29926. </summary>
  29927. <returns>An array of all the keys.</returns>
  29928. <remarks>
  29929. <para>
  29930. Gets the key names.
  29931. </para>
  29932. </remarks>
  29933. </member>
  29934. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Item(System.String)">
  29935. <summary>
  29936. Gets or sets the value of the property with the specified key.
  29937. </summary>
  29938. <value>
  29939. The value of the property with the specified key.
  29940. </value>
  29941. <param name="key">The key of the property to get or set.</param>
  29942. <remarks>
  29943. <para>
  29944. The property value will only be serialized if it is serializable.
  29945. If it cannot be serialized it will be silently ignored if
  29946. a serialization operation is performed.
  29947. </para>
  29948. </remarks>
  29949. </member>
  29950. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Contains(System.String)">
  29951. <summary>
  29952. Test if the dictionary contains a specified key
  29953. </summary>
  29954. <param name="key">the key to look for</param>
  29955. <returns>true if the dictionary contains the specified key</returns>
  29956. <remarks>
  29957. <para>
  29958. Test if the dictionary contains a specified key
  29959. </para>
  29960. </remarks>
  29961. </member>
  29962. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.InnerHashtable">
  29963. <summary>
  29964. The hashtable used to store the properties
  29965. </summary>
  29966. <value>
  29967. The internal collection used to store the properties
  29968. </value>
  29969. <remarks>
  29970. <para>
  29971. The hashtable used to store the properties
  29972. </para>
  29973. </remarks>
  29974. </member>
  29975. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  29976. <summary>
  29977. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  29978. </summary>
  29979. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
  29980. <param name="context">The destination for this serialization.</param>
  29981. <remarks>
  29982. <para>
  29983. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  29984. </para>
  29985. </remarks>
  29986. </member>
  29987. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  29988. <summary>
  29989. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  29990. </summary>
  29991. </member>
  29992. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  29993. <summary>
  29994. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  29995. </summary>
  29996. <param name="key"></param>
  29997. </member>
  29998. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  29999. <summary>
  30000. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  30001. </summary>
  30002. <param name="key"></param>
  30003. <returns></returns>
  30004. </member>
  30005. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Clear">
  30006. <summary>
  30007. Remove all properties from the properties collection
  30008. </summary>
  30009. </member>
  30010. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  30011. <summary>
  30012. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  30013. </summary>
  30014. <param name="key"></param>
  30015. <param name="value"></param>
  30016. </member>
  30017. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  30018. <summary>
  30019. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  30020. </summary>
  30021. </member>
  30022. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  30023. <summary>
  30024. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  30025. </summary>
  30026. </member>
  30027. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Values">
  30028. <summary>
  30029. See <see cref="P:System.Collections.IDictionary.Values"/>
  30030. </summary>
  30031. </member>
  30032. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Keys">
  30033. <summary>
  30034. See <see cref="P:System.Collections.IDictionary.Keys"/>
  30035. </summary>
  30036. </member>
  30037. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  30038. <summary>
  30039. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  30040. </summary>
  30041. </member>
  30042. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  30043. <summary>
  30044. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  30045. </summary>
  30046. <param name="array"></param>
  30047. <param name="index"></param>
  30048. </member>
  30049. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  30050. <summary>
  30051. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  30052. </summary>
  30053. </member>
  30054. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Count">
  30055. <summary>
  30056. The number of properties in this collection
  30057. </summary>
  30058. </member>
  30059. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#SyncRoot">
  30060. <summary>
  30061. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  30062. </summary>
  30063. </member>
  30064. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  30065. <summary>
  30066. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  30067. </summary>
  30068. </member>
  30069. <member name="T:log4net.Util.ReusableStringWriter">
  30070. <summary>
  30071. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused
  30072. </summary>
  30073. <remarks>
  30074. <para>
  30075. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused.
  30076. This uses a single buffer for string operations.
  30077. </para>
  30078. </remarks>
  30079. <author>Nicko Cadell</author>
  30080. </member>
  30081. <member name="M:log4net.Util.ReusableStringWriter.#ctor(System.IFormatProvider)">
  30082. <summary>
  30083. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  30084. </summary>
  30085. <param name="formatProvider">the format provider to use</param>
  30086. <remarks>
  30087. <para>
  30088. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  30089. </para>
  30090. </remarks>
  30091. </member>
  30092. <member name="M:log4net.Util.ReusableStringWriter.Dispose(System.Boolean)">
  30093. <summary>
  30094. Override Dispose to prevent closing of writer
  30095. </summary>
  30096. <param name="disposing">flag</param>
  30097. <remarks>
  30098. <para>
  30099. Override Dispose to prevent closing of writer
  30100. </para>
  30101. </remarks>
  30102. </member>
  30103. <member name="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)">
  30104. <summary>
  30105. Reset this string writer so that it can be reused.
  30106. </summary>
  30107. <param name="maxCapacity">the maximum buffer capacity before it is trimmed</param>
  30108. <param name="defaultSize">the default size to make the buffer</param>
  30109. <remarks>
  30110. <para>
  30111. Reset this string writer so that it can be reused.
  30112. The internal buffers are cleared and reset.
  30113. </para>
  30114. </remarks>
  30115. </member>
  30116. <member name="T:log4net.Util.SystemInfo">
  30117. <summary>
  30118. Utility class for system specific information.
  30119. </summary>
  30120. <remarks>
  30121. <para>
  30122. Utility class of static methods for system specific information.
  30123. </para>
  30124. </remarks>
  30125. <author>Nicko Cadell</author>
  30126. <author>Gert Driesen</author>
  30127. <author>Alexey Solofnenko</author>
  30128. </member>
  30129. <member name="M:log4net.Util.SystemInfo.#ctor">
  30130. <summary>
  30131. Private constructor to prevent instances.
  30132. </summary>
  30133. <remarks>
  30134. <para>
  30135. Only static methods are exposed from this type.
  30136. </para>
  30137. </remarks>
  30138. </member>
  30139. <member name="M:log4net.Util.SystemInfo.#cctor">
  30140. <summary>
  30141. Initialize default values for private static fields.
  30142. </summary>
  30143. <remarks>
  30144. <para>
  30145. Only static methods are exposed from this type.
  30146. </para>
  30147. </remarks>
  30148. </member>
  30149. <member name="P:log4net.Util.SystemInfo.NewLine">
  30150. <summary>
  30151. Gets the system dependent line terminator.
  30152. </summary>
  30153. <value>
  30154. The system dependent line terminator.
  30155. </value>
  30156. <remarks>
  30157. <para>
  30158. Gets the system dependent line terminator.
  30159. </para>
  30160. </remarks>
  30161. </member>
  30162. <member name="P:log4net.Util.SystemInfo.ApplicationBaseDirectory">
  30163. <summary>
  30164. Gets the base directory for this <see cref="T:System.AppDomain"/>.
  30165. </summary>
  30166. <value>The base directory path for the current <see cref="T:System.AppDomain"/>.</value>
  30167. <remarks>
  30168. <para>
  30169. Gets the base directory for this <see cref="T:System.AppDomain"/>.
  30170. </para>
  30171. <para>
  30172. The value returned may be either a local file path or a URI.
  30173. </para>
  30174. </remarks>
  30175. </member>
  30176. <member name="P:log4net.Util.SystemInfo.ConfigurationFileLocation">
  30177. <summary>
  30178. Gets the path to the configuration file for the current <see cref="T:System.AppDomain"/>.
  30179. </summary>
  30180. <value>The path to the configuration file for the current <see cref="T:System.AppDomain"/>.</value>
  30181. <remarks>
  30182. <para>
  30183. The .NET Compact Framework 1.0 does not have a concept of a configuration
  30184. file. For this runtime, we use the entry assembly location as the root for
  30185. the configuration file name.
  30186. </para>
  30187. <para>
  30188. The value returned may be either a local file path or a URI.
  30189. </para>
  30190. </remarks>
  30191. </member>
  30192. <member name="P:log4net.Util.SystemInfo.EntryAssemblyLocation">
  30193. <summary>
  30194. Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
  30195. </summary>
  30196. <value>The path to the entry assembly.</value>
  30197. <remarks>
  30198. <para>
  30199. Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
  30200. </para>
  30201. </remarks>
  30202. </member>
  30203. <member name="P:log4net.Util.SystemInfo.CurrentThreadId">
  30204. <summary>
  30205. Gets the ID of the current thread.
  30206. </summary>
  30207. <value>The ID of the current thread.</value>
  30208. <remarks>
  30209. <para>
  30210. On the .NET framework, the <c>AppDomain.GetCurrentThreadId</c> method
  30211. is used to obtain the thread ID for the current thread. This is the
  30212. operating system ID for the thread.
  30213. </para>
  30214. <para>
  30215. On the .NET Compact Framework 1.0 it is not possible to get the
  30216. operating system thread ID for the current thread. The native method
  30217. <c>GetCurrentThreadId</c> is implemented inline in a header file
  30218. and cannot be called.
  30219. </para>
  30220. <para>
  30221. On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this
  30222. gives a stable id unrelated to the operating system thread ID which may
  30223. change if the runtime is using fibers.
  30224. </para>
  30225. </remarks>
  30226. </member>
  30227. <member name="P:log4net.Util.SystemInfo.HostName">
  30228. <summary>
  30229. Get the host name or machine name for the current machine
  30230. </summary>
  30231. <value>
  30232. The hostname or machine name
  30233. </value>
  30234. <remarks>
  30235. <para>
  30236. Get the host name or machine name for the current machine
  30237. </para>
  30238. <para>
  30239. The host name (<see cref="M:System.Net.Dns.GetHostName"/>) or
  30240. the machine name (<c>Environment.MachineName</c>) for
  30241. the current machine, or if neither of these are available
  30242. then <c>NOT AVAILABLE</c> is returned.
  30243. </para>
  30244. </remarks>
  30245. </member>
  30246. <member name="P:log4net.Util.SystemInfo.ApplicationFriendlyName">
  30247. <summary>
  30248. Get this application's friendly name
  30249. </summary>
  30250. <value>
  30251. The friendly name of this application as a string
  30252. </value>
  30253. <remarks>
  30254. <para>
  30255. If available the name of the application is retrieved from
  30256. the <c>AppDomain</c> using <c>AppDomain.CurrentDomain.FriendlyName</c>.
  30257. </para>
  30258. <para>
  30259. Otherwise the file name of the entry assembly is used.
  30260. </para>
  30261. </remarks>
  30262. </member>
  30263. <member name="P:log4net.Util.SystemInfo.ProcessStartTime">
  30264. <summary>
  30265. Get the start time for the current process.
  30266. </summary>
  30267. <remarks>
  30268. <para>
  30269. This is the time at which the log4net library was loaded into the
  30270. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  30271. this is not the start time for the current process.
  30272. </para>
  30273. <para>
  30274. The log4net library should be loaded by an application early during its
  30275. startup, therefore this start time should be a good approximation for
  30276. the actual start time.
  30277. </para>
  30278. <para>
  30279. Note that AppDomains may be loaded and unloaded within the
  30280. same process without the process terminating, however this start time
  30281. will be set per AppDomain.
  30282. </para>
  30283. </remarks>
  30284. </member>
  30285. <member name="P:log4net.Util.SystemInfo.ProcessStartTimeUtc">
  30286. <summary>
  30287. Get the UTC start time for the current process.
  30288. </summary>
  30289. <remarks>
  30290. <para>
  30291. This is the UTC time at which the log4net library was loaded into the
  30292. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  30293. this is not the start time for the current process.
  30294. </para>
  30295. <para>
  30296. The log4net library should be loaded by an application early during its
  30297. startup, therefore this start time should be a good approximation for
  30298. the actual start time.
  30299. </para>
  30300. <para>
  30301. Note that AppDomains may be loaded and unloaded within the
  30302. same process without the process terminating, however this start time
  30303. will be set per AppDomain.
  30304. </para>
  30305. </remarks>
  30306. </member>
  30307. <member name="P:log4net.Util.SystemInfo.NullText">
  30308. <summary>
  30309. Text to output when a <c>null</c> is encountered.
  30310. </summary>
  30311. <remarks>
  30312. <para>
  30313. Use this value to indicate a <c>null</c> has been encountered while
  30314. outputting a string representation of an item.
  30315. </para>
  30316. <para>
  30317. The default value is <c>(null)</c>. This value can be overridden by specifying
  30318. a value for the <c>log4net.NullText</c> appSetting in the application's
  30319. .config file.
  30320. </para>
  30321. </remarks>
  30322. </member>
  30323. <member name="P:log4net.Util.SystemInfo.NotAvailableText">
  30324. <summary>
  30325. Text to output when an unsupported feature is requested.
  30326. </summary>
  30327. <remarks>
  30328. <para>
  30329. Use this value when an unsupported feature is requested.
  30330. </para>
  30331. <para>
  30332. The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying
  30333. a value for the <c>log4net.NotAvailableText</c> appSetting in the application's
  30334. .config file.
  30335. </para>
  30336. </remarks>
  30337. </member>
  30338. <member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)">
  30339. <summary>
  30340. Gets the assembly location path for the specified assembly.
  30341. </summary>
  30342. <param name="myAssembly">The assembly to get the location for.</param>
  30343. <returns>The location of the assembly.</returns>
  30344. <remarks>
  30345. <para>
  30346. This method does not guarantee to return the correct path
  30347. to the assembly. If only tries to give an indication as to
  30348. where the assembly was loaded from.
  30349. </para>
  30350. </remarks>
  30351. </member>
  30352. <member name="M:log4net.Util.SystemInfo.AssemblyQualifiedName(System.Type)">
  30353. <summary>
  30354. Gets the fully qualified name of the <see cref="T:System.Type" />, including
  30355. the name of the assembly from which the <see cref="T:System.Type" /> was
  30356. loaded.
  30357. </summary>
  30358. <param name="type">The <see cref="T:System.Type" /> to get the fully qualified name for.</param>
  30359. <returns>The fully qualified name for the <see cref="T:System.Type" />.</returns>
  30360. <remarks>
  30361. <para>
  30362. This is equivalent to the <c>Type.AssemblyQualifiedName</c> property,
  30363. but this method works on the .NET Compact Framework 1.0 as well as
  30364. the full .NET runtime.
  30365. </para>
  30366. </remarks>
  30367. </member>
  30368. <member name="M:log4net.Util.SystemInfo.AssemblyShortName(System.Reflection.Assembly)">
  30369. <summary>
  30370. Gets the short name of the <see cref="T:System.Reflection.Assembly" />.
  30371. </summary>
  30372. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly" /> to get the name for.</param>
  30373. <returns>The short name of the <see cref="T:System.Reflection.Assembly" />.</returns>
  30374. <remarks>
  30375. <para>
  30376. The short name of the assembly is the <see cref="P:System.Reflection.Assembly.FullName" />
  30377. without the version, culture, or public key. i.e. it is just the
  30378. assembly's file name without the extension.
  30379. </para>
  30380. <para>
  30381. Use this rather than <c>Assembly.GetName().Name</c> because that
  30382. is not available on the Compact Framework.
  30383. </para>
  30384. <para>
  30385. Because of a FileIOPermission security demand we cannot do
  30386. the obvious Assembly.GetName().Name. We are allowed to get
  30387. the <see cref="P:System.Reflection.Assembly.FullName" /> of the assembly so we
  30388. start from there and strip out just the assembly name.
  30389. </para>
  30390. </remarks>
  30391. </member>
  30392. <member name="M:log4net.Util.SystemInfo.AssemblyFileName(System.Reflection.Assembly)">
  30393. <summary>
  30394. Gets the file name portion of the <see cref="T:System.Reflection.Assembly" />, including the extension.
  30395. </summary>
  30396. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly" /> to get the file name for.</param>
  30397. <returns>The file name of the assembly.</returns>
  30398. <remarks>
  30399. <para>
  30400. Gets the file name portion of the <see cref="T:System.Reflection.Assembly" />, including the extension.
  30401. </para>
  30402. </remarks>
  30403. </member>
  30404. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Type,System.String,System.Boolean,System.Boolean)">
  30405. <summary>
  30406. Loads the type specified in the type string.
  30407. </summary>
  30408. <param name="relativeType">A sibling type to use to load the type.</param>
  30409. <param name="typeName">The name of the type to load.</param>
  30410. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  30411. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  30412. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  30413. <remarks>
  30414. <para>
  30415. If the type name is fully qualified, i.e. if contains an assembly name in
  30416. the type name, the type will be loaded from the system using
  30417. <see cref="M:Type.GetType(string,bool)"/>.
  30418. </para>
  30419. <para>
  30420. If the type name is not fully qualified, it will be loaded from the assembly
  30421. containing the specified relative type. If the type is not found in the assembly
  30422. then all the loaded assemblies will be searched for the type.
  30423. </para>
  30424. </remarks>
  30425. </member>
  30426. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.String,System.Boolean,System.Boolean)">
  30427. <summary>
  30428. Loads the type specified in the type string.
  30429. </summary>
  30430. <param name="typeName">The name of the type to load.</param>
  30431. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  30432. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  30433. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  30434. <remarks>
  30435. <para>
  30436. If the type name is fully qualified, i.e. if contains an assembly name in
  30437. the type name, the type will be loaded from the system using
  30438. <see cref="M:Type.GetType(string,bool)"/>.
  30439. </para>
  30440. <para>
  30441. If the type name is not fully qualified it will be loaded from the
  30442. assembly that is directly calling this method. If the type is not found
  30443. in the assembly then all the loaded assemblies will be searched for the type.
  30444. </para>
  30445. </remarks>
  30446. </member>
  30447. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Reflection.Assembly,System.String,System.Boolean,System.Boolean)">
  30448. <summary>
  30449. Loads the type specified in the type string.
  30450. </summary>
  30451. <param name="relativeAssembly">An assembly to load the type from.</param>
  30452. <param name="typeName">The name of the type to load.</param>
  30453. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  30454. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  30455. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  30456. <remarks>
  30457. <para>
  30458. If the type name is fully qualified, i.e. if contains an assembly name in
  30459. the type name, the type will be loaded from the system using
  30460. <see cref="M:Type.GetType(string,bool)"/>.
  30461. </para>
  30462. <para>
  30463. If the type name is not fully qualified it will be loaded from the specified
  30464. assembly. If the type is not found in the assembly then all the loaded assemblies
  30465. will be searched for the type.
  30466. </para>
  30467. </remarks>
  30468. </member>
  30469. <member name="M:log4net.Util.SystemInfo.NewGuid">
  30470. <summary>
  30471. Generate a new guid
  30472. </summary>
  30473. <returns>A new Guid</returns>
  30474. <remarks>
  30475. <para>
  30476. Generate a new guid
  30477. </para>
  30478. </remarks>
  30479. </member>
  30480. <member name="M:log4net.Util.SystemInfo.CreateArgumentOutOfRangeException(System.String,System.Object,System.String)">
  30481. <summary>
  30482. Create an <see cref="T:System.ArgumentOutOfRangeException"/>
  30483. </summary>
  30484. <param name="parameterName">The name of the parameter that caused the exception</param>
  30485. <param name="actualValue">The value of the argument that causes this exception</param>
  30486. <param name="message">The message that describes the error</param>
  30487. <returns>the ArgumentOutOfRangeException object</returns>
  30488. <remarks>
  30489. <para>
  30490. Create a new instance of the <see cref="T:System.ArgumentOutOfRangeException"/> class
  30491. with a specified error message, the parameter name, and the value
  30492. of the argument.
  30493. </para>
  30494. <para>
  30495. The Compact Framework does not support the 3 parameter constructor for the
  30496. <see cref="T:System.ArgumentOutOfRangeException"/> type. This method provides an
  30497. implementation that works for all platforms.
  30498. </para>
  30499. </remarks>
  30500. </member>
  30501. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int32@)">
  30502. <summary>
  30503. Parse a string into an <see cref="T:System.Int32"/> value
  30504. </summary>
  30505. <param name="s">the string to parse</param>
  30506. <param name="val">out param where the parsed value is placed</param>
  30507. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  30508. <remarks>
  30509. <para>
  30510. Attempts to parse the string into an integer. If the string cannot
  30511. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  30512. </para>
  30513. </remarks>
  30514. </member>
  30515. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int64@)">
  30516. <summary>
  30517. Parse a string into an <see cref="T:System.Int64"/> value
  30518. </summary>
  30519. <param name="s">the string to parse</param>
  30520. <param name="val">out param where the parsed value is placed</param>
  30521. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  30522. <remarks>
  30523. <para>
  30524. Attempts to parse the string into an integer. If the string cannot
  30525. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  30526. </para>
  30527. </remarks>
  30528. </member>
  30529. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int16@)">
  30530. <summary>
  30531. Parse a string into an <see cref="T:System.Int16"/> value
  30532. </summary>
  30533. <param name="s">the string to parse</param>
  30534. <param name="val">out param where the parsed value is placed</param>
  30535. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  30536. <remarks>
  30537. <para>
  30538. Attempts to parse the string into an integer. If the string cannot
  30539. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  30540. </para>
  30541. </remarks>
  30542. </member>
  30543. <member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)">
  30544. <summary>
  30545. Lookup an application setting
  30546. </summary>
  30547. <param name="key">the application settings key to lookup</param>
  30548. <returns>the value for the key, or <c>null</c></returns>
  30549. <remarks>
  30550. <para>
  30551. Configuration APIs are not supported under the Compact Framework
  30552. </para>
  30553. </remarks>
  30554. </member>
  30555. <member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)">
  30556. <summary>
  30557. Convert a path into a fully qualified local file path.
  30558. </summary>
  30559. <param name="path">The path to convert.</param>
  30560. <returns>The fully qualified path.</returns>
  30561. <remarks>
  30562. <para>
  30563. Converts the path specified to a fully
  30564. qualified path. If the path is relative it is
  30565. taken as relative from the application base
  30566. directory.
  30567. </para>
  30568. <para>
  30569. The path specified must be a local file path, a URI is not supported.
  30570. </para>
  30571. </remarks>
  30572. </member>
  30573. <member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable">
  30574. <summary>
  30575. Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity.
  30576. </summary>
  30577. <returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns>
  30578. <remarks>
  30579. <para>
  30580. The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer.
  30581. </para>
  30582. </remarks>
  30583. </member>
  30584. <member name="M:log4net.Util.SystemInfo.EqualsIgnoringCase(System.String,System.String)">
  30585. <summary>
  30586. Tests two strings for equality, the ignoring case.
  30587. </summary>
  30588. <remarks>
  30589. If the platform permits, culture information is ignored completely (ordinal comparison).
  30590. The aim of this method is to provide a fast comparison that deals with <c>null</c> and ignores different casing.
  30591. It is not supposed to deal with various, culture-specific habits.
  30592. Use it to compare against pure ASCII constants, like keywords etc.
  30593. </remarks>
  30594. <param name="a">The one string.</param>
  30595. <param name="b">The other string.</param>
  30596. <returns><c>true</c> if the strings are equal, <c>false</c> otherwise.</returns>
  30597. </member>
  30598. <member name="F:log4net.Util.SystemInfo.EmptyTypes">
  30599. <summary>
  30600. Gets an empty array of types.
  30601. </summary>
  30602. <remarks>
  30603. <para>
  30604. The <c>Type.EmptyTypes</c> field is not available on
  30605. the .NET Compact Framework 1.0.
  30606. </para>
  30607. </remarks>
  30608. </member>
  30609. <member name="F:log4net.Util.SystemInfo.declaringType">
  30610. <summary>
  30611. The fully qualified type of the SystemInfo class.
  30612. </summary>
  30613. <remarks>
  30614. Used by the internal logger to record the Type of the
  30615. log message.
  30616. </remarks>
  30617. </member>
  30618. <member name="F:log4net.Util.SystemInfo.s_hostName">
  30619. <summary>
  30620. Cache the host name for the current machine
  30621. </summary>
  30622. </member>
  30623. <member name="F:log4net.Util.SystemInfo.s_appFriendlyName">
  30624. <summary>
  30625. Cache the application friendly name
  30626. </summary>
  30627. </member>
  30628. <member name="F:log4net.Util.SystemInfo.s_nullText">
  30629. <summary>
  30630. Text to output when a <c>null</c> is encountered.
  30631. </summary>
  30632. </member>
  30633. <member name="F:log4net.Util.SystemInfo.s_notAvailableText">
  30634. <summary>
  30635. Text to output when an unsupported feature is requested.
  30636. </summary>
  30637. </member>
  30638. <member name="F:log4net.Util.SystemInfo.s_processStartTimeUtc">
  30639. <summary>
  30640. Start time for the current process.
  30641. </summary>
  30642. </member>
  30643. <member name="T:log4net.Util.SystemStringFormat">
  30644. <summary>
  30645. Utility class that represents a format string.
  30646. </summary>
  30647. <remarks>
  30648. <para>
  30649. Utility class that represents a format string.
  30650. </para>
  30651. </remarks>
  30652. <author>Nicko Cadell</author>
  30653. </member>
  30654. <member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])">
  30655. <summary>
  30656. Initialise the <see cref="T:log4net.Util.SystemStringFormat"/>
  30657. </summary>
  30658. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  30659. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  30660. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  30661. </member>
  30662. <member name="M:log4net.Util.SystemStringFormat.ToString">
  30663. <summary>
  30664. Format the string and arguments
  30665. </summary>
  30666. <returns>the formatted string</returns>
  30667. </member>
  30668. <member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])">
  30669. <summary>
  30670. Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent
  30671. of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array.
  30672. A specified parameter supplies culture-specific formatting information.
  30673. </summary>
  30674. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  30675. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  30676. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  30677. <returns>
  30678. A copy of format in which the format items have been replaced by the <see cref="T:System.String"/>
  30679. equivalent of the corresponding instances of <see cref="T:System.Object"/> in args.
  30680. </returns>
  30681. <remarks>
  30682. <para>
  30683. This method does not throw exceptions. If an exception thrown while formatting the result the
  30684. exception and arguments are returned in the result string.
  30685. </para>
  30686. </remarks>
  30687. </member>
  30688. <member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])">
  30689. <summary>
  30690. Process an error during StringFormat
  30691. </summary>
  30692. </member>
  30693. <member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)">
  30694. <summary>
  30695. Dump the contents of an array into a string builder
  30696. </summary>
  30697. </member>
  30698. <member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)">
  30699. <summary>
  30700. Dump an object to a string
  30701. </summary>
  30702. </member>
  30703. <member name="F:log4net.Util.SystemStringFormat.declaringType">
  30704. <summary>
  30705. The fully qualified type of the SystemStringFormat class.
  30706. </summary>
  30707. <remarks>
  30708. Used by the internal logger to record the Type of the
  30709. log message.
  30710. </remarks>
  30711. </member>
  30712. <member name="T:log4net.Util.TextWriterAdapter">
  30713. <summary>
  30714. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  30715. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  30716. </summary>
  30717. <remarks>
  30718. <para>
  30719. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  30720. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  30721. </para>
  30722. </remarks>
  30723. <author>Nicko Cadell</author>
  30724. </member>
  30725. <member name="F:log4net.Util.TextWriterAdapter.m_writer">
  30726. <summary>
  30727. The writer to forward messages to
  30728. </summary>
  30729. </member>
  30730. <member name="M:log4net.Util.TextWriterAdapter.#ctor(System.IO.TextWriter)">
  30731. <summary>
  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. </summary>
  30735. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to forward to</param>
  30736. <remarks>
  30737. <para>
  30738. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  30739. messages to a <see cref="T:System.IO.TextWriter"/>.
  30740. </para>
  30741. </remarks>
  30742. </member>
  30743. <member name="P:log4net.Util.TextWriterAdapter.Writer">
  30744. <summary>
  30745. Gets or sets the underlying <see cref="T:System.IO.TextWriter" />.
  30746. </summary>
  30747. <value>
  30748. The underlying <see cref="T:System.IO.TextWriter" />.
  30749. </value>
  30750. <remarks>
  30751. <para>
  30752. Gets or sets the underlying <see cref="T:System.IO.TextWriter" />.
  30753. </para>
  30754. </remarks>
  30755. </member>
  30756. <member name="P:log4net.Util.TextWriterAdapter.Encoding">
  30757. <summary>
  30758. The Encoding in which the output is written
  30759. </summary>
  30760. <value>
  30761. The <see cref="P:log4net.Util.TextWriterAdapter.Encoding"/>
  30762. </value>
  30763. <remarks>
  30764. <para>
  30765. The Encoding in which the output is written
  30766. </para>
  30767. </remarks>
  30768. </member>
  30769. <member name="P:log4net.Util.TextWriterAdapter.FormatProvider">
  30770. <summary>
  30771. Gets an object that controls formatting
  30772. </summary>
  30773. <value>
  30774. The format provider
  30775. </value>
  30776. <remarks>
  30777. <para>
  30778. Gets an object that controls formatting
  30779. </para>
  30780. </remarks>
  30781. </member>
  30782. <member name="P:log4net.Util.TextWriterAdapter.NewLine">
  30783. <summary>
  30784. Gets or sets the line terminator string used by the TextWriter
  30785. </summary>
  30786. <value>
  30787. The line terminator to use
  30788. </value>
  30789. <remarks>
  30790. <para>
  30791. Gets or sets the line terminator string used by the TextWriter
  30792. </para>
  30793. </remarks>
  30794. </member>
  30795. <member name="M:log4net.Util.TextWriterAdapter.Close">
  30796. <summary>
  30797. Closes the writer and releases any system resources associated with the writer
  30798. </summary>
  30799. <remarks>
  30800. <para>
  30801. </para>
  30802. </remarks>
  30803. </member>
  30804. <member name="M:log4net.Util.TextWriterAdapter.Dispose(System.Boolean)">
  30805. <summary>
  30806. Dispose this writer
  30807. </summary>
  30808. <param name="disposing">flag indicating if we are being disposed</param>
  30809. <remarks>
  30810. <para>
  30811. Dispose this writer
  30812. </para>
  30813. </remarks>
  30814. </member>
  30815. <member name="M:log4net.Util.TextWriterAdapter.Flush">
  30816. <summary>
  30817. Flushes any buffered output
  30818. </summary>
  30819. <remarks>
  30820. <para>
  30821. Clears all buffers for the writer and causes any buffered data to be written
  30822. to the underlying device
  30823. </para>
  30824. </remarks>
  30825. </member>
  30826. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char)">
  30827. <summary>
  30828. Writes a character to the wrapped TextWriter
  30829. </summary>
  30830. <param name="value">the value to write to the TextWriter</param>
  30831. <remarks>
  30832. <para>
  30833. Writes a character to the wrapped TextWriter
  30834. </para>
  30835. </remarks>
  30836. </member>
  30837. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char[],System.Int32,System.Int32)">
  30838. <summary>
  30839. Writes a character buffer to the wrapped TextWriter
  30840. </summary>
  30841. <param name="buffer">the data buffer</param>
  30842. <param name="index">the start index</param>
  30843. <param name="count">the number of characters to write</param>
  30844. <remarks>
  30845. <para>
  30846. Writes a character buffer to the wrapped TextWriter
  30847. </para>
  30848. </remarks>
  30849. </member>
  30850. <member name="M:log4net.Util.TextWriterAdapter.Write(System.String)">
  30851. <summary>
  30852. Writes a string to the wrapped TextWriter
  30853. </summary>
  30854. <param name="value">the value to write to the TextWriter</param>
  30855. <remarks>
  30856. <para>
  30857. Writes a string to the wrapped TextWriter
  30858. </para>
  30859. </remarks>
  30860. </member>
  30861. <member name="T:log4net.Util.ThreadContextProperties">
  30862. <summary>
  30863. Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/>
  30864. </summary>
  30865. <remarks>
  30866. <para>
  30867. Class implements a collection of properties that is specific to each thread.
  30868. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  30869. </para>
  30870. </remarks>
  30871. <author>Nicko Cadell</author>
  30872. </member>
  30873. <member name="F:log4net.Util.ThreadContextProperties._dictionary">
  30874. <summary>
  30875. Each thread will automatically have its instance.
  30876. </summary>
  30877. </member>
  30878. <member name="M:log4net.Util.ThreadContextProperties.#ctor">
  30879. <summary>
  30880. Internal constructor
  30881. </summary>
  30882. <remarks>
  30883. <para>
  30884. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextProperties" /> class.
  30885. </para>
  30886. </remarks>
  30887. </member>
  30888. <member name="P:log4net.Util.ThreadContextProperties.Item(System.String)">
  30889. <summary>
  30890. Gets or sets the value of a property
  30891. </summary>
  30892. <value>
  30893. The value for the property with the specified key
  30894. </value>
  30895. <remarks>
  30896. <para>
  30897. Gets or sets the value of a property
  30898. </para>
  30899. </remarks>
  30900. </member>
  30901. <member name="M:log4net.Util.ThreadContextProperties.Remove(System.String)">
  30902. <summary>
  30903. Remove a property
  30904. </summary>
  30905. <param name="key">the key for the entry to remove</param>
  30906. <remarks>
  30907. <para>
  30908. Remove a property
  30909. </para>
  30910. </remarks>
  30911. </member>
  30912. <member name="M:log4net.Util.ThreadContextProperties.GetKeys">
  30913. <summary>
  30914. Get the keys stored in the properties.
  30915. </summary>
  30916. <para>
  30917. Gets the keys stored in the properties.
  30918. </para>
  30919. <returns>a set of the defined keys</returns>
  30920. </member>
  30921. <member name="M:log4net.Util.ThreadContextProperties.Clear">
  30922. <summary>
  30923. Clear all properties
  30924. </summary>
  30925. <remarks>
  30926. <para>
  30927. Clear all properties
  30928. </para>
  30929. </remarks>
  30930. </member>
  30931. <member name="M:log4net.Util.ThreadContextProperties.GetProperties(System.Boolean)">
  30932. <summary>
  30933. Get the <c>PropertiesDictionary</c> for this thread.
  30934. </summary>
  30935. <param name="create">create the dictionary if it does not exist, otherwise return null if does not exist</param>
  30936. <returns>the properties for this thread</returns>
  30937. <remarks>
  30938. <para>
  30939. The collection returned is only to be used on the calling thread. If the
  30940. caller needs to share the collection between different threads then the
  30941. caller must clone the collection before doing so.
  30942. </para>
  30943. </remarks>
  30944. </member>
  30945. <member name="T:log4net.Util.ThreadContextStack">
  30946. <summary>
  30947. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  30948. </summary>
  30949. <remarks>
  30950. <para>
  30951. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  30952. </para>
  30953. </remarks>
  30954. <author>Nicko Cadell</author>
  30955. </member>
  30956. <member name="F:log4net.Util.ThreadContextStack.m_stack">
  30957. <summary>
  30958. The stack store.
  30959. </summary>
  30960. </member>
  30961. <member name="M:log4net.Util.ThreadContextStack.#ctor">
  30962. <summary>
  30963. Internal constructor
  30964. </summary>
  30965. <remarks>
  30966. <para>
  30967. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack" /> class.
  30968. </para>
  30969. </remarks>
  30970. </member>
  30971. <member name="P:log4net.Util.ThreadContextStack.Count">
  30972. <summary>
  30973. The number of messages in the stack
  30974. </summary>
  30975. <value>
  30976. The current number of messages in the stack
  30977. </value>
  30978. <remarks>
  30979. <para>
  30980. The current number of messages in the stack. That is
  30981. the number of times <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> has been called
  30982. minus the number of times <see cref="M:log4net.Util.ThreadContextStack.Pop"/> has been called.
  30983. </para>
  30984. </remarks>
  30985. </member>
  30986. <member name="M:log4net.Util.ThreadContextStack.Clear">
  30987. <summary>
  30988. Clears all the contextual information held in this stack.
  30989. </summary>
  30990. <remarks>
  30991. <para>
  30992. Clears all the contextual information held in this stack.
  30993. Only call this if you think that this tread is being reused after
  30994. a previous call execution which may not have completed correctly.
  30995. You do not need to use this method if you always guarantee to call
  30996. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  30997. returned from <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  30998. for example by using the <c>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  30999. syntax.
  31000. </para>
  31001. </remarks>
  31002. </member>
  31003. <member name="M:log4net.Util.ThreadContextStack.Pop">
  31004. <summary>
  31005. Removes the top context from this stack.
  31006. </summary>
  31007. <returns>The message in the context that was removed from the top of this stack.</returns>
  31008. <remarks>
  31009. <para>
  31010. Remove the top context from this stack, and return
  31011. it to the caller. If this stack is empty then an
  31012. empty string (not <see langword="null"/>) is returned.
  31013. </para>
  31014. </remarks>
  31015. </member>
  31016. <member name="M:log4net.Util.ThreadContextStack.Push(System.String)">
  31017. <summary>
  31018. Pushes a new context message into this stack.
  31019. </summary>
  31020. <param name="message">The new context message.</param>
  31021. <returns>
  31022. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  31023. </returns>
  31024. <remarks>
  31025. <para>
  31026. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  31027. is returned that can be used to clean up this stack. This
  31028. can be easily combined with the <c>using</c> keyword to scope the
  31029. context.
  31030. </para>
  31031. </remarks>
  31032. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  31033. <code lang="C#">
  31034. using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
  31035. {
  31036. log.Warn("This should have an ThreadContext Stack message");
  31037. }
  31038. </code>
  31039. </example>
  31040. </member>
  31041. <member name="M:log4net.Util.ThreadContextStack.GetFullMessage">
  31042. <summary>
  31043. Gets the current context information for this stack.
  31044. </summary>
  31045. <returns>The current context information.</returns>
  31046. </member>
  31047. <member name="P:log4net.Util.ThreadContextStack.InternalStack">
  31048. <summary>
  31049. Gets and sets the internal stack used by this <see cref="T:log4net.Util.ThreadContextStack"/>
  31050. </summary>
  31051. <value>The internal storage stack</value>
  31052. <remarks>
  31053. <para>
  31054. This property is provided only to support backward compatability
  31055. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  31056. be modified.
  31057. </para>
  31058. </remarks>
  31059. </member>
  31060. <member name="M:log4net.Util.ThreadContextStack.ToString">
  31061. <summary>
  31062. Gets the current context information for this stack.
  31063. </summary>
  31064. <returns>Gets the current context information</returns>
  31065. <remarks>
  31066. <para>
  31067. Gets the current context information for this stack.
  31068. </para>
  31069. </remarks>
  31070. </member>
  31071. <member name="M:log4net.Util.ThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  31072. <summary>
  31073. Get a portable version of this object
  31074. </summary>
  31075. <returns>the portable instance of this object</returns>
  31076. <remarks>
  31077. <para>
  31078. Get a cross thread portable version of this object
  31079. </para>
  31080. </remarks>
  31081. </member>
  31082. <member name="T:log4net.Util.ThreadContextStack.StackFrame">
  31083. <summary>
  31084. Inner class used to represent a single context frame in the stack.
  31085. </summary>
  31086. <remarks>
  31087. <para>
  31088. Inner class used to represent a single context frame in the stack.
  31089. </para>
  31090. </remarks>
  31091. </member>
  31092. <member name="M:log4net.Util.ThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.ThreadContextStack.StackFrame)">
  31093. <summary>
  31094. Constructor
  31095. </summary>
  31096. <param name="message">The message for this context.</param>
  31097. <param name="parent">The parent context in the chain.</param>
  31098. <remarks>
  31099. <para>
  31100. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.StackFrame" /> class
  31101. with the specified message and parent context.
  31102. </para>
  31103. </remarks>
  31104. </member>
  31105. <member name="P:log4net.Util.ThreadContextStack.StackFrame.Message">
  31106. <summary>
  31107. Get the message.
  31108. </summary>
  31109. <value>The message.</value>
  31110. <remarks>
  31111. <para>
  31112. Get the message.
  31113. </para>
  31114. </remarks>
  31115. </member>
  31116. <member name="P:log4net.Util.ThreadContextStack.StackFrame.FullMessage">
  31117. <summary>
  31118. Gets the full text of the context down to the root level.
  31119. </summary>
  31120. <value>
  31121. The full text of the context down to the root level.
  31122. </value>
  31123. <remarks>
  31124. <para>
  31125. Gets the full text of the context down to the root level.
  31126. </para>
  31127. </remarks>
  31128. </member>
  31129. <member name="T:log4net.Util.ThreadContextStack.AutoPopStackFrame">
  31130. <summary>
  31131. Struct returned from the <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> method.
  31132. </summary>
  31133. <remarks>
  31134. <para>
  31135. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  31136. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  31137. </para>
  31138. </remarks>
  31139. </member>
  31140. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameStack">
  31141. <summary>
  31142. The ThreadContextStack internal stack
  31143. </summary>
  31144. </member>
  31145. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameDepth">
  31146. <summary>
  31147. The depth to trim the stack to when this instance is disposed
  31148. </summary>
  31149. </member>
  31150. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.#ctor(System.Collections.Stack,System.Int32)">
  31151. <summary>
  31152. Constructor
  31153. </summary>
  31154. <param name="frameStack">The internal stack used by the ThreadContextStack.</param>
  31155. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  31156. <remarks>
  31157. <para>
  31158. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.AutoPopStackFrame" /> class with
  31159. the specified stack and return depth.
  31160. </para>
  31161. </remarks>
  31162. </member>
  31163. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.Dispose">
  31164. <summary>
  31165. Returns the stack to the correct depth.
  31166. </summary>
  31167. <remarks>
  31168. <para>
  31169. Returns the stack to the correct depth.
  31170. </para>
  31171. </remarks>
  31172. </member>
  31173. <member name="T:log4net.Util.ThreadContextStacks">
  31174. <summary>
  31175. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  31176. </summary>
  31177. <remarks>
  31178. <para>
  31179. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  31180. </para>
  31181. </remarks>
  31182. <author>Nicko Cadell</author>
  31183. </member>
  31184. <member name="M:log4net.Util.ThreadContextStacks.#ctor(log4net.Util.ContextPropertiesBase)">
  31185. <summary>
  31186. Internal constructor
  31187. </summary>
  31188. <remarks>
  31189. <para>
  31190. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks" /> class.
  31191. </para>
  31192. </remarks>
  31193. </member>
  31194. <member name="P:log4net.Util.ThreadContextStacks.Item(System.String)">
  31195. <summary>
  31196. Gets the named thread context stack
  31197. </summary>
  31198. <value>
  31199. The named stack
  31200. </value>
  31201. <remarks>
  31202. <para>
  31203. Gets the named thread context stack
  31204. </para>
  31205. </remarks>
  31206. </member>
  31207. <member name="F:log4net.Util.ThreadContextStacks.declaringType">
  31208. <summary>
  31209. The fully qualified type of the ThreadContextStacks class.
  31210. </summary>
  31211. <remarks>
  31212. Used by the internal logger to record the Type of the
  31213. log message.
  31214. </remarks>
  31215. </member>
  31216. <member name="T:log4net.Util.Transform">
  31217. <summary>
  31218. Utility class for transforming strings.
  31219. </summary>
  31220. <remarks>
  31221. <para>
  31222. Utility class for transforming strings.
  31223. </para>
  31224. </remarks>
  31225. <author>Nicko Cadell</author>
  31226. <author>Gert Driesen</author>
  31227. </member>
  31228. <member name="M:log4net.Util.Transform.#ctor">
  31229. <summary>
  31230. Initializes a new instance of the <see cref="T:log4net.Util.Transform" /> class.
  31231. </summary>
  31232. <remarks>
  31233. <para>
  31234. Uses a private access modifier to prevent instantiation of this class.
  31235. </para>
  31236. </remarks>
  31237. </member>
  31238. <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)">
  31239. <summary>
  31240. Write a string to an <see cref="T:System.Xml.XmlWriter"/>
  31241. </summary>
  31242. <param name="writer">the writer to write to</param>
  31243. <param name="textData">the string to write</param>
  31244. <param name="invalidCharReplacement">The string to replace non XML compliant chars with</param>
  31245. <remarks>
  31246. <para>
  31247. The test is escaped either using XML escape entities
  31248. or using CDATA sections.
  31249. </para>
  31250. </remarks>
  31251. </member>
  31252. <member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)">
  31253. <summary>
  31254. Replace invalid XML characters in text string
  31255. </summary>
  31256. <param name="textData">the XML text input string</param>
  31257. <param name="mask">the string to use in place of invalid characters</param>
  31258. <returns>A string that does not contain invalid XML characters.</returns>
  31259. <remarks>
  31260. <para>
  31261. Certain Unicode code points are not allowed in the XML InfoSet, for
  31262. details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>.
  31263. </para>
  31264. <para>
  31265. This method replaces any illegal characters in the input string
  31266. with the mask string specified.
  31267. </para>
  31268. </remarks>
  31269. </member>
  31270. <member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)">
  31271. <summary>
  31272. Count the number of times that the substring occurs in the text
  31273. </summary>
  31274. <param name="text">the text to search</param>
  31275. <param name="substring">the substring to find</param>
  31276. <returns>the number of times the substring occurs in the text</returns>
  31277. <remarks>
  31278. <para>
  31279. The substring is assumed to be non repeating within itself.
  31280. </para>
  31281. </remarks>
  31282. </member>
  31283. <member name="F:log4net.Util.Transform.INVALIDCHARS">
  31284. <summary>
  31285. Characters illegal in XML 1.0
  31286. </summary>
  31287. </member>
  31288. <member name="T:log4net.Util.TypeConverters.BooleanConverter">
  31289. <summary>
  31290. Type converter for Boolean.
  31291. </summary>
  31292. <remarks>
  31293. <para>
  31294. Supports conversion from string to <c>bool</c> type.
  31295. </para>
  31296. </remarks>
  31297. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31298. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31299. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31300. <author>Nicko Cadell</author>
  31301. <author>Gert Driesen</author>
  31302. </member>
  31303. <member name="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)">
  31304. <summary>
  31305. Can the source type be converted to the type supported by this object
  31306. </summary>
  31307. <param name="sourceType">the type to convert</param>
  31308. <returns>true if the conversion is possible</returns>
  31309. <remarks>
  31310. <para>
  31311. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31312. the <see cref="T:System.String"/> type.
  31313. </para>
  31314. </remarks>
  31315. </member>
  31316. <member name="M:log4net.Util.TypeConverters.BooleanConverter.ConvertFrom(System.Object)">
  31317. <summary>
  31318. Convert the source object to the type supported by this object
  31319. </summary>
  31320. <param name="source">the object to convert</param>
  31321. <returns>the converted object</returns>
  31322. <remarks>
  31323. <para>
  31324. Uses the <see cref="M:System.Boolean.Parse(System.String)"/> method to convert the
  31325. <see cref="T:System.String"/> argument to a <see cref="T:System.Boolean"/>.
  31326. </para>
  31327. </remarks>
  31328. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31329. The <paramref name="source"/> object cannot be converted to the
  31330. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"/>
  31331. method.
  31332. </exception>
  31333. </member>
  31334. <member name="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31335. <summary>
  31336. Exception base type for conversion errors.
  31337. </summary>
  31338. <remarks>
  31339. <para>
  31340. This type extends <see cref="T:System.ApplicationException"/>. It
  31341. does not add any new functionality but does differentiate the
  31342. type of exception being thrown.
  31343. </para>
  31344. </remarks>
  31345. <author>Nicko Cadell</author>
  31346. <author>Gert Driesen</author>
  31347. </member>
  31348. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor">
  31349. <summary>
  31350. Constructor
  31351. </summary>
  31352. <remarks>
  31353. <para>
  31354. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  31355. </para>
  31356. </remarks>
  31357. </member>
  31358. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String)">
  31359. <summary>
  31360. Constructor
  31361. </summary>
  31362. <param name="message">A message to include with the exception.</param>
  31363. <remarks>
  31364. <para>
  31365. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class
  31366. with the specified message.
  31367. </para>
  31368. </remarks>
  31369. </member>
  31370. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String,System.Exception)">
  31371. <summary>
  31372. Constructor
  31373. </summary>
  31374. <param name="message">A message to include with the exception.</param>
  31375. <param name="innerException">A nested exception to include.</param>
  31376. <remarks>
  31377. <para>
  31378. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class
  31379. with the specified message and inner exception.
  31380. </para>
  31381. </remarks>
  31382. </member>
  31383. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  31384. <summary>
  31385. Serialization constructor
  31386. </summary>
  31387. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
  31388. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  31389. <remarks>
  31390. <para>
  31391. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class
  31392. with serialized data.
  31393. </para>
  31394. </remarks>
  31395. </member>
  31396. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object)">
  31397. <summary>
  31398. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  31399. </summary>
  31400. <param name="destinationType">The conversion destination type.</param>
  31401. <param name="sourceValue">The value to convert.</param>
  31402. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" />.</returns>
  31403. <remarks>
  31404. <para>
  31405. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  31406. </para>
  31407. </remarks>
  31408. </member>
  31409. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object,System.Exception)">
  31410. <summary>
  31411. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  31412. </summary>
  31413. <param name="destinationType">The conversion destination type.</param>
  31414. <param name="sourceValue">The value to convert.</param>
  31415. <param name="innerException">A nested exception to include.</param>
  31416. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" />.</returns>
  31417. <remarks>
  31418. <para>
  31419. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  31420. </para>
  31421. </remarks>
  31422. </member>
  31423. <member name="T:log4net.Util.TypeConverters.ConverterRegistry">
  31424. <summary>
  31425. Register of type converters for specific types.
  31426. </summary>
  31427. <remarks>
  31428. <para>
  31429. Maintains a registry of type converters used to convert between
  31430. types.
  31431. </para>
  31432. <para>
  31433. Use the <see cref="M:AddConverter(Type, object)"/> and
  31434. <see cref="M:AddConverter(Type, Type)"/> methods to register new converters.
  31435. 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
  31436. lookup appropriate converters to use.
  31437. </para>
  31438. </remarks>
  31439. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31440. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31441. <author>Nicko Cadell</author>
  31442. <author>Gert Driesen</author>
  31443. </member>
  31444. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#ctor">
  31445. <summary>
  31446. Private constructor
  31447. </summary>
  31448. <remarks>
  31449. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConverterRegistry" /> class.
  31450. </remarks>
  31451. </member>
  31452. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#cctor">
  31453. <summary>
  31454. Static constructor.
  31455. </summary>
  31456. <remarks>
  31457. <para>
  31458. This constructor defines the intrinsic type converters.
  31459. </para>
  31460. </remarks>
  31461. </member>
  31462. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)">
  31463. <summary>
  31464. Adds a converter for a specific type.
  31465. </summary>
  31466. <param name="destinationType">The type being converted to.</param>
  31467. <param name="converter">The type converter to use to convert to the destination type.</param>
  31468. <remarks>
  31469. <para>
  31470. Adds a converter instance for a specific type.
  31471. </para>
  31472. </remarks>
  31473. </member>
  31474. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)">
  31475. <summary>
  31476. Adds a converter for a specific type.
  31477. </summary>
  31478. <param name="destinationType">The type being converted to.</param>
  31479. <param name="converterType">The type of the type converter to use to convert to the destination type.</param>
  31480. <remarks>
  31481. <para>
  31482. Adds a converter <see cref="T:System.Type"/> for a specific type.
  31483. </para>
  31484. </remarks>
  31485. </member>
  31486. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)">
  31487. <summary>
  31488. Gets the type converter to use to convert values to the destination type.
  31489. </summary>
  31490. <param name="sourceType">The type being converted from.</param>
  31491. <param name="destinationType">The type being converted to.</param>
  31492. <returns>
  31493. The type converter instance to use for type conversions or <c>null</c>
  31494. if no type converter is found.
  31495. </returns>
  31496. <remarks>
  31497. <para>
  31498. Gets the type converter to use to convert values to the destination type.
  31499. </para>
  31500. </remarks>
  31501. </member>
  31502. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)">
  31503. <summary>
  31504. Gets the type converter to use to convert values to the destination type.
  31505. </summary>
  31506. <param name="destinationType">The type being converted to.</param>
  31507. <returns>
  31508. The type converter instance to use for type conversions or <c>null</c>
  31509. if no type converter is found.
  31510. </returns>
  31511. <remarks>
  31512. <para>
  31513. Gets the type converter to use to convert values to the destination type.
  31514. </para>
  31515. </remarks>
  31516. </member>
  31517. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConverterFromAttribute(System.Type)">
  31518. <summary>
  31519. Lookups the type converter to use as specified by the attributes on the
  31520. destination type.
  31521. </summary>
  31522. <param name="destinationType">The type being converted to.</param>
  31523. <returns>
  31524. The type converter instance to use for type conversions or <c>null</c>
  31525. if no type converter is found.
  31526. </returns>
  31527. </member>
  31528. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.CreateConverterInstance(System.Type)">
  31529. <summary>
  31530. Creates the instance of the type converter.
  31531. </summary>
  31532. <param name="converterType">The type of the type converter.</param>
  31533. <returns>
  31534. The type converter instance to use for type conversions or <c>null</c>
  31535. if no type converter is found.
  31536. </returns>
  31537. <remarks>
  31538. <para>
  31539. The type specified for the type converter must implement
  31540. the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> or <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces
  31541. and must have a public default (no argument) constructor.
  31542. </para>
  31543. </remarks>
  31544. </member>
  31545. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.declaringType">
  31546. <summary>
  31547. The fully qualified type of the ConverterRegistry class.
  31548. </summary>
  31549. <remarks>
  31550. Used by the internal logger to record the Type of the
  31551. log message.
  31552. </remarks>
  31553. </member>
  31554. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.s_type2converter">
  31555. <summary>
  31556. Mapping from <see cref="T:System.Type" /> to type converter.
  31557. </summary>
  31558. </member>
  31559. <member name="T:log4net.Util.TypeConverters.EncodingConverter">
  31560. <summary>
  31561. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  31562. </summary>
  31563. <remarks>
  31564. <para>
  31565. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  31566. </para>
  31567. </remarks>
  31568. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31569. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31570. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31571. <author>Nicko Cadell</author>
  31572. <author>Gert Driesen</author>
  31573. </member>
  31574. <member name="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)">
  31575. <summary>
  31576. Can the source type be converted to the type supported by this object
  31577. </summary>
  31578. <param name="sourceType">the type to convert</param>
  31579. <returns>true if the conversion is possible</returns>
  31580. <remarks>
  31581. <para>
  31582. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31583. the <see cref="T:System.String"/> type.
  31584. </para>
  31585. </remarks>
  31586. </member>
  31587. <member name="M:log4net.Util.TypeConverters.EncodingConverter.ConvertFrom(System.Object)">
  31588. <summary>
  31589. Overrides the ConvertFrom method of IConvertFrom.
  31590. </summary>
  31591. <param name="source">the object to convert to an encoding</param>
  31592. <returns>the encoding</returns>
  31593. <remarks>
  31594. <para>
  31595. Uses the <see cref="M:Encoding.GetEncoding(string)"/> method to
  31596. convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
  31597. </para>
  31598. </remarks>
  31599. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31600. The <paramref name="source"/> object cannot be converted to the
  31601. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"/>
  31602. method.
  31603. </exception>
  31604. </member>
  31605. <member name="T:log4net.Util.TypeConverters.IConvertFrom">
  31606. <summary>
  31607. Interface supported by type converters
  31608. </summary>
  31609. <remarks>
  31610. <para>
  31611. This interface supports conversion from arbitrary types
  31612. to a single target type. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  31613. </para>
  31614. </remarks>
  31615. <author>Nicko Cadell</author>
  31616. <author>Gert Driesen</author>
  31617. </member>
  31618. <member name="M:log4net.Util.TypeConverters.IConvertFrom.CanConvertFrom(System.Type)">
  31619. <summary>
  31620. Can the source type be converted to the type supported by this object
  31621. </summary>
  31622. <param name="sourceType">the type to convert</param>
  31623. <returns>true if the conversion is possible</returns>
  31624. <remarks>
  31625. <para>
  31626. Test if the <paramref name="sourceType"/> can be converted to the
  31627. type supported by this converter.
  31628. </para>
  31629. </remarks>
  31630. </member>
  31631. <member name="M:log4net.Util.TypeConverters.IConvertFrom.ConvertFrom(System.Object)">
  31632. <summary>
  31633. Convert the source object to the type supported by this object
  31634. </summary>
  31635. <param name="source">the object to convert</param>
  31636. <returns>the converted object</returns>
  31637. <remarks>
  31638. <para>
  31639. Converts the <paramref name="source"/> to the type supported
  31640. by this converter.
  31641. </para>
  31642. </remarks>
  31643. </member>
  31644. <member name="T:log4net.Util.TypeConverters.IConvertTo">
  31645. <summary>
  31646. Interface supported by type converters
  31647. </summary>
  31648. <remarks>
  31649. <para>
  31650. This interface supports conversion from a single type to arbitrary types.
  31651. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  31652. </para>
  31653. </remarks>
  31654. <author>Nicko Cadell</author>
  31655. </member>
  31656. <member name="M:log4net.Util.TypeConverters.IConvertTo.CanConvertTo(System.Type)">
  31657. <summary>
  31658. Returns whether this converter can convert the object to the specified type
  31659. </summary>
  31660. <param name="targetType">A Type that represents the type you want to convert to</param>
  31661. <returns>true if the conversion is possible</returns>
  31662. <remarks>
  31663. <para>
  31664. Test if the type supported by this converter can be converted to the
  31665. <paramref name="targetType"/>.
  31666. </para>
  31667. </remarks>
  31668. </member>
  31669. <member name="M:log4net.Util.TypeConverters.IConvertTo.ConvertTo(System.Object,System.Type)">
  31670. <summary>
  31671. Converts the given value object to the specified type, using the arguments
  31672. </summary>
  31673. <param name="source">the object to convert</param>
  31674. <param name="targetType">The Type to convert the value parameter to</param>
  31675. <returns>the converted object</returns>
  31676. <remarks>
  31677. <para>
  31678. Converts the <paramref name="source"/> (which must be of the type supported
  31679. by this converter) to the <paramref name="targetType"/> specified..
  31680. </para>
  31681. </remarks>
  31682. </member>
  31683. <member name="T:log4net.Util.TypeConverters.IPAddressConverter">
  31684. <summary>
  31685. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  31686. </summary>
  31687. <remarks>
  31688. <para>
  31689. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  31690. </para>
  31691. </remarks>
  31692. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31693. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31694. <author>Nicko Cadell</author>
  31695. </member>
  31696. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)">
  31697. <summary>
  31698. Can the source type be converted to the type supported by this object
  31699. </summary>
  31700. <param name="sourceType">the type to convert</param>
  31701. <returns>true if the conversion is possible</returns>
  31702. <remarks>
  31703. <para>
  31704. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31705. the <see cref="T:System.String"/> type.
  31706. </para>
  31707. </remarks>
  31708. </member>
  31709. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.ConvertFrom(System.Object)">
  31710. <summary>
  31711. Overrides the ConvertFrom method of IConvertFrom.
  31712. </summary>
  31713. <param name="source">the object to convert to an IPAddress</param>
  31714. <returns>the IPAddress</returns>
  31715. <remarks>
  31716. <para>
  31717. Uses the <see cref="M:System.Net.IPAddress.Parse(System.String)"/> method to convert the
  31718. <see cref="T:System.String"/> argument to an <see cref="T:System.Net.IPAddress"/>.
  31719. If that fails then the string is resolved as a DNS hostname.
  31720. </para>
  31721. </remarks>
  31722. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31723. The <paramref name="source"/> object cannot be converted to the
  31724. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"/>
  31725. method.
  31726. </exception>
  31727. </member>
  31728. <member name="F:log4net.Util.TypeConverters.IPAddressConverter.validIpAddressChars">
  31729. <summary>
  31730. Valid characters in an IPv4 or IPv6 address string. (Does not support subnets)
  31731. </summary>
  31732. </member>
  31733. <member name="T:log4net.Util.TypeConverters.PatternLayoutConverter">
  31734. <summary>
  31735. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  31736. </summary>
  31737. <remarks>
  31738. <para>
  31739. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  31740. </para>
  31741. <para>
  31742. The string is used as the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>
  31743. of the <see cref="T:log4net.Layout.PatternLayout"/>.
  31744. </para>
  31745. </remarks>
  31746. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31747. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31748. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31749. <author>Nicko Cadell</author>
  31750. </member>
  31751. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)">
  31752. <summary>
  31753. Can the source type be converted to the type supported by this object
  31754. </summary>
  31755. <param name="sourceType">the type to convert</param>
  31756. <returns>true if the conversion is possible</returns>
  31757. <remarks>
  31758. <para>
  31759. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31760. the <see cref="T:System.String"/> type.
  31761. </para>
  31762. </remarks>
  31763. </member>
  31764. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.ConvertFrom(System.Object)">
  31765. <summary>
  31766. Overrides the ConvertFrom method of IConvertFrom.
  31767. </summary>
  31768. <param name="source">the object to convert to a PatternLayout</param>
  31769. <returns>the PatternLayout</returns>
  31770. <remarks>
  31771. <para>
  31772. Creates and returns a new <see cref="T:log4net.Layout.PatternLayout"/> using
  31773. the <paramref name="source"/> <see cref="T:System.String"/> as the
  31774. <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>.
  31775. </para>
  31776. </remarks>
  31777. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31778. The <paramref name="source"/> object cannot be converted to the
  31779. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"/>
  31780. method.
  31781. </exception>
  31782. </member>
  31783. <member name="T:log4net.Util.TypeConverters.PatternStringConverter">
  31784. <summary>
  31785. Convert between string and <see cref="T:log4net.Util.PatternString"/>
  31786. </summary>
  31787. <remarks>
  31788. <para>
  31789. Supports conversion from string to <see cref="T:log4net.Util.PatternString"/> type,
  31790. and from a <see cref="T:log4net.Util.PatternString"/> type to a string.
  31791. </para>
  31792. <para>
  31793. The string is used as the <see cref="P:log4net.Util.PatternString.ConversionPattern"/>
  31794. of the <see cref="T:log4net.Util.PatternString"/>.
  31795. </para>
  31796. </remarks>
  31797. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31798. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31799. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31800. <author>Nicko Cadell</author>
  31801. </member>
  31802. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)">
  31803. <summary>
  31804. Can the target type be converted to the type supported by this object
  31805. </summary>
  31806. <param name="targetType">A <see cref="T:System.Type"/> that represents the type you want to convert to</param>
  31807. <returns>true if the conversion is possible</returns>
  31808. <remarks>
  31809. <para>
  31810. Returns <c>true</c> if the <paramref name="targetType"/> is
  31811. assignable from a <see cref="T:System.String"/> type.
  31812. </para>
  31813. </remarks>
  31814. </member>
  31815. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertTo(System.Object,System.Type)">
  31816. <summary>
  31817. Converts the given value object to the specified type, using the arguments
  31818. </summary>
  31819. <param name="source">the object to convert</param>
  31820. <param name="targetType">The Type to convert the value parameter to</param>
  31821. <returns>the converted object</returns>
  31822. <remarks>
  31823. <para>
  31824. Uses the <see cref="M:PatternString.Format()"/> method to convert the
  31825. <see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>.
  31826. </para>
  31827. </remarks>
  31828. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31829. The <paramref name="source"/> object cannot be converted to the
  31830. <paramref name="targetType"/>. To check for this condition use the
  31831. <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"/> method.
  31832. </exception>
  31833. </member>
  31834. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)">
  31835. <summary>
  31836. Can the source type be converted to the type supported by this object
  31837. </summary>
  31838. <param name="sourceType">the type to convert</param>
  31839. <returns>true if the conversion is possible</returns>
  31840. <remarks>
  31841. <para>
  31842. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31843. the <see cref="T:System.String"/> type.
  31844. </para>
  31845. </remarks>
  31846. </member>
  31847. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertFrom(System.Object)">
  31848. <summary>
  31849. Overrides the ConvertFrom method of IConvertFrom.
  31850. </summary>
  31851. <param name="source">the object to convert to a PatternString</param>
  31852. <returns>the PatternString</returns>
  31853. <remarks>
  31854. <para>
  31855. Creates and returns a new <see cref="T:log4net.Util.PatternString"/> using
  31856. the <paramref name="source"/> <see cref="T:System.String"/> as the
  31857. <see cref="P:log4net.Util.PatternString.ConversionPattern"/>.
  31858. </para>
  31859. </remarks>
  31860. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31861. The <paramref name="source"/> object cannot be converted to the
  31862. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"/>
  31863. method.
  31864. </exception>
  31865. </member>
  31866. <member name="T:log4net.Util.TypeConverters.TypeConverter">
  31867. <summary>
  31868. Supports conversion from string to <see cref="T:System.Type"/> type.
  31869. </summary>
  31870. <remarks>
  31871. <para>
  31872. Supports conversion from string to <see cref="T:System.Type"/> type.
  31873. </para>
  31874. </remarks>
  31875. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  31876. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31877. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  31878. <author>Nicko Cadell</author>
  31879. </member>
  31880. <member name="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)">
  31881. <summary>
  31882. Can the source type be converted to the type supported by this object
  31883. </summary>
  31884. <param name="sourceType">the type to convert</param>
  31885. <returns>true if the conversion is possible</returns>
  31886. <remarks>
  31887. <para>
  31888. Returns <c>true</c> if the <paramref name="sourceType"/> is
  31889. the <see cref="T:System.String"/> type.
  31890. </para>
  31891. </remarks>
  31892. </member>
  31893. <member name="M:log4net.Util.TypeConverters.TypeConverter.ConvertFrom(System.Object)">
  31894. <summary>
  31895. Overrides the ConvertFrom method of IConvertFrom.
  31896. </summary>
  31897. <param name="source">the object to convert to a Type</param>
  31898. <returns>the Type</returns>
  31899. <remarks>
  31900. <para>
  31901. Uses the <see cref="M:Type.GetType(string,bool)"/> method to convert the
  31902. <see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>.
  31903. Additional effort is made to locate partially specified types
  31904. by searching the loaded assemblies.
  31905. </para>
  31906. </remarks>
  31907. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  31908. The <paramref name="source"/> object cannot be converted to the
  31909. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"/>
  31910. method.
  31911. </exception>
  31912. </member>
  31913. <member name="T:log4net.Util.TypeConverters.TypeConverterAttribute">
  31914. <summary>
  31915. Attribute used to associate a type converter
  31916. </summary>
  31917. <remarks>
  31918. <para>
  31919. Class and Interface level attribute that specifies a type converter
  31920. to use with the associated type.
  31921. </para>
  31922. <para>
  31923. To associate a type converter with a target type apply a
  31924. <c>TypeConverterAttribute</c> to the target type. Specify the
  31925. type of the type converter on the attribute.
  31926. </para>
  31927. </remarks>
  31928. <author>Nicko Cadell</author>
  31929. <author>Gert Driesen</author>
  31930. </member>
  31931. <member name="F:log4net.Util.TypeConverters.TypeConverterAttribute.m_typeName">
  31932. <summary>
  31933. The string type name of the type converter
  31934. </summary>
  31935. </member>
  31936. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor">
  31937. <summary>
  31938. Default constructor
  31939. </summary>
  31940. <remarks>
  31941. <para>
  31942. Default constructor
  31943. </para>
  31944. </remarks>
  31945. </member>
  31946. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.String)">
  31947. <summary>
  31948. Create a new type converter attribute for the specified type name
  31949. </summary>
  31950. <param name="typeName">The string type name of the type converter</param>
  31951. <remarks>
  31952. <para>
  31953. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31954. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  31955. </para>
  31956. </remarks>
  31957. </member>
  31958. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.Type)">
  31959. <summary>
  31960. Create a new type converter attribute for the specified type
  31961. </summary>
  31962. <param name="converterType">The type of the type converter</param>
  31963. <remarks>
  31964. <para>
  31965. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31966. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  31967. </para>
  31968. </remarks>
  31969. </member>
  31970. <member name="P:log4net.Util.TypeConverters.TypeConverterAttribute.ConverterTypeName">
  31971. <summary>
  31972. The string type name of the type converter
  31973. </summary>
  31974. <value>
  31975. The string type name of the type converter
  31976. </value>
  31977. <remarks>
  31978. <para>
  31979. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  31980. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  31981. </para>
  31982. </remarks>
  31983. </member>
  31984. <member name="T:log4net.Util.WindowsSecurityContext">
  31985. <summary>
  31986. Impersonate a Windows Account
  31987. </summary>
  31988. <remarks>
  31989. <para>
  31990. This <see cref="T:log4net.Core.SecurityContext"/> impersonates a Windows account.
  31991. </para>
  31992. <para>
  31993. How the impersonation is done depends on the value of <see cref="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)"/>.
  31994. This allows the context to either impersonate a set of user credentials specified
  31995. using username, domain name and password or to revert to the process credentials.
  31996. </para>
  31997. </remarks>
  31998. </member>
  31999. <member name="T:log4net.Util.WindowsSecurityContext.ImpersonationMode">
  32000. <summary>
  32001. The impersonation modes for the <see cref="T:log4net.Util.WindowsSecurityContext"/>
  32002. </summary>
  32003. <remarks>
  32004. <para>
  32005. See the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property for
  32006. details.
  32007. </para>
  32008. </remarks>
  32009. </member>
  32010. <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User">
  32011. <summary>
  32012. Impersonate a user using the credentials supplied
  32013. </summary>
  32014. </member>
  32015. <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process">
  32016. <summary>
  32017. Revert this the thread to the credentials of the process
  32018. </summary>
  32019. </member>
  32020. <member name="M:log4net.Util.WindowsSecurityContext.#ctor">
  32021. <summary>
  32022. Default constructor
  32023. </summary>
  32024. <remarks>
  32025. <para>
  32026. Default constructor
  32027. </para>
  32028. </remarks>
  32029. </member>
  32030. <member name="P:log4net.Util.WindowsSecurityContext.Credentials">
  32031. <summary>
  32032. Gets or sets the impersonation mode for this security context
  32033. </summary>
  32034. <value>
  32035. The impersonation mode for this security context
  32036. </value>
  32037. <remarks>
  32038. <para>
  32039. Impersonate either a user with user credentials or
  32040. revert this thread to the credentials of the process.
  32041. The value is one of the <see cref="T:log4net.Util.WindowsSecurityContext.ImpersonationMode"/>
  32042. enum.
  32043. </para>
  32044. <para>
  32045. The default value is <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
  32046. </para>
  32047. <para>
  32048. When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
  32049. the user's credentials are established using the
  32050. <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>, <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.Password"/>
  32051. values.
  32052. </para>
  32053. <para>
  32054. When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process"/>
  32055. no other properties need to be set. If the calling thread is
  32056. impersonating then it will be reverted back to the process credentials.
  32057. </para>
  32058. </remarks>
  32059. </member>
  32060. <member name="P:log4net.Util.WindowsSecurityContext.UserName">
  32061. <summary>
  32062. Gets or sets the Windows username for this security context
  32063. </summary>
  32064. <value>
  32065. The Windows username for this security context
  32066. </value>
  32067. <remarks>
  32068. <para>
  32069. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  32070. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  32071. </para>
  32072. </remarks>
  32073. </member>
  32074. <member name="P:log4net.Util.WindowsSecurityContext.DomainName">
  32075. <summary>
  32076. Gets or sets the Windows domain name for this security context
  32077. </summary>
  32078. <value>
  32079. The Windows domain name for this security context
  32080. </value>
  32081. <remarks>
  32082. <para>
  32083. The default value for <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> is the local machine name
  32084. taken from the <see cref="P:System.Environment.MachineName"/> property.
  32085. </para>
  32086. <para>
  32087. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  32088. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  32089. </para>
  32090. </remarks>
  32091. </member>
  32092. <member name="P:log4net.Util.WindowsSecurityContext.Password">
  32093. <summary>
  32094. 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.
  32095. </summary>
  32096. <value>
  32097. 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.
  32098. </value>
  32099. <remarks>
  32100. <para>
  32101. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  32102. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  32103. </para>
  32104. </remarks>
  32105. </member>
  32106. <member name="M:log4net.Util.WindowsSecurityContext.ActivateOptions">
  32107. <summary>
  32108. Initialize the SecurityContext based on the options set.
  32109. </summary>
  32110. <remarks>
  32111. <para>
  32112. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  32113. activation scheme. The <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> method must
  32114. be called on this object after the configuration properties have
  32115. been set. Until <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> is called this
  32116. object is in an undefined state and must not be used.
  32117. </para>
  32118. <para>
  32119. If any of the configuration properties are modified then
  32120. <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> must be called again.
  32121. </para>
  32122. <para>
  32123. The security context will try to Logon the specified user account and
  32124. capture a primary token for impersonation.
  32125. </para>
  32126. </remarks>
  32127. <exception cref="T:System.ArgumentNullException">The required <see cref="P:log4net.Util.WindowsSecurityContext.UserName" />,
  32128. <see cref="P:log4net.Util.WindowsSecurityContext.DomainName" /> or <see cref="P:log4net.Util.WindowsSecurityContext.Password" /> properties were not specified.</exception>
  32129. </member>
  32130. <member name="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)">
  32131. <summary>
  32132. Impersonate the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
  32133. </summary>
  32134. <param name="state">caller provided state</param>
  32135. <returns>
  32136. An <see cref="T:System.IDisposable"/> instance that will revoke the impersonation of this SecurityContext
  32137. </returns>
  32138. <remarks>
  32139. <para>
  32140. Depending on the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property either
  32141. impersonate a user using credentials supplied or revert
  32142. to the process credentials.
  32143. </para>
  32144. </remarks>
  32145. </member>
  32146. <member name="M:log4net.Util.WindowsSecurityContext.LogonUser(System.String,System.String,System.String)">
  32147. <summary>
  32148. Create a <see cref="T:System.Security.Principal.WindowsIdentity"/> given the userName, domainName and password.
  32149. </summary>
  32150. <param name="userName">the user name</param>
  32151. <param name="domainName">the domain name</param>
  32152. <param name="password">the password</param>
  32153. <returns>the <see cref="T:System.Security.Principal.WindowsIdentity"/> for the account specified</returns>
  32154. <remarks>
  32155. <para>
  32156. Uses the Windows API call LogonUser to get a principal token for the account. This
  32157. token is used to initialize the WindowsIdentity.
  32158. </para>
  32159. </remarks>
  32160. </member>
  32161. <member name="T:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext">
  32162. <summary>
  32163. Adds <see cref="T:System.IDisposable"/> to <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
  32164. </summary>
  32165. <remarks>
  32166. <para>
  32167. Helper class to expose the <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
  32168. through the <see cref="T:System.IDisposable"/> interface.
  32169. </para>
  32170. </remarks>
  32171. </member>
  32172. <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.#ctor(System.Security.Principal.WindowsImpersonationContext)">
  32173. <summary>
  32174. Constructor
  32175. </summary>
  32176. <param name="impersonationContext">the impersonation context being wrapped</param>
  32177. <remarks>
  32178. <para>
  32179. Constructor
  32180. </para>
  32181. </remarks>
  32182. </member>
  32183. <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.Dispose">
  32184. <summary>
  32185. Revert the impersonation
  32186. </summary>
  32187. <remarks>
  32188. <para>
  32189. Revert the impersonation
  32190. </para>
  32191. </remarks>
  32192. </member>
  32193. </members>
  32194. </doc>