NAnt.Contrib.Tasks.xml 873 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NAnt.Contrib.Tasks</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NAnt.Contrib.Functions.FileSetFunctions">
  8. <summary>
  9. Provides methods for interrogating Filesets.
  10. </summary>
  11. </member>
  12. <member name="M:NAnt.Contrib.Functions.FileSetFunctions.GetFileCount(System.String)">
  13. <summary>
  14. Determines the number of files within a <see cref="T:NAnt.Core.Types.FileSet"/>.
  15. </summary>
  16. <param name="fileset">The id of the FileSet to scan.</param>
  17. <returns>The number of files included in the FileSet</returns>
  18. <exception cref="T:System.ArgumentException"><paramref name="fileset"/> is not a valid refid to a defined fileset.</exception>
  19. <example>
  20. <para>
  21. Define a fileset and check the number of files in it.
  22. </para>
  23. <code>
  24. <![CDATA[
  25. <fileset id="test.fileset">
  26. <include name="**/*.cs">
  27. </fileset>
  28. <echo message="FileSet contains ${fileset::get-file-count('test.fileset')} files." />
  29. ]]>
  30. </code>
  31. </example>
  32. </member>
  33. <member name="M:NAnt.Contrib.Functions.FileSetFunctions.HasFiles(System.String)">
  34. <summary>
  35. Determines whether <see cref="T:NAnt.Core.Types.FileSet"/> contains any files.
  36. </summary>
  37. <param name="fileset">The id of the fileset to check.</param>
  38. <returns><see langword="true"/> if the FileSet contains one or more files, otherwise <see langword="false"/>.</returns>
  39. <exception cref="T:System.ArgumentException"><paramref name="fileset"/> is not a valid refid to a defined fileset.</exception>
  40. <example>
  41. <para>
  42. Perform conditional processing on a fileset if it contains files.
  43. </para>
  44. <code>
  45. <![CDATA[
  46. <fileset id="test.fileset">
  47. <include name="**/*.cs">
  48. </fileset>
  49. <if test="${fileset::has-files('test.fileset')}">
  50. <dostuff... />
  51. </if>
  52. ]]>
  53. </code>
  54. </example>
  55. </member>
  56. <member name="M:NAnt.Contrib.Functions.FileSetFunctions.ToString(System.String,System.String)">
  57. <summary>
  58. Returns a delimited string of all the filenames within a <see cref="T:NAnt.Core.Types.FileSet"/> with each filename
  59. separated by the specified delimiter string.
  60. </summary>
  61. <param name="fileset">The id of the fileset to check.</param>
  62. <param name="delimiter">String to separate filenames with.</param>
  63. <returns>A delimited string of the filenames within the specified FileSet.</returns>
  64. <exception cref="T:System.ArgumentException"><paramref name="fileset"/> is not a valid refid to a defined fileset.</exception>
  65. <example>
  66. <para>
  67. Displays a space-pipe-space separated string fo the files within a defined FileSet.
  68. </para>
  69. <code>
  70. <![CDATA[
  71. <fileset id="test.fileset">
  72. <include name="**/*.cs">
  73. </fileset>
  74. <echo message="${fileset::to-string('test.fileset', ' | ')}">
  75. ]]>
  76. </code>
  77. </example>
  78. </member>
  79. <member name="T:NAnt.Contrib.Functions.ServiceFunctions">
  80. <summary>
  81. Allow information on a Windows service to be retrieved.
  82. </summary>
  83. </member>
  84. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsInstalled(System.String,System.String)">
  85. <summary>
  86. Returns a value indicating whether the specified service is
  87. installed on a given machine.
  88. </summary>
  89. <param name="service">The short name that identifies the service to the system.</param>
  90. <param name="machineName">The computer on which the service resides.</param>
  91. <returns>
  92. <see langword="true"/> if the service is installed; otherwise,
  93. <see langword="false"/>.
  94. </returns>
  95. <remarks>
  96. For the machineName parameter, you can use "." or a zero-length
  97. <see cref="T:System.String"/> to represent the local computer.
  98. </remarks>
  99. <example>
  100. <para>
  101. The following example starts the "World Wide Web Publishing"
  102. service if it's installed on the local computer.
  103. </para>
  104. <code>
  105. <![CDATA[
  106. <if test="${service::is-installed('World Wide Web Publishing', '.')}">
  107. <servicecontroller action="Start" service="World Wide Web Publishing" />
  108. </if>
  109. ]]>
  110. </code>
  111. </example>
  112. </member>
  113. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsRunning(System.String,System.String)">
  114. <summary>
  115. Returns a value indicating whether the specified service is running.
  116. </summary>
  117. <param name="service">The short name that identifies the service to the system.</param>
  118. <param name="machineName">The computer on which the service resides.</param>
  119. <returns>
  120. <see langword="true"/> if the service is running; otherwise,
  121. <see langword="false"/>.
  122. </returns>
  123. <remarks>
  124. For the machineName parameter, you can use "." or a zero-length
  125. <see cref="T:System.String"/> to represent the local computer.
  126. </remarks>
  127. </member>
  128. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsStopped(System.String,System.String)">
  129. <summary>
  130. Returns a value indicating whether the specified service is stopped.
  131. </summary>
  132. <param name="service">The short name that identifies the service to the system.</param>
  133. <param name="machineName">The computer on which the service resides.</param>
  134. <returns>
  135. <see langword="true"/> if the service is stopped; otherwise,
  136. <see langword="false"/>.
  137. </returns>
  138. <remarks>
  139. For the machineName parameter, you can use "." or a zero-length
  140. <see cref="T:System.String"/> to represent the local computer.
  141. </remarks>
  142. </member>
  143. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsPaused(System.String,System.String)">
  144. <summary>
  145. Returns a value indicating whether the specified service is paused.
  146. </summary>
  147. <param name="service">The short name that identifies the service to the system.</param>
  148. <param name="machineName">The computer on which the service resides.</param>
  149. <returns>
  150. <see langword="true"/> if the service is paused; otherwise,
  151. <see langword="false"/>.
  152. </returns>
  153. <remarks>
  154. For the machineName parameter, you can use "." or a zero-length
  155. <see cref="T:System.String"/> to represent the local computer.
  156. </remarks>
  157. </member>
  158. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.GetStatus(System.String,System.String)">
  159. <summary>
  160. Gets the status of the specified service.
  161. </summary>
  162. <param name="service">The short name that identifies the service to the system.</param>
  163. <param name="machineName">The computer on which the service resides.</param>
  164. <returns>
  165. One of the <see cref="T:System.ServiceProcess.ServiceControllerStatus"/> values that
  166. indicates whether the service is running, stopped, or paused, or
  167. whether a start, stop, pause, or continue command is pending.
  168. </returns>
  169. <remarks>
  170. <para>
  171. For the machineName parameter, you can use "." or a zero-length
  172. <see cref="T:System.String"/> to represent the local computer.
  173. </para>
  174. <para>
  175. The value returned by <see cref="M:NAnt.Contrib.Functions.ServiceFunctions.GetStatus(System.String,System.String)"/> can be compared
  176. to either a corresponding enum field name or the underlying
  177. integral value.
  178. </para>
  179. </remarks>
  180. <example>
  181. <para>
  182. Displays a warning if the <b>Alerter</b> service is stopping
  183. on <c>SV-ARD-EAI1</c>.
  184. </para>
  185. <code>
  186. <![CDATA[
  187. <if test="${service::get-status('Alerter', 'SV-ARD-EAI1') == 'StopPending'}">
  188. <echo level="Warning">The Alerter service is stopping.</echo>
  189. </if>
  190. ]]>
  191. </code>
  192. </example>
  193. <example>
  194. <para>
  195. The "deploy-web-application" target is only executed if
  196. IIS is running on the local computer.
  197. </para>
  198. <code>
  199. <![CDATA[
  200. <target name="deploy" depends="deploy-sql-scripts, deploy-web-application" />
  201. <target name="deploy-sql-scripts">
  202. ...
  203. </target>
  204. <target name="deploy-web-application" if="$(service::get-status('World Wide Web Publishing', '.') == 4)}">
  205. ...
  206. </target>
  207. ]]>
  208. </code>
  209. </example>
  210. </member>
  211. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.GetDisplayName(System.String,System.String)">
  212. <summary>
  213. Gets the friendly name of the specified service.
  214. </summary>
  215. <param name="service">The short name that identifies the service to the system.</param>
  216. <param name="machineName">The computer on which the service resides.</param>
  217. <returns>
  218. The friendly name of the service, which can be used to identify the service.
  219. </returns>
  220. </member>
  221. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.GetServiceName(System.String,System.String)">
  222. <summary>
  223. Gets the name that identifies the specified service
  224. </summary>
  225. <param name="service">The short name that identifies the service to the system.</param>
  226. <param name="machineName">The computer on which the service resides.</param>
  227. <returns>
  228. The name that identifies the service.
  229. </returns>
  230. </member>
  231. <member name="P:NAnt.Contrib.Tasks.BizTalk.BizTalkBase.Database">
  232. <summary>
  233. The name of the management SQL database.
  234. </summary>
  235. </member>
  236. <member name="P:NAnt.Contrib.Tasks.BizTalk.BizTalkBase.Server">
  237. <summary>
  238. The name of the SQL Server where the management database is
  239. located.
  240. </summary>
  241. </member>
  242. <member name="T:NAnt.Contrib.Tasks.BizTalk.Deploy">
  243. <summary>
  244. Deploys an assembly to a given BizTalk configuration database.
  245. </summary>
  246. <remarks>
  247. Deployment will fail if the assembly is already deployed.
  248. </remarks>
  249. </member>
  250. <member name="M:NAnt.Contrib.Tasks.BizTalk.Deploy.ExecuteTask">
  251. <summary>
  252. Deploys the assembly.
  253. </summary>
  254. <exception cref="T:NAnt.Core.BuildException">
  255. <para>The assembly does not exist.</para>
  256. <para>-or-</para>
  257. <para>The assembly binding information file does not exist.</para>
  258. <para>-or-</para>
  259. <para>The assembly could not be deployed.</para>
  260. </exception>
  261. </member>
  262. <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.Assembly">
  263. <summary>
  264. The path to the BizTalk assembly to deploy.
  265. </summary>
  266. </member>
  267. <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.Install">
  268. <summary>
  269. Determines whether to install the assembly in the Global Assembly
  270. Cache. The default is <see langword="false" />.
  271. </summary>
  272. </member>
  273. <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.BindingFile">
  274. <summary>
  275. The path to an assembly binding information file to import bindings
  276. from.
  277. </summary>
  278. </member>
  279. <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.LogFile">
  280. <summary>
  281. The path to the HTML log file to generate.
  282. </summary>
  283. </member>
  284. <member name="T:NAnt.Contrib.Tasks.BizTalk.Export">
  285. <summary>
  286. Exports bindings for a BizTalk assembly to an assembly binding
  287. information file.
  288. </summary>
  289. </member>
  290. <member name="M:NAnt.Contrib.Tasks.BizTalk.Export.ExecuteTask">
  291. <summary>
  292. Exports the bindings.
  293. </summary>
  294. <exception cref="T:NAnt.Core.BuildException">
  295. <para>The assembly does not exist.</para>
  296. <para>-or-</para>
  297. <para>The bindings could not be exported.</para>
  298. </exception>
  299. </member>
  300. <member name="P:NAnt.Contrib.Tasks.BizTalk.Export.Assembly">
  301. <summary>
  302. The path to the BizTalk assembly for which to export bindings.
  303. </summary>
  304. </member>
  305. <member name="P:NAnt.Contrib.Tasks.BizTalk.Export.BindingFile">
  306. <summary>
  307. The path to an assembly binding information file in which the
  308. bindings will be saved.
  309. </summary>
  310. </member>
  311. <member name="P:NAnt.Contrib.Tasks.BizTalk.Export.LogFile">
  312. <summary>
  313. The path to the HTML log file to generate.
  314. </summary>
  315. </member>
  316. <member name="T:NAnt.Contrib.Tasks.BizTalk.Host">
  317. <summary>
  318. Allows BizTalk (in-process) host instances to be controlled.
  319. </summary>
  320. <example>
  321. <para>
  322. Starts the &quot;BizTalkServerApplication&quot; host instance
  323. on server &quot;SV-ARD-EAI&quot;.
  324. </para>
  325. <code>
  326. <![CDATA[
  327. <btshost action="Start" host="BizTalkServerApplication" server="SV-ARD-EAI" />
  328. ]]>
  329. </code>
  330. </example>
  331. <example>
  332. <para>
  333. Stops all &quot;BizTalkServerApplication&quot; host instances.
  334. </para>
  335. <code>
  336. <![CDATA[
  337. <btshost action="Stop" host="BizTalkServerApplication" />
  338. ]]>
  339. </code>
  340. </example>
  341. </member>
  342. <member name="P:NAnt.Contrib.Tasks.BizTalk.Host.HostName">
  343. <summary>
  344. The name of the host on which the perform the action.
  345. </summary>
  346. </member>
  347. <member name="P:NAnt.Contrib.Tasks.BizTalk.Host.Server">
  348. <summary>
  349. The name of the BizTalk server on which to perform the action.
  350. If not specified, the action will be performed on all instances.
  351. </summary>
  352. </member>
  353. <member name="P:NAnt.Contrib.Tasks.BizTalk.Host.Action">
  354. <summary>
  355. The action that should be performed on the host.
  356. </summary>
  357. </member>
  358. <member name="T:NAnt.Contrib.Tasks.BizTalk.Host.HostAction">
  359. <summary>
  360. Defines the actions that can be performed on a host instance.
  361. </summary>
  362. </member>
  363. <member name="F:NAnt.Contrib.Tasks.BizTalk.Host.HostAction.Start">
  364. <summary>
  365. Starts the host instance.
  366. </summary>
  367. </member>
  368. <member name="F:NAnt.Contrib.Tasks.BizTalk.Host.HostAction.Stop">
  369. <summary>
  370. Stops the host instance.
  371. </summary>
  372. </member>
  373. <member name="F:NAnt.Contrib.Tasks.BizTalk.Host.HostAction.Restart">
  374. <summary>
  375. Stops and restarts the host instance.
  376. </summary>
  377. </member>
  378. <member name="T:NAnt.Contrib.Tasks.BizTalk.Import">
  379. <summary>
  380. Imports bindings from a given assembly binding information file into
  381. the specified BizTalk configuration database.
  382. </summary>
  383. </member>
  384. <member name="M:NAnt.Contrib.Tasks.BizTalk.Import.ExecuteTask">
  385. <summary>
  386. Imports the assembly binding information file.
  387. </summary>
  388. <exception cref="T:NAnt.Core.BuildException">
  389. <para>The assembly binding information file does not exist.</para>
  390. <para>-or-</para>
  391. <para>The assembly binding information file could not be imported.</para>
  392. </exception>
  393. </member>
  394. <member name="P:NAnt.Contrib.Tasks.BizTalk.Import.BindingFile">
  395. <summary>
  396. The path to the assembly binding information file containing the
  397. bindings to import.
  398. </summary>
  399. </member>
  400. <member name="P:NAnt.Contrib.Tasks.BizTalk.Import.LogFile">
  401. <summary>
  402. The path to the HTML log file to generate.
  403. </summary>
  404. </member>
  405. <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration">
  406. <summary>
  407. Performs a set of actions on a given orchestration.
  408. </summary>
  409. </member>
  410. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.Server">
  411. <summary>
  412. The name of the BizTalk server on which to perform the action.
  413. </summary>
  414. </member>
  415. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.OrchestrationName">
  416. <summary>
  417. The name of the orchestration to perform an action on.
  418. </summary>
  419. </member>
  420. <member name="M:NAnt.Contrib.Tasks.BizTalk.Orchestration.OrchestrationActionBase.Log(NAnt.Core.Level,System.String)">
  421. <summary>
  422. Logs a message with the given priority.
  423. </summary>
  424. <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
  425. <param name="message">The message to be logged.</param>
  426. <remarks>
  427. The actual logging is delegated to the project.
  428. </remarks>
  429. </member>
  430. <member name="M:NAnt.Contrib.Tasks.BizTalk.Orchestration.OrchestrationActionBase.Log(NAnt.Core.Level,System.String,System.Object[])">
  431. <summary>
  432. Logs a message with the given priority.
  433. </summary>
  434. <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
  435. <param name="message">The message to log, containing zero or more format items.</param>
  436. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  437. <remarks>
  438. The actual logging is delegated to the project.
  439. </remarks>
  440. </member>
  441. <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction">
  442. <summary>
  443. Starts the orchestration.
  444. </summary>
  445. <remarks>
  446. If the orchestration is not yet enlisted, then this will be done
  447. first.
  448. </remarks>
  449. </member>
  450. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction.AutoEnableReceiveLocation">
  451. <summary>
  452. Specifies whether receive locations associated with this
  453. orchestration should be automatically enabled. The default is
  454. <see langword="false" />.
  455. </summary>
  456. </member>
  457. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction.AutoResumeOrchestrationInstance">
  458. <summary>
  459. Specifies whether service instances of this orchestration that
  460. were manually suspended previously should be automatically
  461. resumed. The default is <see langword="true" />.
  462. </summary>
  463. </member>
  464. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction.AutoStartSendPorts">
  465. <summary>
  466. Specifies whether send ports and send port groups imported by
  467. this orchestration should be automatically started. The default
  468. is <see langword="true" />.
  469. </summary>
  470. </member>
  471. <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction">
  472. <summary>
  473. Stops the orchestration.
  474. </summary>
  475. <remarks>
  476. If the status of the orchestration is <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Bound"/>,
  477. <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Unbound"/> or <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Stopped"/>,
  478. then no further processing is done.
  479. </remarks>
  480. </member>
  481. <member name="M:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction.Invoke(System.Management.ManagementObject)">
  482. <summary>
  483. Stops the orchestration.
  484. </summary>
  485. <param name="orchestration">The orchestration to stop.</param>
  486. <remarks>
  487. If the status of orchestration is <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Bound"/>,
  488. <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Unbound"/> or <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Stopped"/>,
  489. then no further processing is done.
  490. </remarks>
  491. </member>
  492. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction.AutoDisableReceiveLocation">
  493. <summary>
  494. Specifies whether receive locations associated with this
  495. orchestration should be automatically disabled. The default
  496. is <see langword="false" />.
  497. </summary>
  498. </member>
  499. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction.AutoSuspendOrchestrationInstance">
  500. <summary>
  501. Specifies whether instances of this orchestration should be
  502. automatically suspended. The default is <see langword="true" />.
  503. </summary>
  504. </member>
  505. <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.EnlistOrchestrationAction">
  506. <summary>
  507. Enlists the orchestration by creating its activation subscription.
  508. </summary>
  509. </member>
  510. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.EnlistOrchestrationAction.Host">
  511. <summary>
  512. Specifies the BizTalk host on which to enlist the orchestration.
  513. </summary>
  514. </member>
  515. <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.UnenlistOrchestrationAction">
  516. <summary>
  517. Unenlists the orchestration by removing its activation subscription.
  518. </summary>
  519. </member>
  520. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.UnenlistOrchestrationAction.AutoTerminateOrchestrationInstance">
  521. <summary>
  522. Specifies whether instances of this orchestration type should
  523. be automatically terminated. The default is <see langword="false" />.
  524. </summary>
  525. </member>
  526. <member name="T:NAnt.Contrib.Tasks.BizTalk.Reset">
  527. <summary>
  528. Allows stopping, starting and resetting of BizTalk in-process host
  529. instances on the specified server.
  530. </summary>
  531. </member>
  532. <member name="P:NAnt.Contrib.Tasks.BizTalk.Reset.Server">
  533. <summary>
  534. The name of the BizTalk server on which to perform the action.
  535. </summary>
  536. </member>
  537. <member name="P:NAnt.Contrib.Tasks.BizTalk.Reset.Action">
  538. <summary>
  539. Specifies the action(s) to perform on the BizTalk host instances. The
  540. default is <see cref="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Reset"/>.
  541. </summary>
  542. </member>
  543. <member name="T:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction">
  544. <summary>
  545. Defines the possible actions that can be performed on the BizTalk
  546. in-process host instances.
  547. </summary>
  548. </member>
  549. <member name="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Stop">
  550. <summary>
  551. Stops all in-process host instances.
  552. </summary>
  553. </member>
  554. <member name="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Start">
  555. <summary>
  556. Starts all in-process host instances.
  557. </summary>
  558. </member>
  559. <member name="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Reset">
  560. <summary>
  561. Stops and restarts all in-process host instances.
  562. </summary>
  563. </member>
  564. <member name="T:NAnt.Contrib.Tasks.BizTalk.SendPort">
  565. <summary>
  566. Allows BizTalk send ports to be controlled.
  567. </summary>
  568. <example>
  569. <para>
  570. Starts the &quot;UmeHttpSendPort&quot; port on server
  571. &quot;SV-ARD-EAI&quot;.
  572. </para>
  573. <code>
  574. <![CDATA[
  575. <btssendport action="Start" port="UmeHttpSendPort" server="SV-ARD-EAI" />
  576. ]]>
  577. </code>
  578. </example>
  579. <example>
  580. <para>
  581. Unenlists the &quot;UmeHttpSendPort&quot; on server &quot;SV-ARD-EAI&quot;.
  582. </para>
  583. <code>
  584. <![CDATA[
  585. <btssendport action="UnEnlist" port="UmeHttpSendPort" server="SV-ARD-EAI" />
  586. ]]>
  587. </code>
  588. </example>
  589. </member>
  590. <member name="P:NAnt.Contrib.Tasks.BizTalk.SendPort.PortName">
  591. <summary>
  592. The name of the send port on which the perform the action.
  593. </summary>
  594. </member>
  595. <member name="P:NAnt.Contrib.Tasks.BizTalk.SendPort.Server">
  596. <summary>
  597. The name of the BizTalk server on which to perform the action.
  598. </summary>
  599. </member>
  600. <member name="P:NAnt.Contrib.Tasks.BizTalk.SendPort.Action">
  601. <summary>
  602. The action that should be performed on the send port.
  603. </summary>
  604. </member>
  605. <member name="T:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction">
  606. <summary>
  607. Defines the actions that can be performed on a BizTalk send port.
  608. </summary>
  609. </member>
  610. <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Start">
  611. <summary>
  612. Starts the send port.
  613. </summary>
  614. </member>
  615. <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Stop">
  616. <summary>
  617. Stops the send port.
  618. </summary>
  619. </member>
  620. <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Restart">
  621. <summary>
  622. Stops and restarts the send port.
  623. </summary>
  624. </member>
  625. <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Enlist">
  626. <summary>
  627. Enlists the send port.
  628. </summary>
  629. </member>
  630. <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.UnEnlist">
  631. <summary>
  632. Unenlists the send port.
  633. </summary>
  634. </member>
  635. <member name="T:NAnt.Contrib.Tasks.BizTalk.Unbind">
  636. <summary>
  637. Removes all bindings for a given assembly from a BizTalk configuration
  638. database.
  639. </summary>
  640. </member>
  641. <member name="M:NAnt.Contrib.Tasks.BizTalk.Unbind.ExecuteTask">
  642. <summary>
  643. Removes bindings for the specified assembly.
  644. </summary>
  645. <exception cref="T:NAnt.Core.BuildException">
  646. <para>The assembly does not exist.</para>
  647. <para>-or-</para>
  648. <para>The bindings could not be removed.</para>
  649. </exception>
  650. </member>
  651. <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.Assembly">
  652. <summary>
  653. The path to the BizTalk assembly for which to remove all bindings.
  654. </summary>
  655. </member>
  656. <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.Server">
  657. <summary>
  658. The name of the BizTalk server on which to perform the operation.
  659. </summary>
  660. </member>
  661. <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.ReceivePipeline">
  662. <summary>
  663. The assembly qualified name of the receive pipeline to set when
  664. unbinding a receive pipeline.
  665. </summary>
  666. </member>
  667. <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.SendPipeline">
  668. <summary>
  669. The assembly qualified name of the SEND pipeline to set when
  670. unbinding a send pipeline.
  671. </summary>
  672. </member>
  673. <member name="T:NAnt.Contrib.Tasks.BizTalk.Undeploy">
  674. <summary>
  675. Removes a given assembly from a BizTalk configuration database.
  676. </summary>
  677. </member>
  678. <member name="M:NAnt.Contrib.Tasks.BizTalk.Undeploy.ExecuteTask">
  679. <summary>
  680. Removes an assembly from a BizTalk configuration database.
  681. </summary>
  682. <exception cref="T:NAnt.Core.BuildException">
  683. <para>The assembly does not exist.</para>
  684. <para>-or-</para>
  685. <para>The assembly could not be remove from the BizTalk configuration database.</para>
  686. </exception>
  687. </member>
  688. <member name="P:NAnt.Contrib.Tasks.BizTalk.Undeploy.Assembly">
  689. <summary>
  690. The path to the BizTalk assembly to remove.
  691. </summary>
  692. </member>
  693. <member name="P:NAnt.Contrib.Tasks.BizTalk.Undeploy.Uninstall">
  694. <summary>
  695. Determines whether to remove the assembly from the Global Assembly
  696. Cache. The default is <see langword="false" />.
  697. </summary>
  698. </member>
  699. <member name="P:NAnt.Contrib.Tasks.BizTalk.Undeploy.LogFile">
  700. <summary>
  701. The path to the HTML log file to generate.
  702. </summary>
  703. </member>
  704. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase">
  705. <summary>
  706. Base class for all the ClearCase tasks.
  707. </summary>
  708. </member>
  709. <member name="M:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.#ctor">
  710. <summary>
  711. Base Constructor.
  712. </summary>
  713. </member>
  714. <member name="M:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.ExecuteTask">
  715. <summary>
  716. Execute the perforce command assembled by subclasses.
  717. </summary>
  718. </member>
  719. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.CommandSpecificArguments">
  720. <summary>
  721. Derived classes should override this to provide command-specific
  722. commandline arguments.
  723. </summary>
  724. </member>
  725. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.ProgramArguments">
  726. <summary>
  727. Overrides the base class.
  728. </summary>
  729. </member>
  730. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCatCs">
  731. <summary>
  732. Displays a ClearCase config spec.
  733. </summary>
  734. </member>
  735. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCatCs.ViewTag">
  736. <summary>
  737. The view tag identifying the ClearCase view that will have its
  738. config spec displayed.
  739. </summary>
  740. </member>
  741. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCatCs.CommandSpecificArguments">
  742. <summary>
  743. This is an override used by the base class to get command specific args.
  744. </summary>
  745. </member>
  746. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn">
  747. <summary>
  748. Checks files into a ClearCase VOB.
  749. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut"/>
  750. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut"/>
  751. </summary>
  752. <remarks>
  753. <para>
  754. This task uses the <c>cleartool checkin</c> command to check in ClearCase elements.
  755. </para>
  756. </remarks>
  757. <example>
  758. <para>
  759. Performs a ClearCase checkin on the file <c>c:/views/viewdir/afile</c>.
  760. All warning messages are suppressed, and the element is checked in even if identical to the original.
  761. Comment text from the file <c>acomment.txt</c> is added to ClearCase as a comment. All warning messages are suppressed. The file is checked in even if it is identical to the original.
  762. </para>
  763. <code>
  764. <![CDATA[
  765. <cccheckin viewpath="c:/views/viewdir/afile"
  766. commentfile="acomment.txt"
  767. nowarn="true"
  768. identical="true"/>
  769. ]]>
  770. </code>
  771. </example>
  772. </member>
  773. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.ViewPath">
  774. <summary>
  775. Path to the ClearCase view file or directory that the command will
  776. operate on.
  777. </summary>
  778. </member>
  779. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Comment">
  780. <summary>
  781. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Comment"/> or
  782. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommentFile"/> may be used.
  783. </summary>
  784. </member>
  785. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommentFile">
  786. <summary>
  787. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Comment"/>
  788. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommentFile"/> may be used.
  789. </summary>
  790. </member>
  791. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.NoWarn">
  792. <summary>
  793. <see langword="true" /> if warning messages should be suppressed.
  794. The default is <see langword="false" />.
  795. </summary>
  796. </member>
  797. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.PreserveTime">
  798. <summary>
  799. If <see langword="true" />, the modification time will be preserved.
  800. Default is <see langword="false" />.
  801. </summary>
  802. </member>
  803. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.KeepCopy">
  804. <summary>
  805. <see langword="true" /> to keep a view-private copy of the file with
  806. a .keep extension. Default is <see langword="true" />.
  807. </summary>
  808. </member>
  809. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Identical">
  810. <summary>
  811. If <see langword="true" />, files may be checked in even if identical
  812. to the original. Default is <see langword="false" />.
  813. </summary>
  814. </member>
  815. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommandSpecificArguments">
  816. <summary>
  817. This is an override used by the base class to get command specific args.
  818. </summary>
  819. </member>
  820. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut">
  821. <summary>
  822. Checks files out of a ClearCase VOB.
  823. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn"/>
  824. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut"/>
  825. </summary>
  826. <remarks>
  827. <para>
  828. This task uses the <c>cleartool checkout</c> command to check out ClearCase elements.
  829. </para>
  830. </remarks>
  831. <example>
  832. <para>
  833. Performs a ClearCase checkout on the file <c>c:/views/viewdir/afile</c>.
  834. It is checked out as reserved on branch called <c>abranch</c>.
  835. All warning messages are suppressed.
  836. <c>Some comment text</c> is added to ClearCase as a comment.
  837. </para>
  838. <code>
  839. <![CDATA[
  840. <cccheckout viewpath="c:/views/viewdir/afile"
  841. reserved="true"
  842. branch="abranch"
  843. nowarn="true"
  844. comment="Some comment text"/>
  845. ]]>
  846. </code>
  847. </example>
  848. </member>
  849. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.ViewPath">
  850. <summary>
  851. Path to the ClearCase view file or directory that the command will
  852. operate on.
  853. </summary>
  854. </member>
  855. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Reserved">
  856. <summary>
  857. <see langword="true" /> to check the element out as reserved.
  858. Default is <see langword="true" />.
  859. </summary>
  860. </member>
  861. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.OutFile">
  862. <summary>
  863. Creates a writable file under a different filename.
  864. </summary>
  865. </member>
  866. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.NoData">
  867. <summary>
  868. If <see langword="true" />, checks out the file but does not create
  869. an editable file containing its data. Default is <see langword="false" />.
  870. </summary>
  871. </member>
  872. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Branch">
  873. <summary>
  874. Specify a branch to check out the file to.
  875. </summary>
  876. </member>
  877. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Version">
  878. <summary>
  879. If <see langword="true" />, checkouts of elements with a version
  880. other than main latest will be allowed. Default is <see langword="false" />.
  881. </summary>
  882. </member>
  883. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.NoWarn">
  884. <summary>
  885. <see langword="true" /> if warning messages should be suppressed.
  886. The default is <see langword="false" />.
  887. </summary>
  888. </member>
  889. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment">
  890. <summary>
  891. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment"/> or
  892. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile"/> may be used.
  893. </summary>
  894. </member>
  895. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile">
  896. <summary>
  897. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment"/>
  898. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile"/> may be used.
  899. </summary>
  900. </member>
  901. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.PreserveTime">
  902. <summary>
  903. If <see langword="true" />, the modification time will be preserved.
  904. Default is <see langword="false" />.
  905. </summary>
  906. </member>
  907. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommandSpecificArguments">
  908. <summary>
  909. This is an override used by the base class to get command specific args.
  910. </summary>
  911. </member>
  912. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock">
  913. <summary>
  914. Locks ClearCase elements.
  915. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock"/>
  916. </summary>
  917. <remarks>
  918. <para>
  919. This task uses the <c>cleartool lock</c> command to lock ClearCase elements.
  920. </para>
  921. </remarks>
  922. <example>
  923. <para>
  924. Performs a ClearCase lock on the object <c>stream:Application_Integration@\MyProject_PVOB</c>.
  925. </para>
  926. <code>
  927. <![CDATA[
  928. <cclock objsel="stream:Application_Integration@\MyProject_PVOB" />
  929. ]]>
  930. </code>
  931. </example>
  932. </member>
  933. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Replace">
  934. <summary>
  935. If <see langword="true" /> an existing lock can be replaced.
  936. Default is <see langword="false" />.
  937. </summary>
  938. </member>
  939. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Nusers">
  940. <summary>
  941. Specifies user(s) who can still modify the object.
  942. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Nusers"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Obsolete"/> may be
  943. used.
  944. </summary>
  945. </member>
  946. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Obsolete">
  947. <summary>
  948. If <see langword="true"/> the object will be marked obsolete.
  949. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Nusers"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Obsolete"/> may
  950. be used. Default is <see langword="false"/>.
  951. </summary>
  952. </member>
  953. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Comment">
  954. <summary>
  955. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Comment"/> or
  956. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommentFile"/> may be used.
  957. </summary>
  958. </member>
  959. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommentFile">
  960. <summary>
  961. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Comment"/>
  962. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommentFile"/> may be used.
  963. </summary>
  964. </member>
  965. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Pname">
  966. <summary>
  967. Specifies the object pathname to be locked.
  968. </summary>
  969. </member>
  970. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.ObjSel">
  971. <summary>
  972. Specifies the object(s) to be locked.
  973. </summary>
  974. </member>
  975. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommandSpecificArguments">
  976. <summary>
  977. This is an override used by the base class to get command specific args.
  978. </summary>
  979. </member>
  980. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem">
  981. <summary>
  982. Creates elements in a ClearCase VOB.
  983. </summary>
  984. <remarks>
  985. <para>
  986. This task uses the <c>cleartool mkelem</c> command to create ClearCase elements.
  987. </para>
  988. </remarks>
  989. <example>
  990. <para>
  991. Performs a ClearCase mkelem on the file <c>c:/views/viewdir/afile</c> with element type <c>text_file</c>.
  992. It checks in the file after creation and adds <c>Some comment text</c> as a comment.
  993. </para>
  994. <code>
  995. <![CDATA[
  996. <ccmkelem viewpath="c:/views/viewdir/afile"
  997. eltype="text_file"
  998. checkin="true"
  999. comment="Some comment text"/>
  1000. ]]>
  1001. </code>
  1002. </example>
  1003. </member>
  1004. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.ViewPath">
  1005. <summary>
  1006. Path to the ClearCase view file or directory that the command will
  1007. operate on.
  1008. </summary>
  1009. </member>
  1010. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Comment">
  1011. <summary>
  1012. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Comment"/> or
  1013. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommentFile"/> may be used.
  1014. </summary>
  1015. </member>
  1016. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommentFile">
  1017. <summary>
  1018. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Comment"/>
  1019. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommentFile"/> may be used.
  1020. </summary>
  1021. </member>
  1022. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.NoWarn">
  1023. <summary>
  1024. If <see langword="true" />, warning will be suppressed.
  1025. The default is <see langword="false" />.
  1026. </summary>
  1027. </member>
  1028. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.NoCheckout">
  1029. <summary>
  1030. Perform a checkout after element creation.
  1031. Default is <see langword="false" />.
  1032. </summary>
  1033. </member>
  1034. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Checkin">
  1035. <summary>
  1036. Checkin element after creation.
  1037. Default is <see langword="false" />.
  1038. </summary>
  1039. </member>
  1040. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.PreserveTime">
  1041. <summary>
  1042. If <see langword="true" />, the modification time will be preserved.
  1043. Default is <see langword="false" />.
  1044. </summary>
  1045. </member>
  1046. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Master">
  1047. <summary>
  1048. Assign mastership of the main branch to the current site.
  1049. Default is <see langword="false" />.
  1050. </summary>
  1051. </member>
  1052. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.ElType">
  1053. <summary>
  1054. Element type to use during element creation.
  1055. </summary>
  1056. </member>
  1057. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.MkPath">
  1058. <summary>
  1059. Create elements from the view-private parent directories.
  1060. Default is <see langword="false" />.
  1061. </summary>
  1062. </member>
  1063. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommandSpecificArguments">
  1064. <summary>
  1065. This is an override used by the base class to get command specific args.
  1066. </summary>
  1067. </member>
  1068. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel">
  1069. <summary>
  1070. Applies a ClearCase label.
  1071. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType"/>
  1072. </summary>
  1073. <remarks>
  1074. <para>
  1075. This task uses the <c>cleartool mklabel</c> command to apply a ClearCase label to specified elements.
  1076. </para>
  1077. </remarks>
  1078. <example>
  1079. <para>
  1080. Performs a ClearCase mklabel on the file <c>c:/views/viewdir/afile</c> under
  1081. the <c>main</c> branch for <c>version 2</c> (<c>\main\2</c>). All matching
  1082. elements will be applied with label <c>VERSION_1</c>.
  1083. <c>Some comment text</c> is added as a comment. Subdirectories will be recursed.
  1084. </para>
  1085. <code>
  1086. <![CDATA[
  1087. <ccmklabel viewpath="c:/views/viewdir/afile"
  1088. comment="Some comment text"
  1089. recurse="true"
  1090. version="\main\2"
  1091. typename="VERSION_1"/>
  1092. ]]>
  1093. </code>
  1094. </example>
  1095. </member>
  1096. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Typename">
  1097. <summary>
  1098. Name of the label type
  1099. </summary>
  1100. </member>
  1101. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.ViewPath">
  1102. <summary>
  1103. Path to the ClearCase view file or directory that the command will
  1104. operate on.
  1105. </summary>
  1106. </member>
  1107. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Replace">
  1108. <summary>
  1109. If <see langword="true" />, allow the replacement of a
  1110. label of the same type on the same branch.
  1111. The default is <see langword="false" />.
  1112. </summary>
  1113. </member>
  1114. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Recurse">
  1115. <summary>
  1116. If <see langword="true" />, process each subdirectory recursively under the viewpath.
  1117. Default is <see langword="false" />.
  1118. </summary>
  1119. </member>
  1120. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Version">
  1121. <summary>
  1122. Identify a specific version to attach the label to.
  1123. </summary>
  1124. </member>
  1125. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Vob">
  1126. <summary>
  1127. Path to the ClearCase view file or directory that the command will operate on.
  1128. </summary>
  1129. </member>
  1130. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Comment">
  1131. <summary>
  1132. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Comment"/> or
  1133. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommentFile"/> may be used.
  1134. </summary>
  1135. </member>
  1136. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommentFile">
  1137. <summary>
  1138. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Comment"/>
  1139. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommentFile"/> may be used.
  1140. </summary>
  1141. </member>
  1142. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Follow">
  1143. <summary>
  1144. For any VOB symbolic links encountered, labels the corresponding target.
  1145. </summary>
  1146. </member>
  1147. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommandSpecificArguments">
  1148. <summary>
  1149. This is an override used by the base class to get command specific args.
  1150. </summary>
  1151. </member>
  1152. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType">
  1153. <summary>
  1154. Creates a label object in a ClearCase VOB.
  1155. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel"/>
  1156. </summary>
  1157. <remarks>
  1158. <para>
  1159. This task uses the <c>cleartool mklabeltype</c> command to create a ClearCase label object.
  1160. </para>
  1161. </remarks>
  1162. <example>
  1163. <para>
  1164. Performs a ClearCase mklbtype to create a label type named <c>VERSION_1</c>.
  1165. It is created as <c>ordinary</c> so it is available only to the current VOB.
  1166. The text <c>Development version 1</c> is added as a comment.
  1167. </para>
  1168. <code>
  1169. <![CDATA[
  1170. <ccmklbtype typename="VERSION_1"
  1171. ordinary="true"
  1172. comment="Development version 1"/>
  1173. ]]>
  1174. </code>
  1175. </example>
  1176. </member>
  1177. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Typename">
  1178. <summary>
  1179. Name of the label type to create.
  1180. </summary>
  1181. </member>
  1182. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Vob">
  1183. <summary>
  1184. Name of the VOB. Must be a valid path to somewhere on a VOB.
  1185. </summary>
  1186. </member>
  1187. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Replace">
  1188. <summary>
  1189. If <see langword="true" />, allow an existing label definition to be replaced.
  1190. The default is <see langword="false" />.
  1191. </summary>
  1192. </member>
  1193. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Global">
  1194. <summary>
  1195. Creates a label type that is global to the VOB or to VOB's that use this VOB.
  1196. Either global or ordinary can be specified, not both.
  1197. The default is <see langword="false" />.
  1198. </summary>
  1199. </member>
  1200. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Ordinary">
  1201. <summary>
  1202. Creates a label type that can be used only in the current VOB.
  1203. Either global or ordinary can be specified, not both.
  1204. Although <see langword="false" /> by default, if global is also <see langword="false" /> or not specified ordinary is the default behaviour.
  1205. </summary>
  1206. </member>
  1207. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.PBranch">
  1208. <summary>
  1209. If <see langword="true" /> the label type is allowed to be used once per branch in a given element's version tree.
  1210. The default is <see langword="false" />.
  1211. </summary>
  1212. </member>
  1213. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Shared">
  1214. <summary>
  1215. Sets the way mastership is checked by ClearCase. See ClearCase documentation for details.
  1216. The default is <see langword="false" />.
  1217. </summary>
  1218. </member>
  1219. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Comment">
  1220. <summary>
  1221. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Comment"/> or
  1222. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommentFile"/> may be used.
  1223. </summary>
  1224. </member>
  1225. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommentFile">
  1226. <summary>
  1227. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Comment"/>
  1228. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommentFile"/> may be used.
  1229. </summary>
  1230. </member>
  1231. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommandSpecificArguments">
  1232. <summary>
  1233. This is an override used by the base class to get command specific args.
  1234. </summary>
  1235. </member>
  1236. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType">
  1237. <summary>
  1238. Removes elements from a ClearCase VOB.
  1239. </summary>
  1240. <remarks>
  1241. <para>
  1242. This task uses the <c>cleartool rmtype</c> command to remove a ClearCase object.
  1243. </para>
  1244. </remarks>
  1245. <example>
  1246. <para>
  1247. Performs a ClearCase rmtype to remove a <see cref="F:NAnt.Contrib.Types.ClearCase.TypeKind.Label"/>
  1248. type named <c>VERSION_1</c>.
  1249. Comment text from the file <c>acomment.txt</c> is added as a comment.
  1250. All instances of the type are removed, including the type object itself.
  1251. </para>
  1252. <code>
  1253. <![CDATA[
  1254. <ccrmtype typekind="Label"
  1255. typename="VERSION_1"
  1256. commentfile="acomment.txt"
  1257. removeall="true" />
  1258. ]]>
  1259. </code>
  1260. </example>
  1261. </member>
  1262. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.TypeKind">
  1263. <summary>
  1264. The kind of type to remove.
  1265. </summary>
  1266. </member>
  1267. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.TypeName">
  1268. <summary>
  1269. The name of the object to remove.
  1270. </summary>
  1271. </member>
  1272. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Ignore">
  1273. <summary>
  1274. Used with <see cref="F:NAnt.Contrib.Types.ClearCase.TypeKind.Trigger"/> types only.
  1275. Forces removal of <see cref="F:NAnt.Contrib.Types.ClearCase.TypeKind.Trigger"/> type even if a
  1276. pre-operation trigger would prevent its removal.
  1277. The default is <see langword="false"/>.
  1278. </summary>
  1279. </member>
  1280. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.RemoveAll">
  1281. <summary>
  1282. Removes all instances of a type and the type object itself.
  1283. The default is <see langword="false" />.
  1284. </summary>
  1285. </member>
  1286. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Comment">
  1287. <summary>
  1288. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Comment"/> or
  1289. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommentFile"/> may be used.
  1290. </summary>
  1291. </member>
  1292. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommentFile">
  1293. <summary>
  1294. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Comment"/>
  1295. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommentFile"/> may be used.
  1296. </summary>
  1297. </member>
  1298. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommandSpecificArguments">
  1299. <summary>
  1300. This is an override used by the base class to get command specific args.
  1301. </summary>
  1302. </member>
  1303. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut">
  1304. <summary>
  1305. Uncheckout ClearCase elements.
  1306. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn"/>
  1307. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut"/>
  1308. </summary>
  1309. <remarks>
  1310. <para>
  1311. This task uses the <c>cleartool unco</c> command to remove a ClearCase object.
  1312. </para>
  1313. </remarks>
  1314. <example>
  1315. <para>
  1316. Does a ClearCase uncheckout on the file <c>c:/views/viewdir/afile</c>.
  1317. A copy of the file called <c>c:/views/viewdir/afile.keep</c> is kept.
  1318. </para>
  1319. <code>
  1320. <![CDATA[
  1321. <ccuncheckout viewpath="c:/views/viewdir/afile"
  1322. keepcopy="true"/>
  1323. ]]>
  1324. </code>
  1325. </example>
  1326. </member>
  1327. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut.ViewPath">
  1328. <summary>
  1329. Path to the ClearCase view file or directory that the command will
  1330. operate on.
  1331. </summary>
  1332. </member>
  1333. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut.KeepCopy">
  1334. <summary>
  1335. If <see langword="true" />, a view-private copy of the file with a
  1336. .keep extension will be kept. Default is <see langword="true" />.
  1337. </summary>
  1338. </member>
  1339. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut.CommandSpecificArguments">
  1340. <summary>
  1341. This is an override used by the base class to get command specific args.
  1342. </summary>
  1343. </member>
  1344. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock">
  1345. <summary>
  1346. Unlocks ClearCase elements.
  1347. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock"/>
  1348. </summary>
  1349. <remarks>
  1350. <para>
  1351. This task uses the <c>cleartool unlock</c> command to unlock a ClearCase object.
  1352. </para>
  1353. </remarks>
  1354. <example>
  1355. <para>
  1356. Performs a ClearCase unlock on the object <c>stream:Application_Integration@\MyProject_PVOB</c>.
  1357. </para>
  1358. <code>
  1359. <![CDATA[
  1360. <ccunlock objsel="stream:Application_Integration@\MyProject_PVOB" />
  1361. ]]>
  1362. </code>
  1363. </example>
  1364. </member>
  1365. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Comment">
  1366. <summary>
  1367. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Comment"/> or
  1368. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommentFile"/> may be used.
  1369. </summary>
  1370. </member>
  1371. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommentFile">
  1372. <summary>
  1373. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Comment"/>
  1374. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommentFile"/> may be used.
  1375. </summary>
  1376. </member>
  1377. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Pname">
  1378. <summary>
  1379. Specifies the object pathname to be unlocked.
  1380. </summary>
  1381. </member>
  1382. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.ObjSel">
  1383. <summary>
  1384. Specifies the object(s) to be unlocked.
  1385. </summary>
  1386. </member>
  1387. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommandSpecificArguments">
  1388. <summary>
  1389. This is an override used by the base class to get command specific args.
  1390. </summary>
  1391. </member>
  1392. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate">
  1393. <summary>
  1394. Updates a ClearCase view.
  1395. </summary>
  1396. <remarks>
  1397. <para>
  1398. This task uses the <c>cleartool update</c> command to update a ClearCase view.
  1399. </para>
  1400. </remarks>
  1401. <example>
  1402. <para>
  1403. Performs a ClearCase update on the snapshot view directory <c>c:/views/viewdir</c>.
  1404. A graphical dialog will be displayed.
  1405. The output will be logged to <c>log.log</c> and it will overwrite any hijacked files.
  1406. The modified time will be set to the current time.
  1407. </para>
  1408. <code>
  1409. <![CDATA[
  1410. <ccupdate viewpath="c:/views/viewdir"
  1411. graphical="false"
  1412. log="log.log"
  1413. overwrite="true"
  1414. currenttime="true"
  1415. rename="false"/>
  1416. ]]>
  1417. </code>
  1418. </example>
  1419. </member>
  1420. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.ViewPath">
  1421. <summary>
  1422. Path to the ClearCase view file or directory that the command will
  1423. operate on.
  1424. </summary>
  1425. </member>
  1426. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.Graphical">
  1427. <summary>
  1428. Displays a graphical dialog during the update.
  1429. The default is <see langword="false" />.
  1430. </summary>
  1431. </member>
  1432. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.LogFile">
  1433. <summary>
  1434. Specifies a log file for ClearCase to write to.
  1435. </summary>
  1436. </member>
  1437. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.Overwrite">
  1438. <summary>
  1439. If <see langword="true" />, hijacked files will be overwritten.
  1440. The default is <see langword="false" />.
  1441. </summary>
  1442. </member>
  1443. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.Rename">
  1444. <summary>
  1445. If <see langword="true" />, hijacked files will be renamed with a .keep extension.
  1446. The default is <see langword="false" />.
  1447. </summary>
  1448. </member>
  1449. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CurrentTime">
  1450. <summary>
  1451. Specifies that modification time should be written as the current time.
  1452. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CurrentTime"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.PreserveTime"/>
  1453. can be specified. The default is <see langword="false"/>.
  1454. </summary>
  1455. </member>
  1456. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.PreserveTime">
  1457. <summary>
  1458. Specifies that modification time should preserved from the VOB time.
  1459. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CurrentTime"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.PreserveTime"/>
  1460. can be specified. The default is <see langword="false"/>.
  1461. </summary>
  1462. </member>
  1463. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CommandSpecificArguments">
  1464. <summary>
  1465. This is an override used by the base class to get command specific args.
  1466. </summary>
  1467. </member>
  1468. <member name="T:NAnt.Contrib.Tasks.Grep.GrepTask">
  1469. <summary>
  1470. Searches files for a regular-expression and produces an XML report of
  1471. the matches.
  1472. </summary>
  1473. <example>
  1474. <para>
  1475. Extract all <i>TODO:</i>, <i>UNDONE:</i> or <i>HACK:</i>-
  1476. comment-tags from C# source files and write them to a file
  1477. <i>out.xml</i>. (A xslt-stylesheet could then transform it to
  1478. a nice html-page for your project-homepage, but that is beyond
  1479. the scope of this example.)
  1480. </para>
  1481. <para>
  1482. <i>Path</i>, <i>File</i> and <i>LineNumber</i> are automatically
  1483. generated elements.
  1484. </para>
  1485. <code>
  1486. <![CDATA[
  1487. <grep output="out.xml" pattern="// (?'Type'TODO|UNDONE|HACK): (\[(?'Author'\w*),(?'Date'.*)\])? (?'Text'[^\n\r]*)">
  1488. <fileset>
  1489. <include name="*.cs" />
  1490. </fileset>
  1491. </grep>
  1492. ]]>
  1493. </code>
  1494. <para>
  1495. The resulting XML file for a comment-tag
  1496. 'TODO: [md, 14-02-2004] comment this method'
  1497. will look like
  1498. </para>
  1499. <code>
  1500. <![CDATA[
  1501. <?xml version="1.0" encoding="utf-8" ?>
  1502. <Matches>
  1503. <Match>
  1504. <Type>TODO</Type>
  1505. <Text>comment this method</Text>
  1506. <Path>C:\MyProjects\MyPath</Path>
  1507. <File>MyFile.cs</Filename>
  1508. <LineNumber>146</LineNumber>
  1509. <Author>md</Author>
  1510. <Date>14-02-2004</Date>
  1511. </Match>
  1512. ...
  1513. </Matches>
  1514. ]]>
  1515. </code>
  1516. </example>
  1517. </member>
  1518. <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.ExecuteTask">
  1519. <summary>
  1520. Performs the regex-search.
  1521. </summary>
  1522. </member>
  1523. <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.WriteXml(NAnt.Contrib.Tasks.Grep.MatchCollection,System.IO.StreamWriter)">
  1524. <summary>
  1525. Writes the collection of matches to the specified <see cref="T:System.IO.StreamWriter"/>
  1526. in XML format.
  1527. </summary>
  1528. <param name="matches">The matches to write.</param>
  1529. <param name="writer"><see cref="T:System.IO.StreamWriter"/> to write the matches to.</param>
  1530. </member>
  1531. <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.WriteMatches(NAnt.Contrib.Tasks.Grep.MatchCollection)">
  1532. <summary>
  1533. Writes the specified matches to <see cref="P:NAnt.Contrib.Tasks.Grep.GrepTask.OutputFile"/>.
  1534. </summary>
  1535. <param name="matches">The collection of matches to write.</param>
  1536. </member>
  1537. <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.OutputFile">
  1538. <summary>
  1539. Specifies the name of the output file.
  1540. </summary>
  1541. </member>
  1542. <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.Pattern">
  1543. <summary>
  1544. Specifies the regular-expression to search for.
  1545. </summary>
  1546. </member>
  1547. <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.InputFiles">
  1548. <summary>
  1549. The set of files in which the expression is searched.
  1550. </summary>
  1551. </member>
  1552. <member name="T:NAnt.Contrib.Tasks.Grep.LineCounter">
  1553. <summary>
  1554. This purpose of this class is to get the line-numbers within
  1555. a string for a specific position of a character
  1556. (an index, as returned by the <see cref="T:System.Text.RegularExpressions.Regex"/> class).
  1557. </summary>
  1558. </member>
  1559. <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._string">
  1560. <summary>
  1561. The string to count in
  1562. </summary>
  1563. </member>
  1564. <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentPos">
  1565. <summary>
  1566. The current position within <see cref="F:NAnt.Contrib.Tasks.Grep.LineCounter._string"/>.
  1567. </summary>
  1568. </member>
  1569. <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentLine">
  1570. <summary>
  1571. The number of line feeds upto (but exluding) <see cref="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentPos"/>.
  1572. </summary>
  1573. </member>
  1574. <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.#ctor(System.String)">
  1575. <summary>
  1576. Constructs a line-counter for a <see cref="T:System.String"/>.
  1577. </summary>
  1578. <param name="str"><see cref="T:System.String"/> for which lines are counted.</param>
  1579. </member>
  1580. <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.CountTo(System.Int32)">
  1581. <summary>
  1582. Counts the line-numbers until the position <paramref name="pos" />
  1583. is reached.
  1584. </summary>
  1585. <param name="pos">Index into the string given during construction </param>
  1586. <returns>
  1587. The number of lines.
  1588. </returns>
  1589. </member>
  1590. <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.Count(System.String,System.Char,System.Int32,System.Int32)">
  1591. <summary>
  1592. Counts the number of occurences of <paramref name="c"/> in the
  1593. range from <paramref name="start"/> to <paramref name="end"/> in
  1594. string <paramref name="str"/>.
  1595. </summary>
  1596. <param name="str"><see cref="T:System.String"/> to count in.</param>
  1597. <param name="c">Character to count.</param>
  1598. <param name="start">Start of range.</param>
  1599. <param name="end">End of range.</param>
  1600. <returns>
  1601. The number of occurences of <paramref name="c"/> in the range from
  1602. <paramref name="start"/> to <paramref name="end"/> in string
  1603. <paramref name="str"/>.
  1604. </returns>
  1605. </member>
  1606. <member name="T:NAnt.Contrib.Tasks.Grep.Match">
  1607. <summary>
  1608. Encapsulation of a match of a regular-expression with the
  1609. associated named capture-groups.
  1610. </summary>
  1611. </member>
  1612. <member name="F:NAnt.Contrib.Tasks.Grep.Match.values">
  1613. <summary>
  1614. <see cref="T:System.Collections.Hashtable"/> containing the mapping from group names
  1615. to values.
  1616. </summary>
  1617. </member>
  1618. <member name="M:NAnt.Contrib.Tasks.Grep.Match.WriteXml(System.Xml.XmlTextWriter)">
  1619. <summary>
  1620. Writes this match to an <see cref="T:System.Xml.XmlTextWriter"/>.
  1621. </summary>
  1622. <param name="xmlWriter">The <see cref="T:System.Xml.XmlTextWriter"/> to write to.</param>
  1623. </member>
  1624. <member name="P:NAnt.Contrib.Tasks.Grep.Match.Item(System.String)">
  1625. <summary>
  1626. Gets or sets the value for a capture group.
  1627. </summary>
  1628. </member>
  1629. <member name="T:NAnt.Contrib.Tasks.Grep.MatchCollection">
  1630. <summary>
  1631. A strongly-typed collection of <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances.
  1632. </summary>
  1633. </member>
  1634. <member name="M:NAnt.Contrib.Tasks.Grep.MatchCollection.Add(NAnt.Contrib.Tasks.Grep.Match)">
  1635. <summary>
  1636. Adds a <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> to this collection.
  1637. </summary>
  1638. <param name="match"><see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> to add.</param>
  1639. </member>
  1640. <member name="M:NAnt.Contrib.Tasks.Grep.MatchCollection.Add(NAnt.Contrib.Tasks.Grep.MatchCollection)">
  1641. <summary>
  1642. Adds all <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances <paramref name="matches"/>
  1643. to this collection.
  1644. </summary>
  1645. <param name="matches">Collection of <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances to add.</param>
  1646. </member>
  1647. <member name="P:NAnt.Contrib.Tasks.Grep.MatchCollection.Item(System.Int32)">
  1648. <summary>
  1649. Gets the <paramref name="idx" />th match stored in this collection.
  1650. </summary>
  1651. </member>
  1652. <member name="T:NAnt.Contrib.Tasks.Grep.Pattern">
  1653. <summary>
  1654. Encapsulation of a search pattern.
  1655. </summary>
  1656. </member>
  1657. <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.#ctor(System.String)">
  1658. <summary>
  1659. Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.Grep.Pattern"/> class from
  1660. a regular-expression.
  1661. </summary>
  1662. <param name="regex">The regular-expression.</param>
  1663. </member>
  1664. <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.ConcatenateCaptures(System.Text.RegularExpressions.Group)">
  1665. <summary>
  1666. Concatenates the captures of <paramref name="group"/> to a string.
  1667. </summary>
  1668. <param name="group"><see cref="T:System.Text.RegularExpressions.Group"/> containing the captures.</param>
  1669. <returns>
  1670. <see cref="T:System.String"/> containg the concatenated captures.
  1671. </returns>
  1672. <remarks>
  1673. A named-group can captured multiple times, when the regular
  1674. expression has a quantifier, e.g. (// (?'Text'.*) )* will match
  1675. multiline comments with group <i>Text</i> having a capture for
  1676. every line.
  1677. </remarks>
  1678. </member>
  1679. <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.Extract(System.String,System.String)">
  1680. <summary>
  1681. Extracts the matches of this pattern from <paramref name="source" />.
  1682. </summary>
  1683. <param name="filename">The name of the file associated with <paramref name="source" />.</param>
  1684. <param name="source">The source string</param>
  1685. <returns>
  1686. A collection of found matches.
  1687. </returns>
  1688. </member>
  1689. <member name="T:NAnt.Contrib.Tasks.Mks.BaseTask">
  1690. <summary>
  1691. The base abstract class for all MKS Tasks.
  1692. </summary>
  1693. <remarks>
  1694. Provides the core attributes, and functionality for opening an item
  1695. in a MKS database.
  1696. </remarks>
  1697. </member>
  1698. <member name="M:NAnt.Contrib.Tasks.Mks.BaseTask.Open">
  1699. <summary>
  1700. Opens the MKS database and sets the reference to the specified
  1701. item and version.
  1702. </summary>
  1703. </member>
  1704. <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Password">
  1705. <summary>
  1706. The password to use to login to the MKS database.
  1707. </summary>
  1708. </member>
  1709. <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.UserName">
  1710. <summary>
  1711. The name of the user needed to access the MKS database.
  1712. </summary>
  1713. </member>
  1714. <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Host">
  1715. <summary>
  1716. The name of the host MKS server to connect to
  1717. </summary>
  1718. </member>
  1719. <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Port">
  1720. <summary>
  1721. The port number on which the host server is accepting requests
  1722. </summary>
  1723. </member>
  1724. <member name="T:NAnt.Contrib.Tasks.Mks.CheckpointTask">
  1725. <summary>
  1726. Checkpoints a project in an MKS Source Integrity database.
  1727. </summary>
  1728. <example>
  1729. <para>Checkpoint a project in an MKS database.</para>
  1730. <code><![CDATA[
  1731. <mkscheckpoint
  1732. username="myusername"
  1733. password="mypassword"
  1734. host="servername"
  1735. port="123"
  1736. project="myproject"
  1737. recursive="false"
  1738. label="test from nant"
  1739. description="this is a test description"
  1740. />
  1741. ]]></code>
  1742. </example>
  1743. </member>
  1744. <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Label">
  1745. <summary>
  1746. The label to apply to the checkpoint.
  1747. </summary>
  1748. </member>
  1749. <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.ProjectName">
  1750. <summary>
  1751. The project to checkpoint.
  1752. </summary>
  1753. </member>
  1754. <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Recursive">
  1755. <summary>
  1756. Apply label to all members. The default is <see langword="false" />.
  1757. </summary>
  1758. </member>
  1759. <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Description">
  1760. <summary>
  1761. The description of the checkpoint.
  1762. </summary>
  1763. </member>
  1764. <member name="T:NAnt.Contrib.Tasks.Mks.GetTask">
  1765. <summary>
  1766. Retrieves an item or project from MKS Source Integrity.
  1767. </summary>
  1768. <example>
  1769. <para>Synchronise sandbox with MKS project.</para>
  1770. <code><![CDATA[
  1771. <mksget
  1772. username="myusername"
  1773. password="mypassword"
  1774. host="servername"
  1775. port="123"
  1776. localpath="c:\sourcecode"
  1777. project="e:/MKS projects/myproject/testproject.pj"
  1778. />
  1779. ]]></code>
  1780. </example>
  1781. </member>
  1782. <member name="P:NAnt.Contrib.Tasks.Mks.GetTask.LocalPath">
  1783. <summary>
  1784. The path to the local working directory.
  1785. </summary>
  1786. </member>
  1787. <member name="P:NAnt.Contrib.Tasks.Mks.GetTask.ProjectName">
  1788. <summary>
  1789. The project to get from MKS.
  1790. </summary>
  1791. </member>
  1792. <member name="T:NAnt.Contrib.Tasks.Mks.ChangesTask">
  1793. <summary>
  1794. Generates an XML file containing the differences between the sandbox and
  1795. the project in the MKS database.
  1796. </summary>
  1797. <example>
  1798. <para>Get changes to a project in an MKS database.</para>
  1799. <code><![CDATA[
  1800. <mkschanges
  1801. username="myusername"
  1802. password="mypassword"
  1803. host="servername"
  1804. port="123"
  1805. sandbox="mysandbox.pj"
  1806. output="mychanges.xml"
  1807. />
  1808. ]]></code>
  1809. </example>
  1810. </member>
  1811. <member name="P:NAnt.Contrib.Tasks.Mks.ChangesTask.Sandbox">
  1812. <summary>
  1813. The project to retrieve the changes for.
  1814. </summary>
  1815. </member>
  1816. <member name="P:NAnt.Contrib.Tasks.Mks.ChangesTask.OutputFile">
  1817. <summary>
  1818. The file where the output will be stored in XML format.
  1819. </summary>
  1820. </member>
  1821. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand">
  1822. <summary>
  1823. Base class for <see cref="T:NAnt.Contrib.Tasks.Msi.MsiCreationCommand"/> and <see cref="T:NAnt.Contrib.Tasks.Msi.MsmCreationCommand"/>.
  1824. </summary>
  1825. </member>
  1826. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.IsVersion(System.String@)">
  1827. <summary>
  1828. Determines if the supplied version string is valid. A valid version string should look like:
  1829. 1
  1830. 1.1
  1831. 1.1.1
  1832. 1.1.1.1
  1833. </summary>
  1834. <param name="Version">The version string to verify.</param>
  1835. <returns></returns>
  1836. </member>
  1837. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ReorderFiles(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32@)">
  1838. <summary>
  1839. Sets the sequence number of files to match their
  1840. storage order in the cabinet file, after some
  1841. files have had their filenames changed to go in
  1842. their own component.
  1843. </summary>
  1844. <param name="database">The MSI database.</param>
  1845. <param name="LastSequence">The last file's sequence number.</param>
  1846. </member>
  1847. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CleanOutput(System.String,System.String)">
  1848. <summary>
  1849. Cleans the output directory after a build.
  1850. </summary>
  1851. <param name="cabFile">The path to the cabinet file.</param>
  1852. <param name="tempPath">The path to temporary files.</param>
  1853. </member>
  1854. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1855. <summary>
  1856. Loads records for the Properties table.
  1857. </summary>
  1858. <param name="database">The MSI database.</param>
  1859. </member>
  1860. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDirectories(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1861. <summary>
  1862. Loads records for the Directories table.
  1863. </summary>
  1864. <param name="database">The MSI database.</param>
  1865. </member>
  1866. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddDirectory(NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,NAnt.Contrib.Schemas.Msi.MSIDirectory,System.Int32)">
  1867. <summary>
  1868. Adds a directory record to the directories table.
  1869. </summary>
  1870. <param name="database">The MSI database.</param>
  1871. <param name="directoryTable">The MSI database view.</param>
  1872. <param name="ParentDirectory">The parent directory.</param>
  1873. <param name="Directory">This directory's Schema object.</param>
  1874. <param name="Depth">The tree depth of this directory.</param>
  1875. </member>
  1876. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetRelativePath(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,System.String,System.String,System.Text.StringBuilder,NAnt.Contrib.Tasks.Msi.InstallerTable)">
  1877. <summary>
  1878. Retrieves the relative path of a file based on
  1879. the component it belongs to and its entry in
  1880. the MSI directory table.
  1881. </summary>
  1882. <param name="database">The MSI database.</param>
  1883. <param name="Name">The Name of the Folder</param>
  1884. <param name="Parent">The Parent of the Folder</param>
  1885. <param name="Default">The Relative Filesystem Path of the Folder</param>
  1886. <param name="Path">The Path to the Folder from previous calls.</param>
  1887. <param name="directoryTable">The MSI database view.</param>
  1888. </member>
  1889. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetDisplayablePath(System.String)">
  1890. <summary>
  1891. If the specified path is longer than 40 characters, 37 are returned plus ...
  1892. </summary>
  1893. <param name="path">A shortened path</param>
  1894. <returns></returns>
  1895. </member>
  1896. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortFile(System.String)">
  1897. <summary>
  1898. Retrieves a DOS 8.3 filename for a file.
  1899. </summary>
  1900. <param name="LongFile">The file to shorten.</param>
  1901. <returns>The new shortened file.</returns>
  1902. </member>
  1903. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortPath(System.String)">
  1904. <summary>
  1905. Retrieves a DOS 8.3 filename for a directory.
  1906. </summary>
  1907. <param name="LongPath">The path to shorten.</param>
  1908. <returns>The new shortened path.</returns>
  1909. </member>
  1910. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortDir(System.String)">
  1911. <summary>
  1912. Retrieves a DOS 8.3 filename for a complete directory.
  1913. </summary>
  1914. <param name="LongPath">The path to shorten.</param>
  1915. <returns>The new shortened path.</returns>
  1916. </member>
  1917. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ExpandPropertiesInNodes(System.Xml.XmlNodeList)">
  1918. <summary>
  1919. Recursively expands properties of all attributes of
  1920. a nodelist and their children.
  1921. </summary>
  1922. <param name="Nodes">The nodes to recurse.</param>
  1923. </member>
  1924. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ByteArrayToString(System.Byte[])">
  1925. <summary>
  1926. Converts the Byte array in a public key
  1927. token of an assembly to a string MSI expects.
  1928. </summary>
  1929. <param name="ByteArray">The array of bytes.</param>
  1930. <returns>The string containing the array.</returns>
  1931. </member>
  1932. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadTypeLibs(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1933. <summary>
  1934. Loads TypeLibs for the TypeLib table.
  1935. </summary>
  1936. <param name="database">The MSI database.</param>
  1937. </member>
  1938. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadEnvironmentVariables(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1939. <summary>
  1940. Loads environment variables for the Environment table.
  1941. </summary>
  1942. <param name="database">The MSI database.</param>
  1943. </member>
  1944. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadRegistry(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1945. <summary>
  1946. Loads records for the Registry table.
  1947. </summary>
  1948. <param name="database">The MSI database.</param>
  1949. </member>
  1950. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadRegistryLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1951. <summary>
  1952. Loads records for the RegLocator table
  1953. </summary>
  1954. <param name="database">The MSI database.</param>
  1955. </member>
  1956. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1957. <summary>
  1958. Loads records for the CompLocator table
  1959. </summary>
  1960. <param name="database">The MSI database.</param>
  1961. </member>
  1962. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIniLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1963. <summary>
  1964. Loads records for the IniLocator table
  1965. </summary>
  1966. <param name="database">The MSI database.</param>
  1967. </member>
  1968. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDirFileLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1969. <summary>
  1970. Loads records for the DrLocator table
  1971. </summary>
  1972. <param name="database">The MSI database.</param>
  1973. </member>
  1974. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDepreciatedLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1975. <summary>
  1976. Loads records for the RegLocator table
  1977. </summary>
  1978. <param name="database">The MSI database.</param>
  1979. </member>
  1980. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetRegistryRootByName(System.String)">
  1981. <summary>
  1982. Gets the name of the registry root id by it's name.
  1983. </summary>
  1984. <param name="root">Name of the registry root</param>
  1985. <returns></returns>
  1986. </member>
  1987. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadApplicationSearch(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1988. <summary>
  1989. Loads records for the AppSearch table
  1990. </summary>
  1991. <param name="database">The MSI database.</param>
  1992. </member>
  1993. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIconData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1994. <summary>
  1995. Loads records for the Icon table.
  1996. </summary>
  1997. <param name="database">The MSI database.</param>
  1998. </member>
  1999. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadShortcutData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2000. <summary>
  2001. Loads records for the Shortcut table.
  2002. </summary>
  2003. <param name="database">The MSI database.</param>
  2004. </member>
  2005. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadUserDefinedTables(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2006. <summary>
  2007. Adds custom table(s) to the msi database
  2008. </summary>
  2009. <param name="database">The MSI database.</param>
  2010. </member>
  2011. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddTableData(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,NAnt.Contrib.Schemas.Msi.MSITable,System.Collections.ArrayList)">
  2012. <summary>
  2013. Adds table data to the msi database table structure
  2014. </summary>
  2015. <param name="database">The MSI database.</param>
  2016. <param name="currentTable">The current table name</param>
  2017. <param name="xmlTable">Xml node representing the current table</param>
  2018. <param name="columnList">List of column objects for the current table (Containing: column name, id, type).</param>
  2019. </member>
  2020. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadBinaryData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2021. <summary>
  2022. Loads records for the Binary table. This table stores items
  2023. such as bitmaps, animations, and icons. The binary table is
  2024. also used to store data for custom actions.
  2025. </summary>
  2026. <param name="database">The MSI database.</param>
  2027. </member>
  2028. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2029. <summary>
  2030. Loads records for the Dialog table.
  2031. </summary>
  2032. <param name="database">The MSI database.</param>
  2033. </member>
  2034. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2035. <summary>
  2036. Loads records for the Control table.
  2037. </summary>
  2038. <param name="database">The MSI database.</param>
  2039. </member>
  2040. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlConditionData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2041. <summary>
  2042. Loads records for the ControlCondtion table.
  2043. </summary>
  2044. <param name="database">The MSI database.</param>
  2045. </member>
  2046. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlEventData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2047. <summary>
  2048. Loads records for the ControlEvent table.
  2049. </summary>
  2050. <param name="database">The MSI database.</param>
  2051. </member>
  2052. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadCustomAction(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2053. <summary>
  2054. Loads records for the CustomAction table
  2055. </summary>
  2056. <param name="database">The MSI database.</param>
  2057. </member>
  2058. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadActionText(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2059. <summary>
  2060. Loads records for the ActionText table. Allows users to specify descriptions/templates for actions.
  2061. </summary>
  2062. <param name="database">The MSI database.</param>
  2063. </member>
  2064. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppMappings(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2065. <summary>
  2066. Loads records for the _AppMappings table.
  2067. </summary>
  2068. <param name="database">The MSI database.</param>
  2069. </member>
  2070. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadUrlProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2071. <summary>
  2072. Loads records for the _UrlToDir table.
  2073. "Load the url properties to convert
  2074. url properties to a properties object" ??
  2075. </summary>
  2076. <param name="database">The MSI database.</param>
  2077. </member>
  2078. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadVDirProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2079. <summary>
  2080. Loads records for the _VDirToUrl table.
  2081. Used for converting a vdir to an url
  2082. </summary>
  2083. <param name="database">The MSI database.</param>
  2084. </member>
  2085. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppRootCreate(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2086. <summary>
  2087. Loads records for the _AppRootCreate table.
  2088. Used for making a virtual directory a virtual application
  2089. </summary>
  2090. <param name="database">The MSI database.</param>
  2091. </member>
  2092. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIISDirectoryProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2093. <summary>
  2094. Loads records for the _IISProperties table.
  2095. </summary>
  2096. <param name="database">The MSI database.</param>
  2097. </member>
  2098. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CheckAssemblyForCOMInterop(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,System.Reflection.Assembly,System.String,System.String,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable)">
  2099. <summary>
  2100. Enumerates the registry to see if an assembly has been registered
  2101. for COM interop, and if so adds these registry keys to the Registry
  2102. table, ProgIds to the ProgId table, classes to the Classes table,
  2103. and a TypeLib to the TypeLib table.
  2104. </summary>
  2105. <param name="database">The MSI database.</param>
  2106. <param name="fileName">The Assembly filename.</param>
  2107. <param name="fileAssembly">The Assembly to check.</param>
  2108. <param name="componentName">The name of the containing component.</param>
  2109. <param name="assemblyComponentName">The name of the containing component's assembly GUID.</param>
  2110. <param name="classTable">View containing the Class table.</param>
  2111. <param name="progIdTable">View containing the ProgId table.</param>
  2112. </member>
  2113. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadSummaryInformation(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2114. <summary>
  2115. Loads properties for the Summary Information Stream.
  2116. </summary>
  2117. <param name="database">The MSI database.</param>
  2118. </member>
  2119. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CreateCabFile(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2120. <summary>
  2121. Creates a .cab file with all source files included.
  2122. </summary>
  2123. <param name="database">The MSI database.</param>
  2124. </member>
  2125. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadSequence(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2126. <summary>
  2127. Loads records for the sequence tables.
  2128. </summary>
  2129. <param name="database">The MSI database.</param>
  2130. </member>
  2131. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddFiles(NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Schemas.Msi.MSIComponent,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,System.String,System.Int32@,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable)">
  2132. <summary>
  2133. Adds a file record to the Files table.
  2134. </summary>
  2135. <param name="database">The MSI database.</param>
  2136. <param name="directoryTable">The MSI database view.</param>
  2137. <param name="Component">The Component's XML Element.</param>
  2138. <param name="fileTable">The MSI database view.</param>
  2139. <param name="ComponentDirectory">The directory of this file's component.</param>
  2140. <param name="ComponentName">The name of this file's component.</param>
  2141. <param name="Sequence">The installation sequence number of this file.</param>
  2142. <param name="msiAssemblyTable">View containing the MsiAssembly table.</param>
  2143. <param name="msiAssemblyNameTable">View containing the MsiAssemblyName table.</param>
  2144. <param name="componentTable">View containing the Components table.</param>
  2145. <param name="featureComponentTable">View containing the FeatureComponents table.</param>
  2146. <param name="classTable">View containing the Class table.</param>
  2147. <param name="progIdTable">View containing the ProgId table.</param>
  2148. <param name="selfRegTable">View containing the SelfReg table.</param>
  2149. <param name="modComponentTable">ModuleComponent table.</param>
  2150. </member>
  2151. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadComponents(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32@)">
  2152. <summary>
  2153. Loads records for the Components table.
  2154. </summary>
  2155. <param name="database">The MSI database.</param>
  2156. <param name="LastSequence">The sequence number of the last file in the .cab</param>
  2157. </member>
  2158. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.Execute">
  2159. <summary>
  2160. Executes the Task.
  2161. </summary>
  2162. <remarks>None.</remarks>
  2163. </member>
  2164. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerDatabase">
  2165. <summary>
  2166. .NET wrapper for a Windows Installer database
  2167. </summary>
  2168. </member>
  2169. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.DropEmptyTables">
  2170. <summary>
  2171. Drops empty tables.
  2172. </summary>
  2173. </member>
  2174. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.DropEmptyTables(System.Boolean)">
  2175. <summary>
  2176. Drops the empty tables.
  2177. </summary>
  2178. <param name="isMergeModule">Determines if this is a merge module or not</param>
  2179. <remarks>If it is a merge module, the FeatureComponents table should not be dropped.</remarks>
  2180. </member>
  2181. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.VerifyTableEmpty(System.String)">
  2182. <summary>
  2183. Checks to see if the specified table is empty.
  2184. </summary>
  2185. <param name="TableName">Name of the table to check existance.</param>
  2186. <returns>True if empy and False if full.</returns>
  2187. </member>
  2188. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.VerifyTableExistance(System.String)">
  2189. <summary>
  2190. Checks to see if the specified table exists in the database
  2191. already.
  2192. </summary>
  2193. <param name="TableName">Name of the table to check existance.</param>
  2194. <returns>True if successful.</returns>
  2195. </member>
  2196. <member name="T:NAnt.Contrib.Tasks.Msi.Installer">
  2197. <remarks>
  2198. Helper class used to avoid errors when instantiating
  2199. WindowsInstaller.Installer.
  2200. </remarks>
  2201. </member>
  2202. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerRecordReader">
  2203. <summary>
  2204. Use to read and manipulate existing records.
  2205. </summary>
  2206. </member>
  2207. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.#ctor(WindowsInstaller.View)">
  2208. <summary>
  2209. Creates a new reader for the entries in the view
  2210. </summary>
  2211. <param name="view">Database view to read entries from. Must be Execute()'ed already.</param>
  2212. </member>
  2213. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.Read">
  2214. <summary>
  2215. Moves to the next record
  2216. </summary>
  2217. <returns>False iff no more records</returns>
  2218. </member>
  2219. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.DeleteCurrentRecord">
  2220. <summary>
  2221. Deletes the current record. Needs no Commit().
  2222. </summary>
  2223. </member>
  2224. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.SetValue(System.Int32,System.Object)">
  2225. <summary>
  2226. Set the value of a field in the current record. Remember to Commit()
  2227. </summary>
  2228. <param name="index">Zero-based index of the field to set</param>
  2229. <param name="value">New value</param>
  2230. </member>
  2231. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.GetString(System.Int32)">
  2232. <summary>
  2233. Get the string value of a field in the current record.
  2234. </summary>
  2235. <param name="index">Zero-based index of the field to get</param>
  2236. </member>
  2237. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.Commit">
  2238. <summary>
  2239. Commits changes to the current record.
  2240. </summary>
  2241. </member>
  2242. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerSearchClause">
  2243. <summary>
  2244. A simple class for a single search clause.
  2245. TODO: more comparison types, use of the Composite pattern, etc.
  2246. </summary>
  2247. </member>
  2248. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerTable">
  2249. <summary>
  2250. Represents a single table in a Windows Installer archive
  2251. </summary>
  2252. </member>
  2253. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerTaskBase">
  2254. <summary>
  2255. Base class for msi/msm installer tasks
  2256. </summary>
  2257. </member>
  2258. <member name="T:NAnt.Contrib.Tasks.SchemaValidatedTask">
  2259. <summary>
  2260. Abstract <see cref="T:NAnt.Core.Task"/> that validates inheriting classes against
  2261. an XML schema of the same name.
  2262. </summary>
  2263. </member>
  2264. <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)">
  2265. <summary>
  2266. Initializes the task and verifies parameters.
  2267. </summary>
  2268. <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>
  2269. </member>
  2270. <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.Task_OnSchemaValidate(System.Object,System.Xml.Schema.ValidationEventArgs)">
  2271. <summary>
  2272. Occurs when a validation error is raised.
  2273. </summary>
  2274. <param name="sender">The object that sent the event.</param>
  2275. <param name="args">Validation arguments passed in.</param>
  2276. </member>
  2277. <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.ExpandPropertiesInNodes(System.Xml.XmlNodeList)">
  2278. <summary>
  2279. Recursively expands properties of all attributes of
  2280. a nodelist and their children.
  2281. </summary>
  2282. <param name="Nodes">The nodes to recurse.</param>
  2283. </member>
  2284. <member name="P:NAnt.Contrib.Tasks.SchemaValidatedTask.SchemaObject">
  2285. <summary>
  2286. Returns the object from the Schema wrapper after
  2287. <see cref="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)"/> is called.
  2288. </summary>
  2289. <value>The object from the Schema wrapper after <see cref="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)"/> is called.</value>
  2290. </member>
  2291. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiOutput">
  2292. <summary>
  2293. The name of the file that will be generated when the task completes
  2294. execution (eg. MyInstall.msi or MyMergeModule.msm).
  2295. </summary>
  2296. </member>
  2297. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiSourceDir">
  2298. <summary>
  2299. A directory relative to the NAnt script in which the msi task resides
  2300. from which to retrieve files that will be installed by the msi
  2301. database. All files that will be included in your installation need
  2302. to be located directly within or in subdirectories of this directory.
  2303. </summary>
  2304. </member>
  2305. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiTemplate">
  2306. <summary>
  2307. A installer file to use as the starting database in which all files
  2308. and entries will be made, and then copied to the filename specified
  2309. by the output parameter. Install templates are included with the
  2310. install tasks, you only need to supply this value if you want to
  2311. override the default template.
  2312. </summary>
  2313. </member>
  2314. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiErrorTemplate">
  2315. <summary>
  2316. A .mst file to use as the starting database containing strings
  2317. displayed to the user when errors occur during installation.
  2318. A .mst template is included with the msi task, you only need to
  2319. supply this value if you want to override the default error
  2320. template and cannot perform something through the features of the
  2321. msi task.
  2322. </summary>
  2323. </member>
  2324. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiDebug">
  2325. <summary>
  2326. Causes the generated msi database file to contain debug messages for
  2327. errors created by inconsistencies in creation of the database. This
  2328. makes the file slightly larger and should be avoided when generating
  2329. a production release of your software.
  2330. </summary>
  2331. </member>
  2332. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSummaryInformationElement">
  2333. <summary>
  2334. <para>
  2335. Sets various properties in the SummaryInformation stream
  2336. (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/summary_information_stream.asp)
  2337. </para>
  2338. <para>
  2339. All of the sub-elements are optional.
  2340. </para>
  2341. <h3>Nested Elements:</h3>
  2342. <h4>&lt;title&gt;</h4>
  2343. <ul>
  2344. Briefly describes the type of installer package. Phrases such as "Installation Database" or
  2345. "Transform" or "Patch" may be used for this property.
  2346. <br />Default value: Value of the <c>ProductName</c> property, if defined.
  2347. </ul>
  2348. <h4>&lt;/title&gt;</h4>
  2349. <h4>&lt;subject&gt;</h4>
  2350. <ul>
  2351. A short description of the product to be installed. This value is typically set from the installer
  2352. property <c>ProductName</c>
  2353. <br />Default value: Value of the <c>ProductName</c> property, if defined.
  2354. </ul>
  2355. <h4>&lt;/subject&gt;</h4>
  2356. <h4>&lt;author&gt;</h4>
  2357. <ul>
  2358. The manufacturer of the installation database. This value is typically set from the installer
  2359. property <c>Manufacturer</c>.
  2360. <br />Default value: Value of the <c>Manufacturer</c> property, if defined.
  2361. </ul>
  2362. <h4>&lt;/author&gt;</h4>
  2363. <h4>&lt;keywords&gt;</h4>
  2364. <ul>
  2365. Used by file browsers to hold keywords that permit the database file to be found in a keyword search.
  2366. The set of keywords typically includes "Installer" as well as product-specific keywords, and may be
  2367. localized.
  2368. <br />Default value: Value of the <c>Keywords</c> property, if defined.
  2369. </ul>
  2370. <h4>&lt;/keywords&gt;</h4>
  2371. <h4>&lt;comments&gt;</h4>
  2372. <ul>
  2373. A general description/purpose of the installer database.
  2374. <br />Default value: Value of the <c>Comments</c> property, if defined.
  2375. </ul>
  2376. <h4>&lt;/comments&gt;</h4>
  2377. <h4>&lt;template&gt;</h4>
  2378. <ul>
  2379. <para>
  2380. Indicates the platform and language versions that are supported by the database. The Template Summary
  2381. Property of a patch package is a semicolon-delimited list of the product codes that can accept the
  2382. patch.
  2383. </para>
  2384. <para>
  2385. See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/template_summary_property.asp for more information.
  2386. </para>
  2387. </ul>
  2388. <h4>&lt;/template&gt;</h4>
  2389. <h4>&lt;revisionnumber&gt;</h4>
  2390. <ul>
  2391. Contains the package code (GUID) for the installer package. The package code is a unique identifier
  2392. of the installer package. Note: Default behavior - a new GUID is generated every time
  2393. </ul>
  2394. <h4>&lt;/revisionnumber&gt;</h4>
  2395. <h4>&lt;creatingapplication&gt;</h4>
  2396. <ul>
  2397. The name of the application used to author the database. Note: Default value is NAnt.
  2398. </ul>
  2399. <h4>&lt;/creatingapplication&gt;</h4>
  2400. <h3>Examples</h3>
  2401. <example>
  2402. <para>Define specific summary information.</para>
  2403. <code>
  2404. &lt;summaryinformation&gt;
  2405. &lt;title&gt;Installation Database&lt;/title&gt;
  2406. &lt;subject&gt;${install.productname}&lt;/subject&gt;
  2407. &lt;author&gt;${install.manufacturer}&lt;/author&gt;
  2408. &lt;keywords&gt;MSI, database, NAnt, Installer&lt;/keywords&gt;
  2409. &lt;comments&gt;This installer database contains the logic and data required to install NAnt&lt;/comments&gt;
  2410. &lt;template&gt;;1033&lt;/template&gt;
  2411. &lt;creatingapplication&gt;NAnt - http://nant.sf.net &lt;/creatingapplication&gt;
  2412. &lt;/summaryinformation&gt;
  2413. </code>
  2414. </example>
  2415. </summary>
  2416. </member>
  2417. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerPropertiesElement">
  2418. <summary>
  2419. <para>
  2420. Name/value pairs which will be set in the PROPERTY table of the
  2421. installer database.
  2422. </para>
  2423. <para>
  2424. The properties element contains within it one to any number of property elements.<br/>
  2425. <see href="http://msdn.microsoft.com/library/en-us/msi/setup/protected_properties.asp">Public property</see> names cannot contain lowercase letters.<br/>
  2426. <see href="http://msdn.microsoft.com/library/en-us/msi/setup/protected_properties.asp">Private property</see> names must contain some lowercase letters.<br/>
  2427. Property names prefixed with % represent system and user environment variables. These are
  2428. never entered into the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/property_table.asp">Property
  2429. table</see>. The permanent settings of environment variables can only be modified using the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">Environment Table</see>.
  2430. More information is available <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/properties.asp">here</see>.
  2431. </para>
  2432. <h3>Parameters</h3>
  2433. <list type="table">
  2434. <listheader>
  2435. <term>Attribute</term>
  2436. <term>Type</term>
  2437. <term>Description</term>
  2438. <term>Required</term>
  2439. </listheader>
  2440. <item>
  2441. <term>name</term>
  2442. <term>string</term>
  2443. <term>A name used to refer to the property.</term>
  2444. <term>True</term>
  2445. </item>
  2446. <item>
  2447. <term>value</term>
  2448. <term>string</term>
  2449. <term>The value of the property. This value can contain references to other, predefined properties to build a compound property.</term>
  2450. <term>True</term>
  2451. </item>
  2452. </list>
  2453. <h3>Examples</h3>
  2454. <example>
  2455. <para>Define the required properties.</para>
  2456. <code>
  2457. &lt;properties&gt;
  2458. &lt;property name="ProductName" value="My Product" /&gt;
  2459. &lt;property name="ProductVersion" value="1.0.0" /&gt;
  2460. &lt;property name="Manufacturer" value="ACME Inc." /&gt;
  2461. &lt;property name="ProductCode" value="{29D8F096-3371-4cba-87E1-A8C6511F7B4C}" /&gt;
  2462. &lt;property name="UpgradeCode" value="{69E66919-0DE1-4280-B4C1-94049F76BA1A}" /&gt;
  2463. &lt;/properties&gt;
  2464. </code>
  2465. </example>
  2466. </summary>
  2467. </member>
  2468. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSearchElement">
  2469. <summary>
  2470. <para>
  2471. Contains within it one to any number of app, registry, ini, or dirfile elements.
  2472. These elements are used to search for an existing filesystem directory, file, or
  2473. Windows Registry setting. A property in the installer database is
  2474. then set with the value obtained from the search.
  2475. </para>
  2476. <h3>&lt;app&gt;</h3>
  2477. <para>
  2478. More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/complocator_table.asp
  2479. </para>
  2480. <list type="table">
  2481. <listheader>
  2482. <term>Attribute</term>
  2483. <term>Type</term>
  2484. <term>Description</term>
  2485. <term>Required</term>
  2486. </listheader>
  2487. <item>
  2488. <term>componentid</term>
  2489. <term>string</term>
  2490. <term>The component ID of the component whose key path is to be used for the search.</term>
  2491. <term>True</term>
  2492. </item>
  2493. <item>
  2494. <term>type</term>
  2495. <term>msi:MSILocatorTypeDirFile</term>
  2496. <term>Valid input: <c>file</c> or <c>directory</c></term>
  2497. <term>True</term>
  2498. </item>
  2499. <item>
  2500. <term>setproperty</term>
  2501. <term>string</term>
  2502. <term>A name used to refer to the property within the Msi database. Set at install time.</term>
  2503. <term>True</term>
  2504. </item>
  2505. </list>
  2506. <h3>&lt;/app&gt;</h3>
  2507. <h3>&lt;registry&gt;</h3>
  2508. <para>
  2509. More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/reglocator_table.asp
  2510. </para>
  2511. <list type="table">
  2512. <listheader>
  2513. <term>Attribute</term>
  2514. <term>Type</term>
  2515. <term>Description</term>
  2516. <term>Required</term>
  2517. </listheader>
  2518. <item>
  2519. <term>type</term>
  2520. <term>msi:MSILocatorTypeDirFileReg64</term>
  2521. <term>Valid input: <c>registry</c>, <c>file</c>, <c>directory</c>, <c>64bit</c></term>
  2522. <term>True</term>
  2523. </item>
  2524. <item>
  2525. <term>path</term>
  2526. <term>string</term>
  2527. <term>Depending on the <c>type</c> specified:
  2528. <list type="bullet">
  2529. <item>Path is a directory.</item>
  2530. <item>Path is a registry key.</item>
  2531. </list>
  2532. </term>
  2533. <term>True</term>
  2534. </item>
  2535. <item>
  2536. <term>root</term>
  2537. <term>msi:MSIRegistryKeyRoot</term>
  2538. <term>Valid input:
  2539. <list type="bullet">
  2540. <item><c>dependent</c> - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1.</item>
  2541. <item><c>machine</c> represents HKEY_LOCAL_MACHINE</item>
  2542. <item><c>classes</c> represents HKEY_CLASSES_ROOT</item>
  2543. <item><c>user</c> represents HKEY_CURRENT_USER</item>
  2544. <item><c>users</c> represents HKEY_USERS</item>
  2545. </list>
  2546. </term>
  2547. <term>True</term>
  2548. </item>
  2549. </list>
  2550. <ul>
  2551. <h3>Nested Elements:</h3>
  2552. <h4>&lt;value&gt;</h4>
  2553. <h3>Parameters</h3>
  2554. <list type="table">
  2555. <listheader>
  2556. <term>Attribute</term>
  2557. <term>Type</term>
  2558. <term>Description</term>
  2559. <term>Required</term>
  2560. </listheader>
  2561. <item>
  2562. <term>name</term>
  2563. <term>string</term>
  2564. <term>Depending on the <c>type</c> specified:
  2565. <list type="bullet">
  2566. <item>Key path is a file name.</item>
  2567. <item>Key path is a registry value.</item>
  2568. </list>
  2569. </term>
  2570. <term>False</term>
  2571. </item>
  2572. <item>
  2573. <term>setproperty</term>
  2574. <term>string</term>
  2575. <term>A name used to refer to the property within the Msi database. Set at install time.</term>
  2576. <term>True</term>
  2577. </item>
  2578. </list>
  2579. <h4>&lt;/value&gt;</h4>
  2580. </ul>
  2581. <h3>&lt;/registry&gt;</h3>
  2582. <h3>&lt;ini&gt;</h3>
  2583. <para>
  2584. More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/inilocator_table.asp
  2585. </para>
  2586. <list type="table">
  2587. <listheader>
  2588. <term>Attribute</term>
  2589. <term>Type</term>
  2590. <term>Description</term>
  2591. <term>Required</term>
  2592. </listheader>
  2593. <item>
  2594. <term>filename</term>
  2595. <term>string</term>
  2596. <term>The .ini file name. (The .ini file must be present in the default Microsoft Windows directory.)
  2597. </term>
  2598. <term>True</term>
  2599. </item>
  2600. <item>
  2601. <term>section</term>
  2602. <term>string</term>
  2603. <term>Section name within the .ini file.
  2604. </term>
  2605. <term>True</term>
  2606. </item>
  2607. <item>
  2608. <term>key</term>
  2609. <term>string</term>
  2610. <term>Key value within the section.
  2611. </term>
  2612. <term>True</term>
  2613. </item>
  2614. <item>
  2615. <term>field</term>
  2616. <term>msi:nonNegativeInt</term>
  2617. <term>The field in the .ini line. If Field is Null or 0, then the entire line is read.
  2618. This must be a non-negative number.
  2619. </term>
  2620. <term>False</term>
  2621. </item>
  2622. <item>
  2623. <term>type</term>
  2624. <term>msi:MSILocatorTypeDirFileRaw</term>
  2625. <term>Valid input: <c>file</c> ,<c>directory</c>, or <c>raw</c></term>
  2626. <term>True</term>
  2627. </item>
  2628. <item>
  2629. <term>setproperty</term>
  2630. <term>string</term>
  2631. <term>A name used to refer to the property within the Msi database. Set at install time.</term>
  2632. <term>True</term>
  2633. </item>
  2634. </list>
  2635. <h3>&lt;/ini&gt;</h3>
  2636. <h3>&lt;dirfile&gt;</h3>
  2637. <para>
  2638. More information on these attributes can be found at:
  2639. http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/drlocator_table.asp
  2640. and
  2641. http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/signature_table.asp
  2642. </para>
  2643. <list type="table">
  2644. <listheader>
  2645. <term>Attribute</term>
  2646. <term>Type</term>
  2647. <term>Description</term>
  2648. <term>Required</term>
  2649. </listheader>
  2650. <item>
  2651. <term>parent</term>
  2652. <term>string</term>
  2653. <term>An identifier to RegLocator, IniLocator, or CompLocator tables.
  2654. If it does not expand to a full path, then all the fixed drives of the user's system are searched by using the Path.
  2655. <br/>In order to determine what the key is for a table, prefix the property name assigned
  2656. to that locator with SIG_
  2657. </term>
  2658. <term>False</term>
  2659. </item>
  2660. <item>
  2661. <term>path</term>
  2662. <term>string</term>
  2663. <term>the path on the user's system. This is a either a full path or a relative subpath
  2664. below the directory specified in the Parent column.
  2665. </term>
  2666. <term>False</term>
  2667. </item>
  2668. <item>
  2669. <term>depth</term>
  2670. <term>msi:nonNegativeInt</term>
  2671. <term>The depth below the path that the installer searches for the file or directory.
  2672. </term>
  2673. <term>False</term>
  2674. </item>
  2675. <item>
  2676. <term>setproperty</term>
  2677. <term>string</term>
  2678. <term>A name used to refer to the property within the Msi database. Set at install time.</term>
  2679. <term>True</term>
  2680. </item>
  2681. </list>
  2682. <ul>
  2683. <h3>Nested Elements:</h3>
  2684. <h4>&lt;file&gt;</h4>
  2685. <h3>Parameters</h3>
  2686. <list type="table">
  2687. <listheader>
  2688. <term>Attribute</term>
  2689. <term>Type</term>
  2690. <term>Description</term>
  2691. <term>Required</term>
  2692. </listheader>
  2693. <item>
  2694. <term>name</term>
  2695. <term>string</term>
  2696. <term>The name of the file.</term>
  2697. <term>True</term>
  2698. </item>
  2699. <item>
  2700. <term>minversion</term>
  2701. <term>string</term>
  2702. <term>The minimum version of the file, with a language comparison. If this field is
  2703. specified, then the file must have a version that is at least equal to MinVersion.
  2704. If the file has an equal version to the MinVersion field value but the language
  2705. specified in the Languages column differs, the file does not satisfy the signature
  2706. filter criteria.</term>
  2707. <term>False</term>
  2708. </item>
  2709. <item>
  2710. <term>maxversion</term>
  2711. <term>string</term>
  2712. <term>The maximum version of the file. If this field is specified, then the file
  2713. must have a version that is at most equal to MaxVersion.</term>
  2714. <term>False</term>
  2715. </item>
  2716. <item>
  2717. <term>minsize</term>
  2718. <term>msi:nonNegativeInt</term>
  2719. <term>The minimum size of the file. If this field is specified, then the file
  2720. under inspection must have a size that is at least equal to MinSize. This must
  2721. be a non-negative number.</term>
  2722. <term>False</term>
  2723. </item>
  2724. <item>
  2725. <term>maxsize</term>
  2726. <term>msi:nonNegativeInt</term>
  2727. <term>The maximum size of the file. If this field is specified, then the file
  2728. under inspection must have a size that is at most equal to MaxSize. This must
  2729. be a non-negative number.</term>
  2730. <term>False</term>
  2731. </item>
  2732. <item>
  2733. <term>mindate</term>
  2734. <term>msi:nonNegativeInt</term>
  2735. <term>The minimum modification date and time of the file. If this field is
  2736. specified, then the file under inspection must have a modification date and time
  2737. that is at least equal to MinDate. This must be a non-negative number.</term>
  2738. <term>False</term>
  2739. </item>
  2740. <item>
  2741. <term>maxdate</term>
  2742. <term>msi:nonNegativeInt</term>
  2743. <term>The maximum creation date of the file. If this field is specified, then the
  2744. file under inspection must have a creation date that is at most equal to MaxDate.
  2745. This must be a non-negative number.</term>
  2746. <term>False</term>
  2747. </item>
  2748. <item>
  2749. <term>languages</term>
  2750. <term>string</term>
  2751. <term>The languages supported by the file.</term>
  2752. <term>False</term>
  2753. </item>
  2754. </list>
  2755. <h4>&lt;/file&gt;</h4>
  2756. </ul>
  2757. <h3>&lt;/dirfile&gt;</h3>
  2758. <h3>Examples</h3>
  2759. <example>
  2760. <para>Get the path of the web directory and the version of IIS. Create new properties in the Msi file with those values.</para>
  2761. <code>
  2762. &lt;search&gt;
  2763. &lt;registry type="registry" path="Software\Microsoft\InetStp" root="machine" &gt;
  2764. &lt;value name="PathWWWRoot" setproperty="IISWWWROOT" /&gt;
  2765. &lt;/registry&gt;
  2766. &lt;registry type="registry" path="SYSTEM\CurrentControlSet\Services\W3SVC\Parameters" root="machine" &gt;
  2767. &lt;value name="MajorVersion" setproperty="IISVERSION" /&gt;
  2768. &lt;/registry&gt;
  2769. &lt;/search&gt;
  2770. </code>
  2771. </example>
  2772. <example>
  2773. <para>Shows two ways to get the default key value for the specified key. Create new properties in the Msi file with those values.</para>
  2774. <code>
  2775. &lt;search&gt;
  2776. &lt;registry type="registry" path="Software\Microsoft\MessengerService" root="machine" &gt;
  2777. &lt;value setproperty="MSGSRVNAME" /&gt;
  2778. &lt;value name="" setproperty="MSGSRVNAME2" /&gt;
  2779. &lt;/registry&gt;
  2780. &lt;/search&gt;
  2781. </code>
  2782. </example>
  2783. </summary>
  2784. </member>
  2785. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerLaunchConditionsElement">
  2786. <summary>
  2787. <para>
  2788. Contains within it one to any number of launchcondition elements.
  2789. Launch conditions are conditions that all must be satisfied for the
  2790. installation to begin.
  2791. </para>
  2792. <h3>Parameters</h3>
  2793. <list type="table">
  2794. <listheader>
  2795. <term>Attribute</term>
  2796. <term>Type</term>
  2797. <term>Description</term>
  2798. <term>Required</term>
  2799. </listheader>
  2800. <item>
  2801. <term>name</term>
  2802. <term>string</term>
  2803. <term>A name used to identify the launch condition.</term>
  2804. <term>True</term>
  2805. </item>
  2806. <item>
  2807. <term>condition</term>
  2808. <term>string</term>
  2809. <term>Expression that must evaluate to True for installation to begin.</term>
  2810. <term>True</term>
  2811. </item>
  2812. </list>
  2813. <h3>Nested Elements:</h3>
  2814. <h4>&lt;description&gt;</h4>
  2815. <ul>
  2816. Localizable text to display when the condition fails and the installation must be terminated.
  2817. </ul>
  2818. <h4>&lt;/description&gt;</h4>
  2819. <h3>Examples</h3>
  2820. <example>
  2821. <para>Create a check to make sure that IIS 5.x is installed.</para>
  2822. <code>
  2823. &lt;launchconditions&gt;
  2824. &lt;launchcondition name="CheckIIS" condition="(IISVERSION = &amp;quot;#5&amp;quot;)" &gt;
  2825. &lt;description&gt;
  2826. This setup requires Internet information Server 5.x. Please install Internet Information Server and run this setup again.
  2827. &lt;/description&gt;
  2828. &lt;/launchcondition&gt;
  2829. &lt;/launchconditions&gt;
  2830. </code>
  2831. </example>
  2832. </summary>
  2833. </member>
  2834. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerTablesElement">
  2835. <summary>
  2836. <para>
  2837. Creates custom tables not directly managed by default features of
  2838. the installer task.
  2839. </para>
  2840. <h3>Parameters</h3>
  2841. <list type="table">
  2842. <listheader>
  2843. <term>Attribute</term>
  2844. <term>Type</term>
  2845. <term>Description</term>
  2846. <term>Required</term>
  2847. </listheader>
  2848. <item>
  2849. <term>name</term>
  2850. <term>string</term>
  2851. <term>A unique name used to identify the table.</term>
  2852. <term>True</term>
  2853. </item>
  2854. </list>
  2855. <h3>Nested Elements:</h3>
  2856. <h4>&lt;columns&gt;</h4>
  2857. <ul>
  2858. <h4>&lt;column&gt;</h4>
  2859. <ul>
  2860. Defines the columns making up the table
  2861. <h3>Parameters</h3>
  2862. <list type="table">
  2863. <listheader>
  2864. <term>Attribute</term>
  2865. <term>Type</term>
  2866. <term>Description</term>
  2867. <term>Required</term>
  2868. </listheader>
  2869. <item>
  2870. <term>name</term>
  2871. <term>string</term>
  2872. <term>A unique name used to define the column.</term>
  2873. <term>True</term>
  2874. </item>
  2875. <item>
  2876. <term>nullable</term>
  2877. <term>bool</term>
  2878. <term>When set to <c>true</c>, allows the column to accept null values; <c>false</c> does not allow null values.</term>
  2879. <term>True</term>
  2880. </item>
  2881. <item>
  2882. <term>category</term>
  2883. <term>msi:MSITableColumnCategoryType</term>
  2884. <term>Valid input:
  2885. <list type="bullet">
  2886. <item><c>Text</c></item>
  2887. <item><c>UpperCase</c></item>
  2888. <item><c>LowerCase</c></item>
  2889. <item><c>Integer</c></item>
  2890. <item><c>DoubleInteger</c></item>
  2891. <item><c>Time/Date</c></item>
  2892. <item><c>Identifier</c></item>
  2893. <item><c>Property</c></item>
  2894. <item><c>Filename</c></item>
  2895. <item><c>WildCardFilename</c></item>
  2896. <item><c>Path</c></item>
  2897. <item><c>Paths</c></item>
  2898. <item><c>AnyPath</c></item>
  2899. <item><c>DefaultDir</c></item>
  2900. <item><c>RegPath</c></item>
  2901. <item><c>Formatted</c></item>
  2902. <item><c>Template</c></item>
  2903. <item><c>Condition</c></item>
  2904. <item><c>GUID</c></item>
  2905. <item><c>Version</c></item>
  2906. <item><c>Language</c></item>
  2907. <item><c>Binary</c></item>
  2908. <item><c>Cabinet</c></item>
  2909. <item><c>Shortcut</c></item>
  2910. </list>
  2911. More information here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp">http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp</a>
  2912. </term>
  2913. <term>False</term>
  2914. </item>
  2915. <item>
  2916. <term>type</term>
  2917. <term>string</term>
  2918. <term>Overrides the <c>category</c> specification. An example of valid input would be: <c>S255</c></term>
  2919. <term>False</term>
  2920. </item>
  2921. <item>
  2922. <term>key</term>
  2923. <term>bool</term>
  2924. <term>When set to <c>true</c>, the column is used to form the primary key for the table; <c>false</c> specifies that the column is not used to form the primary key.</term>
  2925. <term>False</term>
  2926. </item>
  2927. <item>
  2928. <term>minvalue</term>
  2929. <term>int</term>
  2930. <term>This field applies to columns having numeric value. The field contains the minimum permissible value. This can be the minimum value for an integer or the minimum value for a date or version string.</term>
  2931. <term>False</term>
  2932. </item>
  2933. <item>
  2934. <term>maxvalue</term>
  2935. <term>int</term>
  2936. <term>This field applies to columns having numeric value. The field is the maximum permissible value. This may be the maximum value for an integer or the maximum value for a date or version string. </term>
  2937. <term>False</term>
  2938. </item>
  2939. <item>
  2940. <term>keytable</term>
  2941. <term>string</term>
  2942. <term>This field applies to columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. This can be a list of tables separated by semicolons.</term>
  2943. <term>False</term>
  2944. </item>
  2945. <item>
  2946. <term>keycolumn</term>
  2947. <term>int</term>
  2948. <term>This field applies to table columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. The permissible range of the KeyColumn field is 1-32.</term>
  2949. <term>False</term>
  2950. </item>
  2951. <item>
  2952. <term>set</term>
  2953. <term>string</term>
  2954. <term>This is a list of permissible values for this field separated by semicolons. This field is usually used for enums.</term>
  2955. <term>False</term>
  2956. </item>
  2957. <item>
  2958. <term>description</term>
  2959. <term>string</term>
  2960. <term>A description of the data that is stored in the column. </term>
  2961. <term>False</term>
  2962. </item>
  2963. </list>
  2964. </ul>
  2965. <h4>&lt;/column&gt;</h4>
  2966. </ul>
  2967. <h4>&lt;/columns&gt;</h4>
  2968. <h4>&lt;rows&gt;</h4>
  2969. <ul>
  2970. <h4>&lt;row&gt;</h4>
  2971. <ul>
  2972. Defines the data for a row in the table
  2973. <h4>&lt;columns&gt;</h4>
  2974. <ul>
  2975. <h4>&lt;column&gt;</h4>
  2976. <ul>
  2977. Defines data for a specific cell in the row
  2978. <h3>Parameters</h3>
  2979. <list type="table">
  2980. <listheader>
  2981. <term>Attribute</term>
  2982. <term>Type</term>
  2983. <term>Description</term>
  2984. <term>Required</term>
  2985. </listheader>
  2986. <item>
  2987. <term>name</term>
  2988. <term>string</term>
  2989. <term>Name of the column to populate.</term>
  2990. <term>True</term>
  2991. </item>
  2992. <item>
  2993. <term>value</term>
  2994. <term>string</term>
  2995. <term>Value to populate the cell with.</term>
  2996. <term>True</term>
  2997. </item>
  2998. </list>
  2999. </ul>
  3000. <h4>&lt;/column&gt;</h4>
  3001. </ul>
  3002. <h4>&lt;/columns&gt;</h4>
  3003. </ul>
  3004. <h4>&lt;/row&gt;</h4>
  3005. </ul>
  3006. <h4>&lt;/rows&gt;</h4>
  3007. <h3>Examples</h3>
  3008. <example>
  3009. <para>
  3010. Build the IniFile table. Since the WriteIniValues and RemoveIniValues actions exist in the template, they will use this table.
  3011. </para>
  3012. <code>
  3013. &lt;tables&gt;
  3014. &lt;table name="IniFile"&gt;
  3015. &lt;columns&gt;
  3016. &lt;column name="IniFile" nullable="false" category="Identifier" key="true" description="The key for this table." /&gt;
  3017. &lt;column name="FileName" nullable="false" category="Text" description="The localizable name of the .ini file in which to write the information. " /&gt;
  3018. &lt;column name="DirProperty" nullable="true" category="Identifier" description="Name of a property having a value that resolves to the full path of the folder containing the .ini file. " /&gt;
  3019. &lt;column name="Section" nullable="false" category="Formatted" description="The localizable .ini file section." /&gt;
  3020. &lt;column name="Key" nullable="false" category="Formatted" description="The localizable .ini file key within the section" /&gt;
  3021. &lt;column name="Value" nullable="false" category="Formatted" description="The localizable value to be written. " /&gt;
  3022. &lt;column name="Action" nullable="false" category="Integer" description="The type of modification to be made. " /&gt;
  3023. &lt;column name="Component_" nullable="false" category="Identifier" description="External key into the first column of the Component table referencing the component that controls the installation of the .ini value. " /&gt;
  3024. &lt;/columns&gt;
  3025. &lt;rows&gt;
  3026. &lt;row&gt;
  3027. &lt;columns&gt;
  3028. &lt;column name="IniFile" value="MyInternetShortcut" /&gt;
  3029. &lt;column name="FileName" value="MyInternetAddr.url" /&gt;
  3030. &lt;column name="DirProperty" value="D__MYDIR" /&gt;
  3031. &lt;column name="Section" value="InternetShortcut" /&gt;
  3032. &lt;column name="Key" value="URL" /&gt;
  3033. &lt;column name="Value" value="[TARGETURL]" /&gt;
  3034. &lt;column name="Action" value="0" /&gt;
  3035. &lt;column name="Component_" value="C__Documentation" /&gt;
  3036. &lt;/columns&gt;
  3037. &lt;/row&gt;
  3038. &lt;/rows&gt;
  3039. &lt;/table&gt;
  3040. &lt;/tables&gt;
  3041. </code>
  3042. </example>
  3043. </summary>
  3044. </member>
  3045. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerDirectoriesElement">
  3046. <summary>
  3047. <para>
  3048. Specifies the directory layout for the product.
  3049. </para>
  3050. <h3>Parameters</h3>
  3051. <list type="table">
  3052. <listheader>
  3053. <term>Attribute</term>
  3054. <term>Type</term>
  3055. <term>Description</term>
  3056. <term>Required</term>
  3057. </listheader>
  3058. <item>
  3059. <term>name</term>
  3060. <term>string</term>
  3061. <term>A name used to refer to the directory.</term>
  3062. <term>True</term>
  3063. </item>
  3064. <item>
  3065. <term>foldername</term>
  3066. <term>string</term>
  3067. <term>The directory's name (localizable)under the parent directory.</term>
  3068. <term>True</term>
  3069. </item>
  3070. <item>
  3071. <term>root</term>
  3072. <term>string</term>
  3073. <term>A reference to the directory's parent directory. This can be a property name or one of the predefined directories included with the default template:
  3074. <list type="bullet">
  3075. <item><c>AdminToolsFolder</c></item>
  3076. <item><c>AppDataFolder</c></item>
  3077. <item><c>CommonAppDataFolder</c></item>
  3078. <item><c>CommonFiles64Folder</c></item>
  3079. <item><c>CommonFilesFolder</c></item>
  3080. <item><c>DesktopFolder</c></item>
  3081. <item><c>FavoritesFolder</c></item>
  3082. <item><c>FontsFolder</c></item>
  3083. <item><c>LocalAppDataFolder</c></item>
  3084. <item><c>MyPicturesFolder</c></item>
  3085. <item><c>PersonalFolder</c></item>
  3086. <item><c>ProgramFilesFolder</c></item>
  3087. <item><c>ProgramMenuFolder</c></item>
  3088. <item><c>ProgramFiles64Folder</c></item>
  3089. <item><c>SendToFolder</c></item>
  3090. <item><c>StartMenuFolder</c></item>
  3091. <item><c>StartupFolder</c></item>
  3092. <item><c>System16Folder</c></item>
  3093. <item><c>System64Folder</c></item>
  3094. <item><c>SystemFolder</c></item>
  3095. <item><c>TARGETDIR</c></item>
  3096. <item><c>TempFolder</c></item>
  3097. <item><c>TemplateFolder</c></item>
  3098. <item><c>WindowsFolder</c></item>
  3099. <item><c>WindowsVolume</c></item>
  3100. </list>
  3101. </term>
  3102. <term>True</term>
  3103. </item>
  3104. </list>
  3105. <h3>Nested Elements:</h3>
  3106. <h4>&lt;directory&gt;</h4>
  3107. <ul>
  3108. Sub directories. Note, this element can contain nested &lt;directory/&gt; sub elements.
  3109. <h3>Parameters</h3>
  3110. <list type="table">
  3111. <listheader>
  3112. <term>Attribute</term>
  3113. <term>Type</term>
  3114. <term>Description</term>
  3115. <term>Required</term>
  3116. </listheader>
  3117. <item>
  3118. <term>name</term>
  3119. <term>string</term>
  3120. <term>A name used to refer to the directory.</term>
  3121. <term>True</term>
  3122. </item>
  3123. <item>
  3124. <term>foldername</term>
  3125. <term>string</term>
  3126. <term>The directory's name (localizable)under the parent directory.</term>
  3127. <term>True</term>
  3128. </item>
  3129. </list>
  3130. </ul>
  3131. <h4>&lt;/directory&gt;</h4>
  3132. <h3>Examples</h3>
  3133. <example>
  3134. <para>Define a sample directory structure.</para>
  3135. <code>
  3136. &lt;directories&gt;
  3137. &lt;directory name="D__ACME" foldername="ACME" root="TARGETDIR" &gt;
  3138. &lt;directory name="D__ACME_MyProduct" foldername="My Product" /&gt;
  3139. &lt;/directory&gt;
  3140. &lt;/directories&gt;
  3141. </code>
  3142. </example>
  3143. </summary>
  3144. </member>
  3145. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerEnvironmentElement">
  3146. <summary>
  3147. <para>
  3148. Used to modify the environment variables of the target computer at
  3149. runtime.
  3150. </para>
  3151. <h3>Parameters</h3>
  3152. <list type="table">
  3153. <listheader>
  3154. <term>Attribute</term>
  3155. <term>Type</term>
  3156. <term>Description</term>
  3157. <term>Required</term>
  3158. </listheader>
  3159. <item>
  3160. <term>name</term>
  3161. <term>string</term>
  3162. <term>The localizable name of the environment variable. The key values are written or removed depending upon
  3163. which of the characters in the following table are prefixed to the name. There is no effect in the ordering of
  3164. the symbols used in a prefix.
  3165. <list type="table">
  3166. <listheader>
  3167. <term>Prefix</term>
  3168. <description>Description</description>
  3169. </listheader>
  3170. <item>
  3171. <term>=</term>
  3172. <description>Create the environment variable if it does not exist, and then set it during installation. If the environment variable exists, set it during the installation.</description>
  3173. </item>
  3174. <item>
  3175. <term>+</term>
  3176. <description>Create the environment variable if it does not exist, then set it during installation. This has no effect on the value of the environment variable if it already exists.</description>
  3177. </item>
  3178. <item>
  3179. <term>-</term>
  3180. <description>Remove the environment variable when the component is removed. This symbol can be combined with any prefix.</description>
  3181. </item>
  3182. <item>
  3183. <term>!</term>
  3184. <description>Remove the environment variable during an installation. The installer only removes an environment variable during an installation if the name and value of the variable match the entries in the Name and Value fields of the Environment table. If you want to remove an environment variable, regardless of its value, use the '!' syntax, and leave the Value field empty.</description>
  3185. </item>
  3186. <item>
  3187. <term>*</term>
  3188. <description>This prefix is used with Microsoft® Windows® NT/Windows® 2000 to indicate that the name refers to a system environment variable. If no asterisk is present, the installer writes the variable to the user's environment. Microsoft Windows 95/98 ignores the asterisk and add the environment variable to autoexec.bat. This symbol can be combined with any prefix. A package that is used for per-machine installations should write environment variables to the machine's environment by including * in the Name column. For more information, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp</a></description>
  3189. </item>
  3190. <item>
  3191. <term>=-</term>
  3192. <description>The environment variable is set on install and removed on uninstall. This is the usual behavior.</description>
  3193. </item>
  3194. <item>
  3195. <term>!-</term>
  3196. <description>Removes an environment variable during an install or uninstall.</description>
  3197. </item>
  3198. </list>
  3199. More information can be found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp</a>
  3200. </term>
  3201. <term>True</term>
  3202. </item>
  3203. <item>
  3204. <term>append</term>
  3205. <term>string</term>
  3206. <term>Localizable value that is to be set as a <a href="http://msdn.microsoft.com/library/en-us/msi/setup/formatted.asp">formatted</a> string</term>
  3207. <term>True</term>
  3208. </item>
  3209. <item>
  3210. <term>component</term>
  3211. <term>string</term>
  3212. <term>Refrence to a component. Allows the variabled to be modified when the component is un/installed.</term>
  3213. <term>True</term>
  3214. </item>
  3215. </list>
  3216. <h3>Examples</h3>
  3217. <example>
  3218. <para>Append the installation path to the user PATH variable.</para>
  3219. <code>
  3220. &lt;environment&gt;
  3221. &lt;variable name="PATH" append="'[TARGETDIR]'" component="C__MainFiles" /&gt;
  3222. &lt;/environment&gt;
  3223. </code>
  3224. </example>
  3225. </summary>
  3226. </member>
  3227. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerComponentsElement">
  3228. <summary>
  3229. <para>
  3230. Groups sets of files into named sets, these can be used to install
  3231. and perform operations on a set of files as one entity.
  3232. </para>
  3233. <h3>Parameters</h3>
  3234. <list type="table">
  3235. <listheader>
  3236. <term>Attribute</term>
  3237. <term>Type</term>
  3238. <term>Description</term>
  3239. <term>Required</term>
  3240. </listheader>
  3241. <item>
  3242. <term>name</term>
  3243. <term>string</term>
  3244. <term>A name used to refer to the component.</term>
  3245. <term>True</term>
  3246. </item>
  3247. <item>
  3248. <term>id</term>
  3249. <term>string</term>
  3250. <term>A string GUID unique to this component, version, and language.<br/>Note that the letters of these GUIDs must be
  3251. uppercase. Utilities such as GUIDGEN can generate GUIDs containing lowercase letters. The lowercase letters must be
  3252. changed to uppercase to make these valid component code GUIDs.
  3253. </term>
  3254. <term>True</term>
  3255. </item>
  3256. <item>
  3257. <term>attr</term>
  3258. <term>int</term>
  3259. <term>This column contains a bit flag that specifies options for remote execution. Add the indicated bit to the total value in the column to include an option.
  3260. <list type="table">
  3261. <listheader>
  3262. <term>Value</term>
  3263. <description>Description</description>
  3264. </listheader>
  3265. <item>
  3266. <term>0</term>
  3267. <description>Component cannot be run from source. <br/>
  3268. Set this bit for all components belonging to a feature to prevent the feature from being run-from-network or
  3269. run-from-source. Note that if a feature has no components, the feature always shows run-from-source and
  3270. run-from-my-computer as valid options.
  3271. </description>
  3272. </item>
  3273. <item>
  3274. <term>1</term>
  3275. <description>Component can only be run from source. <br/>
  3276. Set this bit for all components belonging to a feature to prevent the feature from being run-from-my-computer.
  3277. Note that if a feature has no components, the feature always shows run-from-source and run-from-my-computer as
  3278. valid options.
  3279. </description>
  3280. </item>
  3281. <item>
  3282. <term>2</term>
  3283. <description>Component can run locally or from source.</description>
  3284. </item>
  3285. <item>
  3286. <term>4</term>
  3287. <description>If this bit is set, the value in the key element is used as a key into the Registry table.<br/>
  3288. If the Value field of the corresponding record in the Registry table is null, the Name field in that record must
  3289. not contain "+", "-", or "*". For more information, see the description of the Name field in Registry table.<br/>
  3290. Setting this bit is recommended for registry entries written to the HKCU hive. This ensures the installer writes
  3291. the necessary HKCU registry entries when there are multiple users on the same machine.
  3292. </description>
  3293. </item>
  3294. <item>
  3295. <term>16</term>
  3296. <description>If this bit is set, the installer does not remove the component during an uninstall. The installer registers an extra system client for the component in the Windows Installer registry settings.
  3297. </description>
  3298. </item>
  3299. <item>
  3300. <term>32</term>
  3301. <description>If this bit is set, the value in the KeyPath column is a key into the ODBCDataSource table.</description>
  3302. </item>
  3303. <item>
  3304. <term>64</term>
  3305. <description>If this bit is set, the installer reevaluates the value of the statement in the Condition column
  3306. upon a reinstall. If the value was previously False and has changed to True, the installer installs the component.
  3307. If the value was previously True and has changed to False, the installer removes the component even if the component
  3308. has other products as clients. <br/>This bit should only be set for transitive components. See Using Transitive
  3309. Components.
  3310. </description>
  3311. </item>
  3312. <item>
  3313. <term>128</term>
  3314. <description>If this bit is set, the installer does not install or reinstall the component if a key path file or
  3315. a key path registry entry for the component already exists. The application does register itself as a client of
  3316. the component. <br/>
  3317. Use this flag only for components that are being registered by the Registry table.
  3318. </description>
  3319. </item>
  3320. <item>
  3321. <term>256</term>
  3322. <description>Set this bit to mark this as a 64-bit component. This attribute facilitates the installation of
  3323. packages that include both 32-bit and 64-bit components. If this bit is not set, the component is registered
  3324. as a 32-bit component.
  3325. </description>
  3326. </item>
  3327. </list>
  3328. </term>
  3329. <term>True</term>
  3330. </item>
  3331. <item>
  3332. <term>directory</term>
  3333. <term>string</term>
  3334. <term>Refrence to a directory. Defines the directory location for where the files assigned to the component are to be placed.</term>
  3335. <term>True</term>
  3336. </item>
  3337. <item>
  3338. <term>feature</term>
  3339. <term>string</term>
  3340. <term>Refrence to a feature. Maps a feature to the component. Used to determine if the component is to be installed or not.</term>
  3341. <term>True</term>
  3342. </item>
  3343. <item>
  3344. <term>condition</term>
  3345. <term>string</term>
  3346. <term>A conditional statement that can control whether a component is installed. If the condition is null or evaluates to
  3347. true, then the component is enabled. If the condition evaluates to False, then the component is disabled and is not
  3348. installed.</term>
  3349. <term>False</term>
  3350. </item>
  3351. <item>
  3352. <term>fileattr</term>
  3353. <term>int</term>
  3354. <term>Integer containing bit flags representing file attributes.<br/>
  3355. The following table shows the definition of the bit field.
  3356. <list type="table">
  3357. <listheader>
  3358. <term>Value</term>
  3359. <description>Description</description>
  3360. </listheader>
  3361. <item>
  3362. <term>1</term>
  3363. <description>Read-Only</description>
  3364. </item>
  3365. <item>
  3366. <term>2</term>
  3367. <description>Hidden</description>
  3368. </item>
  3369. <item>
  3370. <term>4</term>
  3371. <description>System</description>
  3372. </item>
  3373. <item>
  3374. <term>512</term>
  3375. <description>The file is vital for the proper operation of the component to which it belongs</description>
  3376. </item>
  3377. <item>
  3378. <term>1024</term>
  3379. <description>The file contains a valid checksum. A checksum is required to repair a file that has become corrupted.</description>
  3380. </item>
  3381. <item>
  3382. <term>4096</term>
  3383. <description>This bit must only be added by a patch and if the file is being added by the patch.</description>
  3384. </item>
  3385. <item>
  3386. <term>8192</term>
  3387. <description>The file's source type is uncompressed. If set, ignore the Word Count Summary Property.
  3388. If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression
  3389. state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed
  3390. and msidbFileAttributesCompressed.</description>
  3391. </item>
  3392. <item>
  3393. <term>16384</term>
  3394. <description>The file's source type is compressed. If set, ignore the Word Count Summary Property.
  3395. If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of
  3396. the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and
  3397. msidbFileAttributesCompressed.</description>
  3398. </item>
  3399. </list>
  3400. </term>
  3401. <term>False</term>
  3402. </item>
  3403. <item>
  3404. <term>checkinterop</term>
  3405. <term>bool</term>
  3406. <term>Used to determine if file(s) in the fileset are interop file(s). If <c>true</c>, extra information will be added in the install
  3407. package to register each interop file. If <c>false</c>, the file(s) will not be not be checked and the extra registration information
  3408. will not be added to the msi. </term>
  3409. <term>False</term>
  3410. </item>
  3411. <item>
  3412. <term>installassembliestogac</term>
  3413. <term>bool</term>
  3414. <term>Used to determine if assemblies should be installed to the Global Assembly Cache.
  3415. If <c>true</c>, all assemblies in the fileset will be added to the GAC. If <c>false</c>, the assemblies will be installed
  3416. to the specified directory (as a normal file would). Note: If an assembly is specified to be installed into the GAC, it will not
  3417. also be installed to the directory specified.</term>
  3418. <term>False</term>
  3419. </item>
  3420. <item>
  3421. <term>keepsubdirs</term>
  3422. <term>bool</term>
  3423. <term>Used to determine if directories in the fileset should be built.
  3424. If <c>true</c>, all subdirectories of the fileset basedir will be built. If <c>false</c> the directories structure will be
  3425. flattened. The default is <c>false</c>.</term>
  3426. <term>False</term>
  3427. </item>
  3428. </list>
  3429. <h3>Nested Elements:</h3>
  3430. <h4>&lt;keyfile&gt;</h4>
  3431. <ul>
  3432. This value points to a file or folder belonging to the component that the installer uses to detect the component. Two components cannot share the same key path value.
  3433. <h3>Parameters</h3>
  3434. <list type="table">
  3435. <listheader>
  3436. <term>Attribute</term>
  3437. <term>Type</term>
  3438. <term>Description</term>
  3439. <term>Required</term>
  3440. </listheader>
  3441. <item>
  3442. <term>file</term>
  3443. <term>string</term>
  3444. <term>Name of the key (file) to use. Also, this could be an id of a registry key value.</term>
  3445. <term>True</term>
  3446. </item>
  3447. </list>
  3448. </ul>
  3449. <h4>&lt;/keyfile&gt;</h4>
  3450. <h4>&lt;fileset&gt;</h4>
  3451. <ul>
  3452. Specifies the files to include with the component
  3453. </ul>
  3454. <h4>&lt;/fileset&gt;</h4>
  3455. <h4>&lt;forceid&gt;</h4>
  3456. <ul>
  3457. Used to force specific attributes on a per file basis
  3458. <h3>Parameters</h3>
  3459. <list type="table">
  3460. <listheader>
  3461. <term>Attribute</term>
  3462. <term>Type</term>
  3463. <term>Description</term>
  3464. <term>Required</term>
  3465. </listheader>
  3466. <item>
  3467. <term>file</term>
  3468. <term>string</term>
  3469. <term>Name of the file, in the fileset, to override.</term>
  3470. <term>True</term>
  3471. </item>
  3472. <item>
  3473. <term>id</term>
  3474. <term>string</term>
  3475. <term>Unique GUID to assign to the file.</term>
  3476. <term>True</term>
  3477. </item>
  3478. <item>
  3479. <term>attr</term>
  3480. <term>int</term>
  3481. <term>Integer containing bit flags representing file attributes.<br/>
  3482. The following table shows the definition of the bit field.
  3483. <list type="table">
  3484. <listheader>
  3485. <term>Value</term>
  3486. <description>Description</description>
  3487. </listheader>
  3488. <item>
  3489. <term>1</term>
  3490. <description>Read-Only</description>
  3491. </item>
  3492. <item>
  3493. <term>2</term>
  3494. <description>Hidden</description>
  3495. </item>
  3496. <item>
  3497. <term>4</term>
  3498. <description>System</description>
  3499. </item>
  3500. <item>
  3501. <term>512</term>
  3502. <description>The file is vital for the proper operation of the component to which it belongs</description>
  3503. </item>
  3504. <item>
  3505. <term>1024</term>
  3506. <description>The file contains a valid checksum. A checksum is required to repair a file that has become corrupted.</description>
  3507. </item>
  3508. <item>
  3509. <term>4096</term>
  3510. <description>This bit must only be added by a patch and if the file is being added by the patch.</description>
  3511. </item>
  3512. <item>
  3513. <term>8192</term>
  3514. <description>The file's source type is uncompressed. If set, ignore the Word Count Summary Property.
  3515. If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression
  3516. state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed
  3517. and msidbFileAttributesCompressed.</description>
  3518. </item>
  3519. <item>
  3520. <term>16384</term>
  3521. <description>The file's source type is compressed. If set, ignore the Word Count Summary Property.
  3522. If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of
  3523. the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and
  3524. msidbFileAttributesCompressed.</description>
  3525. </item>
  3526. </list>
  3527. </term>
  3528. <term>False</term>
  3529. </item>
  3530. <item>
  3531. <term>version</term>
  3532. <term>string</term>
  3533. <term>This field is the version string for a versioned file. This field is blank for non-versioned files.</term>
  3534. <term>False</term>
  3535. </item>
  3536. <item>
  3537. <term>language</term>
  3538. <term>string</term>
  3539. <term>A list of decimal language IDs separated by commas.</term>
  3540. <term>False</term>
  3541. </item>
  3542. <item>
  3543. <term>checkinterop</term>
  3544. <term>bool</term>
  3545. <term>Used to determine if file is an interop file. If <c>true</c>, extra information will be added in the install
  3546. package to register the interop file. If <c>false</c>, the file will not be not be checked and the extra registration information
  3547. will not be added to the msi.</term>
  3548. <term>False</term>
  3549. </item>
  3550. <item>
  3551. <term>installtogac</term>
  3552. <term>bool</term>
  3553. <term>If <c>true</c>, and if the file is an assembly, it will be installed to the GAC. If <c>false</c>, the file
  3554. will be installed to the directory specified by the component. Note: If an assembly is specified to
  3555. be installed into the GAC, it will not also be installed to the directory specified.</term>
  3556. <term>False</term>
  3557. </item>
  3558. </list>
  3559. </ul>
  3560. <h4>&lt;/forceid&gt;</h4>
  3561. <h3>Examples</h3>
  3562. <example>
  3563. <para>Define a sample component structure.</para>
  3564. <code>
  3565. &lt;components&gt;
  3566. &lt;component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" &gt;
  3567. &lt;key file="default.aspx" /&gt;
  3568. &lt;fileset basedir="${install.dir}"&gt;
  3569. &lt;include name="*.*" /&gt;
  3570. &lt;/fileset&gt;
  3571. &lt;/component&gt;
  3572. &lt;/components&gt;
  3573. </code>
  3574. </example>
  3575. <example>
  3576. <para>Install files to TARGETDIR and assemblies to the GAC (Global Assembly Cache). Do not install MyOtherAssembly.dll to the GAC, but rather install it with the other files (to TARGETDIR)</para>
  3577. <code>
  3578. &lt;components&gt;
  3579. &lt;component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" installassembliestogac="true" &gt;
  3580. &lt;key file="MyAssemblyName.xml" /&gt;
  3581. &lt;fileset basedir="${install.dir}"&gt;
  3582. &lt;include name="*.*" /&gt;
  3583. &lt;/fileset&gt;
  3584. &lt;forceid file="MyOtherAssembly.dll" id="_4EB7CCB23D394958988ED817DA00B9D1" installtogac="false" /&gt;
  3585. &lt;/component&gt;
  3586. &lt;/components&gt;
  3587. </code>
  3588. </example>
  3589. <example>
  3590. <para>Assign a registry entry to a specific component.</para>
  3591. <code>
  3592. &lt;components&gt;
  3593. &lt;component name="C__RegistryEntry" id="{06C654AA-273D-4E39-885C-3E5225D9F336}" attr="4" directory="TARGETDIR" feature="F__DefaultFeature" &gt;
  3594. &lt;key file="R__822EC365A8754FACBF6C713BFE4E57F0" /&gt;
  3595. &lt;/component&gt;
  3596. &lt;/components&gt;
  3597. .
  3598. .
  3599. .
  3600. &lt;registry&gt;
  3601. &lt;key path="SOFTWARE\MyCompany\MyProduct\" root="machine" component="C__RegistryEntry"&gt;
  3602. &lt;value id="R__822EC365A8754FACBF6C713BFE4E57F0" name="MyKeyName" value="MyKeyValue" /&gt;
  3603. &lt;/key&gt;
  3604. &lt;/registry&gt;
  3605. </code>
  3606. </example>
  3607. </summary>
  3608. </member>
  3609. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerDialogsElement">
  3610. <summary>
  3611. <para>
  3612. Creates custom dialogs that can gather information not handled by
  3613. the default installer template.
  3614. </para>
  3615. <h3>Parameters</h3>
  3616. <list type="table">
  3617. <listheader>
  3618. <term>Attribute</term>
  3619. <term>Type</term>
  3620. <term>Description</term>
  3621. <term>Required</term>
  3622. </listheader>
  3623. <item>
  3624. <term>name</term>
  3625. <term>string</term>
  3626. <term>A name used to refer to the dialog.</term>
  3627. <term>True</term>
  3628. </item>
  3629. <item>
  3630. <term>hcenter</term>
  3631. <term>int</term>
  3632. <term>Horizontal position of the dialog box. The range is 0 to 100, with 0 at the left edge of the screen and 100 at the right edge.</term>
  3633. <term>True</term>
  3634. </item>
  3635. <item>
  3636. <term>vcenter</term>
  3637. <term>int</term>
  3638. <term>Vertical position of the dialog box. The range is 0 to 100, with 0 at the top edge of the screen and 100 at the bottom edge.</term>
  3639. <term>True</term>
  3640. </item>
  3641. <item>
  3642. <term>width</term>
  3643. <term>int</term>
  3644. <term>Width of the rectangular boundary of the dialog box. This number must be non-negative.</term>
  3645. <term>True</term>
  3646. </item>
  3647. <item>
  3648. <term>height</term>
  3649. <term>int</term>
  3650. <term>Height of the rectangular boundary of the dialog box. This number must be non-negative.</term>
  3651. <term>True</term>
  3652. </item>
  3653. <item>
  3654. <term>attr</term>
  3655. <term>int</term>
  3656. <term>A 32-bit word that specifies the attribute flags to be applied to this dialog box. This number must be non-negative.
  3657. <list type="table">
  3658. <listheader>
  3659. <term>Value</term>
  3660. <description>Description</description>
  3661. </listheader>
  3662. <item>
  3663. <term>1</term>
  3664. <description>Visible</description>
  3665. </item>
  3666. <item>
  3667. <term>2</term>
  3668. <description>Modal</description>
  3669. </item>
  3670. <item>
  3671. <term>4</term>
  3672. <description>Minimize</description>
  3673. </item>
  3674. <item>
  3675. <term>8</term>
  3676. <description>SysModal</description>
  3677. </item>
  3678. <item>
  3679. <term>16</term>
  3680. <description>KeepModeless</description>
  3681. </item>
  3682. <item>
  3683. <term>32</term>
  3684. <description>TrackDiskSpace</description>
  3685. </item>
  3686. <item>
  3687. <term>64</term>
  3688. <description>UseCustomPalette</description>
  3689. </item>
  3690. <item>
  3691. <term>128</term>
  3692. <description>RTLRO</description>
  3693. </item>
  3694. <item>
  3695. <term>256</term>
  3696. <description>RightAligned</description>
  3697. </item>
  3698. <item>
  3699. <term>512</term>
  3700. <description>LeftScroll</description>
  3701. </item>
  3702. <item>
  3703. <term>896</term>
  3704. <description>BiDi</description>
  3705. </item>
  3706. <item>
  3707. <term>65536</term>
  3708. <description>Error</description>
  3709. </item>
  3710. </list>
  3711. More information here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp">http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp</a>
  3712. </term>
  3713. <term>True</term>
  3714. </item>
  3715. <item>
  3716. <term>title</term>
  3717. <term>string</term>
  3718. <term>A localizable text string specifying the title to be displayed in the title bar of the dialog box.</term>
  3719. <term>True</term>
  3720. </item>
  3721. <item>
  3722. <term>firstcontrol</term>
  3723. <term>string</term>
  3724. <term>An external key to the second column of the Control table. Combining this field with the Dialog field identifies a
  3725. unique control in the Control table. This defines the control that takes the focus when the dialog box is created. This
  3726. column is ignored in an Error dialog box. <br/>
  3727. Because static text cannot take the focus, a Text control that describes an Edit, PathEdit, ListView, ComboBox or
  3728. VolumeSelectCombo control must be made the first control in the dialog box to ensure compatibility with screen readers.
  3729. </term>
  3730. <term>True</term>
  3731. </item>
  3732. <item>
  3733. <term>defaultcontrol</term>
  3734. <term>string</term>
  3735. <term>An external key to the second column of the Control table. Combining this field with the Dialog field results in
  3736. a primary key into the Control table that defines the default control. Hitting the Return key is equivalent to clicking
  3737. on the default control. If this column is left blank, then there is no default control. This column is ignored in the
  3738. Error dialog box.
  3739. </term>
  3740. <term>True</term>
  3741. </item>
  3742. <item>
  3743. <term>cancelcontrol</term>
  3744. <term>string</term>
  3745. <term>An external key to the second column of the Control table. Combining this field with the Dialog field results in
  3746. a primary key of the Control table that defines the cancel control. Hitting the ESC key or clicking the Close button in
  3747. the dialog box is equivalent to clicking on the cancel control. This column is ignored in an Error dialog box. <br />
  3748. The cancel control is hidden during rollback or the removal of backed up files. The protected UI handler hides the control
  3749. upon receiving a INSTALLMESSAGE_COMMONDATA message.
  3750. </term>
  3751. <term>True</term>
  3752. </item>
  3753. </list>
  3754. <h3>Examples</h3>
  3755. <example>
  3756. <para>Add a web folder dialog:</para>
  3757. <code>
  3758. &lt;dialogs&gt;
  3759. &lt;dialog name="WebFolderDlg" hcenter="50" vcenter="50" width="370" height="270" attr="39" title="[ProductName] [Setup]" firstcontrol="Next" defaultcontrol="Next" cancelcontrol="Cancel" /&gt;
  3760. &lt;/dialogs&gt;
  3761. </code>
  3762. </example>
  3763. </summary>
  3764. </member>
  3765. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlsElement">
  3766. <summary>
  3767. <para>
  3768. Creates user interface controls displayed on custom dialogs.
  3769. </para>
  3770. <h3>Parameters</h3>
  3771. <list type="table">
  3772. <listheader>
  3773. <term>Attribute</term>
  3774. <term>Type</term>
  3775. <term>Description</term>
  3776. <term>Required</term>
  3777. </listheader>
  3778. <item>
  3779. <term>name</term>
  3780. <term>string</term>
  3781. <term>Name of the control. This name must be unique within a dialog box but can be repeated on different dialog boxes.</term>
  3782. <term>True</term>
  3783. </item>
  3784. <item>
  3785. <term>dialog</term>
  3786. <term>string</term>
  3787. <term>Refrence to a dialog. Used to associate the control with the dialog.</term>
  3788. <term>True</term>
  3789. </item>
  3790. <item>
  3791. <term>type</term>
  3792. <term>string</term>
  3793. <term>The type of the control.
  3794. <list type="table">
  3795. <listheader>
  3796. <term>Control name</term>
  3797. <description>Description</description>
  3798. </listheader>
  3799. <item>
  3800. <term>Billboard</term>
  3801. <description>Displays billboards based on progress messages.</description>
  3802. </item>
  3803. <item>
  3804. <term>Bitmap</term>
  3805. <description>Displays a static picture of a bitmap.</description>
  3806. </item>
  3807. <item>
  3808. <term>CheckBox</term>
  3809. <description>A two-state check box.</description>
  3810. </item>
  3811. <item>
  3812. <term>ComboBox</term>
  3813. <description>A drop-down list with an edit field.</description>
  3814. </item>
  3815. <item>
  3816. <term>DirectoryCombo</term>
  3817. <description>Select all except the last segment of the path.</description>
  3818. </item>
  3819. <item>
  3820. <term>DirectoryList</term>
  3821. <description>Displays folders below the main part of path.</description>
  3822. </item>
  3823. <item>
  3824. <term>Edit</term>
  3825. <description>A regular edit field for any string or integer.</description>
  3826. </item>
  3827. <item>
  3828. <term>GroupBox</term>
  3829. <description>Displays a rectangle that groups other controls together.</description>
  3830. </item>
  3831. <item>
  3832. <term>Icon</term>
  3833. <description>Displays a static picture of an icon.</description>
  3834. </item>
  3835. <item>
  3836. <term>Line</term>
  3837. <description>Displays a horizontal line.</description>
  3838. </item>
  3839. <item>
  3840. <term>ListBox</term>
  3841. <description>A drop-down list without an edit field.</description>
  3842. </item>
  3843. <item>
  3844. <term>ListView</term>
  3845. <description>Displays a column of values with icons for selection.</description>
  3846. </item>
  3847. <item>
  3848. <term>MaskedEdit</term>
  3849. <description>An edit field with a mask in the text field.</description>
  3850. </item>
  3851. <item>
  3852. <term>PathEdit</term>
  3853. <description>Displays folder name or entire path in an edit field.</description>
  3854. </item>
  3855. <item>
  3856. <term>ProgressBar</term>
  3857. <description>Bar graph that changes length as it receives progress messages.</description>
  3858. </item>
  3859. <item>
  3860. <term>PushButton</term>
  3861. <description>Displays a basic push button.</description>
  3862. </item>
  3863. <item>
  3864. <term>RadioButtonGroup</term>
  3865. <description>A group of radio buttons.</description>
  3866. </item>
  3867. <item>
  3868. <term>ScrollableText</term>
  3869. <description>Displays a long string of text.</description>
  3870. </item>
  3871. <item>
  3872. <term>SelectionTree</term>
  3873. <description>Displays information from the Feature table and enables the user to change their selection state.</description>
  3874. </item>
  3875. <item>
  3876. <term>Text</term>
  3877. <description>Displays static text.</description>
  3878. </item>
  3879. <item>
  3880. <term>VolumeCostList</term>
  3881. <description>Displays costing information on different volumes.</description>
  3882. </item>
  3883. <item>
  3884. <term>VolumeSelectCombo</term>
  3885. <description>Selects volume from an alphabetical list.</description>
  3886. </item>
  3887. </list>
  3888. More information found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp">http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp</a></term>
  3889. <term>True</term>
  3890. </item>
  3891. <item>
  3892. <term>x</term>
  3893. <term>int</term>
  3894. <term>Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number.</term>
  3895. <term>True</term>
  3896. </item>
  3897. <item>
  3898. <term>y</term>
  3899. <term>int</term>
  3900. <term>Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number.</term>
  3901. <term>True</term>
  3902. </item>
  3903. <item>
  3904. <term>width</term>
  3905. <term>int</term>
  3906. <term>Width of the rectangular boundary of the control. This must be a non-negative number.</term>
  3907. <term>True</term>
  3908. </item>
  3909. <item>
  3910. <term>height</term>
  3911. <term>int</term>
  3912. <term>Height of the rectangular boundary of the control. This must be a non-negative number.</term>
  3913. <term>True</term>
  3914. </item>
  3915. <item>
  3916. <term>attr</term>
  3917. <term>int</term>
  3918. <term>A 32-bit word that specifies the bit flags to be applied to this control. This must be a non-negative number, and the allowed values depend upon the type of control.For a list of all control attributes, and the value to enter in this field, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/control_attributes.asp">Control Attributes</a>.</term>
  3919. <term>True</term>
  3920. </item>
  3921. <item>
  3922. <term>property</term>
  3923. <term>string</term>
  3924. <term>The name of a defined property to be linked to this control. Radio button, list box, and combo box values are tied into a group by being linked to the same property. This column is required for active controls and is ignored by static controls.</term>
  3925. <term>False</term>
  3926. </item>
  3927. <item>
  3928. <term>text</term>
  3929. <term>string</term>
  3930. <term>A localizable string used to set the initial text contained in a control. The string can also contain embedded properties.</term>
  3931. <term>False</term>
  3932. </item>
  3933. <item>
  3934. <term>nextcontrol</term>
  3935. <term>string</term>
  3936. <term>The name of another control on the same dialog box. If the focus in the dialog box is on the control in the Control column, hitting the tab key moves the focus to the control listed here. Therefore this is used to specify the tab order of the controls on the dialog box. The links between the controls must form a closed cycle. Some controls, such as static text controls, can be left out of the cycle. In that case, this field may be left blank. </term>
  3937. <term>False</term>
  3938. </item>
  3939. <item>
  3940. <term>help</term>
  3941. <term>string</term>
  3942. <term>Optional, localizable text strings that are used with the Help button. The string is divided into two parts by a separator character (|). The first part of the string is used as ToolTip text. This text is used by screen readers for controls that contain a picture. The second part of the string is reserved for future use. The separator character is required even if only one of the two kinds of text is present.</term>
  3943. <term>False</term>
  3944. </item>
  3945. <item>
  3946. <term>remove</term>
  3947. <term>bool</term>
  3948. <term>If <c>true</c>, the control is removed. If <c>false</c>, the control is added.</term>
  3949. <term>False</term>
  3950. </item>
  3951. </list>
  3952. <h3>Examples</h3>
  3953. <example>
  3954. <para>Remove the Browse button from the customize dialog and add controls for a web dialog</para>
  3955. <code>
  3956. &lt;controls&gt;
  3957. &lt;!-- Remove the Browse button from customize dialog --&gt;
  3958. &lt;control dialog="CustomizeDlg" name="Browse" type="PushButton"
  3959. x="304" y="200" width="56" height="17" attr="3" remove="true" /&gt;
  3960. &lt;control dialog="CustomizeDlg" name="Tree" type="SelectionTree"
  3961. x="25" y="85" width="175" height="95" attr="7" remove="true" /&gt;
  3962. &lt;!-- Re add the tree control with the proper next control --&gt;
  3963. &lt;control dialog="CustomizeDlg" name="Tree" type="SelectionTree"
  3964. x="25" y="85" width="175" height="95" attr="7"
  3965. property="_BrowseProperty" text="Tree of selections" nextcontrol="Reset" /&gt;
  3966. &lt;!-- Adds the controls associated with the webfolder dialog --&gt;
  3967. &lt;control dialog="WebFolderDlg" name="BannerBitmap" type="Bitmap"
  3968. x="0" y="0" width="374" height="44" attr="1"
  3969. text="[BannerBitmap]" nextcontrol="VDirLabel" /&gt;
  3970. &lt;control dialog="WebFolderDlg" name="Title" type="Text"
  3971. x="15" y="6" width="200" height="15" attr="196611"
  3972. text="[DlgTitleFont]Virtual Directory Information" /&gt;
  3973. &lt;control dialog="WebFolderDlg" name="Description" type="Text"
  3974. x="25" y="23" width="280" height="15" attr="196611"
  3975. text="Please enter your virtual directory and port information." /&gt;
  3976. &lt;control dialog="WebFolderDlg" name="BannerLine" type="Line"
  3977. x="0" y="44" width="374" height="0" attr="1" /&gt;
  3978. &lt;control dialog="WebFolderDlg" name="VDirLabel" type="Text"
  3979. x="18" y="73" width="348" height="15" attr="3"
  3980. text="&amp;Virtual directory:"
  3981. nextcontrol="Edit_VDir" /&gt;
  3982. &lt;control dialog="WebFolderDlg" name="Edit_VDir" type="Edit"
  3983. x="18" y="85" width="252" height="18" attr="7"
  3984. property="TARGETVDIR"
  3985. text="[TARGETVDIR]"
  3986. nextcontrol="PortLabel" /&gt;
  3987. &lt;control dialog="WebFolderDlg" name="PortLabel" type="Text"
  3988. x="18" y="110" width="348" height="15" attr="3"
  3989. text="&amp;Port:"
  3990. nextcontrol="Edit_Port" /&gt;
  3991. &lt;control dialog="WebFolderDlg" name="Edit_Port" type="Edit"
  3992. x="18" y="122" width="48" height="18" attr="7"
  3993. property="TARGETPORT"
  3994. text="[TARGETPORT]"
  3995. nextcontrol="Back" /&gt;
  3996. &lt;control dialog="WebFolderDlg" name="BottomLine" type="Line"
  3997. x="0" y="234" width="374" height="0" attr="1" /&gt;
  3998. &lt;control dialog="WebFolderDlg" name="Back" type="PushButton"
  3999. x="180" y="243" width="56" height="17" attr="3"
  4000. text="[ButtonText_Back]" nextcontrol="Next" /&gt;
  4001. &lt;control dialog="WebFolderDlg" name="Next" type="PushButton"
  4002. x="236" y="243" width="56" height="17" attr="3"
  4003. text="[ButtonText_Next]" nextcontrol="Cancel" /&gt;
  4004. &lt;control dialog="WebFolderDlg" name="Cancel" type="PushButton"
  4005. x="304" y="243" width="56" height="17" attr="3"
  4006. text="[ButtonText_Cancel]" nextcontrol="BannerBitmap" /&gt;
  4007. &lt;/controls&gt;
  4008. </code>
  4009. </example>
  4010. </summary>
  4011. </member>
  4012. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlConditionsElement">
  4013. <summary>
  4014. <para>
  4015. Used to validate and perform operations as the result of information
  4016. entered by the user into controls on custom dialogs.
  4017. </para>
  4018. <h3>Parameters</h3>
  4019. <list type="table">
  4020. <listheader>
  4021. <term>Attribute</term>
  4022. <term>Type</term>
  4023. <term>Description</term>
  4024. <term>Required</term>
  4025. </listheader>
  4026. <item>
  4027. <term>dialog</term>
  4028. <term>string</term>
  4029. <term>Refrence to a dialog. Used to associate the control with the dialog.</term>
  4030. <term>True</term>
  4031. </item>
  4032. <item>
  4033. <term>control</term>
  4034. <term>string</term>
  4035. <term>Refrence to a control. Maps to a control for the specified dialog.</term>
  4036. <term>True</term>
  4037. </item>
  4038. <item>
  4039. <term>action</term>
  4040. <term>string</term>
  4041. <term>The action that is to be taken on the control. The possible actions are shown in the following table.
  4042. <list type="table">
  4043. <listheader>
  4044. <term>Value</term>
  4045. <description>Description</description>
  4046. </listheader>
  4047. <item>
  4048. <term>Default</term>
  4049. <description>Set control as the default.</description>
  4050. </item>
  4051. <item>
  4052. <term>Disable</term>
  4053. <description>Disable the control.</description>
  4054. </item>
  4055. <item>
  4056. <term>Enable</term>
  4057. <description>Enable the control.</description>
  4058. </item>
  4059. <item>
  4060. <term>Hide</term>
  4061. <description>Hide the control.</description>
  4062. </item>
  4063. <item>
  4064. <term>Show</term>
  4065. <description>Display the control.</description>
  4066. </item>
  4067. </list>
  4068. </term>
  4069. <term>True</term>
  4070. </item>
  4071. <item>
  4072. <term>condition</term>
  4073. <term>string</term>
  4074. <term>A conditional statement that specifies under which conditions the action should be triggered. If this statement does not evaluate to TRUE, the action does not take place. If it is set to 1, the action is always applied. </term>
  4075. <term>True</term>
  4076. </item>
  4077. <item>
  4078. <term>remove</term>
  4079. <term>bool</term>
  4080. <term>If <c>true</c>, the control condition is removed. If <c>false</c>, the control condition is added.</term>
  4081. <term>False</term>
  4082. </item>
  4083. </list>
  4084. <h3>Examples</h3>
  4085. <example>
  4086. <para>Remove the control condition for the Browse button from the customize dialog and add control conditions for a web dialog</para>
  4087. <code>
  4088. &lt;controlconditions&gt;
  4089. &lt;!-- Remove control condition for Browse button on customizeDlg --&gt;
  4090. &lt;controlcondition dialog="CustomizeDlg" control="Browse" action="Hide"
  4091. condition="Installed" remove="true" /&gt;
  4092. &lt;!-- Add control conditions for the web folder dialog --&gt;
  4093. &lt;controlcondition dialog="WebFolderDlg" control="Back" action="Disable"
  4094. condition="ShowUserRegistrationDlg=&quot;&quot;" /&gt;
  4095. &lt;controlcondition dialog="WebFolderDlg" control="Back" action="Enable"
  4096. condition="ShowUserRegistrationDlg&lt;&gt;&quot;&quot;" /&gt;
  4097. &lt;/controlconditions&gt;
  4098. </code>
  4099. </example>
  4100. </summary>
  4101. </member>
  4102. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlEventsElement">
  4103. <summary>
  4104. <para>
  4105. Used to route the flow of the installation process as the result of
  4106. events raised by the user interacting with controls on dialogs.
  4107. </para>
  4108. <h3>Parameters</h3>
  4109. <list type="table">
  4110. <listheader>
  4111. <term>Attribute</term>
  4112. <term>Type</term>
  4113. <term>Description</term>
  4114. <term>Required</term>
  4115. </listheader>
  4116. <item>
  4117. <term>dialog</term>
  4118. <term>string</term>
  4119. <term>Refrence to a dialog. Used to associate the control with the dialog.</term>
  4120. <term>True</term>
  4121. </item>
  4122. <item>
  4123. <term>control</term>
  4124. <term>string</term>
  4125. <term>Refrence to a control. Maps to a control for the specified dialog.</term>
  4126. <term>True</term>
  4127. </item>
  4128. <item>
  4129. <term>name</term>
  4130. <term>string</term>
  4131. <term>An identifier that specifies the type of event that should take place when the user interacts with the control
  4132. specified by Dialog_ and Control_. For a list of possible values see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/controlevent_overview.asp">ControlEvent Overview</a>. <br/>
  4133. To set a property with a control, put [Property_Name] in this field and the new value in the argument field. Put { }
  4134. into the argument field to enter the null value.
  4135. </term>
  4136. <term>True</term>
  4137. </item>
  4138. <item>
  4139. <term>argument</term>
  4140. <term>string</term>
  4141. <term>A value used as a modifier when triggering a particular event.</term>
  4142. <term>True</term>
  4143. </item>
  4144. <item>
  4145. <term>condition</term>
  4146. <term>string</term>
  4147. <term>A conditional statement that determines whether the installer activates the event in the Event column. The installer
  4148. triggers the event if the conditional statement in the Condition field evaluates to True. Therefore put a 1 in this column
  4149. to ensure that the installer triggers the event. The installer does not trigger the event if the Condition field contains
  4150. a statement that evaluates to False. The installer does not trigger an event with a blank in the Condition field unless no
  4151. other events of the control evaluate to True. If none of the Condition fields for the control named in the Control_ field
  4152. evaluate to True, the installer triggers the one event having a blank Condition field, and if more than one Condition field
  4153. is blank it triggers the one event of these with the largest value in the Ordering field.</term>
  4154. <term>False</term>
  4155. </item>
  4156. <item>
  4157. <term>order</term>
  4158. <term>int</term>
  4159. <term>An integer used to order several events tied to the same control. This must be a non-negative number.</term>
  4160. <term>False</term>
  4161. </item>
  4162. <item>
  4163. <term>remove</term>
  4164. <term>bool</term>
  4165. <term>If <c>true</c>, the control condition is removed. If <c>false</c>, the control condition is added.</term>
  4166. <term>False</term>
  4167. </item>
  4168. </list>
  4169. <h3>Examples</h3>
  4170. <example>
  4171. <para>Remove the control events for the Browse button from the customize dialog and add events conditions for a web dialog</para>
  4172. <code>
  4173. <!-- Make sure the dialog is put into the execute order -->
  4174. &lt;controlevents&gt;
  4175. &lt;!-- Remove the old control events --&gt;
  4176. &lt;controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog"
  4177. argument="SetupTypeDlg" condition="ProductID" remove="true" /&gt;
  4178. &lt;controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog"
  4179. argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg &lt;&gt; 1" remove="true" /&gt;
  4180. &lt;controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog"
  4181. argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg = 1" remove="true" /&gt;
  4182. &lt;!-- Remove control events for Browse button on CustomizeDlg --&gt;
  4183. &lt;controlevent dialog="CustomizeDlg" control="Browse" name="SelectionBrowse"
  4184. argument="BrowseDlg" condition="1" remove="true" /&gt;
  4185. &lt;!-- Add new control events for the web dialog --&gt;
  4186. &lt;controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog"
  4187. argument="WebFolderDlg" condition="ProductID" /&gt;
  4188. &lt;controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog"
  4189. argument="WebFolderDlg" condition="ShowWebFolderDlg &lt;&gt; 1" /&gt;
  4190. &lt;controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog"
  4191. argument="WebFolderDlg" condition="ShowWebFolderDlg = 1" /&gt;
  4192. &lt;controlevent dialog="WebFolderDlg" control="Cancel" name="SpawnDialog"
  4193. argument="CancelDlg" order="0" /&gt;
  4194. &lt;controlevent dialog="WebFolderDlg" control="Back" name="NewDialog"
  4195. argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg&lt;&gt;1"
  4196. order="0" /&gt;
  4197. &lt;controlevent dialog="WebFolderDlg" control="Back" name="NewDialog"
  4198. argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg=1"
  4199. order="0" /&gt;
  4200. &lt;!-- Virtual Directory Control Events --&gt;
  4201. &lt;controlevent dialog="WebFolderDlg" control="Next" name="DoAction"
  4202. argument="WEBCA_CreateURLs" condition="1" order="0" /&gt;
  4203. &lt;controlevent dialog="WebFolderDlg" control="Next" name="DoAction"
  4204. argument="WEBCA_EvaluateURLsMB" condition="1" order="1" /&gt;
  4205. &lt;controlevent dialog="WebFolderDlg" control="Next" name="SetTargetPath"
  4206. argument="TARGETDIR" condition="1" order="2" /&gt;
  4207. &lt;controlevent dialog="WebFolderDlg" control="Next" name="NewDialog"
  4208. argument="SetupTypeDlg" condition="1" order="3" /&gt;
  4209. &lt;/controlevents&gt;
  4210. </code>
  4211. </example>
  4212. </summary>
  4213. </member>
  4214. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerRegistryElement">
  4215. <summary>
  4216. <para>
  4217. Makes modifications to the Windows Registry of the target computer
  4218. at runtime.
  4219. </para>
  4220. <h3>Parameters</h3>
  4221. <list type="table">
  4222. <listheader>
  4223. <term>Attribute</term>
  4224. <term>Type</term>
  4225. <term>Description</term>
  4226. <term>Required</term>
  4227. </listheader>
  4228. <item>
  4229. <term>component</term>
  4230. <term>string</term>
  4231. <term>Refrence to a component. The component that controls the installation of the registry value.</term>
  4232. <term>True</term>
  4233. </item>
  4234. <item>
  4235. <term>root</term>
  4236. <term>msi:MSIRegistryKeyRoot</term>
  4237. <term>Valid input:
  4238. <list type="bullet">
  4239. <item><c>dependent</c> - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1.</item>
  4240. <item><c>machine</c> represents HKEY_LOCAL_MACHINE</item>
  4241. <item><c>classes</c> represents HKEY_CLASSES_ROOT</item>
  4242. <item><c>user</c> represents HKEY_CURRENT_USER</item>
  4243. <item><c>users</c> represents HKEY_USERS</item>
  4244. </list>
  4245. </term>
  4246. <term>True</term>
  4247. </item>
  4248. <item>
  4249. <term>path</term>
  4250. <term>string</term>
  4251. <term>Registry key.</term>
  4252. <term>True</term>
  4253. </item>
  4254. </list>
  4255. <h3>Nested Elements:</h3>
  4256. <h4>&lt;value&gt;</h4>
  4257. <ul>
  4258. Specifies the registry value to add to the target machine.
  4259. <list type="table">
  4260. <listheader>
  4261. <term>Attribute</term>
  4262. <term>Type</term>
  4263. <term>Description</term>
  4264. <term>Required</term>
  4265. </listheader>
  4266. <item>
  4267. <term>name</term>
  4268. <term>string</term>
  4269. <term>The registry value name (localizable). If this is Null, then the data entered into the Value column are
  4270. written to the default registry key. <br/>
  4271. If the Value column is Null, then the strings shown in the following table in the Name column have special
  4272. significance.
  4273. <list type="table">
  4274. <listheader>
  4275. <term>String</term>
  4276. <description>Description</description>
  4277. </listheader>
  4278. <item>
  4279. <term>+</term>
  4280. <description>The key is to be created, if absent, when the component is installed.</description>
  4281. </item>
  4282. <item>
  4283. <term>-</term>
  4284. <description>The key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled.</description>
  4285. </item>
  4286. <item>
  4287. <term>*</term>
  4288. <description>The key is to be created, if absent, when the component is installed. Additionally, the key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled.</description>
  4289. </item>
  4290. </list>
  4291. </term>
  4292. <term>False</term>
  4293. </item>
  4294. <item>
  4295. <term>value</term>
  4296. <term>string</term>
  4297. <term>The localizable registry value. The field is <a href="http://msdn.microsoft.com/library/en-us/msi/setup/formatted.asp">Formatted</a>. If the value is attached to one of the following prefixes (i.e. #%value) then the value is interpreted as described in the table. Note that each prefix begins with a number sign (#). If the value begins with two or more consecutive number signs (#), the first # is ignored and value is interpreted and stored as a string.
  4298. <list type="table">
  4299. <listheader>
  4300. <term>Prefix</term>
  4301. <description>Description</description>
  4302. </listheader>
  4303. <item>
  4304. <term>#x</term>
  4305. <description>The value is interpreted and stored as a hexadecimal value (REG_BINARY).</description>
  4306. </item>
  4307. <item>
  4308. <term>#%</term>
  4309. <description>The value is interpreted and stored as an expandable string (REG_EXPAND_SZ).</description>
  4310. </item>
  4311. <item>
  4312. <term>#</term>
  4313. <description>The value is interpreted and stored as an integer (REG_DWORD).</description>
  4314. </item>
  4315. </list>
  4316. <list type="bullet">
  4317. <item>If the value contains the sequence tilde [~], then the value is interpreted as a Null-delimited list of strings (REG_MULTI_SZ). For example, to specify a list containing the three strings a, b and c, use "a[~]b[~]c." </item>
  4318. <item>The sequence [~] within the value separates the individual strings and is interpreted and stored as a Null character.</item>
  4319. <item>If a [~] precedes the string list, the strings are to be appended to any existing registry value strings. If an appending string already occurs in the registry value, the original occurrence of the string is removed.</item>
  4320. <item>If a [~] follows the end of the string list, the strings are to be prepended to any existing registry value strings. If a prepending string already occurs in the registry value, the original occurrence of the string is removed.</item>
  4321. <item>If a [~] is at both the beginning and the end or at neither the beginning nor the end of the string list, the strings are to replace any existing registry value strings.</item>
  4322. <item>Otherwise, the value is interpreted and stored as a string (REG_SZ). </item>
  4323. </list>
  4324. </term>
  4325. <term>False</term>
  4326. </item>
  4327. <item>
  4328. <term>dword</term>
  4329. <term>string</term>
  4330. <term>A dword value to input, if the value attribute is null. This removes the requirement of adding "#" before the value.</term>
  4331. <term>False</term>
  4332. </item>
  4333. <item>
  4334. <term>id</term>
  4335. <term>string</term>
  4336. <term>Primary key used to identify a registry record.</term>
  4337. <term>False</term>
  4338. </item>
  4339. </list>
  4340. </ul>
  4341. <h4>&lt;/value&gt;</h4>
  4342. <h3>Examples</h3>
  4343. <example>
  4344. <para>Add the a couple registry entries on the target machine.</para>
  4345. <code>
  4346. &lt;registry&gt;
  4347. &lt;key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" &gt;
  4348. &lt;value name="ProductVersion" value="1.0.0" /&gt;
  4349. &lt;value name="ProductDir" value="[TARGETDIR]" /&gt;
  4350. &lt;value name="VirtualDir" value="[TARGETVDIR]" /&gt;
  4351. &lt;/key&gt;
  4352. &lt;/registry&gt;
  4353. </code>
  4354. </example>
  4355. <example>
  4356. <para>Add a default key value to the specified registry key path</para>
  4357. <code>
  4358. &lt;registry&gt;
  4359. &lt;key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" &gt;
  4360. &lt;value value="1.0.0" /&gt;
  4361. &lt;/key&gt;
  4362. &lt;/registry&gt;
  4363. </code>
  4364. </example>
  4365. <example>
  4366. <para>Another way to add a default key value to the specified registry key path</para>
  4367. <code>
  4368. &lt;registry&gt;
  4369. &lt;key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" &gt;
  4370. &lt;value name="" value="1.0.0" /&gt;
  4371. &lt;/key&gt;
  4372. &lt;/registry&gt;
  4373. </code>
  4374. </example>
  4375. <example>
  4376. <para>Specify hexadecimal value (REG_BINARY) for the default key</para>
  4377. <code>
  4378. &lt;registry&gt;
  4379. &lt;key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" &gt;
  4380. &lt;value&gt;
  4381. 1a,81,0a,03,01,00,06,00,00,00,d3,15,fd,00,01,00,00,00,00,00,01,
  4382. 00,00,00,00,00,00,00,00,00,00,00,b0,90,ce,09,01,00,00,00,00,00,ff,ff,ff,00,
  4383. 00,00,00,00,00,00,00,00,6d,7a,0a,03,01,00,00,00,00,00,00,00,38,40,00,00,00,
  4384. 00,00,00,00,00,00,00,00,00,90,01,00,00,00,00,00,01,00,00,00,00,0f,00,00,00,
  4385. f0,ff,ff,ff,54,69,6d,65,73,20,4e,65,77,20,52,6f,6d,61,6e,f4,6f,d4,08,02,00
  4386. &lt;/value&gt;
  4387. &lt;/key&gt;
  4388. &lt;/registry&gt;
  4389. </code>
  4390. </example>
  4391. </summary>
  4392. </member>
  4393. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerIconsElement">
  4394. <summary>
  4395. <para>
  4396. Stores icons to be used with shortcuts, file extensions, CLSIDs or
  4397. similar uses.
  4398. </para>
  4399. <h3>Parameters</h3>
  4400. <list type="table">
  4401. <listheader>
  4402. <term>Attribute</term>
  4403. <term>Type</term>
  4404. <term>Description</term>
  4405. <term>Required</term>
  4406. </listheader>
  4407. <item>
  4408. <term>name</term>
  4409. <term>string</term>
  4410. <term>Name of the icon file.</term>
  4411. <term>True</term>
  4412. </item>
  4413. <item>
  4414. <term>value</term>
  4415. <term>string</term>
  4416. <term>The binary icon data in PE (.dll or .exe) or icon (.ico) format.</term>
  4417. <term>True</term>
  4418. </item>
  4419. </list>
  4420. <h3>Examples</h3>
  4421. <example>
  4422. <para>Add a compiled help icon to the msi database; To be used with a shortcut.</para>
  4423. <code>
  4424. &lt;icons&gt;
  4425. &lt;icon name="CHMICON" value="${resource.dir}\chm.ico" /&gt;
  4426. &lt;/icons&gt;
  4427. </code>
  4428. </example>
  4429. </summary>
  4430. </member>
  4431. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerShortcutsElement">
  4432. <summary>
  4433. <para>
  4434. Creates shortcuts on the target computer.
  4435. </para>
  4436. <h3>Parameters</h3>
  4437. <list type="table">
  4438. <listheader>
  4439. <term>Attribute</term>
  4440. <term>Type</term>
  4441. <term>Description</term>
  4442. <term>Required</term>
  4443. </listheader>
  4444. <item>
  4445. <term>name</term>
  4446. <term>string</term>
  4447. <term>Unique name identifying the shortcut.</term>
  4448. <term>True</term>
  4449. </item>
  4450. <item>
  4451. <term>directory</term>
  4452. <term>string</term>
  4453. <term>Reference to a directory. The location of where the shortcut should be created.</term>
  4454. <term>True</term>
  4455. </item>
  4456. <item>
  4457. <term>filename</term>
  4458. <term>string</term>
  4459. <term>The localizable name of the shortcut to be created.</term>
  4460. <term>True</term>
  4461. </item>
  4462. <item>
  4463. <term>component</term>
  4464. <term>string</term>
  4465. <term>Reference to a component. The installer uses the installation state of this specified component to determine whether the shortcut is created or deleted. This component must have a valid key path for the shortcut to be installed. If the Target column contains the name of a feature, the file launched by the shortcut is the key file of the component listed in this column. </term>
  4466. <term>True</term>
  4467. </item>
  4468. <item>
  4469. <term>target</term>
  4470. <term>string</term>
  4471. <term>The shortcut target. The installer evaluates this field as a Formatted string. The field should contains a property identifier enclosed by square brackets ([ ]), that is expanded into the file or a folder pointed to by the shortcut.</term>
  4472. <term>True</term>
  4473. </item>
  4474. <item>
  4475. <term>arguments</term>
  4476. <term>string</term>
  4477. <term>The command-line arguments for the shortcut. <br/>Note that the resolution of properties in the Arguments field is limited. A property formatted as [Property] in this field can only be resolved if the property already has the intended value when the component owning the shortcut is installed. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the same process must be installing the file MyDoc.doc and the component that owns the shortcut.
  4478. </term>
  4479. <term>False</term>
  4480. </item>
  4481. <item>
  4482. <term>hotkey</term>
  4483. <term>string</term>
  4484. <term>The hotkey for the shortcut. The low-order byte contains the virtual-key code for the key, and the high-order byte contains modifier flags. This must be a non-negative number. Authors of installation packages are generally recommend not to set this option, because this can add duplicate hotkeys to a users desktop. In addition, the practice of assigning hotkeys to shortcuts can be problematic for users using hotkeys for accessibility.</term>
  4485. <term>False</term>
  4486. </item>
  4487. <item>
  4488. <term>icon</term>
  4489. <term>string</term>
  4490. <term>Reference to an icon. </term>
  4491. <term>False</term>
  4492. </item>
  4493. <item>
  4494. <term>iconindex</term>
  4495. <term>int</term>
  4496. <term>The icon index for the shortcut. This must be a non-negative number.</term>
  4497. <term>False</term>
  4498. </item>
  4499. <item>
  4500. <term>showcmd</term>
  4501. <term>int</term>
  4502. <term>The Show command for the application window. <br/>The following values may be used. The values are as defined for the Windows API function ShowWindow.
  4503. <list type="table">
  4504. <listheader>
  4505. <term>Value</term>
  4506. <description>Description</description>
  4507. </listheader>
  4508. <item>
  4509. <term>1</term>
  4510. <description>SW_SHOWNORMAL</description>
  4511. </item>
  4512. <item>
  4513. <term>3</term>
  4514. <description>SW_SHOWMAXIMIZED</description>
  4515. </item>
  4516. <item>
  4517. <term>7</term>
  4518. <description>SW_SHOWMINNOACTIVE</description>
  4519. </item>
  4520. </list>
  4521. </term>
  4522. <term>False</term>
  4523. </item>
  4524. <item>
  4525. <term>wkdir</term>
  4526. <term>string</term>
  4527. <term>The name of the property that has the path of the working directory for the shortcut.</term>
  4528. <term>False</term>
  4529. </item>
  4530. </list>
  4531. <h3>Nested Elements:</h3>
  4532. <h4>&lt;description&gt;</h4>
  4533. <ul>
  4534. The localizable description of the shortcut.
  4535. </ul>
  4536. <h4>&lt;/description&gt;</h4>
  4537. <h3>Examples</h3>
  4538. <example>
  4539. <para>Add a compiled help icon to the msi database; To be used with a shortcut.</para>
  4540. <code>
  4541. &lt;shortcuts&gt;
  4542. &lt;shortcut name="HelpFiles" directory="D__PROGRAMMENU_ACME_MYPRODUCT" filename="Help File" component="C__MainFiles" target="[$C__MainFiles]\Help.chm" icon="CHMICON" iconindex="0" showcmd="3" &gt;
  4543. &lt;description&gt;My Product help documentation&lt;/description&gt;
  4544. &lt;/shortcut&gt;
  4545. &lt;/shortcuts&gt;
  4546. </code>
  4547. </example>
  4548. </summary>
  4549. </member>
  4550. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerBinariesElement">
  4551. <summary>
  4552. <para>
  4553. Stores the binary data for items such as bitmaps, animations, and
  4554. icons. The binary table is also used to store data for custom
  4555. actions.
  4556. </para>
  4557. <h3>Parameters</h3>
  4558. <list type="table">
  4559. <listheader>
  4560. <term>Attribute</term>
  4561. <term>Type</term>
  4562. <term>Description</term>
  4563. <term>Required</term>
  4564. </listheader>
  4565. <item>
  4566. <term>name</term>
  4567. <term>string</term>
  4568. <term>A unique key that identifies the particular binary data. If the binary data is for a control, the key appears in the Text column of the associated control in the Control table. This key must be unique among all controls requiring binary data.</term>
  4569. <term>True</term>
  4570. </item>
  4571. <item>
  4572. <term>value</term>
  4573. <term>string</term>
  4574. <term>The binary file to add.</term>
  4575. <term>True</term>
  4576. </item>
  4577. </list>
  4578. <h3>Examples</h3>
  4579. <example>
  4580. <para>Add the custom action dll to create/modify virtual directories</para>
  4581. <code>
  4582. &lt;binaries&gt;
  4583. &lt;binary name="MSVBDPCADLL" value="${resource.dir}\MSVBDPCA.DLL" /&gt;
  4584. &lt;/binaries&gt;
  4585. </code>
  4586. </example>
  4587. </summary>
  4588. </member>
  4589. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerCustomActionsElement">
  4590. <summary>
  4591. <para>
  4592. Used to configure executables that may be run during steps in the
  4593. installation process to do things outside the bounds of MSI
  4594. technology's feature set. This is the main spot you can extend MSI
  4595. technology to perform custom processes via compiled code.
  4596. </para>
  4597. <h3>Parameters</h3>
  4598. <list type="table">
  4599. <listheader>
  4600. <term>Attribute</term>
  4601. <term>Type</term>
  4602. <term>Description</term>
  4603. <term>Required</term>
  4604. </listheader>
  4605. <item>
  4606. <term>action</term>
  4607. <term>string</term>
  4608. <term>Name of the action. The action normally appears in a sequence table unless it is called by another custom action. If the name matches any built-in action, then the custom action is never called. </term>
  4609. <term>True</term>
  4610. </item>
  4611. <item>
  4612. <term>type</term>
  4613. <term>string</term>
  4614. <term>A field of flag bits specifying the basic type of custom action and options. See <a href="http://msdn.microsoft.com/library/en-us/msi/setup/summary_list_of_all_custom_action_types.asp">Summary List of All Custom Action Types</a> for a list of the basic types. See <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_return_processing_options.asp">Custom Action Return Processing Options</a>, <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_execution_scheduling_options.asp">Custom Action Execution Scheduling Options</a>, <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_hidden_target_option.asp">Custom Action Hidden Target Option</a>, and <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_in_script_execution_options.asp">Custom Action In-Script Execution Options</a>. </term>
  4615. <term>True</term>
  4616. </item>
  4617. <item>
  4618. <term>source</term>
  4619. <term>string</term>
  4620. <term>A property name or external key into another table. For a discussion of the possible custom action sources, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_sources.asp">Custom Action Sources</a> and the <a href="http://msdn.microsoft.com/library/en-us/msi/setup/summary_list_of_all_custom_action_types.asp">Summary List of All Custom Action Types</a>. For example, the Source column may contain an external key into the first column of one of the following tables containing the source of the custom action code. <br/>
  4621. Directory table for calling existing executables.<br/>
  4622. File table for calling executables and DLLs that have just been installed.<br/>
  4623. Binary table for calling executables, DLLs, and data stored in the database.<br/>
  4624. Property table for calling executables whose paths are held by a property.
  4625. </term>
  4626. <term>True</term>
  4627. </item>
  4628. <item>
  4629. <term>target</term>
  4630. <term>string</term>
  4631. <term>An execution parameter that depends on the basic type of custom action. See the Summary List of All Custom Action Types for a description of what should be entered in this field for each type of custom action. For example, this field may contain the following depending on the custom action.
  4632. <list type="table">
  4633. <listheader>
  4634. <term>Target</term>
  4635. <term>Custom Action</term>
  4636. </listheader>
  4637. <item>
  4638. <term>Entry point (required)</term>
  4639. <term>Calling a DLL.</term>
  4640. </item>
  4641. <item>
  4642. <term>Executable name with arguments (required)</term>
  4643. <term>Calling an existing executable.</term>
  4644. </item>
  4645. <item>
  4646. <term>Command line arguments (optional)</term>
  4647. <term>Calling an executable just installed.</term>
  4648. </item>
  4649. <item>
  4650. <term>Target file name (required)</term>
  4651. <term>Creating a file from custom data.</term>
  4652. </item>
  4653. <item>
  4654. <term>Null</term>
  4655. <term>Executing script code.</term>
  4656. </item>
  4657. </list>
  4658. </term>
  4659. <term>True</term>
  4660. </item>
  4661. </list>
  4662. <h3>Examples</h3>
  4663. <example>
  4664. <para>Add some custom actions related to the virtual directory dialog and custom action.</para>
  4665. <code>
  4666. &lt;customactions&gt;
  4667. &lt;!-- Custom actions creating entry points into the custom action dll specified in the binary table --&gt;
  4668. &lt;customaction action="WEBCA_GatherWebFolderProperties" type="1" source="MSVBDPCADLL" target="GatherWebFolderProperties" /&gt;
  4669. &lt;customaction action="WEBCA_ApplyWebFolderProperties" type="1537" source="MSVBDPCADLL" target="ApplyWebFolderProperties" /&gt;
  4670. &lt;customaction action="WEBCA_RollbackApplyWebFolderProperties" type="1281" source="MSVBDPCADLL" target="RollbackApplyWebFolderProperties" /&gt;
  4671. &lt;customaction action="WEBCA_CreateURLs" type="1" source="MSVBDPCADLL" target="CreateURLs" /&gt;
  4672. &lt;customaction action="WEBCA_EvaluateURLs" type="1" source="MSVBDPCADLL" target="EvaluateURLs" /&gt;
  4673. &lt;customaction action="WEBCA_EvaluateURLsNoFail" type="1" source="MSVBDPCADLL" target="EvaluateURLsNoFail" /&gt;
  4674. &lt;customaction action="WEBCA_EvaluateURLsMB" type="1" source="MSVBDPCADLL" target="EvaluateURLsMB" /&gt;
  4675. &lt;customaction action="WEBCA_CreateAppRoots" type="1" source="MSVBDPCADLL" target="CreateAppRoots" /&gt;
  4676. &lt;!-- Custom actions to set default control values in the webfolder dialog --&gt;
  4677. &lt;customaction action="WEBCA_TARGETVDIR" type="307" source="TARGETVDIR" target="Default VDir" /&gt;
  4678. &lt;customaction action="WEBCA_TARGETPORT" type="307" source="TARGETPORT" target="80" /&gt;
  4679. &lt;/customactions&gt;
  4680. </code>
  4681. </example>
  4682. </summary>
  4683. </member>
  4684. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSequencesElement">
  4685. <summary>
  4686. <para>
  4687. Used to modify the sequence of tasks/events that execute during the
  4688. overall installation process.
  4689. </para>
  4690. <h3>Parameters</h3>
  4691. <list type="table">
  4692. <listheader>
  4693. <term>Attribute</term>
  4694. <term>Type</term>
  4695. <term>Description</term>
  4696. <term>Required</term>
  4697. </listheader>
  4698. <item>
  4699. <term>type</term>
  4700. <term>msi:MSISequenceTable</term>
  4701. <term>Valid inputs:
  4702. <list type="bullet">
  4703. <item><c>installexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/installexecutesequence_table.asp">InstallExecuteSequence Table</a>.</item>
  4704. <item><c>installui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/installuisequence_table.asp">InstallUISequence Table</a></item>
  4705. <item><c>adminexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/adminexecutesequence_table.asp">AdminExecuteSequence Table</a></item>
  4706. <item><c>adminui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/adminuisequence_table.asp">AdminUISequence Table</a></item>
  4707. <item><c>advtexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/advtuisequence_table.asp">AdvtUISequence Table</a></item>
  4708. </list>
  4709. </term>
  4710. <term>True</term>
  4711. </item>
  4712. <item>
  4713. <term>action</term>
  4714. <term>string</term>
  4715. <term>Name of the action to execute. This is either a built-in action or a custom action.</term>
  4716. <term>True</term>
  4717. </item>
  4718. <item>
  4719. <term>value</term>
  4720. <term>int</term>
  4721. <term>Number that determines the sequence position in which this action is to be executed. <br/>
  4722. A positive value represents the sequence position. A Null value indicates that the action is not executed. The following
  4723. negative values indicate that this action is to be executed if the installer returns the associated termination flag. No
  4724. more than one action may have a negative value entered in the Sequence field.
  4725. <list type="table">
  4726. <listheader>
  4727. <term>Value</term>
  4728. <description>Description</description>
  4729. </listheader>
  4730. <item>
  4731. <term>-1</term>
  4732. <description>Successful completion.</description>
  4733. </item>
  4734. <item>
  4735. <term>-2</term>
  4736. <description>User terminates install.</description>
  4737. </item>
  4738. <item>
  4739. <term>-3</term>
  4740. <description>Fatal exit terminates.</description>
  4741. </item>
  4742. <item>
  4743. <term>-4</term>
  4744. <description>Install is suspended.</description>
  4745. </item>
  4746. </list>
  4747. </term>
  4748. <term>True</term>
  4749. </item>
  4750. <item>
  4751. <term>condition</term>
  4752. <term>string</term>
  4753. <term>This field contains a conditional expression. If the expression evaluates to False, then the action is skipped. If the expression syntax is invalid, then the sequence terminates, returning iesBadActionData. </term>
  4754. <term>False</term>
  4755. </item>
  4756. </list>
  4757. <h3>Examples</h3>
  4758. <example>
  4759. <para>Add the sequences to support virtual directories</para>
  4760. <code>
  4761. &lt;sequences&gt;
  4762. &lt;sequence type="installexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&amp;quot;&amp;quot;" /&gt;
  4763. &lt;sequence type="installexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&amp;quot;&amp;quot;" /&gt;
  4764. &lt;sequence type="installexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /&gt;
  4765. &lt;sequence type="installexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /&gt;
  4766. &lt;sequence type="installexecute" action="WEBCA_GatherWebFolderProperties" value="3701" condition="NOT Installed" /&gt;
  4767. &lt;sequence type="installexecute" action="WEBCA_ApplyWebFolderProperties" value="3701" condition="NOT Installed" /&gt;
  4768. &lt;sequence type="installexecute" action="WEBCA_RollbackApplyWebFolderProperties" value="3701" condition="NOT Installed" /&gt;
  4769. &lt;sequence type="installexecute" action="WEBCA_CreateAppRoots" value="3701" condition="NOT Installed" /&gt;
  4770. &lt;sequence type="installui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&amp;quot;&amp;quot;" /&gt;
  4771. &lt;sequence type="installui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&amp;quot;&amp;quot;" /&gt;
  4772. &lt;sequence type="installui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /&gt;
  4773. &lt;sequence type="installui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /&gt;
  4774. &lt;sequence type="adminexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&amp;quot;&amp;quot;" /&gt;
  4775. &lt;sequence type="adminexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&amp;quot;&amp;quot;" /&gt;
  4776. &lt;sequence type="adminexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /&gt;
  4777. &lt;sequence type="adminexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /&gt;
  4778. &lt;sequence type="adminui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&amp;quot;&amp;quot;" /&gt;
  4779. &lt;sequence type="adminui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&amp;quot;&amp;quot;" /&gt;
  4780. &lt;sequence type="adminui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /&gt;
  4781. &lt;sequence type="adminui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /&gt;
  4782. &lt;/sequences&gt;
  4783. </code>
  4784. </example>
  4785. </summary>
  4786. </member>
  4787. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerActionTextElement">
  4788. <summary>
  4789. <para>
  4790. Creates text to be displayed in a progress dialog box and written
  4791. to the log for actions that take a long time to execute. The text
  4792. displayed consists of the action description and optionally formatted
  4793. data from the action. The entries in the ActionText table typically
  4794. refer to actions in sequence tables.
  4795. </para>
  4796. <h3>Parameters</h3>
  4797. <list type="table">
  4798. <listheader>
  4799. <term>Attribute</term>
  4800. <term>Type</term>
  4801. <term>Description</term>
  4802. <term>Required</term>
  4803. </listheader>
  4804. <item>
  4805. <term>name</term>
  4806. <term>string</term>
  4807. <term>Unique name identifying the action.</term>
  4808. <term>True</term>
  4809. </item>
  4810. <item>
  4811. <term>template</term>
  4812. <term>string</term>
  4813. <term>A localized format template is used to format action data records for display during action execution. If no template is supplied, then the action data will not be displayed.</term>
  4814. <term>False</term>
  4815. </item>
  4816. </list>
  4817. <h3>Nested Elements:</h3>
  4818. <h4>&lt;description&gt;</h4>
  4819. <ul>
  4820. Localized description displayed in the progress dialog box or written to the log when the action is executing.
  4821. </ul>
  4822. <h4>&lt;/description&gt;</h4>
  4823. <h3>Examples</h3>
  4824. <example>
  4825. <para>Add the related action text for the web folder actions.</para>
  4826. <code>
  4827. &lt;actiontext&gt;
  4828. &lt;action name="WEBCA_GatherWebFolderProperties" &gt;
  4829. &lt;description&gt;Gathering web folder properties&lt;/description&gt;
  4830. &lt;/action&gt;
  4831. &lt;action name="WEBCA_ApplyWebFolderProperties" &gt;
  4832. &lt;description&gt;Applying web folder properties&lt;/description&gt;
  4833. &lt;/action&gt;
  4834. &lt;action name="WEBCA_RollbackApplyWebFolderProperties" &gt;
  4835. &lt;description&gt;Removing web folder properties&lt;/description&gt;
  4836. &lt;/action&gt;
  4837. &lt;action name="WEBCA_CreateURLs" &gt;
  4838. &lt;description&gt;Creating URLs&lt;/description&gt;
  4839. &lt;/action&gt;
  4840. &lt;action name="WEBCA_EvaluateURLs" &gt;
  4841. &lt;description&gt;Evaluating URLs&lt;/description&gt;
  4842. &lt;/action&gt;
  4843. &lt;action name="WEBCA_EvaluateURLsNoFail" &gt;
  4844. &lt;description&gt;Evaluating URLs and do not fail if URL is invalid&lt;/description&gt;
  4845. &lt;/action&gt;
  4846. &lt;action name="WEBCA_EvaluateURLsMB" &gt;
  4847. &lt;description&gt;Evaluating URLs&lt;/description&gt;
  4848. &lt;/action&gt;
  4849. &lt;action name="WEBCA_CreateAppRoots" &gt;
  4850. &lt;description&gt;Creating application roots&lt;/description&gt;
  4851. &lt;/action&gt;
  4852. &lt;action name="WEBCA_TARGETVDIR" &gt;
  4853. &lt;description&gt;Set TARGETVDIR property to the specified virtual dir&lt;/description&gt;
  4854. &lt;/action&gt;
  4855. &lt;action name="WEBCA_TARGETPORT" &gt;
  4856. &lt;description&gt;Set TARGETPORT property to the specified virtual dir port&lt;/description&gt;
  4857. &lt;/action&gt;
  4858. &lt;/actiontext&gt;
  4859. </code>
  4860. </example>
  4861. </summary>
  4862. </member>
  4863. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerAppMappingsElement">
  4864. <summary>
  4865. <para>
  4866. Adds Verbs and a handler for the specified file type.
  4867. </para>
  4868. <note>This not an officially Microsoft supported table.</note>
  4869. <h3>Parameters</h3>
  4870. <list type="table">
  4871. <listheader>
  4872. <term>Attribute</term>
  4873. <term>Type</term>
  4874. <term>Description</term>
  4875. <term>Required</term>
  4876. </listheader>
  4877. <item>
  4878. <term>directory</term>
  4879. <term>string</term>
  4880. <term>Refrence to a directory. The directory to add the specific verb/handler to IIS for the specified file type.</term>
  4881. <term>True</term>
  4882. </item>
  4883. <item>
  4884. <term>extension</term>
  4885. <term>string</term>
  4886. <term>File name extension to specifically handle</term>
  4887. <term>False</term>
  4888. </item>
  4889. <item>
  4890. <term>exepath</term>
  4891. <term>string</term>
  4892. <term>Path to the Internet Server API (ISAPI) or Common Gateway Interface (CGI) program to run to process a request.</term>
  4893. <term>False</term>
  4894. </item>
  4895. <item>
  4896. <term>verbs</term>
  4897. <term>string</term>
  4898. <term>Internet Information Services verbs that are allowed for the executable file. Only verbs entered in this field will be allowed.</term>
  4899. <term>False</term>
  4900. </item>
  4901. </list>
  4902. <h3>Examples</h3>
  4903. <example>
  4904. <para>Add the aspx app mapping</para>
  4905. <code>
  4906. &lt;appmappings&gt;
  4907. &lt;appmapping directory="D__ACME_MyProduct" extension=".aspx" exepath="[DOTNETFOLDER]aspnet_isapi.dll" verbs="GET,HEAD,POST,DEBUG" /&gt;
  4908. &lt;/appmappings&gt;
  4909. </code>
  4910. </example>
  4911. </summary>
  4912. </member>
  4913. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerUrlPropertiesElement">
  4914. <summary>
  4915. <para>
  4916. Determines the local path equivalent for a url and stores this
  4917. information in a property.
  4918. </para>
  4919. <note>This not an officially Microsoft supported table.</note>
  4920. <h3>Parameters</h3>
  4921. <list type="table">
  4922. <listheader>
  4923. <term>Attribute</term>
  4924. <term>Type</term>
  4925. <term>Description</term>
  4926. <term>Required</term>
  4927. </listheader>
  4928. <item>
  4929. <term>name</term>
  4930. <term>string</term>
  4931. <term>The name of the URLProperty to convert</term>
  4932. <term>True</term>
  4933. </item>
  4934. <item>
  4935. <term>property</term>
  4936. <term>string</term>
  4937. <term>The name of the property to store the directory information.</term>
  4938. <term>True</term>
  4939. </item>
  4940. </list>
  4941. <h3>Examples</h3>
  4942. <example>
  4943. <para>Convert the TARGETURL property to a directory and store that information in TARGETDIR</para>
  4944. <code>
  4945. &lt;urlproperties&gt;
  4946. &lt;urlproperty name="TARGETURL" property="TARGETDIR" /&gt;
  4947. &lt;/urlproperties&gt;
  4948. </code>
  4949. </example>
  4950. </summary>
  4951. </member>
  4952. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerVDirPropertiesElement">
  4953. <summary>
  4954. <para>
  4955. Creates a URLProperty representing the virtual directory and port.
  4956. </para>
  4957. <note>This not an officially Microsoft supported table.</note>
  4958. <h3>Parameters</h3>
  4959. <list type="table">
  4960. <listheader>
  4961. <term>Attribute</term>
  4962. <term>Type</term>
  4963. <term>Description</term>
  4964. <term>Required</term>
  4965. </listheader>
  4966. <item>
  4967. <term>name</term>
  4968. <term>string</term>
  4969. <term>Property containing the virtual directory</term>
  4970. <term>True</term>
  4971. </item>
  4972. <item>
  4973. <term>portproperty</term>
  4974. <term>string</term>
  4975. <term>Property containing the network port number to use.</term>
  4976. <term>True</term>
  4977. </item>
  4978. <item>
  4979. <term>urlproperty</term>
  4980. <term>string</term>
  4981. <term>URLProperty to store the url in</term>
  4982. <term>True</term>
  4983. </item>
  4984. </list>
  4985. <h3>Examples</h3>
  4986. <example>
  4987. <para>Convert the virtual directory and port to a url and store the value in a property.</para>
  4988. <code>
  4989. &lt;vdirproperties&gt;
  4990. &lt;vdirproperty name="TARGETVDIR" portproperty="TARGETPORT" urlproperty="TARGETURL" /&gt;
  4991. &lt;/vdirproperties&gt;
  4992. </code>
  4993. </example>
  4994. </summary>
  4995. </member>
  4996. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerAppRootsElement">
  4997. <summary>
  4998. <para>
  4999. Create a Web application definition and marks it as running in-process
  5000. or out-of-process. If an application already exists at the specified
  5001. path, you can use this method to reconfigure the application from
  5002. in-process to out-of-process, or the reverse.
  5003. </para>
  5004. <note>This not an officially Microsoft supported table.</note>
  5005. <h3>Parameters</h3>
  5006. <list type="table">
  5007. <listheader>
  5008. <term>Attribute</term>
  5009. <term>Type</term>
  5010. <term>Description</term>
  5011. <term>Required</term>
  5012. </listheader>
  5013. <item>
  5014. <term>component</term>
  5015. <term>string</term>
  5016. <term>Reference to a component. Determines when the approot will be created.</term>
  5017. <term>True</term>
  5018. </item>
  5019. <item>
  5020. <term>urlproperty</term>
  5021. <term>string</term>
  5022. <term>URLProperty with stored url</term>
  5023. <term>True</term>
  5024. </item>
  5025. <item>
  5026. <term>inprocflag</term>
  5027. <term>int</term>
  5028. <term>Specifies whether the application being created is to run in-process (0), out-of-process (1), or in a pooled process (2). If the application already exists and is running, changing the value of this flag will cause the application definition to be deleted and a new application created to run in the specified process space.</term>
  5029. <term>True</term>
  5030. </item>
  5031. </list>
  5032. <h3>Examples</h3>
  5033. <example>
  5034. <para>Convert the virtual directory and port to a url and store the value in a property.</para>
  5035. <code>
  5036. &lt;approots&gt;
  5037. &lt;approot component="C__MainFiles" urlproperty="TARGETURL" inprocflag="2" /&gt;
  5038. &lt;/approots&gt;
  5039. </code>
  5040. </example>
  5041. </summary>
  5042. </member>
  5043. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerIISPropertiesElement">
  5044. <summary>
  5045. <para>
  5046. Specifies directory security in IIS. Can also configure the default
  5047. documents supported by each directory.
  5048. </para>
  5049. <note>This not an officially Microsoft supported table.</note>
  5050. <h3>Parameters</h3>
  5051. <list type="table">
  5052. <listheader>
  5053. <term>Attribute</term>
  5054. <term>Type</term>
  5055. <term>Description</term>
  5056. <term>Required</term>
  5057. </listheader>
  5058. <item>
  5059. <term>directory</term>
  5060. <term>string</term>
  5061. <term>Reference to a directory. This is the directory that gets modified with the specific attributes.</term>
  5062. <term>True</term>
  5063. </item>
  5064. <item>
  5065. <term>attr</term>
  5066. <term>int</term>
  5067. <term>Attributes to set for the directory.
  5068. <list type="table">
  5069. <listheader>
  5070. <term>Value</term>
  5071. <term>Flag Name</term>
  5072. <description>Description</description>
  5073. </listheader>
  5074. <item>
  5075. <term>1</term>
  5076. <term>AccessRead</term>
  5077. <description>The file or the contents of the folder may be read through Microsoft Internet Explorer.</description>
  5078. </item>
  5079. <item>
  5080. <term>2</term>
  5081. <term>AccessWrite</term>
  5082. <description>Users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a Write-enabled file. Write can be implemented only with a browser that supports the PUT feature of the HTTP 1.1 protocol standard.</description>
  5083. </item>
  5084. <item>
  5085. <term>4</term>
  5086. <term>AccessExecute</term>
  5087. <description>The file or the contents of the folder may be executed, regardless of file type.</description>
  5088. </item>
  5089. <item>
  5090. <term>8</term>
  5091. <term>AccessSSL</term>
  5092. <description>File access requires SSL file permission processing, with or without a client certificate.</description>
  5093. </item>
  5094. <item>
  5095. <term>16</term>
  5096. <term>AccessSource</term>
  5097. <description>Users are allowed to access source code if either Read or Write permissions are set. Source code includes scripts in Microsoft ® Active Server Pages (ASP) applications.</description>
  5098. </item>
  5099. <item>
  5100. <term>32</term>
  5101. <term>AccessSSLNegotiateCert</term>
  5102. <description>SSL file access processing requests a certificate from the client. A value of false indicates that access continues if the client does not have a certificate. Some versions of Internet Explorer will close the connection if the server requests a certificate and a certificate is not available (even if AccessSSLRequireCert is also set to true).</description>
  5103. </item>
  5104. <item>
  5105. <term>64</term>
  5106. <term>AccessSSLRequireCert</term>
  5107. <description>SSL file access processing requests a certificate from the client. If the client provides no certificate, the connection is closed. AccessSSLNegotiateCert must also be set to true when using AccessSSLRequireCert.</description>
  5108. </item>
  5109. <item>
  5110. <term>128</term>
  5111. <term>AccessSSLMapCert</term>
  5112. <description>SSL file permission processing maps a client certificate to a Microsoft Windows ® operating system user-account. The AccessSSLNegotiateCert property must also be set to true for the mapping to occur.</description>
  5113. </item>
  5114. <item>
  5115. <term>256</term>
  5116. <term>AccessSSL128</term>
  5117. <description>File access requires SSL file permission processing with a minimum key size of 128 bits, with or without a client certificate.</description>
  5118. </item>
  5119. <item>
  5120. <term>512</term>
  5121. <term>AccessScript</term>
  5122. <description>The file or the contents of the folder may be executed if they are script files or static content. A value of false only allows static files, such as HTML files, to be served.</description>
  5123. </item>
  5124. <item>
  5125. <term>1024</term>
  5126. <term>AccessNoRemoteWrite</term>
  5127. <description>Remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests.</description>
  5128. </item>
  5129. <item>
  5130. <term>4096</term>
  5131. <term>AccessNoRemoteRead</term>
  5132. <description>Remote requests to view files are denied; only requests from the same computer as the IIS server succeed if the AccessRead property is set to true. You cannot set AccessNoRemoteRead to false to enable remote requests, and set AccessRead to false to disable local requests.</description>
  5133. </item>
  5134. <item>
  5135. <term>8192</term>
  5136. <term>AccessNoRemoteExecute</term>
  5137. <description>Remote requests to execute applications are denied; only requests from the same computer as the IIS server succeed if the AccessExecute property is set to true. You cannot set AccessNoRemoteExecute to false to enable remote requests, and set AccessExecute to false to disable local requests.</description>
  5138. </item>
  5139. <item>
  5140. <term>16384</term>
  5141. <term>AccessNoRemoteScript</term>
  5142. <description>Requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests.</description>
  5143. </item>
  5144. <item>
  5145. <term>32768</term>
  5146. <term>AccessNoPhysicalDir</term>
  5147. <description>Access to the physical path is not allowed.</description>
  5148. </item>
  5149. </list>
  5150. </term>
  5151. <term>True</term>
  5152. </item>
  5153. <item>
  5154. <term>defaultdoc</term>
  5155. <term>string</term>
  5156. <term>Adds a filename to the <a href="http://msdn.microsoft.com/library/en-us/iissdk/iis/ref_mb_defaultdoc.asp">Default Documents</a> to process. Add multiple separated with a comma (Eg. "Default.aspx,Default.htm")</term>
  5157. <term>False</term>
  5158. </item>
  5159. </list>
  5160. <h3>Examples</h3>
  5161. <example>
  5162. <para>Specify permissions for the directory structure.</para>
  5163. <code>
  5164. &lt;iisproperties&gt;
  5165. &lt;iisproperty directory="TARGETDIR" attr="626" defaultdoc="Default.aspx" /&gt;
  5166. &lt;iisproperty directory="D__BIN" attr="112" /&gt;
  5167. &lt;iisproperty directory="D__SomeSubDir" attr="114" /&gt;
  5168. &lt;/iisproperties&gt;
  5169. </code>
  5170. </example>
  5171. </summary>
  5172. </member>
  5173. <member name="T:NAnt.Contrib.Tasks.Msi.MsiCreationCommand">
  5174. <summary>
  5175. Summary description for MsiTaskInfo.
  5176. </summary>
  5177. </member>
  5178. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadBannerImage(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5179. <summary>
  5180. Loads the banner image.
  5181. </summary>
  5182. <param name="database">The MSI database.</param>
  5183. </member>
  5184. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadBackgroundImage(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5185. <summary>
  5186. Loads the background image.
  5187. </summary>
  5188. <param name="database">The MSI database.</param>
  5189. </member>
  5190. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadLicense(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5191. <summary>
  5192. Loads the license file.
  5193. </summary>
  5194. <param name="database">The MSI database.</param>
  5195. </member>
  5196. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadMedia(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32)">
  5197. <summary>
  5198. Loads records for the Media table.
  5199. </summary>
  5200. <param name="database">The MSI database.</param>
  5201. <param name="LastSequence">The sequence number of the last file in the .cab.</param>
  5202. </member>
  5203. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadFeatures(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5204. <summary>
  5205. Loads records for the Features table.
  5206. </summary>
  5207. <param name="database">The MSI database.</param>
  5208. </member>
  5209. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.AddFeature(NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Schemas.Msi.MSIFeature,System.Int32,System.Int32)">
  5210. <summary>
  5211. Adds a feature record to the Features table.
  5212. </summary>
  5213. <param name="featureTable">The MSI database Feature table.</param>
  5214. <param name="conditionTable">The MSI database Condition table.</param>
  5215. <param name="ParentFeature">The name of this feature's parent.</param>
  5216. <param name="database">The MSI database.</param>
  5217. <param name="Feature">This Feature's Schema element.</param>
  5218. <param name="Depth">The tree depth of this feature.</param>
  5219. <param name="Order">The tree order of this feature.</param>
  5220. </member>
  5221. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadLaunchCondition(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5222. <summary>
  5223. Loads records for the LaunchCondition table
  5224. </summary>
  5225. <param name="database">The MSI database.</param>
  5226. </member>
  5227. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadMergeModules(System.String,System.String)">
  5228. <summary>
  5229. Merges Merge Modules into the MSI Database.
  5230. </summary>
  5231. <param name="Database">The MSI Database.</param>
  5232. <param name="TempPath">The path to temporary files.</param>
  5233. </member>
  5234. <member name="T:NAnt.Contrib.Tasks.Msi.MsiTask">
  5235. <summary>
  5236. Creates a Windows Installer (also known as Microsoft Installer, or MSI) setup database for installing software on the Windows Platform.
  5237. </summary>
  5238. <remarks>
  5239. <para>
  5240. Requires <c>cabarc.exe</c> in the path. This tool is part of the
  5241. <see href="http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">Microsoft Cabinet SDK</see>.
  5242. </para>
  5243. <para>
  5244. Requires <c>mergemod.dll</c> version 2.0 or greater. This dll is part of the
  5245. <see href="http://www.microsoft.com/msdownload/platformsdk/instmsi.htm">Microsoft Platform SDK</see>.
  5246. </para>
  5247. <para>
  5248. See the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/roadmap_to_windows_installer_documentation.asp?frame=true" >Roadmap to Windows Installer Documentation</see>
  5249. at Microsoft's MSDN website for more information.
  5250. </para>
  5251. </remarks>
  5252. </member>
  5253. <member name="M:NAnt.Contrib.Tasks.Msi.MsiTask.InitializeTask(System.Xml.XmlNode)">
  5254. <summary>
  5255. Initializes task and verifies parameters.
  5256. </summary>
  5257. <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>
  5258. </member>
  5259. <member name="M:NAnt.Contrib.Tasks.Msi.MsiTask.ExecuteTask">
  5260. <summary>
  5261. Executes the task.
  5262. </summary>
  5263. </member>
  5264. <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiLicense">
  5265. <summary>
  5266. An .rtf (rich text format) file containing the license agreement
  5267. for your software. The contents of this file will be displayed to
  5268. the user when setup runs and must be accepted to continue.
  5269. </summary>
  5270. </member>
  5271. <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiBanner">
  5272. <summary>
  5273. A .bmp (bitmap) file 495x60 pixels in size that will be displayed
  5274. as the banner (top) image of the installation user interface.
  5275. </summary>
  5276. </member>
  5277. <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiBackground">
  5278. <summary>
  5279. A .bmp (bitmap) file 495x315 pixels in size that will be displayed
  5280. as the background image of the installation user interface.
  5281. </summary>
  5282. </member>
  5283. <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiFeaturesElement">
  5284. <summary>
  5285. <para>
  5286. Groups sets of components into named sets, these can be used to
  5287. layout the tree control that allows users to select and deselect
  5288. features of your software product when a custom installation is
  5289. selected at runtime.
  5290. </para>
  5291. <h3>Parameters</h3>
  5292. <list type="table">
  5293. <listheader>
  5294. <term>Attribute</term>
  5295. <term>Type</term>
  5296. <term>Description</term>
  5297. <term>Required</term>
  5298. </listheader>
  5299. <item>
  5300. <term>name</term>
  5301. <term>string</term>
  5302. <term>A name used to refer to the feature.</term>
  5303. <term>True</term>
  5304. </item>
  5305. <item>
  5306. <term>display</term>
  5307. <term>int</term>
  5308. <term>The number in this field specifies the order in which the feature is to be displayed in the user interface.
  5309. The value also determines if the feature is initially displayed expanded or collapsed.<br/>
  5310. If the value is null or zero, the record is not displayed. If the value is odd, the feature node is expanded initially.
  5311. If the value is even, the feature node is collapsed initially.
  5312. </term>
  5313. <term>True</term>
  5314. </item>
  5315. <item>
  5316. <term>title</term>
  5317. <term>string</term>
  5318. <term>Short string of text identifying the feature. This string is listed as an item by the SelectionTree control of the Selection Dialog.</term>
  5319. <term>False</term>
  5320. </item>
  5321. <item>
  5322. <term>typical</term>
  5323. <term>bool</term>
  5324. <term>Determines if the feature should be included in a "typical" install. This is useful for when the user selects to just install the typical features.</term>
  5325. <term>False</term>
  5326. </item>
  5327. <item>
  5328. <term>directory</term>
  5329. <term>string</term>
  5330. <term>Refrence to a directory. Specify a corresponding directory to go with the feature.</term>
  5331. <term>False</term>
  5332. </item>
  5333. <item>
  5334. <term>attr</term>
  5335. <term>int</term>
  5336. <term>Any combination of the following:
  5337. <list type="table">
  5338. <listheader>
  5339. <term>Value</term>
  5340. <description>Description</description>
  5341. </listheader>
  5342. <item>
  5343. <term>0</term>
  5344. <description>Components of this feature that are not marked for installation from source are installed locally.</description>
  5345. </item>
  5346. <item>
  5347. <term>1</term>
  5348. <description>Components of this feature not marked for local installation are installed to run from the source CD-ROM or server.</description>
  5349. </item>
  5350. <item>
  5351. <term>2</term>
  5352. <description>Set this attribute and the state of the feature is the same as the state of the feature's parent.</description>
  5353. </item>
  5354. <item>
  5355. <term>4</term>
  5356. <description>Set this attribute and the feature state is Advertise.</description>
  5357. </item>
  5358. <item>
  5359. <term>8</term>
  5360. <description>Note that this bit works only with features that are listed by the ADVERTISE property. <br/>Set this attribute to prevent the feature from being advertised.</description>
  5361. </item>
  5362. <item>
  5363. <term>16</term>
  5364. <description>Set this attribute and the user interface does not display an option to change the feature state to Absent. Setting this attribute forces the feature to the installation state, whether or not the feature is visible in the UI.</description>
  5365. </item>
  5366. <item>
  5367. <term>32</term>
  5368. <description>Set this attribute and advertising is disabled for the feature if the operating system shell does not support Windows Installer descriptors.</description>
  5369. </item>
  5370. </list>
  5371. More information found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp</a>
  5372. </term>
  5373. <term>False</term>
  5374. </item>
  5375. </list>
  5376. <h3>Nested Elements:</h3>
  5377. <h4>&lt;feature&gt;</h4>
  5378. <ul>
  5379. Nested feature elements are supported.
  5380. </ul>
  5381. <h4>&lt;/feature&gt;</h4>
  5382. <h4>&lt;description&gt;</h4>
  5383. <ul>
  5384. Longer string of text describing the feature. This localizable string is displayed by the Text control of the Selection Dialog.
  5385. </ul>
  5386. <h4>&lt;/description&gt;</h4>
  5387. <h4>&lt;conditions&gt;</h4>
  5388. <ul>
  5389. <h4>&lt;condition&gt;</h4>
  5390. <ul>
  5391. <list type="table">
  5392. <listheader>
  5393. <term>Attribute</term>
  5394. <term>Type</term>
  5395. <term>Description</term>
  5396. <term>Required</term>
  5397. </listheader>
  5398. <item>
  5399. <term>expression</term>
  5400. <term>string</term>
  5401. <term>If this conditional expression evaluates to TRUE, then the Level column in the Feature table is set to the
  5402. conditional install level. <br/>
  5403. The expression in the Condition column should not contain reference to the installed state of any feature or component.
  5404. This is because the expressions in the Condition column are evaluated before the installer evaluates the installed
  5405. states of features and components. Any expression in the Condition table that attempts to check the installed state
  5406. of a feature or component always evaluates to false.<br/>
  5407. For information on the syntax of conditional statements, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/conditional_statement_syntax.asp">Conditional Statement Syntax</a>.
  5408. </term>
  5409. <term>True</term>
  5410. </item>
  5411. <item>
  5412. <term>level</term>
  5413. <term>int</term>
  5414. <term>The installer sets the install level of this feature to the level specified in this column if the expression in
  5415. the Condition column evaluates to TRUE. Set this value to 0 to have the component not install if the condition is not met.<br/>
  5416. For any installation, there is a defined install level, which is an integral value from 1 to 32,767. The initial value
  5417. is determined by the InstallLevel property, which is set in the Property table.<br/>
  5418. A feature is installed only if the feature level value is less than or equal to the current install level. The user
  5419. interface can be authored such that once the installation is initialized, the installer allows the user to modify the
  5420. install level of any feature in the Feature table. For example, an author can define install level values that represent
  5421. specific installation options, such as Complete, Typical, or Minimum, and then create a dialog box that uses
  5422. SetInstallLevel ControlEvents to enable the user to select one of these states. Depending on the state the user selects,
  5423. the dialog box sets the install level property to the corresponding value. If the author assigns Typical a level of 100
  5424. and the user selects Typical, only those features with a level of 100 or less are installed. In addition, the Custom
  5425. option could lead to another dialog box containing a Selection Tree control. The Selection Tree would then allow the user
  5426. to individually change whether each feature is installed.</term>
  5427. <term>True</term>
  5428. </item>
  5429. </list>
  5430. </ul>
  5431. <h4>&lt;/condition&gt;</h4>
  5432. </ul>
  5433. <h4>&lt;/conditions&gt;</h4>
  5434. <h3>Examples</h3>
  5435. <example>
  5436. <para>Define a sample features structure.</para>
  5437. <code>
  5438. &lt;features&gt;
  5439. &lt;feature name="F__Default" title="My Product" display="1" typical="true" directory="TARGETDIR"&gt;
  5440. &lt;description&gt;My Product from ACME, Inc. &lt;/description&gt;
  5441. &lt;feature name="F__MainFiles" display="0" typical="true" /&gt;
  5442. &lt;/feature&gt;
  5443. &lt;feature name="F__Help" title="My Product Help Files" display="1" typical="false" directory="D__ACME_MyProduct_Help" /&gt;
  5444. &lt;/features&gt;
  5445. </code>
  5446. </example>
  5447. </summary>
  5448. </member>
  5449. <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiMergeModulesElement">
  5450. <summary>
  5451. <para>
  5452. Includes pre-packaged installation components (.msm files) as part
  5453. of the msi database. This feature allows reuse of installation
  5454. components that use MSI technology from other setup vendors or as
  5455. created by the <see cref="T:NAnt.Contrib.Tasks.Msi.MsmTask"/>.
  5456. </para>
  5457. <h3>Parameters</h3>
  5458. <list type="table">
  5459. <listheader>
  5460. <term>Attribute</term>
  5461. <term>Type</term>
  5462. <term>Description</term>
  5463. <term>Required</term>
  5464. </listheader>
  5465. <item>
  5466. <term>feature</term>
  5467. <term>string</term>
  5468. <term>Refrence to a feature. Used to associate the merge module with the feature (and the feature's directory) for when to install the components in the merge module.</term>
  5469. <term>True</term>
  5470. </item>
  5471. </list>
  5472. <h3>Nested Elements:</h3>
  5473. <h4>&lt;modules&gt;</h4>
  5474. <ul>
  5475. Specifies the merge module(s) to include with the specified feature.
  5476. </ul>
  5477. <h4>&lt;/modules&gt;</h4>
  5478. <h4>&lt;configurationitems&gt;</h4>
  5479. <ul>
  5480. <h4>&lt;configurationitem&gt;</h4>
  5481. <ul>
  5482. Specifies the value for a configurable item
  5483. <h3>Parameters</h3>
  5484. <list type="table">
  5485. <listheader>
  5486. <term>Attribute</term>
  5487. <term>Type</term>
  5488. <term>Description</term>
  5489. <term>Required</term>
  5490. </listheader>
  5491. <item>
  5492. <term>module</term>
  5493. <term>string</term>
  5494. <term>Merge module filename to limit the configuration item to. If this is not set, the configuration item will be applied to all merge modules in the fileset.</term>
  5495. <term>True</term>
  5496. </item>
  5497. <item>
  5498. <term>name</term>
  5499. <term>string</term>
  5500. <term>Name of item for which data is to be set</term>
  5501. <term>True</term>
  5502. </item>
  5503. <item>
  5504. <term>value</term>
  5505. <term>string</term>
  5506. <term>Value of the configurable item</term>
  5507. <term>True</term>
  5508. </item>
  5509. </list>
  5510. </ul>
  5511. <h4>&lt;/configurationitem&gt;</h4>
  5512. </ul>
  5513. <h4>&lt;/configurationitems&gt;</h4>
  5514. <h3>Examples</h3>
  5515. <example>
  5516. <para>Add the NAnt merge module to the install.</para>
  5517. <code>
  5518. &lt;mergemodules&gt;
  5519. &lt;merge feature="F__NAntMSM"&gt;
  5520. &lt;modules&gt;
  5521. &lt;include name="${nant.dir}\Install\NAnt.msm" /&gt;
  5522. &lt;/modules&gt;
  5523. &lt;/merge&gt;
  5524. &lt;/mergemodules&gt;
  5525. </code>
  5526. </example>
  5527. <example>
  5528. <para>Add a Visual Studio .wid package (merge module) and specify some configurable items.</para>
  5529. <code>
  5530. &lt;mergemodules&gt;
  5531. &lt;merge feature="F__DefaultFeature"&gt;
  5532. &lt;modules&gt;
  5533. &lt;include name="VsdReadmeDlg.wid" /&gt;
  5534. &lt;/modules&gt;
  5535. &lt;configurationitems&gt;
  5536. &lt;configurationitem name="BannerBitmap" value="CONFIGURED_BANNERBITMAP" /&gt;
  5537. &lt;configurationitem module="VsdReadmeDlg.wid" name="ReadmeText" value="CONFIGURED_READMETEXT" /&gt;
  5538. &lt;/configurationitems&gt;
  5539. &lt;/merge&gt;
  5540. &lt;/mergemodules&gt;
  5541. </code>
  5542. </example>
  5543. </summary>
  5544. </member>
  5545. <member name="T:NAnt.Contrib.Tasks.Msi.MsmCreationCommand">
  5546. <summary>
  5547. Summary description for MsmTaskInfo.
  5548. </summary>
  5549. </member>
  5550. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSignature(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5551. <summary>
  5552. Loads records for the ModuleSignature table.
  5553. </summary>
  5554. <param name="database">The MSM database.</param>
  5555. </member>
  5556. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleDependency(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5557. <summary>
  5558. Loads records for the ModuleDependency table.
  5559. </summary>
  5560. <param name="database">The MSM database.</param>
  5561. </member>
  5562. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleExclusion(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5563. <summary>
  5564. Loads records for the ModuleExclusion table.
  5565. </summary>
  5566. <param name="database">The MSM database.</param>
  5567. </member>
  5568. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSequence(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5569. <summary>
  5570. Loads records for the ModuleInstallUISequence, ModuleInstallExecuteSequence,
  5571. ModuleAdminUISequence, ModuleAdminExecute, and ModuleAdvtExecuteSequence tables.
  5572. </summary>
  5573. <param name="database">The MSM database.</param>
  5574. </member>
  5575. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleIgnoreTable(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5576. <summary>
  5577. Loads records for the ModuleIgnoreTable table.
  5578. </summary>
  5579. <param name="database">The MSM database.</param>
  5580. </member>
  5581. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSubstitution(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5582. <summary>
  5583. Loads records for the ModuleSubstitution table.
  5584. </summary>
  5585. <param name="database">The MSM database.</param>
  5586. </member>
  5587. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleConfiguration(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5588. <summary>
  5589. Loads records for the ModuleConfiguration table.
  5590. </summary>
  5591. <param name="database">The MSM database.</param>
  5592. </member>
  5593. <member name="T:NAnt.Contrib.Tasks.Msi.MsmTask">
  5594. <summary>
  5595. Builds a Windows Installer Merge Module (MSM) database.
  5596. </summary>
  5597. <para>
  5598. Requires <c>cabarc.exe</c> in the path. This tool is part of the
  5599. <see href="http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">Microsoft Cabinet SDK</see>.
  5600. </para>
  5601. </member>
  5602. <member name="M:NAnt.Contrib.Tasks.Msi.MsmTask.InitializeTask(System.Xml.XmlNode)">
  5603. <summary>
  5604. Initializes task and verifies parameters.
  5605. </summary>
  5606. <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>
  5607. </member>
  5608. <member name="M:NAnt.Contrib.Tasks.Msi.MsmTask.ExecuteTask">
  5609. <summary>
  5610. Executes the task.
  5611. </summary>
  5612. </member>
  5613. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmId">
  5614. <summary>
  5615. Stores a unique identifier for a merge module. To be used as the merge module's ModuleSignature
  5616. </summary>
  5617. </member>
  5618. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmLanguage">
  5619. <summary>
  5620. Specifies the numeric language ID or IDs for a merge module.
  5621. </summary>
  5622. </member>
  5623. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmVersion">
  5624. <summary>
  5625. Stores the version number of a merge module.
  5626. </summary>
  5627. </member>
  5628. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleDependenciesElement">
  5629. <summary>
  5630. <para>
  5631. Lists other merge modules that are required for this merge module
  5632. to operate properly.
  5633. </para>
  5634. <para>
  5635. Contains any number of dependency elements.
  5636. </para>
  5637. <para>
  5638. More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduledependency_table.asp">here</see>.
  5639. </para>
  5640. <h3>Parameters</h3>
  5641. <list type="table">
  5642. <listheader>
  5643. <term>Attribute</term>
  5644. <term>Type</term>
  5645. <term>Description</term>
  5646. <term>Required</term>
  5647. </listheader>
  5648. <item>
  5649. <term>id</term>
  5650. <term>string</term>
  5651. <term>Identifier of the merge module required</term>
  5652. <term>True</term>
  5653. </item>
  5654. <item>
  5655. <term>language</term>
  5656. <term>string</term>
  5657. <term>Numeric language ID of the dependent merge module. Can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. If the field contains a group language ID, any merge module with having a language code in that group satisfies the dependency. If the RequiredLanguage is set to 0, any merge module filling the other requirements satisfies the dependency.</term>
  5658. <term>True</term>
  5659. </item>
  5660. <item>
  5661. <term>version</term>
  5662. <term>string</term>
  5663. <term>Version of the dependent merge module. If ommited, any version fills the dependency.</term>
  5664. <term>False</term>
  5665. </item>
  5666. </list>
  5667. <h3>Examples</h3>
  5668. <example>
  5669. <para>Make sure that the NAnt merge module is included</para>
  5670. <code>
  5671. &lt;moduledependencies&gt;
  5672. &lt;dependency id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" /&gt;
  5673. &lt;/moduledependencies&gt;
  5674. </code>
  5675. </example>
  5676. </summary>
  5677. </member>
  5678. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleExclusionsElement">
  5679. <summary>
  5680. <para>
  5681. Lists other merge modules that are incompatible in the same
  5682. installer database.
  5683. </para>
  5684. <para>
  5685. Contains any number of exclusion elements.
  5686. </para>
  5687. <para>
  5688. More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleexclusion_table.asp">here</see>.
  5689. </para>
  5690. <h3>Parameters</h3>
  5691. <list type="table">
  5692. <listheader>
  5693. <term>Attribute</term>
  5694. <term>Type</term>
  5695. <term>Description</term>
  5696. <term>Required</term>
  5697. </listheader>
  5698. <item>
  5699. <term>id</term>
  5700. <term>string</term>
  5701. <term>Identifier of the merge module required</term>
  5702. <term>True</term>
  5703. </item>
  5704. <item>
  5705. <term>language</term>
  5706. <term>string</term>
  5707. <term>Numeric language ID of the merge module in ExcludedID. The ExcludedLanguage column can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. The ExcludedLanguage column can accept negative language IDs. The meaning of the value in the ExcludedLanguage column is as follows.
  5708. <list type="table">
  5709. <listheader>
  5710. <term>ExcludedLanguage</term>
  5711. <description>Description</description>
  5712. </listheader>
  5713. <item>
  5714. <term>&gt; 0</term>
  5715. <description>Exclude the language IDs specified by ExcludedLanguage.</description>
  5716. </item>
  5717. <item>
  5718. <term>= 0</term>
  5719. <description>Exclude no language IDs.</description>
  5720. </item>
  5721. <item>
  5722. <term>&lt; 0</term>
  5723. <description>Exclude all language IDs except those specified by ExcludedLanguage.</description>
  5724. </item>
  5725. </list>
  5726. </term>
  5727. <term>True</term>
  5728. </item>
  5729. <item>
  5730. <term>minversion</term>
  5731. <term>string</term>
  5732. <term>Minimum version excluded from a range. If ommitted, all versions before maxversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version.</term>
  5733. <term>False</term>
  5734. </item>
  5735. <item>
  5736. <term>maxversion</term>
  5737. <term>string</term>
  5738. <term>Maximum version excluded from a range. If ommitted, all versions after minversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version.</term>
  5739. <term>False</term>
  5740. </item>
  5741. </list>
  5742. <h3>Examples</h3>
  5743. <example>
  5744. <para>Exclude the all NAnt merge modules created before version 0.85.0</para>
  5745. <code>
  5746. &lt;moduleexclusions&gt;
  5747. &lt;exclusion id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" maxversion="0.85.0" /&gt;
  5748. &lt;/moduleexclusions&gt;
  5749. </code>
  5750. </example>
  5751. </summary>
  5752. </member>
  5753. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleSequencesElement">
  5754. <summary>
  5755. <para>
  5756. Used to modify the sequence of tasks/events that execute during the
  5757. overall installation process.
  5758. </para>
  5759. <h3>Parameters</h3>
  5760. <list type="table">
  5761. <listheader>
  5762. <term>Attribute</term>
  5763. <term>Type</term>
  5764. <term>Description</term>
  5765. <term>Required</term>
  5766. </listheader>
  5767. <item>
  5768. <term>type</term>
  5769. <term>msi:MSISequenceTable</term>
  5770. <term>Valid inputs:
  5771. <list type="bullet">
  5772. <item><c>installexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleinstallexecutesequence_table.asp">ModuleInstallExecuteSequence Table</a>.</item>
  5773. <item><c>installui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleinstalluisequence_table.asp">ModuleInstallUISequence Table</a></item>
  5774. <item><c>adminexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadminexecutesequence_table.asp">ModuleAdminExecuteSequence Table</a></item>
  5775. <item><c>adminui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadminuisequence_table.asp">ModuleAdminUISequence Table</a></item>
  5776. <item><c>advtexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadvtuisequence_table.asp">ModuleAdvtUISequence Table</a></item>
  5777. </list>
  5778. </term>
  5779. <term>True</term>
  5780. </item>
  5781. <item>
  5782. <term>action</term>
  5783. <term>string</term>
  5784. <term>Action to insert into sequence. Refers to one of the installer standard actions, or an entry in the merge module's CustomAction table or Dialog table.<br/>If a standard action is used in the Action column of a merge module sequence table, the BaseAction and After attributes must be ommitted.</term>
  5785. <term>True</term>
  5786. </item>
  5787. <item>
  5788. <term>sequence</term>
  5789. <term>int</term>
  5790. <term>The sequence number of a standard action. If a custom action or dialog is entered into the Action column of this row, this attribute must be ommitted <br/>When using standard actions in merge module sequence tables, the value in the Sequence column should be the recommended action sequence number. If the sequence number in the merge module differs from that for the same action in the .msi file sequence table, the merge tool uses the sequence number from the .msi file. See the suggested sequences in Using a Sequence Table for the recommended sequence numbers of standard actions.</term>
  5791. <term>False</term>
  5792. </item>
  5793. <item>
  5794. <term>baseaction</term>
  5795. <term>string</term>
  5796. <term>Can contain a standard action, a custom action specified in the merge module's custom action table, or a dialog specified in the module's dialog table. Is a key into the Action column of this table. It cannot be a foreign key into another merge table or table in the .msi file. This means that every standard action, custom action, or dialog listed in the BaseAction column must also be listed in the Action column of another record in this table.</term>
  5797. <term>False</term>
  5798. </item>
  5799. <item>
  5800. <term>after</term>
  5801. <term>bool</term>
  5802. <term>Boolean for whether Action comes before or after BaseAction
  5803. <list type="table">
  5804. <listheader>
  5805. <term>Value</term>
  5806. <description>Description</description>
  5807. </listheader>
  5808. <item>
  5809. <term>True</term>
  5810. <description>Action to come after BaseAction</description>
  5811. </item>
  5812. <item>
  5813. <term>False</term>
  5814. <description>Action to come before BaseAction</description>
  5815. </item>
  5816. </list>
  5817. </term>
  5818. <term>False</term>
  5819. </item>
  5820. <item>
  5821. <term>condition</term>
  5822. <term>string</term>
  5823. <term>A conditional statement that indicates if the action is be executed.</term>
  5824. <term>False</term>
  5825. </item>
  5826. </list>
  5827. </summary>
  5828. </member>
  5829. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleIgnoreTablesElement">
  5830. <summary>
  5831. <para>
  5832. If a table in the merge module is listed in the ModuleIgnoreTable
  5833. table, it is not merged into the .msi file. If the table already
  5834. exists in the .msi file, it is not modified by the merge. The tables
  5835. in the ModuleIgnoreTable can therefore contain data that is unneeded
  5836. after the merge.
  5837. </para>
  5838. <para>
  5839. More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleignoretable_table.asp?frame=true">here</see>.
  5840. </para>
  5841. <h3>Parameters</h3>
  5842. <list type="table">
  5843. <listheader>
  5844. <term>Attribute</term>
  5845. <term>Type</term>
  5846. <term>Description</term>
  5847. <term>Required</term>
  5848. </listheader>
  5849. <item>
  5850. <term>table</term>
  5851. <term>string</term>
  5852. <term>Name of the table in the merge module that is not to be merged into the .msi file.</term>
  5853. <term>True</term>
  5854. </item>
  5855. </list>
  5856. <h3>Examples</h3>
  5857. <example>
  5858. <para>Ensure the module is compatible for users who have versions of Mergemod.dll earlier than 2.0</para>
  5859. <code>
  5860. &lt;moduleignoretables&gt;
  5861. &lt;table name="ModuleConfiguration" /&gt;
  5862. &lt;table name="ModuleSubstitution" /&gt;
  5863. &lt;table name="_ModuleConfigurationGroup" /&gt;
  5864. &lt;/moduleignoretables&gt;
  5865. </code>
  5866. </example>
  5867. </summary>
  5868. </member>
  5869. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleSubstitutionsElement">
  5870. <summary>
  5871. <para>
  5872. The ModuleSubstitution table specifies the configurable fields of a
  5873. module database and provides a template for the configuration of each
  5874. field. The user or merge tool may query this table to determine what
  5875. configuration operations are to take place. This table is not merged
  5876. into the target database.
  5877. </para>
  5878. <para>
  5879. More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/modulesubstitution_table.asp">here</see>.
  5880. </para>
  5881. <h3>Parameters</h3>
  5882. <list type="table">
  5883. <listheader>
  5884. <term>Attribute</term>
  5885. <term>Type</term>
  5886. <term>Description</term>
  5887. <term>Required</term>
  5888. </listheader>
  5889. <item>
  5890. <term>table</term>
  5891. <term>string</term>
  5892. <term>Name of the table being modified in the module database.</term>
  5893. <term>True</term>
  5894. </item>
  5895. <item>
  5896. <term>row</term>
  5897. <term>string</term>
  5898. <term>Specifies the primary keys of the target row in the table named in the Table column. Multiple primary keys are separated by semicolons. Target rows are selected for modification before any changes are made to the target table. If one record in the ModuleSubstitution table changes the primary key field of a target row, other records in the ModuleSubstitution table are applied based on the original primary key data, not the resulting of primary key substitutions. The order of row substitution is undefined.<br/>Values in this column are always in CMSM special format. A literal semicolon (';') or equal sign ('=') can be added by prefixing the character with a backslash. '\'. A null value for a key is signified by a null, a leading semicolon, two consecutive semicolons, or a trailing semicolon, depending on whether the null value is a sole, first, middle, or final key column value.</term>
  5899. <term>True</term>
  5900. </item>
  5901. <item>
  5902. <term>column</term>
  5903. <term>string</term>
  5904. <term>Specifies the target column in the row named in the Row column. If multiple rows in the ModuleSubstitution table change different columns of the same target row, all the column substitutions are performed before the modified row is inserted into the database. The order of column substitution is undefined.</term>
  5905. <term>True</term>
  5906. </item>
  5907. <item>
  5908. <term>value</term>
  5909. <term>string</term>
  5910. <term>Contains a string that provides a formatting template for the data being substituted into the target field specified by Table, Row, and Column. When a substitution string of the form [=ItemA] is encountered, the string, including the bracket characters, is replaced by the value for the configurable "ItemA." The configurable item "ItemA" is specified in the Name column of the ModuleConfiguration table and its value is provided by the merge tool. If the merge tool declines to provide a value for any item in a replacement string, the default value specified in the DefaultValue column of the ModuleConfiguration Table is substituted. If a string references an item not in the ModuleConfiguration table, the merge fails.
  5911. <list type="bullet">
  5912. <item>
  5913. This column uses CMSM special format. A literal semicolon (';') or equals sign ('=') can be added to the table by prefixing the character with a backslash. '\'.
  5914. </item>
  5915. <item>
  5916. The Value field may contain multiple substitution strings. For example, the configuration of items "Food1" and "Food2" in the string: "[=Food1] is good, but [=Food2] is better because [=Food2] is more nutritious."
  5917. </item>
  5918. <item>
  5919. Replacement strings must not be nested. The template "[=AB[=CDE]]" is invalid.
  5920. </item>
  5921. <item>
  5922. If the Value field evaluates to null, and the target field is not nullable, the merge fails and an error object of type msmErrorBadNullSubstitution is created and added to the error list. For details, see the error types described in get_Type Function.
  5923. </item>
  5924. <item>
  5925. If the Value field evaluates to the null GUID: {00000000-0000-0000-0000-000000000000}, the null GUID is replaced by the name of the feature before the row is merged into the module. For details, see Referencing Features in Merge Modules.
  5926. </item>
  5927. <item>
  5928. The template in the Value field is evaluated before being inserted into the target field. Substitution into a row is done before replacing any features.
  5929. </item>
  5930. <item>
  5931. If the Value column evaluates to a string of only integer characters (with an optional + or -), the string is converted into an integer before being substituted into an target field of the Integer Format Type. If the template evaluates to a string that does not consist only of integer characters (and an optional + or -) the result cannot be substituted into an integer target field. Attempting to insert a non-integer into an integer field causes the merge to fail and adds a msmErrorBadSubstitutionType error object to the error list.
  5932. </item>
  5933. <item>
  5934. If the target column specified in the Table and Column fields is a Text Format Type, and evaluation of the Value field results in an Integer Format Type, a decimal representation of the number is inserted into the target text field.
  5935. </item>
  5936. <item>
  5937. If the target field is an Integer Format Type, and the Value field consists of a non-delimited list of items in Bitfield Format, the value in the target field is combined using the bitwise AND operator with the inverse of the bitwise OR of all of the mask values from the items, then combined using the bitwise OR operator with each of the integer or bitfield items when masked by their corresponding mask values. Essentially, this explicitly sets the bits from the properties to the provided values but leaves all other bits in the cell alone.
  5938. </item>
  5939. <item>
  5940. If the Value field evaluates to a Key Format Type, and is a key into a table that uses multiple primary keys, the item name may be followed by a semicolon and an integer value that indicates the 1-based index into the set of values that together make a primary key. If no integer is specified, the value 1 is used. For example, the Control table has two primary key columns, Dialog_ and Control. The value of an item "Item1" that is a key into the Control table will be of the form "DialogName;ControlName", where DialogName is the value in the Dialog_ table and ControlName is the value in the Control column. To substitute just ControlName, the substitution string [=Item1;2] should be used.
  5941. </item>
  5942. </list>
  5943. </term>
  5944. <term>False</term>
  5945. </item>
  5946. </list>
  5947. </summary>
  5948. </member>
  5949. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleConfigurationsElement">
  5950. <summary>
  5951. <para>
  5952. Identifies the configurable attributes of the module. This table is
  5953. not merged into the database.
  5954. </para>
  5955. <para>
  5956. More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleconfiguration_table.asp">here</see>.
  5957. </para>
  5958. <h3>Parameters</h3>
  5959. <list type="table">
  5960. <listheader>
  5961. <term>Attribute</term>
  5962. <term>Type</term>
  5963. <term>Description</term>
  5964. <term>Required</term>
  5965. </listheader>
  5966. <item>
  5967. <term>name</term>
  5968. <term>string</term>
  5969. <term>Name of the configurable item. This name is referenced in the formatting template in the Value column of the ModuleSubstitution table.</term>
  5970. <term>True</term>
  5971. </item>
  5972. <item>
  5973. <term>format</term>
  5974. <term>msi:MSMModuleConfigurationFormat</term>
  5975. <term>Specifies the format of the data being changed
  5976. <list type="bullet">
  5977. <item>text</item>
  5978. <item>key</item>
  5979. <item>integer</item>
  5980. <item>bitfield</item>
  5981. </list>
  5982. </term>
  5983. <term>True</term>
  5984. </item>
  5985. <item>
  5986. <term>type</term>
  5987. <term>string</term>
  5988. <term>Specifies the type for the data being changed. This type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this depend on the value in the Format attribute.</term>
  5989. <term>False</term>
  5990. </item>
  5991. <item>
  5992. <term>contextdata</term>
  5993. <term>string</term>
  5994. <term>Specifies a semantic context for the requested data. The type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this column depend on the values in the Format and Type attributes.</term>
  5995. <term>False</term>
  5996. </item>
  5997. <item>
  5998. <term>defaultvalue</term>
  5999. <term>string</term>
  6000. <term>Specifies a default value for the item in this record if the merge tool declines to provide a value. This value must have the format, type, and context of the item. If this is a "Key" format item, the foreign key must be a valid key into the tables of the module. Null may be a valid value for this column depending on the item. For "Key" format items, this value is in CMSM special format. For all other types, the value is treated literally.<br/>Module authors must ensure that the module is valid in its default state. This ensures that versions of Mergemod.dll earlier than version 2.0 can still use the module in its default state.</term>
  6001. <term>False</term>
  6002. </item>
  6003. <item>
  6004. <term>attr</term>
  6005. <term>int</term>
  6006. <term>Bit field containing attributes for this configurable item. Null is equivalent to 0.
  6007. <list type="table">
  6008. <listheader>
  6009. <term>Value</term>
  6010. <description>Description</description>
  6011. </listheader>
  6012. <item>
  6013. <term>1</term>
  6014. <description>This attribute only applies to records that list a foreign key to a module table in their DefaultValue field.</description>
  6015. </item>
  6016. <item>
  6017. <term>2</term>
  6018. <description>When this attribute is set, null is not a valid response for this item. This attribute has no effect for Integer Format Types or Bitfield Format Types.</description>
  6019. </item>
  6020. </list>
  6021. </term>
  6022. <term>False</term>
  6023. </item>
  6024. <item>
  6025. <term>displayname</term>
  6026. <term>string</term>
  6027. <term>Provides a short description of this item that the authoring tool may use in the user interface. This column may not be localized. Set this column to null to have the module is request that the authoring tool not expose this property in the UI.</term>
  6028. <term>False</term>
  6029. </item>
  6030. <item>
  6031. <term>description</term>
  6032. <term>string</term>
  6033. <term>Provides a description of this item that the authoring tool may use in UI elements. This string may be localized by the module's language transform.</term>
  6034. <term>False</term>
  6035. </item>
  6036. <item>
  6037. <term>helplocation</term>
  6038. <term>string</term>
  6039. <term>Provides either the name of a help file (without the .chm extension) or a semicolon delimited list of help namespaces. This can be ommitted if no help is available.</term>
  6040. <term>False</term>
  6041. </item>
  6042. <item>
  6043. <term>helpkeyword</term>
  6044. <term>string</term>
  6045. <term>Provides a keyword into the help file or namespace from the HelpLocation column. The interpretation of this keyword depends on the HelpLocation attribute.</term>
  6046. <term>False</term>
  6047. </item>
  6048. </list>
  6049. </summary>
  6050. </member>
  6051. <member name="T:NAnt.Contrib.Tasks.Msi.TypeLibRecord">
  6052. <summary>
  6053. Maintains a forward reference to a .tlb file
  6054. in the same directory as an assembly .dll
  6055. that has been registered for COM interop.
  6056. </summary>
  6057. </member>
  6058. <member name="M:NAnt.Contrib.Tasks.Msi.TypeLibRecord.#ctor(System.String,System.String,System.Reflection.AssemblyName,System.String,System.String)">
  6059. <summary>
  6060. Creates a new <see cref="T:NAnt.Contrib.Tasks.Msi.TypeLibRecord"/>.
  6061. </summary>
  6062. <param name="LibId">The typelibrary id.</param>
  6063. <param name="TypeLibFileName">The typelibrary filename.</param>
  6064. <param name="AssemblyName">The name of the assembly.</param>
  6065. <param name="FeatureName">The feature containing the typelibrary's file.</param>
  6066. <param name="AssemblyComponent">The name of the Assembly's component.</param>
  6067. </member>
  6068. <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.AssemblyComponent">
  6069. <summary>
  6070. Retrieves the name of the Assembly's component.
  6071. </summary>
  6072. <value>The Assembly's component Name.</value>
  6073. </member>
  6074. <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.TypeLibFileName">
  6075. <summary>
  6076. Retrieves the typelibrary filename.
  6077. </summary>
  6078. <value>The typelibrary filename.</value>
  6079. </member>
  6080. <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.LibId">
  6081. <summary>
  6082. Retrieves the typelibrary id.
  6083. </summary>
  6084. <value>The typelibrary id.</value>
  6085. </member>
  6086. <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.AssemblyName">
  6087. <summary>
  6088. Retrieves the name of the assembly.
  6089. </summary>
  6090. <value>The name of the assembly.</value>
  6091. </member>
  6092. <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.FeatureName">
  6093. <summary>
  6094. Retrieves the feature containing the typelibrary's file.
  6095. </summary>
  6096. <value>The feature containing the typelibrary's file.</value>
  6097. </member>
  6098. <member name="T:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask">
  6099. <summary>
  6100. A task that generates a summary HTML
  6101. from a set of NUnit xml report files.
  6102. </summary>
  6103. <remarks>
  6104. <para>
  6105. This task can generate a combined HTML report out of a set of NUnit
  6106. result files generated using the XML Result Formatter.
  6107. </para>
  6108. <para>
  6109. All the properties defined in the current project will be passed
  6110. down to the XSLT file as template parameters, so you can access
  6111. properties such as nant.project.name, nant.version, etc.
  6112. </para>
  6113. </remarks>
  6114. <example>
  6115. <code>
  6116. <![CDATA[
  6117. <nunit2report todir="${outputdir}">
  6118. <fileset>
  6119. <includes name="${outputdir}\results.xml" />
  6120. </fileset>
  6121. </nunit2report>
  6122. ]]>
  6123. </code>
  6124. </example>
  6125. </member>
  6126. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.InitializeTask(System.Xml.XmlNode)">
  6127. <summary>
  6128. Initializes task and ensures the supplied attributes are valid.
  6129. </summary>
  6130. <param name="taskNode">Xml node used to define this task instance.</param>
  6131. </member>
  6132. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.ExecuteTask">
  6133. <summary>
  6134. This is where the work is done
  6135. </summary>
  6136. </member>
  6137. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LoadStyleSheet(System.String)">
  6138. <summary>
  6139. Load a stylesheet from the assemblies resource stream.
  6140. </summary>
  6141. <param name="xslFileName">File name of the file to extract.</param>
  6142. </member>
  6143. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LoadStyleSheet(System.IO.FileInfo)">
  6144. <summary>
  6145. Load a stylesheet from the file system.
  6146. </summary>
  6147. <param name="xslFile">The XSLT file to load.</param>
  6148. </member>
  6149. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.CreateSummaryXmlDoc">
  6150. <summary>
  6151. Initializes the XmlDocument instance
  6152. used to summarize the test results
  6153. </summary>
  6154. <returns></returns>
  6155. </member>
  6156. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.GetPropertyList">
  6157. <summary>
  6158. Builds an XsltArgumentList with all
  6159. the properties defined in the
  6160. current project as XSLT parameters.
  6161. </summary>
  6162. <returns></returns>
  6163. </member>
  6164. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Write(System.IO.StringReader,System.String)">
  6165. <summary>
  6166. Run the transform and output to filename
  6167. </summary>
  6168. <param name="stream"></param>
  6169. <param name="fileName"></param>
  6170. </member>
  6171. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Format">
  6172. <summary>
  6173. The format of the generated report. The default is
  6174. <see cref="F:NAnt.Contrib.Types.NUnit2Report.ReportFormat.NoFrames"/>.
  6175. </summary>
  6176. </member>
  6177. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Language">
  6178. <summary>
  6179. The output language.
  6180. </summary>
  6181. </member>
  6182. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.OpenDescription">
  6183. <summary>
  6184. Open all description method. Default to "false".
  6185. </summary>
  6186. </member>
  6187. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.ToDir">
  6188. <summary>
  6189. The directory where the files resulting from the transformation
  6190. should be written to. The default is the project's base directory.
  6191. </summary>
  6192. </member>
  6193. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.XmlFileSet">
  6194. <summary>
  6195. Set of XML files to use as input
  6196. </summary>
  6197. </member>
  6198. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.XmlSummaries">
  6199. <summary>
  6200. Set of summary XML files to use as input.
  6201. </summary>
  6202. </member>
  6203. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.XslFile">
  6204. <summary>
  6205. XSLT file used to generate the report if <see cref="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Format"/> is
  6206. <see cref="F:NAnt.Contrib.Types.NUnit2Report.ReportFormat.NoFrames"/>.
  6207. </summary>
  6208. </member>
  6209. <member name="T:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LocalResXmlResolver">
  6210. <summary>
  6211. Custom XmlResolver used to load the
  6212. XSLT files out of this assembly resources.
  6213. </summary>
  6214. </member>
  6215. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LocalResXmlResolver.GetEntity(System.Uri,System.String,System.Type)">
  6216. <summary>
  6217. Loads the specified file from our internal resources if its there
  6218. </summary>
  6219. <param name="absoluteUri"></param>
  6220. <param name="role"></param>
  6221. <param name="objToReturn"></param>
  6222. <returns></returns>
  6223. </member>
  6224. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask">
  6225. <summary>
  6226. Adds files to a PVCS repository.
  6227. </summary>
  6228. <remarks>
  6229. <para>
  6230. This task uses the <c>addfiles</c> PCLI command to add files to a PVCS repository.
  6231. </para>
  6232. </remarks>
  6233. <example>
  6234. <para>
  6235. Adds <c>File1.txt</c> and <c>File2.txt</c> to the root level of the
  6236. project database specified by the <c>project-database</c> property.
  6237. </para>
  6238. <code>
  6239. <![CDATA[
  6240. <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control.">
  6241. <entities>
  6242. <entity name="C:\Data\File1.txt"/>
  6243. <entity name="C:\Data\Folder\File2.txt"/>
  6244. </entities>
  6245. </pvcsaddfiles>
  6246. ]]>
  6247. </code>
  6248. </example>
  6249. <example>
  6250. <para>
  6251. Adds <c>File1.txt</c> and <c>File2.txt</c> to the <c>folder</c> project
  6252. of the project database specified by the <c>project-database</c>
  6253. property.
  6254. </para>
  6255. <code>
  6256. <![CDATA[
  6257. <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control." projectpath="/folder">
  6258. <entities>
  6259. <entity name="C:\Data\File1.txt"/>
  6260. <entity name="C:\Data\Folder\File2.txt"/>
  6261. </entities>
  6262. </pvcsaddfiles>
  6263. ]]>
  6264. </code>
  6265. </example>
  6266. <example>
  6267. <para>
  6268. Adds <c>another_file.txt</c> and all files and folders at and below
  6269. <c>C:\Data</c> to the project database specified by the <c>project-database</c>
  6270. property.
  6271. </para>
  6272. <code>
  6273. <![CDATA[
  6274. <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control." includesubprojects="true">
  6275. <entities>
  6276. <entity name="C:\Data\"/>
  6277. <entity name="C:\Temp\another_file.txt"/>
  6278. </entities>
  6279. </pvcsaddfiles>
  6280. ]]>
  6281. </code>
  6282. </example>
  6283. <example>
  6284. <para>
  6285. Adds all files at and below <c>C:\Data\</c> to the project database specified by the <c>project-database</c>
  6286. property. Workfiles will be copied to the workfile location and will overwrite any existing files (as
  6287. dictated by the <c>copymode</c> attribute). The relevant revisions will be locked in PVCS. Added files
  6288. will be assigned the <c>SYSTEST</c> promotion group.
  6289. </para>
  6290. <code>
  6291. <![CDATA[
  6292. <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Files." copymode="CopyWorkfileWithOverwrite" lock="true" promotiongroup="SYSTEST" includesubprojects="true">
  6293. <entities>
  6294. <entity name="C:\Data\"/>
  6295. </entities>
  6296. </pvcsaddfiles>
  6297. ]]>
  6298. </code>
  6299. </example>
  6300. </member>
  6301. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask">
  6302. <summary>
  6303. Base class for all PVCS project database tasks that operate against one or more entities.
  6304. </summary>
  6305. </member>
  6306. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask">
  6307. <summary>
  6308. A base class for PVCS tasks that deal with project databases.
  6309. </summary>
  6310. <remarks>
  6311. <para>
  6312. This class can be used as a base class for PVCS tasks that operate against a project database. It provides
  6313. common attributes and functionality for such tasks.
  6314. </para>
  6315. </remarks>
  6316. </member>
  6317. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSTask">
  6318. <summary>
  6319. Base class functionality for all PVCS tasks.
  6320. </summary>
  6321. </member>
  6322. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSTask._pvcsBin">
  6323. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PVCSBin"/>
  6324. </member>
  6325. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSTask._process">
  6326. <summary>
  6327. This is the PCLI process that is run by this task.
  6328. </summary>
  6329. </member>
  6330. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.StartProcess">
  6331. <summary>
  6332. Starts the process that is wrapped by this PVCS task.
  6333. </summary>
  6334. <remarks>
  6335. Provided only to seal the implementation of <c>StartProcess()</c>.
  6336. </remarks>
  6337. <returns>The process that was started.</returns>
  6338. </member>
  6339. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.ExecuteTask">
  6340. <summary>
  6341. Executes the task.
  6342. </summary>
  6343. <remarks>
  6344. Provided only to seal the implementation of <c>ExecuteTask()</c>.
  6345. </remarks>
  6346. </member>
  6347. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.PrepareProcess(System.Diagnostics.Process)">
  6348. <summary>
  6349. Prepares the process wrapped by this task for execution.
  6350. </summary>
  6351. <param name="process">The process to prepare for execution.</param>
  6352. </member>
  6353. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6354. <summary>
  6355. Allows tasks to add their task-specific arguments to the collection of arguments to be passed to the
  6356. PVCS command-line tool.
  6357. </summary>
  6358. <param name="arguments">The collection of arguments.</param>
  6359. </member>
  6360. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.GetProgramArguments">
  6361. <summary>
  6362. Constructs the program arguments that should be used when executing the wrapped PVCS process.
  6363. </summary>
  6364. <returns>A <c>string</c> containing the program arguments.</returns>
  6365. </member>
  6366. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PVCSBin">
  6367. <summary>
  6368. Gets or sets the location of the PVCS binary command-line tools.
  6369. </summary>
  6370. <remarks>
  6371. <para>
  6372. Generally, the PVCS command-line tools will be available on the current path. However, if this is not
  6373. the case then this property allows an exact location to be specified. If this property is not set, the
  6374. task will assume that the PVCS binaries are available on the current path.
  6375. </para>
  6376. </remarks>
  6377. </member>
  6378. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.Process">
  6379. <summary>
  6380. Gets or sets the process that is run as a result of running this task.
  6381. </summary>
  6382. </member>
  6383. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.ProgramArguments">
  6384. <summary>
  6385. Gets the program arguments with which to run the wrapped PVCS process.
  6386. </summary>
  6387. </member>
  6388. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.ExeName">
  6389. <summary>
  6390. Gets the executable name for the command-line tool to run for the PVCS task.
  6391. </summary>
  6392. </member>
  6393. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PCLICommandName">
  6394. <summary>
  6395. Gets the PCLI command name that corresponds to the operation the task performs.
  6396. </summary>
  6397. <remarks>
  6398. <para>
  6399. By default, this property will return the name of the task minus the starting "pvcs". Subclasses need
  6400. only override this property if there is a mismatch between the task name and the PCLI command name.
  6401. </para>
  6402. </remarks>
  6403. </member>
  6404. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._includeSubprojects">
  6405. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects"/>
  6406. </member>
  6407. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._password">
  6408. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Password"/>
  6409. </member>
  6410. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._projectDatabase">
  6411. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectDatabase"/>
  6412. </member>
  6413. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._projectPath">
  6414. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectPath"/>
  6415. </member>
  6416. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._userId">
  6417. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.UserId"/>
  6418. </member>
  6419. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._workspace">
  6420. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Workspace"/>
  6421. </member>
  6422. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._includeSubProjectsUsed">
  6423. <summary>
  6424. Set to <c>true</c> if the <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects"/> property is manipulated. Some tasks don't
  6425. support this property and so an exception will be thrown if the property is used.
  6426. </summary>
  6427. </member>
  6428. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6429. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6430. </member>
  6431. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects">
  6432. <summary>
  6433. Gets or sets a value indicating whether the operation should include subprojects.
  6434. </summary>
  6435. <remarks>
  6436. <para>
  6437. This is equivalent to the <c>-z</c> command-line option.
  6438. </para>
  6439. </remarks>
  6440. </member>
  6441. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects">
  6442. <summary>
  6443. Gets a value indicating whether the specific task implementation supports the <c>includesubprojects</c>
  6444. task attribute. If not, an exception will be thrown if an attempt is made to set the attribute.
  6445. </summary>
  6446. </member>
  6447. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Password">
  6448. <summary>
  6449. Gets or sets the password to use when connecting to the project database.
  6450. </summary>
  6451. <remarks>
  6452. <para>
  6453. This is equivalent to the password part of the <c>-id</c> command-line option.
  6454. </para>
  6455. </remarks>
  6456. </member>
  6457. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.UserId">
  6458. <summary>
  6459. Gets or sets the user ID to use when connecting to the project database.
  6460. </summary>
  6461. <remarks>
  6462. <para>
  6463. This is equivalent to the user ID part of the <c>-id</c> command-line option.
  6464. </para>
  6465. </remarks>
  6466. </member>
  6467. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Workspace">
  6468. <summary>
  6469. Gets or sets the workspace to use when connecting to the project database.
  6470. </summary>
  6471. <remarks>
  6472. <para>
  6473. This is equivalent to the <c>-sp</c> command-line option.
  6474. </para>
  6475. </remarks>
  6476. </member>
  6477. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectDatabase">
  6478. <summary>
  6479. Gets or sets the project database to utilize during the operation.
  6480. </summary>
  6481. <remarks>
  6482. <para>
  6483. This is equivalent to the <c>-pr</c> command-line option.
  6484. </para>
  6485. </remarks>
  6486. </member>
  6487. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectPath">
  6488. <summary>
  6489. Gets or sets the project path to utilize during the operation.
  6490. </summary>
  6491. <remarks>
  6492. <para>
  6493. This is equivalent to the <c>-pp</c> command-line option.
  6494. </para>
  6495. </remarks>
  6496. </member>
  6497. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask._entities">
  6498. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.Entities"/>
  6499. </member>
  6500. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.#ctor">
  6501. <summary>
  6502. Constructs and initializes an instance of <c>PVCSMultipleEntityTask</c>.
  6503. </summary>
  6504. </member>
  6505. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6506. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6507. </member>
  6508. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.Entities">
  6509. <summary>
  6510. Gets or sets the entities involved in the operation.
  6511. </summary>
  6512. </member>
  6513. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._archiveDescription">
  6514. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.ArchiveDescription"/>
  6515. </member>
  6516. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._copyMode">
  6517. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.CopyMode"/>
  6518. </member>
  6519. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._deleteWorkfiles">
  6520. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.DeleteWorkfiles"/>
  6521. </member>
  6522. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._description">
  6523. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Description"/>
  6524. </member>
  6525. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._lock">
  6526. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Lock"/>
  6527. </member>
  6528. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._promotionGroup">
  6529. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PromotionGroup"/>
  6530. </member>
  6531. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._suppressAddIfExists">
  6532. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.SuppressAddIfExists"/>
  6533. </member>
  6534. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._versionLabel">
  6535. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.VersionLabel"/>
  6536. </member>
  6537. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.#ctor">
  6538. <summary>
  6539. Constructs and initializes an instance of <c>PVCSAddFilesTask</c>.
  6540. </summary>
  6541. </member>
  6542. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6543. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6544. </member>
  6545. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.ArchiveDescription">
  6546. <summary>
  6547. Gets or sets the archive description for versioned files.
  6548. </summary>
  6549. <remarks>
  6550. <para>
  6551. This is equivalent to the <c>-t</c> parameter to the <c>pcli addfiles</c> command.
  6552. </para>
  6553. </remarks>
  6554. </member>
  6555. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.CopyMode">
  6556. <summary>
  6557. Gets or sets the copy mode for the operation.
  6558. </summary>
  6559. </member>
  6560. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.DeleteWorkfiles">
  6561. <summary>
  6562. Gets or sets a value indicating whether workfiles will be deleted after adding them to PVCS.
  6563. </summary>
  6564. <remarks>
  6565. <para>
  6566. This is equivalent to the <c>-d</c> parameter to the <c>pcli addfiles</c> command.
  6567. </para>
  6568. </remarks>
  6569. </member>
  6570. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Description">
  6571. <summary>
  6572. Gets or sets the description for versioned files.
  6573. </summary>
  6574. <remarks>
  6575. <para>
  6576. This is equivalent to the <c>-m</c> parameter to the <c>pcli addfiles</c> command.
  6577. </para>
  6578. </remarks>
  6579. </member>
  6580. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Lock">
  6581. <summary>
  6582. Gets or sets a value indicating whether versioned files should be locked after being added to PVCS.
  6583. </summary>
  6584. <remarks>
  6585. <para>
  6586. This is equivalent to the <c>-l</c> parameter to the <c>pcli addfiles</c> command.
  6587. </para>
  6588. </remarks>
  6589. </member>
  6590. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PromotionGroup">
  6591. <summary>
  6592. Gets or sets the promotion group to which added files will be assigned. Setting this attribute to an
  6593. empty string indicates the versioned files will not be assigned to any promotion group.
  6594. </summary>
  6595. <remarks>
  6596. <para>
  6597. This is equivalent to the <c>-g</c> parameter to the <c>pcli addfiles</c> command.
  6598. </para>
  6599. </remarks>
  6600. </member>
  6601. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.SuppressAddIfExists">
  6602. <summary>
  6603. Gets or sets a value indicating whether workfiles shouldn't be added if they already exist in the PVCS
  6604. repository.
  6605. </summary>
  6606. <remarks>
  6607. <para>
  6608. This is equivalent to the <c>-qw</c> parameter to the <c>pcli addfiles</c> command.
  6609. </para>
  6610. </remarks>
  6611. </member>
  6612. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.VersionLabel">
  6613. <summary>
  6614. Gets or sets the version label to assign to the added versioned files.
  6615. </summary>
  6616. <remarks>
  6617. <para>
  6618. This is equivalent to the <c>-v</c> parameter to the <c>pcli addfiles</c> command.
  6619. </para>
  6620. </remarks>
  6621. </member>
  6622. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode">
  6623. <summary>
  6624. Specifies possible copy modes for the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask"/> task.
  6625. </summary>
  6626. </member>
  6627. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.Default">
  6628. <summary>
  6629. Indicates the default copy mode should be used.
  6630. </summary>
  6631. </member>
  6632. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.CopyWorkfileIfRequired">
  6633. <summary>
  6634. Indicates that workfiles should be copied to the project workfile location is it doesn't already exist.
  6635. </summary>
  6636. </member>
  6637. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.CopyWorkfileWithOverwrite">
  6638. <summary>
  6639. Indicates that workfiles should be copied to the project workfile location and overwrite any existing
  6640. workfile.
  6641. </summary>
  6642. </member>
  6643. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask">
  6644. <summary>
  6645. Adds a user to a PVCS project or project database.
  6646. </summary>
  6647. <remarks>
  6648. <para>
  6649. This task uses the <c>adduser</c> PCLI command to add the user to the PVCS project or database.
  6650. </para>
  6651. </remarks>
  6652. <example>
  6653. <para>
  6654. Adds a user with name <c>kb</c> and password <c>*Muse*</c> to the project database specified by the
  6655. <c>project-database</c> property.
  6656. </para>
  6657. <code>
  6658. <![CDATA[
  6659. <pvcsadduser projectdatabase="${project-database}" username="kb" password="*Muse*"/>
  6660. ]]>
  6661. </code>
  6662. </example>
  6663. <example>
  6664. <para>
  6665. Adds a user with name <c>kb</c> and password <c>*Muse*</c> to the project database specified by the
  6666. <c>project-database</c> property. The user's logon will expire on the 26th of October, 2005.
  6667. </para>
  6668. <code>
  6669. <![CDATA[
  6670. <pvcsadduser projectdatabase="${project-database}" username="kb" password="*Muse*" expirydate="10/26/2005"/>
  6671. ]]>
  6672. </code>
  6673. </example>
  6674. </member>
  6675. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._expiryDate">
  6676. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.ExpiryDate"/>
  6677. </member>
  6678. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._userPassword">
  6679. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserPassword"/>
  6680. </member>
  6681. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._userName">
  6682. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserName"/>
  6683. </member>
  6684. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.#ctor">
  6685. <summary>
  6686. Constructs and initializes an instance of <c>PVCSAddUserTask</c>.
  6687. </summary>
  6688. </member>
  6689. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6690. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6691. </member>
  6692. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.ExpiryDate">
  6693. <summary>
  6694. Gets or sets the expiration date for the new user.
  6695. </summary>
  6696. <remarks>
  6697. <para>
  6698. This is equivalent to the <c>-e</c> parameter to the <c>pcli adduser</c> command.
  6699. </para>
  6700. </remarks>
  6701. </member>
  6702. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserPassword">
  6703. <summary>
  6704. Gets or sets the password for the new user.
  6705. </summary>
  6706. </member>
  6707. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserName">
  6708. <summary>
  6709. Gets or sets the user name for the new user.
  6710. </summary>
  6711. </member>
  6712. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.SupportsIncludeSubprojects">
  6713. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
  6714. </member>
  6715. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask">
  6716. <summary>
  6717. Assigns a promotion group to versioned files.
  6718. </summary>
  6719. <remarks>
  6720. <para>
  6721. This task uses the <c>assigngroup</c> PCLI command to assign the group to versioned files.
  6722. </para>
  6723. </remarks>
  6724. <example>
  6725. <para>
  6726. Assigns the <c>SYSTEST</c> promotion group to all entities with the <c>DEV</c> promotion group in the
  6727. <c>folder</c> project.
  6728. </para>
  6729. <code>
  6730. <![CDATA[
  6731. <pvcsassigngroup projectdatabase="${project-database}" entity="/folder" assignpromotiongroup="SYSTEST" promotiongroup="DEV"/>
  6732. ]]>
  6733. </code>
  6734. </example>
  6735. <example>
  6736. <para>
  6737. Assigns the <c>SYSTEST</c> promotion group to revision <c>1.2</c> of all entities.
  6738. </para>
  6739. <code>
  6740. <![CDATA[
  6741. <pvcsassigngroup projectdatabase="${project-database}" entity="/" includesubprojects="true" assignpromotiongroup="SYSTEST" revision="1.2"/>
  6742. ]]>
  6743. </code>
  6744. </example>
  6745. </member>
  6746. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask">
  6747. <summary>
  6748. Base class for all PVCS project database tasks that operate against a single entity.
  6749. </summary>
  6750. </member>
  6751. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask._entity">
  6752. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.Entity"/>
  6753. </member>
  6754. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6755. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6756. </member>
  6757. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.Entity">
  6758. <summary>
  6759. Gets or sets the entity involved in the operation.
  6760. </summary>
  6761. </member>
  6762. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._assignPromotionGroup">
  6763. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AssignPromotionGroup"/>
  6764. </member>
  6765. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._promotionGroup">
  6766. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.PromotionGroup"/>
  6767. </member>
  6768. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._revision">
  6769. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.Revision"/>
  6770. </member>
  6771. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._versionLabel">
  6772. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.VersionLabel"/>
  6773. </member>
  6774. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.#ctor">
  6775. <summary>
  6776. Constructs and initializes an instance of <c>PVCSAssignGroupTask</c>.
  6777. </summary>
  6778. </member>
  6779. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6780. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6781. </member>
  6782. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AssignPromotionGroup">
  6783. <summary>
  6784. Gets or sets the promotion group to assign to the versioned files.
  6785. </summary>
  6786. <remarks>
  6787. <para>
  6788. This is equivalent to the <c>-g</c> parameter to the <c>pcli assigngroup</c> command.
  6789. </para>
  6790. </remarks>
  6791. </member>
  6792. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.PromotionGroup">
  6793. <summary>
  6794. Gets or sets the promotion group for the versioned files to be assigned the promotion group.
  6795. </summary>
  6796. <remarks>
  6797. <para>
  6798. This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.
  6799. </para>
  6800. </remarks>
  6801. </member>
  6802. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.Revision">
  6803. <summary>
  6804. Gets or sets the revision for the versioned files to be assigned the promotion group.
  6805. </summary>
  6806. <remarks>
  6807. <para>
  6808. This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.
  6809. </para>
  6810. <para>
  6811. If this property has not yet been set, it will return <c>Double.MaxValue</c>.
  6812. </para>
  6813. </remarks>
  6814. </member>
  6815. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.VersionLabel">
  6816. <summary>
  6817. Gets or sets the version label for the versioned files to be assigned the promotion group.
  6818. </summary>
  6819. <remarks>
  6820. <para>
  6821. This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.
  6822. </para>
  6823. </remarks>
  6824. </member>
  6825. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask">
  6826. <summary>
  6827. Changes the promotion group for specified versioned files.
  6828. </summary>
  6829. <remarks>
  6830. <para>
  6831. This task uses the <c>changegroup</c> PCLI command to change the group for versioned files.
  6832. </para>
  6833. </remarks>
  6834. <example>
  6835. <para>
  6836. Changes the promotion group for <c>file.txt</c> from <c>SYSTEST</c> to <c>DEV</c>.
  6837. </para>
  6838. <code>
  6839. <![CDATA[
  6840. <pvcschangegroup projectdatabase="${project-database}" from="SYSTEST" to="DEV" entity="/file.txt"/>
  6841. ]]>
  6842. </code>
  6843. </example>
  6844. <example>
  6845. <para>
  6846. Changes the promotion group for all files from <c>DEV</c> to <c>PROD</c>.
  6847. </para>
  6848. <code>
  6849. <![CDATA[
  6850. <pvcschangegroup projectdatabase="${project-database}" from="DEV" to="PROD" entity="/" includesubprojects="true"/>
  6851. ]]>
  6852. </code>
  6853. </example>
  6854. </member>
  6855. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask._from">
  6856. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.From"/>
  6857. </member>
  6858. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask._to">
  6859. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.To"/>
  6860. </member>
  6861. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6862. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6863. </member>
  6864. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.From">
  6865. <summary>
  6866. Gets or sets the promotion group to change from.
  6867. </summary>
  6868. <remarks>
  6869. <para>
  6870. This is equivalent to the <c>-gf</c> parameter to the <c>pcli changegroup</c> command.
  6871. </para>
  6872. </remarks>
  6873. </member>
  6874. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.To">
  6875. <summary>
  6876. Gets or sets the promotion group to change to.
  6877. </summary>
  6878. <remarks>
  6879. <para>
  6880. This is equivalent to the <c>-gt</c> parameter to the <c>pcli changegroup</c> command.
  6881. </para>
  6882. </remarks>
  6883. </member>
  6884. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument">
  6885. <summary>
  6886. Encapsulates the details of a PVCS command argument.
  6887. </summary>
  6888. <remarks>
  6889. <para>
  6890. PVCS tasks must "fill in" a collection of arguments to be passed to the PVCS command line interface (PCLI).
  6891. This class represents one such argument.
  6892. </para>
  6893. <para>
  6894. Each argument consists of a command and an optional command value. The command is always passed to the PVCS
  6895. command line utility and is therefore required. An example of a command is "-g" which is passed to many
  6896. PVCS command line utilities to specify a promotion group.
  6897. </para>
  6898. <para>
  6899. The command value is used to specify extra information to the command. For example, if the command is "-g"
  6900. then the command value would be the name of the promotion group.
  6901. </para>
  6902. <para>
  6903. The command can be assigned a position (see the <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position"/> property). This position defines
  6904. where the command appears relative to other commands. For example, some commands must appear after other
  6905. commands. Therefore, they should be assigned a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>.
  6906. </para>
  6907. </remarks>
  6908. </member>
  6909. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._command">
  6910. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command"/>
  6911. </member>
  6912. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._commandValue">
  6913. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CommandValue"/>
  6914. </member>
  6915. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._position">
  6916. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position"/>
  6917. </member>
  6918. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String)">
  6919. <summary>
  6920. Constructs an instance of <c>PVCSCommandArgument</c> with the specified information. No value is
  6921. applied and the argument has a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>.
  6922. </summary>
  6923. <param name="command">The command string.</param>
  6924. </member>
  6925. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String,System.Object)">
  6926. <summary>
  6927. Constructs an instance of <c>PVCSCommandArgument</c> with the specified information. The argument has
  6928. a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>.
  6929. </summary>
  6930. <param name="command">The command string.</param>
  6931. <param name="commandValue">The value for the command, or <c>null</c> if no value applies.</param>
  6932. </member>
  6933. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String,System.Object,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition)">
  6934. <summary>
  6935. Constructs an instance of <c>PVCSCommandArgument</c> with the specified information.
  6936. </summary>
  6937. <param name="command">The command string.</param>
  6938. <param name="commandValue">The value for the command, or <c>null</c> if no value applies.</param>
  6939. <param name="position">The position for the command.</param>
  6940. </member>
  6941. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CompareTo(System.Object)">
  6942. <summary>
  6943. Compares two PVCS command arguments based on their position.
  6944. </summary>
  6945. <param name="o">The PVCS command argument to compare to <c>this</c>.</param>
  6946. <returns>
  6947. Less than zero if this instance is less than <paramref name="o"/>.
  6948. Zero if this instance is equal to <paramref name="o"/>.
  6949. Greater than zero if this instance is greater than <paramref name="o"/>.
  6950. </returns>
  6951. </member>
  6952. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.ToString">
  6953. <summary>
  6954. Converts this command argument to its <c>string</c> representation.
  6955. </summary>
  6956. <returns>The <c>string</c> representation of this command argument.</returns>
  6957. </member>
  6958. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.EscapeStringCommandArgument(System.String)">
  6959. <summary>
  6960. Escapes a <c>string</c> command line argument.
  6961. </summary>
  6962. <remarks>
  6963. <para>
  6964. This method attempts to deal with the mess of keeping both PCLI and the shell happy with string
  6965. arguments. It's not perfect yet (try an argument with several backslashes before a double quote). It
  6966. would be nice to have a regex to handle this but I wouldn't even bother until this logic is spot on.
  6967. </para>
  6968. </remarks>
  6969. <param name="argument">The string argument to escape.</param>
  6970. <returns>The escaped string argument.</returns>
  6971. </member>
  6972. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command">
  6973. <summary>
  6974. Gets a <c>string</c> that contains the command to pass to PVCS.
  6975. </summary>
  6976. </member>
  6977. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CommandValue">
  6978. <summary>
  6979. Gets the value to append to <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command"/>.
  6980. </summary>
  6981. <remarks>
  6982. <para>
  6983. If this property is <c>null</c>, no value will be appended to the command.
  6984. </para>
  6985. </remarks>
  6986. </member>
  6987. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position">
  6988. <summary>
  6989. Gets the position for the command.
  6990. </summary>
  6991. </member>
  6992. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection">
  6993. <summary>
  6994. Implements a type-safe collection of <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/>s.
  6995. </summary>
  6996. </member>
  6997. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
  6998. <see cref="M:System.Collections.IList.Add(System.Object)"/>
  6999. </member>
  7000. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String)">
  7001. <summary>
  7002. Adds a new command argument to this collection with the specified information.
  7003. </summary>
  7004. <param name="command">The command string for the new command.</param>
  7005. </member>
  7006. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String,System.Object)">
  7007. <summary>
  7008. Adds a new command argument to this collection with the specified information.
  7009. </summary>
  7010. <param name="command">The command string for the new command.</param>
  7011. <param name="commandValue">
  7012. The command value for the new command, or <c>null</c> if no value applies.
  7013. </param>
  7014. </member>
  7015. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String,System.Object,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition)">
  7016. <summary>
  7017. Adds a new command argument to this collection with the specified information.
  7018. </summary>
  7019. <param name="command">The command string for the new command.</param>
  7020. <param name="commandValue">
  7021. The command value for the new command, or <c>null</c> if no value applies.
  7022. </param>
  7023. <param name="position">The position for the new command.</param>
  7024. </member>
  7025. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.AddRange(System.Collections.ICollection)">
  7026. <summary>
  7027. Adds all specified command arguments to this collection.
  7028. </summary>
  7029. <param name="commandArguments">The collection of command arguments to add.</param>
  7030. </member>
  7031. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.IndexOf(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
  7032. <see cref="M:System.Collections.IList.IndexOf(System.Object)"/>
  7033. </member>
  7034. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Insert(System.Int32,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
  7035. <see cref="M:System.Collections.IList.Insert(System.Int32,System.Object)"/>
  7036. </member>
  7037. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Remove(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
  7038. <see cref="M:System.Collections.IList.Remove(System.Object)"/>
  7039. </member>
  7040. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Contains(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
  7041. <see cref="M:System.Collections.IList.Contains(System.Object)"/>
  7042. </member>
  7043. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.ToArray">
  7044. <summary>
  7045. Retrieves an array of <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/> objects in this collection.
  7046. </summary>
  7047. <returns>An array of command arguments in this collection.</returns>
  7048. </member>
  7049. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnInsert(System.Int32,System.Object)">
  7050. <see cref="M:System.Collections.CollectionBase.OnInsert(System.Int32,System.Object)"/>
  7051. </member>
  7052. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnSet(System.Int32,System.Object,System.Object)">
  7053. <see cref="M:System.Collections.CollectionBase.OnSet(System.Int32,System.Object,System.Object)"/>
  7054. </member>
  7055. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnValidate(System.Object)">
  7056. <see cref="M:System.Collections.CollectionBase.OnValidate(System.Object)"/>
  7057. </member>
  7058. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Item(System.Int32)">
  7059. <summary>
  7060. Allows the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/> objects in the collection to be manipulated.
  7061. </summary>
  7062. </member>
  7063. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition">
  7064. <summary>
  7065. Defines possible values for specifying positions for PCLI command arguments and arguments to PCLI itself.
  7066. </summary>
  7067. <remarks>
  7068. <para>
  7069. Members of this enumeration are used to specify relative positions of PCLI command arguments. All arguments
  7070. given a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/> will appear after arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>
  7071. or <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>. Similarly, arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/> will appear after
  7072. those with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/> but before those with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/>.
  7073. </para>
  7074. <para>
  7075. No order is guaranteed for arguments with the same position. That is, if two arguments have a position of
  7076. <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>, it is not possible to specify which one is output to the command line first.
  7077. </para>
  7078. <para>
  7079. The <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.BeforePCLICommand"/> member is special in that it ensures the argument will appear before
  7080. the PCLI command name. This is useful when the argument is to PCLI itself, not the PCLI command.
  7081. </para>
  7082. </remarks>
  7083. </member>
  7084. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.BeforePCLICommand">
  7085. <summary>
  7086. Arguments that should appear before the PCLI command argument. This is useful for arguments to PCLI
  7087. itself (as opposed to the PCLI command).
  7088. </summary>
  7089. </member>
  7090. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start">
  7091. <summary>
  7092. PCLI command arguments that should appear before other PCLI command arguments.
  7093. </summary>
  7094. </member>
  7095. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle">
  7096. <summary>
  7097. PCLI command arguments that should appear before other arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/>
  7098. but after other arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>.
  7099. </summary>
  7100. </member>
  7101. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End">
  7102. <summary>
  7103. PCLI command arguments that should appear after other PCLI command arguments.
  7104. </summary>
  7105. </member>
  7106. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask">
  7107. <summary>
  7108. Creates a project in a PVCS repository.
  7109. </summary>
  7110. <remarks>
  7111. <para>
  7112. This task uses the <c>createproject</c> PCLI command to create the project in the PVCS repository.
  7113. </para>
  7114. </remarks>
  7115. <example>
  7116. <para>
  7117. Creates a project called <c>Songs</c> in the project database specified by the <c>project-database</c>
  7118. property. The workfile location for the project is set to <c>C:\Work\Songs</c>.
  7119. </para>
  7120. <code>
  7121. <![CDATA[
  7122. <pvcscreateproject projectdatabase="${project-database}" workfilelocation="C:\Work\Songs" entity="/Songs"/>
  7123. ]]>
  7124. </code>
  7125. </example>
  7126. </member>
  7127. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask._workfileLocation">
  7128. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.WorkfileLocation"/>
  7129. </member>
  7130. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7131. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7132. </member>
  7133. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.WorkfileLocation">
  7134. <summary>
  7135. Gets or sets the workfile location for the created project.
  7136. </summary>
  7137. <remarks>
  7138. <para>
  7139. This is equivalent to the <c>-w</c> parameter to the <c>pcli createproject</c> command.
  7140. </para>
  7141. </remarks>
  7142. </member>
  7143. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.SupportsIncludeSubprojects">
  7144. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
  7145. </member>
  7146. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask">
  7147. <summary>
  7148. Removes a specified promotion group from versioned files.
  7149. </summary>
  7150. <remarks>
  7151. <para>
  7152. This task uses the <c>deletegroup</c> PCLI command to remove the promotion group from the versioned files.
  7153. </para>
  7154. </remarks>
  7155. <example>
  7156. <para>
  7157. Removes the <c>DEV</c> promotion group from <c>App.ico</c> in the project database specified by the
  7158. <c>project-database</c> property.
  7159. </para>
  7160. <code>
  7161. <![CDATA[
  7162. <pvcsdeletegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/App.ico"/>
  7163. ]]>
  7164. </code>
  7165. </example>
  7166. <example>
  7167. <para>
  7168. Removes the <c>DEV</c> promotion group all files in the project database specified by the
  7169. <c>project-database</c> property.
  7170. </para>
  7171. <code>
  7172. <![CDATA[
  7173. <pvcsdeletegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/" includesubprojects="true"/>
  7174. ]]>
  7175. </code>
  7176. </example>
  7177. </member>
  7178. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask._promotionGroup">
  7179. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.PromotionGroup"/>
  7180. </member>
  7181. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7182. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7183. </member>
  7184. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.PromotionGroup">
  7185. <summary>
  7186. Gets or sets the promotion group to delete.
  7187. </summary>
  7188. <remarks>
  7189. <para>
  7190. This is equivalent to the <c>-g</c> parameter to the <c>pcli deletegroup</c> command.
  7191. </para>
  7192. </remarks>
  7193. </member>
  7194. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask">
  7195. <summary>
  7196. Removes a label from specified versioned files or projects.
  7197. </summary>
  7198. <remarks>
  7199. <para>
  7200. This task uses the <c>deletelabel</c> PCLI command to remove the version label from the versioned files.
  7201. </para>
  7202. </remarks>
  7203. <example>
  7204. <para>
  7205. Removes the label called <c>My Label</c> from the versioned file called <c>App.ico</c> from the project
  7206. database specified by the <c>project-database</c> property.
  7207. </para>
  7208. <code>
  7209. <![CDATA[
  7210. <pvcsdeletelabel projectdatabase="${project-database}" versionlabel="My Label">
  7211. <entities>
  7212. <entity name="/App.ico"/>
  7213. </entities>
  7214. </pvcsdeletelabel>
  7215. ]]>
  7216. </code>
  7217. </example>
  7218. <example>
  7219. <para>
  7220. Removes the label called <c>My Label</c> from all files at and below both <c>folder1</c> and <c>folder2</c>
  7221. in the project database specified by the <c>project-database</c> property.
  7222. </para>
  7223. <code>
  7224. <![CDATA[
  7225. <pvcsdeletelabel projectdatabase="${project-database}" versionlabel="My Label" includesubprojects="true">
  7226. <entities>
  7227. <entity name="/folder1"/>
  7228. <entity name="/folder2"/>
  7229. </entities>
  7230. </pvcsdeletelabel>
  7231. ]]>
  7232. </code>
  7233. </example>
  7234. </member>
  7235. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask._versionLabel">
  7236. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.VersionLabel"/>
  7237. </member>
  7238. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7239. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7240. </member>
  7241. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.VersionLabel">
  7242. <summary>
  7243. Gets or sets the version label to remove.
  7244. </summary>
  7245. <remarks>
  7246. <para>
  7247. This is equivalent to the <c>-v</c> parameter to the <c>pcli deletelabel</c> command.
  7248. </para>
  7249. </remarks>
  7250. </member>
  7251. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteTask">
  7252. <summary>
  7253. Deletes folder, projects, versioned items and workspaces in a PVCS repository.
  7254. </summary>
  7255. <remarks>
  7256. <para>
  7257. This task uses the <c>delete</c> PCLI command to delete the items.
  7258. </para>
  7259. </remarks>
  7260. <example>
  7261. <para>
  7262. Deletes the versioned file called <c>App.ico</c> from the project database specified by the
  7263. <c>project-database</c> property.
  7264. </para>
  7265. <code>
  7266. <![CDATA[
  7267. <pvcsdelete projectdatabase="${project-database}">
  7268. <entities>
  7269. <entity name="/App.ico"/>
  7270. </entities>
  7271. </pvcsdelete>
  7272. ]]>
  7273. </code>
  7274. </example>
  7275. <example>
  7276. <para>
  7277. Deletes the files called <c>file1.txt</c> and <c>file2.txt</c> from the project called <c>folder</c> in the
  7278. project database specified by the <c>project-database</c> property.
  7279. </para>
  7280. <code>
  7281. <![CDATA[
  7282. <pvcsdelete projectdatabase="${project-database}" projectpath="/folder">
  7283. <entities>
  7284. <entity name="file1.txt"/>
  7285. <entity name="file2.txt"/>
  7286. </entities>
  7287. </pvcsdelete>
  7288. ]]>
  7289. </code>
  7290. </example>
  7291. </member>
  7292. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteTask.SupportsIncludeSubprojects">
  7293. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
  7294. </member>
  7295. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask">
  7296. <summary>
  7297. Deletes the specified users from the PVCS access control database.
  7298. </summary>
  7299. <remarks>
  7300. <para>
  7301. This task uses the <c>deleteuser</c> PCLI command to delete the users.
  7302. </para>
  7303. </remarks>
  7304. <example>
  7305. <para>
  7306. Deletes the users called <c>kb</c>, <c>kv</c> and <c>tb</c> from the project database specified by the
  7307. <c>project-database</c> property.
  7308. </para>
  7309. <code>
  7310. <![CDATA[
  7311. <pvcsdeleteusers projectdatabase="${project-database}">
  7312. <entities>
  7313. <entity name="kb"/>
  7314. <entity name="kv"/>
  7315. <entity name="tb"/>
  7316. </entities>
  7317. </pvcsdeleteusers>
  7318. ]]>
  7319. </code>
  7320. </example>
  7321. </member>
  7322. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask.SupportsIncludeSubprojects">
  7323. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
  7324. </member>
  7325. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask.PCLICommandName">
  7326. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PCLICommandName"/>
  7327. </member>
  7328. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSGetTask">
  7329. <summary>
  7330. Gets files from a PVCS repository.
  7331. </summary>
  7332. <remarks>
  7333. <para>
  7334. This task uses the <c>get</c> PCLI command to get the versioned files from PVCS.
  7335. </para>
  7336. </remarks>
  7337. <example>
  7338. <para>
  7339. Gets the versioned file called <c>App.ico</c> from the project database specified by the
  7340. <c>project-database</c> property.
  7341. </para>
  7342. <code>
  7343. <![CDATA[
  7344. <pvcsget projectdatabase="${project-database}">
  7345. <entities>
  7346. <entity name="/App.ico"/>
  7347. </entities>
  7348. </pvcsget>
  7349. ]]>
  7350. </code>
  7351. </example>
  7352. <example>
  7353. <para>
  7354. Gets the versioned file called <c>App.ico</c> from the project database specified by the
  7355. <c>project-database</c> property. The file is also locked.
  7356. </para>
  7357. <code>
  7358. <![CDATA[
  7359. <pvcsget projectdatabase="${project-database}" lock="true">
  7360. <entities>
  7361. <entity name="/App.ico"/>
  7362. </entities>
  7363. </pvcsget>
  7364. ]]>
  7365. </code>
  7366. </example>
  7367. <example>
  7368. <para>
  7369. Gets all revisions assigned the <c>SYSTEST</c> promotion group from the project database specified by the
  7370. <c>project-database</c> property. The workfiles are touched after the get operation.
  7371. </para>
  7372. <code>
  7373. <![CDATA[
  7374. <pvcsget projectdatabase="${project-database}" includesubprojects="true" promotiongroup="SYSTEST" touch="true">
  7375. <entities>
  7376. <entity name="/"/>
  7377. </entities>
  7378. </pvcsget>
  7379. ]]>
  7380. </code>
  7381. </example>
  7382. </member>
  7383. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._baseProjectPath">
  7384. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.BaseProjectPath"/>
  7385. </member>
  7386. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._location">
  7387. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Location"/>
  7388. </member>
  7389. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._lock">
  7390. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Lock"/>
  7391. </member>
  7392. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._makeWritable">
  7393. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MakeWritable"/>
  7394. </member>
  7395. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._maxDateTime">
  7396. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MaxDateTime"/>
  7397. </member>
  7398. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._overrideWorkfileLocation">
  7399. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.OverrideWorkfileLocation"/>
  7400. </member>
  7401. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._promotionGroup">
  7402. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.PromotionGroup"/>
  7403. </member>
  7404. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._revision">
  7405. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Revision"/>
  7406. </member>
  7407. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._touch">
  7408. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Touch"/>
  7409. </member>
  7410. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._updateOnly">
  7411. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.UpdateOnly"/>
  7412. </member>
  7413. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._versionLabel">
  7414. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.VersionLabel"/>
  7415. </member>
  7416. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.#ctor">
  7417. <summary>
  7418. Constructs and initializes an instance of <c>PVCSGetTask</c>.
  7419. </summary>
  7420. </member>
  7421. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7422. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7423. </member>
  7424. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.BaseProjectPath">
  7425. <summary>
  7426. Gets or sets the base project path.
  7427. </summary>
  7428. <remarks>
  7429. <para>
  7430. This is equivalent to the <c>-bp</c> parameter to the <c>pcli get</c> command.
  7431. </para>
  7432. </remarks>
  7433. </member>
  7434. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Location">
  7435. <summary>
  7436. Gets or sets an alternative location for workfiles.
  7437. </summary>
  7438. <remarks>
  7439. <para>
  7440. This is equivalent to the <c>-a</c> parameter to the <c>pcli get</c> command.
  7441. </para>
  7442. </remarks>
  7443. </member>
  7444. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Lock">
  7445. <summary>
  7446. Gets or sets a value indicating whether revisions involved in the get operation should be locked.
  7447. </summary>
  7448. <remarks>
  7449. <para>
  7450. This is equivalent to the <c>-l</c> parameter to the <c>pcli get</c> command.
  7451. </para>
  7452. </remarks>
  7453. </member>
  7454. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MakeWritable">
  7455. <summary>
  7456. Gets or sets whether the workfiles should be made writable.
  7457. </summary>
  7458. <remarks>
  7459. <para>
  7460. This is equivalent to the <c>-w</c> parameter to the <c>pcli get</c> command.
  7461. </para>
  7462. </remarks>
  7463. </member>
  7464. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MaxDateTime">
  7465. <summary>
  7466. Gets or sets the maximum date and time of workfiles to retrieve.
  7467. </summary>
  7468. <remarks>
  7469. <para>
  7470. This is equivalent to the <c>-d</c> parameter to the <c>pcli get</c> command.
  7471. </para>
  7472. <para>
  7473. If this property has not yet been set, it will return <c>DateTime.MaxValue</c>.
  7474. </para>
  7475. </remarks>
  7476. </member>
  7477. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.OverrideWorkfileLocation">
  7478. <summary>
  7479. Gets or sets a value indicating whether the workfile location for files should be overridden.
  7480. </summary>
  7481. <remarks>
  7482. <para>
  7483. This is equivalent to the <c>-o</c> parameter to the <c>pcli get</c> command.
  7484. </para>
  7485. </remarks>
  7486. </member>
  7487. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.PromotionGroup">
  7488. <summary>
  7489. Gets or sets the promotion group to get.
  7490. </summary>
  7491. <remarks>
  7492. <para>
  7493. This is equivalent to the <c>-g</c> parameter to the <c>pcli get</c> command.
  7494. </para>
  7495. </remarks>
  7496. </member>
  7497. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Revision">
  7498. <summary>
  7499. Gets or sets the revision to get against.
  7500. </summary>
  7501. <remarks>
  7502. <para>
  7503. This is equivalent to the <c>-r</c> parameter to the <c>pcli get</c> command.
  7504. </para>
  7505. <para>
  7506. If this property has not yet been set, it will return <c>Double.MaxValue</c>.
  7507. </para>
  7508. </remarks>
  7509. </member>
  7510. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Touch">
  7511. <summary>
  7512. Gets or sets a value indicating whether workfiles should be touched after the get.
  7513. </summary>
  7514. <remarks>
  7515. <para>
  7516. This is equivalent to the <c>-t</c> parameter to the <c>pcli get</c> command.
  7517. </para>
  7518. </remarks>
  7519. </member>
  7520. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.UpdateOnly">
  7521. <summary>
  7522. Gets or sets a value indicating whether workfiles should only be gotten if they are newer than the
  7523. current workfile.
  7524. </summary>
  7525. <remarks>
  7526. <para>
  7527. This is equivalent to the <c>-u</c> parameter to the <c>pcli get</c> command (without specifying a
  7528. date or time).
  7529. </para>
  7530. </remarks>
  7531. </member>
  7532. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.VersionLabel">
  7533. <summary>
  7534. Gets or sets the version label to get against.
  7535. </summary>
  7536. <remarks>
  7537. <para>
  7538. This is equivalent to the <c>-v</c> parameter to the <c>pcli get</c> command.
  7539. </para>
  7540. </remarks>
  7541. </member>
  7542. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask">
  7543. <summary>
  7544. Assigns a version label to a revision of the specified versioned files.
  7545. </summary>
  7546. <remarks>
  7547. <para>
  7548. This task uses the <c>label</c> PCLI command to label the items.
  7549. </para>
  7550. </remarks>
  7551. <example>
  7552. <para>
  7553. Labels all files in the project database specified by the <c>project-database</c> property. The label
  7554. applied is <c>Beta</c>.
  7555. </para>
  7556. <code>
  7557. <![CDATA[
  7558. <pvcslabel projectdatabase="${project-database}" versionlabel="Beta" includesubprojects="true">
  7559. <entities>
  7560. <entity name="/"/>
  7561. </entities>
  7562. </pvcslabel>
  7563. ]]>
  7564. </code>
  7565. </example>
  7566. <example>
  7567. <para>
  7568. Labels revision <c>1.8</c> of <c>App.ico</c> as <c>Dodgy</c> in the project database specified by the
  7569. <c>project-database</c> property.
  7570. </para>
  7571. <code>
  7572. <![CDATA[
  7573. <pvcslabel projectdatabase="${project-database}" versionlabel="Dodgy" revision="1.8">
  7574. <entities>
  7575. <entity name="App.ico"/>
  7576. </entities>
  7577. </pvcslabel>
  7578. ]]>
  7579. </code>
  7580. </example>
  7581. </member>
  7582. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._floating">
  7583. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Floating"/>
  7584. </member>
  7585. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._revision">
  7586. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Revision"/>
  7587. </member>
  7588. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._versionLabel">
  7589. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.VersionLabel"/>
  7590. </member>
  7591. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.#ctor">
  7592. <summary>
  7593. Constructs and initializes an instance of <c>PVCSLabel</c>.
  7594. </summary>
  7595. </member>
  7596. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7597. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7598. </member>
  7599. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Floating">
  7600. <summary>
  7601. Gets or sets a value indicating whether the label should "float" to the newest revision.
  7602. </summary>
  7603. <remarks>
  7604. <para>
  7605. This is equivalent to the <c>-f</c> parameter to the <c>pcli label</c> command.
  7606. </para>
  7607. </remarks>
  7608. </member>
  7609. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Revision">
  7610. <summary>
  7611. Gets or sets the revision to label.
  7612. </summary>
  7613. <remarks>
  7614. <para>
  7615. This is equivalent to the <c>-r</c> parameter to the <c>pcli label</c> command.
  7616. </para>
  7617. <para>
  7618. If this property has not yet been set, it will return <c>Double.MaxValue</c>.
  7619. </para>
  7620. </remarks>
  7621. </member>
  7622. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.VersionLabel">
  7623. <summary>
  7624. Gets or sets the version label to assign.
  7625. </summary>
  7626. <remarks>
  7627. <para>
  7628. This is equivalent to the <c>-v</c> parameter to the <c>pcli label</c> command.
  7629. </para>
  7630. </remarks>
  7631. </member>
  7632. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSLockTask">
  7633. <summary>
  7634. Locks a revision of the specified versioned files.
  7635. </summary>
  7636. <remarks>
  7637. <para>
  7638. This task uses the <c>lock</c> PCLI command to lock the versioned files.
  7639. </para>
  7640. </remarks>
  7641. <example>
  7642. <para>
  7643. Locks <c>App.ico</c> in the project database specified by the <c>project-database</c> property.
  7644. </para>
  7645. <code>
  7646. <![CDATA[
  7647. <pvcslock projectdatabase="${project-database}">
  7648. <entities>
  7649. <entity name="/App.ico"/>
  7650. </entities>
  7651. </pvcslock>
  7652. ]]>
  7653. </code>
  7654. </example>
  7655. <example>
  7656. <para>
  7657. Locks all files at and below <c>folder</c> in the project database specified by the <c>project-database</c>
  7658. property.
  7659. </para>
  7660. <code>
  7661. <![CDATA[
  7662. <pvcslock projectdatabase="${project-database}" includesubprojects="true">
  7663. <entities>
  7664. <entity name="/folder"/>
  7665. </entities>
  7666. </pvcslock>
  7667. ]]>
  7668. </code>
  7669. </example>
  7670. </member>
  7671. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._noBranching">
  7672. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoBranching"/>
  7673. </member>
  7674. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._noMultilock">
  7675. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoMultilock"/>
  7676. </member>
  7677. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._promotionGroup">
  7678. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.PromotionGroup"/>
  7679. </member>
  7680. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._revision">
  7681. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.Revision"/>
  7682. </member>
  7683. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._yesToBranching">
  7684. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToBranching"/>
  7685. </member>
  7686. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._yesToMultilock">
  7687. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToMultilock"/>
  7688. </member>
  7689. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.#ctor">
  7690. <summary>
  7691. Constructs and initializes an instance of <c>PVCSLock</c>.
  7692. </summary>
  7693. </member>
  7694. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7695. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7696. </member>
  7697. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoBranching">
  7698. <summary>
  7699. Gets or sets a value indicating whether locking files will take place if checking in those files would
  7700. result in a branch.
  7701. </summary>
  7702. <remarks>
  7703. <para>
  7704. This is equivalent to the <c>-nb</c> parameter to the <c>pcli lock</c> command.
  7705. </para>
  7706. </remarks>
  7707. </member>
  7708. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoMultilock">
  7709. <summary>
  7710. Gets or sets a value indicating whether already locked revisions will be locked.
  7711. </summary>
  7712. <remarks>
  7713. <para>
  7714. This is equivalent to the <c>-nm</c> parameter to the <c>pcli lock</c> command.
  7715. </para>
  7716. </remarks>
  7717. </member>
  7718. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.PromotionGroup">
  7719. <summary>
  7720. Gets or sets the promotion group to assign the locked revision.
  7721. </summary>
  7722. <remarks>
  7723. <para>
  7724. This is equivalent to the <c>-g</c> parameter to the <c>pcli lock</c> command.
  7725. </para>
  7726. </remarks>
  7727. </member>
  7728. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.Revision">
  7729. <summary>
  7730. Gets or sets the revision to lock.
  7731. </summary>
  7732. <remarks>
  7733. <para>
  7734. This is equivalent to the <c>-r</c> parameter to the <c>pcli lock</c> command.
  7735. </para>
  7736. <para>
  7737. If this property has not yet been set, it will return <c>Double.MaxValue</c>.
  7738. </para>
  7739. </remarks>
  7740. </member>
  7741. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToBranching">
  7742. <summary>
  7743. Gets or sets a value indicating whether revisions will be locked even if that will result in a branch
  7744. upon check in.
  7745. </summary>
  7746. <remarks>
  7747. <para>
  7748. This is equivalent to the <c>-yb</c> parameter to the <c>pcli lock</c> command.
  7749. </para>
  7750. </remarks>
  7751. </member>
  7752. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToMultilock">
  7753. <summary>
  7754. Gets or sets a value indicating whether revisions will be locked even if that will result in multiple
  7755. locks against the same revision.
  7756. </summary>
  7757. <remarks>
  7758. <para>
  7759. This is equivalent to the <c>-ym</c> parameter to the <c>pcli lock</c> command.
  7760. </para>
  7761. </remarks>
  7762. </member>
  7763. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask">
  7764. <summary>
  7765. Promotes versioned files to the next promotion group.
  7766. </summary>
  7767. <remarks>
  7768. <para>
  7769. This task uses the <c>promotegroup</c> PCLI command to promote versioned files.
  7770. </para>
  7771. </remarks>
  7772. <example>
  7773. <para>
  7774. Promotes all files in the root of the project database specified by the <c>project-database</c> property.
  7775. The files are promoted from the <c>DEV</c> promotion group to the next. Promotion will not take place across
  7776. branches.
  7777. </para>
  7778. <code>
  7779. <![CDATA[
  7780. <pvcspromotegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/" acrossbranches="false"/>
  7781. ]]>
  7782. </code>
  7783. </example>
  7784. <example>
  7785. <para>
  7786. Promotes all files in the project database specified by the <c>project-database</c> property. The files are
  7787. promoted from the <c>SYSTEST</c> promotion group to the next. Promotion will take place across branches.
  7788. </para>
  7789. <code>
  7790. <![CDATA[
  7791. <pvcspromotegroup projectdatabase="${project-database}" promotiongroup="SYSTEST" entity="/" includesubprojects="true" acrossbranches="true"/>
  7792. ]]>
  7793. </code>
  7794. </example>
  7795. </member>
  7796. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask._acrossBrances">
  7797. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AcrossBranches"/>
  7798. </member>
  7799. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask._promotionGroup">
  7800. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.PromotionGroup"/>
  7801. </member>
  7802. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7803. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7804. </member>
  7805. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AcrossBranches">
  7806. <summary>
  7807. Gets or sets a value indicating whether the promotion may occur across branches.
  7808. </summary>
  7809. <remarks>
  7810. <para>
  7811. This is equivalent to the <c>-nb</c> and <c>-yb</c> parameters to the <c>pcli promotegroup</c> command.
  7812. </para>
  7813. </remarks>
  7814. </member>
  7815. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.PromotionGroup">
  7816. <summary>
  7817. Gets or sets the promotion group to be promoted.
  7818. </summary>
  7819. <remarks>
  7820. <para>
  7821. This is equivalent to the <c>-g</c> parameter to the <c>pcli promotegroup</c> command.
  7822. </para>
  7823. </remarks>
  7824. </member>
  7825. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSPutTask">
  7826. <summary>
  7827. Puts files into a PVCS repository.
  7828. </summary>
  7829. <remarks>
  7830. <para>
  7831. This task uses the <c>put</c> PCLI command to put the files into PVCS.
  7832. </para>
  7833. </remarks>
  7834. <example>
  7835. <para>
  7836. Puts the file called <c>App.ico</c> into the project database specified by the <c>project-database</c>
  7837. property. The description for the change is <c>Added more colour</c>.
  7838. </para>
  7839. <code>
  7840. <![CDATA[
  7841. <pvcsput projectdatabase="${project-database}" description="Added more colour">
  7842. <entities>
  7843. <entity name="/App.ico"/>
  7844. </entities>
  7845. </pvcsput>
  7846. ]]>
  7847. </code>
  7848. </example>
  7849. <example>
  7850. <para>
  7851. Puts all files into the project database specified by the <c>project-database</c> property. The description
  7852. for the changes is <c>Major changes</c>. Even if the workfiles have not been changed, they will result in a
  7853. new revision in PVCS.
  7854. </para>
  7855. <code>
  7856. <![CDATA[
  7857. <pvcsput projectdatabase="${project-database}" description="Major changes" checkinunchanged="true" includesubprojects="true">
  7858. <entities>
  7859. <entity name="/"/>
  7860. </entities>
  7861. </pvcsput>
  7862. ]]>
  7863. </code>
  7864. </example>
  7865. <example>
  7866. <para>
  7867. Puts <c>file.txt</c> and all files in <c>folder</c> into the project database specified by the
  7868. <c>project-database</c> property. The description for the changes is <c>Some changes</c>. A new branch is
  7869. forcibly created via the <c>forcebranch</c> attribute. Leading and trailing whitespace is ignored when
  7870. determining whether the workfile has been altered.
  7871. </para>
  7872. <code>
  7873. <![CDATA[
  7874. <pvcsput projectdatabase="${project-database}" description="Some changes" forcebranch="true" ignorespaces="true">
  7875. <entities>
  7876. <entity name="/folder"/>
  7877. <entity name="/file.txt"/>
  7878. </entities>
  7879. </pvcsput>
  7880. ]]>
  7881. </code>
  7882. </example>
  7883. </member>
  7884. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._baseProjectPath">
  7885. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.BaseProjectPath"/>
  7886. </member>
  7887. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._checkInUnchanged">
  7888. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.CheckInUnchanged"/>
  7889. </member>
  7890. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._description">
  7891. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Description"/>
  7892. </member>
  7893. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._floatLabel">
  7894. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.FloatLabel"/>
  7895. </member>
  7896. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._forceBranch">
  7897. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ForceBranch"/>
  7898. </member>
  7899. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._ignoreSpaces">
  7900. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.IgnoreSpaces"/>
  7901. </member>
  7902. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._keepWorkfile">
  7903. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.KeepWorkfile"/>
  7904. </member>
  7905. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._location">
  7906. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Location"/>
  7907. </member>
  7908. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._lock">
  7909. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Lock"/>
  7910. </member>
  7911. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._overrideWorkfileLocation">
  7912. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.OverrideWorkfileLocation"/>
  7913. </member>
  7914. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._promotionGroup">
  7915. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.PromotionGroup"/>
  7916. </member>
  7917. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._reassignLabelIfExists">
  7918. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ReassignLabelIfExists"/>
  7919. </member>
  7920. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._revision">
  7921. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Revision"/>
  7922. </member>
  7923. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._useSameDescription">
  7924. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.UseSameDescription"/>
  7925. </member>
  7926. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._versionLabel">
  7927. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>
  7928. </member>
  7929. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.#ctor">
  7930. <summary>
  7931. Constructs and initializes an instance of <c>PVCSPut</c>.
  7932. </summary>
  7933. </member>
  7934. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7935. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7936. </member>
  7937. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.BaseProjectPath">
  7938. <summary>
  7939. Gets or sets the base project path.
  7940. </summary>
  7941. <remarks>
  7942. <para>
  7943. This is equivalent to the <c>-bp</c> parameter to the <c>pcli put</c> command.
  7944. </para>
  7945. </remarks>
  7946. </member>
  7947. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.CheckInUnchanged">
  7948. <summary>
  7949. Gets or sets a value indicating whether unchanged workfiles should be checked in.
  7950. </summary>
  7951. <remarks>
  7952. <para>
  7953. This is equivalent to the <c>-yf</c> parameter to the <c>pcli put</c> command.
  7954. </para>
  7955. </remarks>
  7956. </member>
  7957. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Description">
  7958. <summary>
  7959. Gets or sets the description to be applied to the checked in revisions.
  7960. </summary>
  7961. <remarks>
  7962. <para>
  7963. This is equivalent to the <c>-m</c> parameter to the <c>pcli put</c> command.
  7964. </para>
  7965. </remarks>
  7966. </member>
  7967. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.FloatLabel">
  7968. <summary>
  7969. Gets or sets a value indicating whether the version label specified by <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>
  7970. should float.
  7971. </summary>
  7972. <remarks>
  7973. <para>
  7974. This is equivalent to the <c>-fv</c> parameter to the <c>pcli put</c> command.
  7975. </para>
  7976. </remarks>
  7977. </member>
  7978. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ForceBranch">
  7979. <summary>
  7980. Gets or sets a value indicating whether a new branch will be created.
  7981. </summary>
  7982. <remarks>
  7983. <para>
  7984. This is equivalent to the <c>-fb</c> parameter to the <c>pcli put</c> command.
  7985. </para>
  7986. </remarks>
  7987. </member>
  7988. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.IgnoreSpaces">
  7989. <summary>
  7990. Gets or sets a value indicating whether leading and trailing spaces should be ignored when determining
  7991. whether the revision has changed.
  7992. </summary>
  7993. <remarks>
  7994. <para>
  7995. This is equivalent to the <c>-b</c> parameter to the <c>pcli put</c> command.
  7996. </para>
  7997. </remarks>
  7998. </member>
  7999. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.KeepWorkfile">
  8000. <summary>
  8001. Gets or sets a value indicating whether the workfile should kept in its original state.
  8002. </summary>
  8003. <remarks>
  8004. <para>
  8005. This is equivalent to the <c>-k</c> parameter to the <c>pcli put</c> command.
  8006. </para>
  8007. </remarks>
  8008. </member>
  8009. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Location">
  8010. <summary>
  8011. Gets or sets an alternative location for workfiles.
  8012. </summary>
  8013. <remarks>
  8014. <para>
  8015. This is equivalent to the <c>-a</c> parameter to the <c>pcli put</c> command.
  8016. </para>
  8017. </remarks>
  8018. </member>
  8019. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Lock">
  8020. <summary>
  8021. Gets or sets a value indicating the files should be locked after the put operation.
  8022. </summary>
  8023. <remarks>
  8024. <para>
  8025. This is equivalent to the <c>-l</c> parameter to the <c>pcli put</c> command.
  8026. </para>
  8027. </remarks>
  8028. </member>
  8029. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.OverrideWorkfileLocation">
  8030. <summary>
  8031. Gets or sets a value indicating whether the workfile location for files should be overridden.
  8032. </summary>
  8033. <remarks>
  8034. <para>
  8035. This is equivalent to the <c>-o</c> parameter to the <c>pcli put</c> command.
  8036. </para>
  8037. </remarks>
  8038. </member>
  8039. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.PromotionGroup">
  8040. <summary>
  8041. Gets or sets the promotion in use. If a promotion group is specified, this option identifies the
  8042. promotion group to which the revision is currently assigned. If no promotion group is specified (ie.
  8043. this property is set to an empty string), this option indicates that one is not identifying the
  8044. revision by promotion group.
  8045. </summary>
  8046. <remarks>
  8047. <para>
  8048. This is equivalent to the <c>-g</c> parameter to the <c>pcli put</c> command.
  8049. </para>
  8050. </remarks>
  8051. </member>
  8052. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ReassignLabelIfExists">
  8053. <summary>
  8054. Gets or sets a value indicating whether the version label specified by <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>
  8055. should be reassigned if it already exists.
  8056. </summary>
  8057. <remarks>
  8058. <para>
  8059. This is equivalent to the <c>-yv</c> parameter to the <c>pcli put</c> command.
  8060. </para>
  8061. </remarks>
  8062. </member>
  8063. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Revision">
  8064. <summary>
  8065. Gets or sets the revision number to use for the new revision.
  8066. </summary>
  8067. <remarks>
  8068. <para>
  8069. This is equivalent to the <c>-r</c> parameter to the <c>pcli put</c> command.
  8070. </para>
  8071. </remarks>
  8072. </member>
  8073. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.UseSameDescription">
  8074. <summary>
  8075. Gets or sets a value indicating whether the same description should be used for all versioned items.
  8076. This is <c>true</c> by default.
  8077. </summary>
  8078. <remarks>
  8079. <para>
  8080. This is equivalent to the <c>-ym</c> parameter to the <c>pcli put</c> command.
  8081. </para>
  8082. </remarks>
  8083. </member>
  8084. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel">
  8085. <summary>
  8086. Gets or sets the version label to assign to the new revisions.
  8087. </summary>
  8088. <remarks>
  8089. <para>
  8090. This is equivalent to the <c>-v</c> parameter to the <c>pcli put</c> command.
  8091. </para>
  8092. </remarks>
  8093. </member>
  8094. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask">
  8095. <summary>
  8096. Renames a label in a PVCS repository.
  8097. </summary>
  8098. <remarks>
  8099. <para>
  8100. This task uses the <c>renamelabel</c> PCLI command to rename the label.
  8101. </para>
  8102. </remarks>
  8103. <example>
  8104. <para>
  8105. Renames the label on <c>App.ico</c> from <c>Beater</c> to <c>Beta</c> in the project database specified by
  8106. the <c>project-database</c> property.
  8107. </para>
  8108. <code>
  8109. <![CDATA[
  8110. <pvcsrenamelabel projectdatabase="${project-database}" from="Beater" to="Beta">
  8111. <entities>
  8112. <entity name="App.ico"/>
  8113. </entities>
  8114. </pvcsrenamelabel>
  8115. ]]>
  8116. </code>
  8117. </example>
  8118. <example>
  8119. <para>
  8120. Renames the label on all files from <c>Alfa</c> to <c>Alpha</c> in the project database specified by the
  8121. <c>project-database</c> property.
  8122. </para>
  8123. <code>
  8124. <![CDATA[
  8125. <pvcsrenamelabel projectdatabase="${project-database}" from="Alfa" to="Alpha" includesubprojects="true">
  8126. <entities>
  8127. <entity name="/"/>
  8128. </entities>
  8129. </pvcsrenamelabel>
  8130. ]]>
  8131. </code>
  8132. </example>
  8133. </member>
  8134. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask._from">
  8135. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.From"/>
  8136. </member>
  8137. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask._to">
  8138. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.To"/>
  8139. </member>
  8140. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  8141. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  8142. </member>
  8143. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.From">
  8144. <summary>
  8145. Gets or sets the existing label.
  8146. </summary>
  8147. <remarks>
  8148. <para>
  8149. This is equivalent to the <c>-vf</c> parameter to the <c>pcli renamelabel</c> command.
  8150. </para>
  8151. </remarks>
  8152. </member>
  8153. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.To">
  8154. <summary>
  8155. Gets or sets the new label.
  8156. </summary>
  8157. <remarks>
  8158. <para>
  8159. This is equivalent to the <c>-vt</c> parameter to the <c>pcli renamelabel</c> command.
  8160. </para>
  8161. </remarks>
  8162. </member>
  8163. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask">
  8164. <summary>
  8165. Unlocks revisions of versioned files in a PVCS repository.
  8166. </summary>
  8167. <remarks>
  8168. <para>
  8169. This task uses the <c>unlock</c> PCLI command to perform the unlock operation.
  8170. </para>
  8171. </remarks>
  8172. <example>
  8173. <para>
  8174. Unlocks <c>App.ico</c> in the project database specified by the <c>project-database</c> property.
  8175. </para>
  8176. <code>
  8177. <![CDATA[
  8178. <pvcsunlock projectdatabase="${project-database}">
  8179. <entities>
  8180. <entity name="/App.ico"/>
  8181. </entities>
  8182. </pvcsunlock>
  8183. ]]>
  8184. </code>
  8185. </example>
  8186. <example>
  8187. <para>
  8188. Unlocks all files in the project specified by the <c>project-database</c> property. Locks by all users are
  8189. removed.
  8190. </para>
  8191. <code>
  8192. <![CDATA[
  8193. <pvcsunlock projectdatabase="${project-database}" includesubprojects="true" unlockmode="AllUsers">
  8194. <entities>
  8195. <entity name="/"/>
  8196. </entities>
  8197. </pvcsunlock>
  8198. ]]>
  8199. </code>
  8200. </example>
  8201. </member>
  8202. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._revision">
  8203. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.Revision"/>
  8204. </member>
  8205. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._unlockMode">
  8206. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode"/>
  8207. </member>
  8208. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._user">
  8209. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.User"/>
  8210. </member>
  8211. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.#ctor">
  8212. <summary>
  8213. Constructs and initializes an instance of <c>PVCSUnlock</c>.
  8214. </summary>
  8215. </member>
  8216. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  8217. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  8218. </member>
  8219. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.Revision">
  8220. <summary>
  8221. Gets or sets the revision number to use for the new revision.
  8222. </summary>
  8223. <remarks>
  8224. <para>
  8225. This is equivalent to the <c>-r</c> parameter to the <c>pcli unlock</c> command.
  8226. </para>
  8227. </remarks>
  8228. </member>
  8229. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode">
  8230. <summary>
  8231. Gets or sets the unlock mode for the operation.
  8232. </summary>
  8233. <remarks>
  8234. <para>
  8235. This is equivalent to the <c>-u</c> parameter to the <c>pcli unlock</c> command.
  8236. </para>
  8237. </remarks>
  8238. </member>
  8239. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.User">
  8240. <summary>
  8241. Gets or sets the user whose locked files are to be unlocked. This is relevant only when
  8242. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode"/> is set to <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.SpecifiedUser"/>.
  8243. </summary>
  8244. </member>
  8245. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode">
  8246. <summary>
  8247. Specifies possible modes for the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask"/> task.
  8248. </summary>
  8249. </member>
  8250. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.CurrentUser">
  8251. <summary>
  8252. All locks held by the current user are removed.
  8253. </summary>
  8254. </member>
  8255. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.SpecifiedUser">
  8256. <summary>
  8257. All locks held by a specified user are removed.
  8258. </summary>
  8259. </member>
  8260. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.AllUsers">
  8261. <summary>
  8262. All locks held by all users are removed.
  8263. </summary>
  8264. </member>
  8265. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Add">
  8266. <summary>
  8267. Open file(s) in a client workspace for addition to the depot.
  8268. </summary>
  8269. <example>
  8270. <para>
  8271. Add all cs files under the given directory into the "new" changelist
  8272. (will be created if it doesn't already exist).
  8273. </para>
  8274. <code>
  8275. <![CDATA[
  8276. <p4add file="C:\Src\Project\*.cs" changelist="new" />
  8277. ]]>
  8278. </code>
  8279. </example>
  8280. <example>
  8281. <para>Add Test.txt into the default changelist.</para>
  8282. <code>
  8283. <![CDATA[
  8284. <p4add file="C:\Src\Project\Test.txt" />
  8285. ]]>
  8286. </code>
  8287. </example>
  8288. </member>
  8289. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Base">
  8290. <summary>
  8291. Base class for Perforce (P4) NAnt tasks. See individual task for example usage.
  8292. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Add">P4Add</seealso>
  8293. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Change">P4Change</seealso>
  8294. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Delete">P4Delete</seealso>
  8295. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Edit">P4Edit</seealso>
  8296. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Label">P4Label</seealso>
  8297. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Labelsync">P4Labelsync</seealso>
  8298. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Print">P4Print</seealso>
  8299. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Reopen">P4Reopen</seealso>
  8300. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Revert">P4Revert</seealso>
  8301. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Submit">P4Submit</seealso>
  8302. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Sync">P4Sync</seealso>
  8303. </summary>
  8304. </member>
  8305. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Base.ExecuteTask">
  8306. <summary>
  8307. Execute the perforce command assembled by subclasses.
  8308. </summary>
  8309. </member>
  8310. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Port">
  8311. <summary>
  8312. The p4 server and port to connect to. The default is "perforce:1666".
  8313. </summary>
  8314. </member>
  8315. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Client">
  8316. <summary>
  8317. The p4 client spec to use. The default is the current client.
  8318. </summary>
  8319. </member>
  8320. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.User">
  8321. <summary>
  8322. The p4 username. The default is the current user.
  8323. </summary>
  8324. </member>
  8325. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.View">
  8326. <summary>
  8327. The client, branch or label view to operate upon. The default is
  8328. "//...".
  8329. </summary>
  8330. </member>
  8331. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Script">
  8332. <summary>
  8333. Prepends a descriptive field (for example, text:, info:, error:, exit:)
  8334. to each line of output produced by a Perforce command. This is most
  8335. often used when scripting. The default is <see langword="false" />.
  8336. </summary>
  8337. </member>
  8338. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.ProgramArguments">
  8339. <summary>
  8340. Gets the command line arguments for the external program.
  8341. </summary>
  8342. <value>
  8343. The command line arguments for the external program.
  8344. </value>
  8345. </member>
  8346. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.ExeName">
  8347. <summary>
  8348. Override the ExeName paramater for p4.exe
  8349. </summary>
  8350. </member>
  8351. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.CommandSpecificArguments">
  8352. <summary>
  8353. Derived classes should override this to provide command-specific
  8354. commandline arguments.
  8355. </summary>
  8356. </member>
  8357. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Add.getSpecificCommandArguments">
  8358. <summary>
  8359. Build the command string for this particular command.
  8360. </summary>
  8361. <returns>
  8362. The command string for this particular command.
  8363. </returns>
  8364. </member>
  8365. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.File">
  8366. <summary>
  8367. File(s) to add. File name can contain wildcard characters. (Note:
  8368. this is not using p4 wildcard syntax, but the OS wildcards).
  8369. </summary>
  8370. </member>
  8371. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.Changelist">
  8372. <summary>
  8373. Changelist that files will be added into. Changelist will be created
  8374. if not already present.
  8375. </summary>
  8376. </member>
  8377. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.Type">
  8378. <summary>
  8379. File Type settings. Applied to all files in the <see cref="P:NAnt.Contrib.Tasks.Perforce.P4Add.File"/>
  8380. parameter.
  8381. </summary>
  8382. </member>
  8383. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.CommandSpecificArguments">
  8384. <summary>
  8385. This is an override used by the base class to get command specific args.
  8386. </summary>
  8387. </member>
  8388. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Change">
  8389. <summary>
  8390. Create or delete a changelist specification.
  8391. </summary>
  8392. <example>
  8393. <para>Create a new changelist called "mynewchange".</para>
  8394. <code>
  8395. <![CDATA[
  8396. <p4change changelist="mynewchange" />
  8397. ]]>
  8398. </code>
  8399. </example>
  8400. <example>
  8401. <para>Delete the changelist called "mynewchange".</para>
  8402. <code>
  8403. <![CDATA[
  8404. <p4change changelist="mynewchange" delete="true" />
  8405. ]]>
  8406. </code>
  8407. </example>
  8408. </member>
  8409. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Change.getSpecificCommandArguments">
  8410. <summary>
  8411. Builds the command string for this particular command.
  8412. </summary>
  8413. <returns>
  8414. The command string for this particular command.
  8415. </returns>
  8416. </member>
  8417. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.Changelist">
  8418. <summary>
  8419. Changelist to create or delete.
  8420. </summary>
  8421. </member>
  8422. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.Delete">
  8423. <summary>
  8424. If <see langword="false" /> causes passed in changelist to be
  8425. deleted. The default is <see langword="false" />.
  8426. </summary>
  8427. </member>
  8428. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.CommandSpecificArguments">
  8429. <summary>
  8430. This is an override used by the base class to get command specific args.
  8431. </summary>
  8432. </member>
  8433. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Client">
  8434. <summary>
  8435. Add/modify/delete a client spec in perforce.
  8436. </summary>
  8437. <example>
  8438. <para>
  8439. Add a client (modify if already present and have sufficient rights).
  8440. </para>
  8441. <code>
  8442. <![CDATA[
  8443. <p4client clientname="myClient" view="//root/test/..." />
  8444. ]]>
  8445. </code>
  8446. </example>
  8447. <example>
  8448. <para>Delete a client.</para>
  8449. <code>
  8450. <![CDATA[
  8451. <p4client delete="true" clientname="myClient" />
  8452. ]]>
  8453. </code>
  8454. </example>
  8455. </member>
  8456. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Client.getSpecificCommandArguments">
  8457. <summary>
  8458. Builds the command string for this particular command.
  8459. </summary>
  8460. <returns>
  8461. The command string for this particular command.
  8462. </returns>
  8463. </member>
  8464. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.ClientName">
  8465. <summary>
  8466. Name of client to create/delete.
  8467. </summary>
  8468. </member>
  8469. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Root">
  8470. <summary>
  8471. Root path for client spec.
  8472. </summary>
  8473. </member>
  8474. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Delete">
  8475. <summary>
  8476. Delete the named client. The default is <see langword="false" />.
  8477. </summary>
  8478. </member>
  8479. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Force">
  8480. <summary>
  8481. Force a delete even if files are open. The default is
  8482. <see langword="false" />.
  8483. </summary>
  8484. </member>
  8485. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.CommandSpecificArguments">
  8486. <summary>
  8487. This is an override used by the base class to get command specific args.
  8488. </summary>
  8489. </member>
  8490. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Delete">
  8491. <summary>
  8492. Open file(s) in a client workspace for deletion from the depot.
  8493. </summary>
  8494. <example>
  8495. <para>
  8496. Mark all cs files under the give view for deletion and place them in
  8497. the "Deleting" changelist.
  8498. </para>
  8499. <code>
  8500. <![CDATA[
  8501. <p4delete view="//Root/ProjectX/Test/...*.cs" changelist="Deleting" />
  8502. ]]>
  8503. </code>
  8504. </example>
  8505. </member>
  8506. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Delete.getSpecificCommandArguments">
  8507. <summary>
  8508. Builds the command string for this particular command.
  8509. </summary>
  8510. <returns>
  8511. The command string for this particular command.
  8512. </returns>
  8513. </member>
  8514. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.Changelist">
  8515. <summary>
  8516. Changelist to place the marked for deletion item into.
  8517. </summary>
  8518. </member>
  8519. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.View">
  8520. <summary>
  8521. The client, branch or label view to operate upon.
  8522. </summary>
  8523. </member>
  8524. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.CommandSpecificArguments">
  8525. <summary>
  8526. This is an override used by the base class to get command specific args.
  8527. </summary>
  8528. </member>
  8529. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Edit">
  8530. <summary>
  8531. Opens file(s) in a client workspace for edit.
  8532. </summary>
  8533. <example>
  8534. <para>
  8535. Open all files in the ProjectX Test folder for edit, and place into
  8536. the default changelist.
  8537. </para>
  8538. <code>
  8539. <![CDATA[
  8540. <p4edit view="//Root/ProjectX/Test/..." />
  8541. ]]>
  8542. </code>
  8543. </example>
  8544. <example>
  8545. <para>
  8546. Open all *.txt files in the ProjectX Test folder for edit, and place
  8547. into the "testing" changelist.
  8548. </para>
  8549. <code>
  8550. <![CDATA[
  8551. <p4edit view="//Root/ProjectX/Test/...*.txt" changelist="testing" />
  8552. ]]>
  8553. </code>
  8554. </example>
  8555. </member>
  8556. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Edit.getSpecificCommandArguments">
  8557. <summary>
  8558. Builds the command string for this particular command.
  8559. </summary>
  8560. <returns>
  8561. The command string for this particular command.
  8562. </returns>
  8563. </member>
  8564. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.Changelist">
  8565. <summary>
  8566. Changelist to place the opened files into.
  8567. </summary>
  8568. </member>
  8569. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.Type">
  8570. <summary>
  8571. File Type settings.
  8572. </summary>
  8573. </member>
  8574. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.View">
  8575. <summary>
  8576. The client, branch or label view to operate upon.
  8577. </summary>
  8578. </member>
  8579. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.CommandSpecificArguments">
  8580. <summary>
  8581. This is an override used by the base class to get command specific args.
  8582. </summary>
  8583. </member>
  8584. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Info">
  8585. <summary>
  8586. Returns information from the "p4 info" command back into variables for
  8587. use within the build process.
  8588. </summary>
  8589. <example>
  8590. <para>Fill the variables using the task.</para>
  8591. <code>
  8592. <![CDATA[
  8593. <p4info user="myuser" client="myclient" host="myhost" root="myroot" />
  8594. <echo message="User: ${myuser} - Client: ${myclient} - Host: ${myhost} - Root: ${myroot}" />
  8595. ]]>
  8596. </code>
  8597. </example>
  8598. </member>
  8599. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.User">
  8600. <summary>
  8601. The name of the property to store the p4 user name in.
  8602. </summary>
  8603. </member>
  8604. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Client">
  8605. <summary>
  8606. The name of the property to store the p4 client name in.
  8607. </summary>
  8608. </member>
  8609. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Host">
  8610. <summary>
  8611. The name of the property to store the p4 host name in.
  8612. </summary>
  8613. </member>
  8614. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Root">
  8615. <summary>
  8616. The name of the property to store the p4 client root in.
  8617. </summary>
  8618. </member>
  8619. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Label">
  8620. <summary>
  8621. Create or edit a label specification and its view.
  8622. </summary>
  8623. <example>
  8624. <para>Create a new label called "SDK_V1.2".</para>
  8625. <code>
  8626. <![CDATA[
  8627. <p4label label="SDK_V1.2" view="//Root/ProjectX/Test/...*.txt" />
  8628. ]]>
  8629. </code>
  8630. </example>
  8631. <example>
  8632. <para>Delete the previously created label.</para>
  8633. <code>
  8634. <![CDATA[
  8635. <p4label label="SDK_V1.2" delete="true" />
  8636. ]]>
  8637. </code>
  8638. </example>
  8639. </member>
  8640. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Label.getSpecificCommandArguments">
  8641. <summary>
  8642. Builds the command string for this particular command.
  8643. </summary>
  8644. <returns>
  8645. The command string for this particular command.
  8646. </returns>
  8647. </member>
  8648. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.Label">
  8649. <summary>
  8650. Name of label to create/delete.
  8651. </summary>
  8652. </member>
  8653. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.Delete">
  8654. <summary>
  8655. Delete the named label. The default is <see langword="false" />.
  8656. </summary>
  8657. </member>
  8658. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.CommandSpecificArguments">
  8659. <summary>
  8660. This is an override used by the base class to get command specific args.
  8661. </summary>
  8662. </member>
  8663. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Labelsync">
  8664. <summary>
  8665. Synchronize a label with the contents of the current client workspace.
  8666. </summary>
  8667. <example>
  8668. <para>Apply a previously created label to the specified view.</para>
  8669. <code>
  8670. <![CDATA[
  8671. <p4labelsync label="SDK_V1.2" view="//Root/..." />
  8672. ]]>
  8673. </code>
  8674. </example>
  8675. </member>
  8676. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Labelsync.getSpecificCommandArguments">
  8677. <summary>
  8678. Builds the command string for this particular command.
  8679. </summary>
  8680. <returns>
  8681. The command string for this particular command.
  8682. </returns>
  8683. </member>
  8684. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.Label">
  8685. <summary>
  8686. Name of the label to sync the specified or default view with.
  8687. </summary>
  8688. </member>
  8689. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.Delete">
  8690. <summary>
  8691. Delete the view defined in the label, or matching the input view
  8692. from the label. The default is <see langword="false" />.
  8693. </summary>
  8694. </member>
  8695. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.CommandSpecificArguments">
  8696. <summary>
  8697. This is an override used by the base class to get command specific args.
  8698. </summary>
  8699. </member>
  8700. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Print">
  8701. <summary>
  8702. Fetch a specific file from a Perforce depot without needing a clientspec
  8703. to map it.
  8704. </summary>
  8705. <example>
  8706. <code>
  8707. <![CDATA[
  8708. <p4print file="//depot/foo/mainline/clientspec" outputfile=".\clientspec" />
  8709. <p4client input=".\clientspec" />
  8710. ]]>
  8711. </code>
  8712. </example>
  8713. </member>
  8714. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Print.getSpecificCommandArguments">
  8715. <summary>
  8716. Builds the command string for this particular command.
  8717. </summary>
  8718. <returns>
  8719. The command string for this particular command.
  8720. </returns>
  8721. </member>
  8722. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.File">
  8723. <summary>
  8724. The depot or local filename (including optional path) of the file
  8725. to fetch.
  8726. </summary>
  8727. </member>
  8728. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.P4OutputFile">
  8729. <summary>
  8730. The local filename to write the fetched file to.
  8731. </summary>
  8732. </member>
  8733. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.CommandSpecificArguments">
  8734. <summary>
  8735. This is an override used by the base class to get command specific args.
  8736. </summary>
  8737. </member>
  8738. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Reopen">
  8739. <summary>
  8740. Move opened files between changelists or change the files’ type.
  8741. </summary>
  8742. <remarks>
  8743. This task has two different but related uses:
  8744. Moving opened files between changelists (default or named).
  8745. Changing the type of an opened file.
  8746. </remarks>
  8747. <example>
  8748. <para>
  8749. Move the specified files matching the view into the "New" changelist.
  8750. </para>
  8751. <code>
  8752. <![CDATA[
  8753. <p4reopen view="//Root/...Version.xml" changelist="New" />
  8754. ]]>
  8755. </code>
  8756. </example>
  8757. <example>
  8758. <para>
  8759. Modify the specified files matching the view to the given file type.
  8760. The change won't affect the repository until submitted.
  8761. </para>
  8762. <code>
  8763. <![CDATA[
  8764. <p4reopen view="//Root/...*.res" type="binary" />
  8765. ]]>
  8766. </code>
  8767. </example>
  8768. </member>
  8769. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Reopen.getSpecificCommandArguments">
  8770. <summary>
  8771. Builds the command string for this particular command.
  8772. </summary>
  8773. <returns>
  8774. The command string for this particular command.
  8775. </returns>
  8776. </member>
  8777. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.View">
  8778. <summary>
  8779. The client, branch or label view to operate upon.
  8780. </summary>
  8781. </member>
  8782. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.Changelist">
  8783. <summary>
  8784. Changelist to place the reopened files into.
  8785. </summary>
  8786. </member>
  8787. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.Type">
  8788. <summary>
  8789. File Type settings.
  8790. </summary>
  8791. </member>
  8792. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.CommandSpecificArguments">
  8793. <summary>
  8794. This is an override used by the base class to get command specific args.
  8795. </summary>
  8796. </member>
  8797. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Revert">
  8798. <summary>
  8799. Discard changes made to open files.
  8800. </summary>
  8801. <example>
  8802. <para>Revert all txt files in a given changelist.</para>
  8803. <code>
  8804. <![CDATA[
  8805. <p4revert changelist="Test" view="//...*.txt" />
  8806. ]]>
  8807. </code>
  8808. </example>
  8809. <example>
  8810. <para>
  8811. Revert all unchanged files opened in the given changelist.
  8812. </para>
  8813. <code>
  8814. <![CDATA[
  8815. <p4revert changelist="Test" revertunchanged="true" />
  8816. ]]>
  8817. </code>
  8818. </example>
  8819. <example>
  8820. <para>Revert all unchanged files opened in any changelist.</para>
  8821. <code>
  8822. <![CDATA[
  8823. <p4revert revertunchanged="true" />
  8824. ]]>
  8825. </code>
  8826. </example>
  8827. </member>
  8828. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Revert.getSpecificCommandArguments">
  8829. <summary>
  8830. Builds the command string for this particular command.
  8831. </summary>
  8832. <returns>
  8833. The command string for this particular command.
  8834. </returns>
  8835. </member>
  8836. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.Changelist">
  8837. <summary>
  8838. Changelist to perform the revert action on. optional.
  8839. </summary>
  8840. </member>
  8841. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.RevertUnchanged">
  8842. <summary>
  8843. Revert all unchanged or missing files from the changelist. default is false. optional.
  8844. </summary>
  8845. </member>
  8846. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.CommandSpecificArguments">
  8847. <summary>
  8848. This is an override used by the base class to get command specific args.
  8849. </summary>
  8850. </member>
  8851. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Set">
  8852. <summary>
  8853. Set registry variables that perforce uses.
  8854. </summary>
  8855. <remarks>
  8856. Note: the environment variables that p4 uses will be set, but will not
  8857. be validated.
  8858. </remarks>
  8859. <example>
  8860. <para>Modify any of the three variables (at least one required).</para>
  8861. <code>
  8862. <![CDATA[
  8863. <p4set client="myClient" user="jonb" port="server:1666" />
  8864. ]]>
  8865. </code>
  8866. </example>
  8867. </member>
  8868. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Set.getSpecificCommandArguments">
  8869. <summary>
  8870. Builds the command string for this particular command.
  8871. </summary>
  8872. <returns>
  8873. The command string for this particular command.
  8874. </returns>
  8875. </member>
  8876. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Set.CommandSpecificArguments">
  8877. <summary>
  8878. This is an override used by the base class to get command specific args.
  8879. </summary>
  8880. </member>
  8881. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Submit">
  8882. <summary>
  8883. Send changes made to open files to the depot.
  8884. </summary>
  8885. <example>
  8886. <para>
  8887. Submit changelist "Temp", but first revert all unchanged files in the
  8888. changelist.
  8889. </para>
  8890. <code>
  8891. <![CDATA[
  8892. <p4submit changelist="Temp" revertunchanged="true" />
  8893. ]]>
  8894. </code>
  8895. </example>
  8896. <example>
  8897. <para>Submit changelist, but leave the files open afterwards.</para>
  8898. <code>
  8899. <![CDATA[
  8900. <p4submit changelist="Temp" remainopen="true" />
  8901. ]]>
  8902. </code>
  8903. </example>
  8904. </member>
  8905. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Submit.getSpecificCommandArguments">
  8906. <summary>
  8907. Builds the command string for this particular command.
  8908. </summary>
  8909. <returns>
  8910. The command string for this particular command.
  8911. </returns>
  8912. </member>
  8913. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.Changelist">
  8914. <summary>
  8915. Changelist to submit.
  8916. </summary>
  8917. </member>
  8918. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.RemainOpen">
  8919. <summary>
  8920. Keep the files open after submitting. The default is
  8921. <see langword="false" />.
  8922. </summary>
  8923. </member>
  8924. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.RevertUnchanged">
  8925. <summary>
  8926. Revert all unchanged or missing files from the changelist.
  8927. The default is <see langword="false" />.
  8928. </summary>
  8929. </member>
  8930. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.CommandSpecificArguments">
  8931. <summary>
  8932. This is an override used by the base class to get command specific args.
  8933. </summary>
  8934. </member>
  8935. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Sync">
  8936. <summary>
  8937. Synchronize client space to a Perforce depot view.
  8938. </summary>
  8939. <example>
  8940. <para>
  8941. Sync to head using P4USER, P4PORT and P4CLIENT settings specified.
  8942. </para>
  8943. <code>
  8944. <![CDATA[
  8945. <p4sync
  8946. view="//projects/foo/main/source/..."
  8947. user="fbloggs"
  8948. port="km01:1666"
  8949. client="fbloggsclient"
  8950. />
  8951. ]]>
  8952. </code>
  8953. </example>
  8954. <example>
  8955. <para>Sync to head using default p4 environment variables.</para>
  8956. <code>
  8957. <![CDATA[
  8958. <p4sync view="//projects/foo/main/source/..." />
  8959. ]]>
  8960. </code>
  8961. </example>
  8962. <example>
  8963. <para>Force a re-sync to head, refreshing all files.</para>
  8964. <code>
  8965. <![CDATA[
  8966. <p4sync force="true" view="//projects/foo/main/source/..." />
  8967. ]]>
  8968. </code>
  8969. </example>
  8970. <example>
  8971. <para>Sync to a label.</para>
  8972. <code>
  8973. <![CDATA[
  8974. <p4sync label="myPerforceLabel" />
  8975. ]]>
  8976. </code>
  8977. </example>
  8978. </member>
  8979. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Sync.getSpecificCommandArguments">
  8980. <summary>
  8981. Builds the command string for this particular command.
  8982. </summary>
  8983. <returns>
  8984. The command string for this particular command.
  8985. </returns>
  8986. </member>
  8987. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.Label">
  8988. <summary> Label to sync client to; optional.
  8989. </summary>
  8990. </member>
  8991. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.Force">
  8992. <summary>
  8993. Force a refresh of files. The default is <see langword="false" />.
  8994. </summary>
  8995. </member>
  8996. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.CommandSpecificArguments">
  8997. <summary>
  8998. This is an override used by the base class to get command specific args.
  8999. </summary>
  9000. </member>
  9001. <member name="T:NAnt.Contrib.Tasks.Perforce.Perforce">
  9002. <summary>
  9003. Static helper class for Perforce tasks.
  9004. </summary>
  9005. </member>
  9006. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetUserName">
  9007. <summary>
  9008. ask p4 for the user name
  9009. </summary>
  9010. <returns></returns>
  9011. </member>
  9012. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetClient">
  9013. <summary>
  9014. ask p4 for the client name
  9015. </summary>
  9016. <returns></returns>
  9017. </member>
  9018. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetChangelistNumber(System.String,System.String,System.String,System.Boolean)">
  9019. <summary>
  9020. Get a changelist number based on on its name
  9021. </summary>
  9022. <param name="User"></param>
  9023. <param name="Client"></param>
  9024. <param name="ChangeList"></param>
  9025. <param name="CreateIfMissing"></param>
  9026. <returns></returns>
  9027. </member>
  9028. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetChangelistNumber(System.String,System.String,System.String)">
  9029. <summary>
  9030. Get a changelist number based on on its name
  9031. </summary>
  9032. <param name="User"></param>
  9033. <param name="Client"></param>
  9034. <param name="ChangeList"></param>
  9035. <returns></returns>
  9036. </member>
  9037. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateLabel(System.String,System.String,System.String)">
  9038. <summary>
  9039. Create a new label
  9040. </summary>
  9041. <param name="User"></param>
  9042. <param name="Labelname"></param>
  9043. <param name="View"></param>
  9044. </member>
  9045. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateClient(System.String,System.String,System.String,System.String)">
  9046. <summary>
  9047. Create a new Client
  9048. </summary>
  9049. <param name="User"></param>
  9050. <param name="Clientname"></param>
  9051. <param name="Root"></param>
  9052. <param name="View"></param>
  9053. </member>
  9054. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateChangelist(System.String,System.String,System.String)">
  9055. <summary>
  9056. Create a new changelist
  9057. </summary>
  9058. <param name="User"></param>
  9059. <param name="Client"></param>
  9060. <param name="ChangeList">Description of Changelist</param>
  9061. <returns></returns>
  9062. </member>
  9063. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetP4Info(System.String)">
  9064. <summary>
  9065. call the p4 process to
  9066. </summary>
  9067. <param name="SearchPattern"></param>
  9068. <returns></returns>
  9069. </member>
  9070. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetP4Info(System.String[])">
  9071. <summary>
  9072. call the p4 process to
  9073. </summary>
  9074. <param name="SearchPatterns"></param>
  9075. <returns></returns>
  9076. </member>
  9077. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.getProcessOutput(System.String,System.String,System.String)">
  9078. <summary>
  9079. Execute a process and return its ourput
  9080. </summary>
  9081. <param name="exe"></param>
  9082. <param name="prms"></param>
  9083. <param name="input"></param>
  9084. <returns></returns>
  9085. </member>
  9086. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.RunProcess(System.String,System.String,System.String,System.String@)">
  9087. <summary>
  9088. Execute a process and return its ourput
  9089. </summary>
  9090. <param name="exe"></param>
  9091. <param name="prms"></param>
  9092. <param name="input"></param>
  9093. <param name="output"></param>
  9094. <returns></returns>
  9095. </member>
  9096. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.RunProcess(System.String,System.String,System.String)">
  9097. <summary>
  9098. Execute a process by name
  9099. </summary>
  9100. <param name="exe"></param>
  9101. <param name="prms"></param>
  9102. <param name="input"></param>
  9103. <returns></returns>
  9104. </member>
  9105. <member name="T:NAnt.Contrib.Tasks.SourceSafe.AddTask">
  9106. <summary>
  9107. Used to add files to a Visual SourceSafe database. If the file is currently
  9108. in the SourceSafe database a message will be logged but files will continue to be added.
  9109. </summary>
  9110. <remarks>
  9111. This version does not support recursive adds. Only adds in the root directory will be added to the
  9112. SourceSafe database.
  9113. </remarks>
  9114. <example>
  9115. <code><![CDATA[
  9116. <vssadd dbpath="C:\SourceSafeFolder\srcsafe.ini" user="user1" password="" path="$/Somefolder">
  9117. <fileset basedir="C:\SourceFolder\">
  9118. <include name="*.dll"/>
  9119. </fileset>
  9120. </vssadd>
  9121. ]]></code>
  9122. </example>
  9123. </member>
  9124. <member name="T:NAnt.Contrib.Tasks.SourceSafe.BaseTask">
  9125. <summary>
  9126. The base abstract class for all Visual Source Safe Tasks.
  9127. Provides the core attributes, and functionality for opening an item
  9128. in a Visual Source Safe database.
  9129. </summary>
  9130. </member>
  9131. <member name="M:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Open">
  9132. <summary>
  9133. Opens the Source Safe database and sets the reference to the specified
  9134. item and version.
  9135. </summary>
  9136. </member>
  9137. <member name="M:NAnt.Contrib.Tasks.SourceSafe.BaseTask.GetFileTimestampFlags(NAnt.Contrib.Tasks.SourceSafe.FileTimestamp)">
  9138. <summary>
  9139. Gets the <see cref="T:SourceSafeTypeLib.VSSFlags"/> value corresponding with the
  9140. specified <see cref="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp"/>.
  9141. </summary>
  9142. <param name="timestamp">A <see cref="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp"/>.</param>
  9143. <returns>
  9144. An <see cref="T:System.Int32"/> representing the <see cref="T:SourceSafeTypeLib.VSSFlags"/> value
  9145. for the <paramref name="timestamp"/>.
  9146. </returns>
  9147. </member>
  9148. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.DBPath">
  9149. <summary>
  9150. The path to the folder that contains "srcsafe.ini".
  9151. </summary>
  9152. </member>
  9153. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Path">
  9154. <summary>
  9155. The Visual SourceSafe project or file path you wish the perform the
  9156. action on (starting with "$/").
  9157. </summary>
  9158. </member>
  9159. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Password">
  9160. <summary>
  9161. The password to use to login to the SourceSafe database.
  9162. </summary>
  9163. </member>
  9164. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName">
  9165. <summary>
  9166. The name of the user needed to access the Visual SourceSafe database.
  9167. When no <see cref="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName"/> is specified and "Use network
  9168. name for automatic user log in" is enabled for the Visual SourceSafe
  9169. database, then the current Windows username will be used to log in.
  9170. </summary>
  9171. </member>
  9172. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Login">
  9173. <summary>
  9174. The name of the user needed to access the Visual SourceSafe database.
  9175. When no <see cref="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName"/> is specified and "Use network
  9176. name for automatic user log in" is enabled, then the current
  9177. Windows username will be used to log in.
  9178. </summary>
  9179. </member>
  9180. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Version">
  9181. <summary>
  9182. A version of the path to reference. Accepts multiple forms,
  9183. including the label, version number, or date of the version.
  9184. If omitted, the latest version is used.
  9185. </summary>
  9186. </member>
  9187. <member name="M:NAnt.Contrib.Tasks.SourceSafe.AddTask.ExecuteTask">
  9188. <summary>
  9189. Main task execution method
  9190. </summary>
  9191. </member>
  9192. <member name="M:NAnt.Contrib.Tasks.SourceSafe.AddTask.CreateProjectPath(System.String)">
  9193. <summary>
  9194. Create project hierarchy in vss
  9195. </summary>
  9196. <param name="file"></param>
  9197. <returns></returns>
  9198. </member>
  9199. <member name="P:NAnt.Contrib.Tasks.SourceSafe.AddTask.Comment">
  9200. <summary>
  9201. Places a comment on all files added into the SourceSafe repository.
  9202. </summary>
  9203. </member>
  9204. <member name="P:NAnt.Contrib.Tasks.SourceSafe.AddTask.AddFileSet">
  9205. <summary>
  9206. List of files that should be added to SourceSafe.
  9207. </summary>
  9208. </member>
  9209. <member name="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp">
  9210. <summary>
  9211. Defines how the local timestamp of files retrieved from a SourceSafe
  9212. database should be set.
  9213. </summary>
  9214. </member>
  9215. <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Current">
  9216. <summary>
  9217. The timestamp of the local file is set to the current date and time.
  9218. </summary>
  9219. </member>
  9220. <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Modified">
  9221. <summary>
  9222. The timestamp of the local file is set to the file's last
  9223. modification date and time.
  9224. </summary>
  9225. </member>
  9226. <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Updated">
  9227. <summary>
  9228. The timestamp of the local file is set to the date and time that
  9229. the file was last checked in to the database.
  9230. </summary>
  9231. </member>
  9232. <member name="T:NAnt.Contrib.Tasks.SourceSafe.CheckinTask">
  9233. <summary>
  9234. Used to checkin files into Visual Source Safe.
  9235. </summary>
  9236. <example>
  9237. <para>Checkin all files from an absolute directory to a local sourcesafe database.</para>
  9238. <code><![CDATA[
  9239. <vsscheckin
  9240. user="myusername"
  9241. password="mypassword"
  9242. localpath="C:\Dev\Latest"
  9243. recursive="true"
  9244. writable="true"
  9245. dbpath="C:\VSS\srcsafe.ini"
  9246. path="$/MyProduct"
  9247. comment="NAnt checkin"
  9248. />
  9249. ]]></code>
  9250. </example>
  9251. <example>
  9252. <para>Checkin a file from a relative directory to a remote sourcesafe database.</para>
  9253. <code><![CDATA[
  9254. <vsscheckin
  9255. user="myusername"
  9256. password="mypassword"
  9257. localpath="Latest\myFile.cs"
  9258. recursive="false"
  9259. writable="true"
  9260. dbpath="\\MyServer\VSS\srcsafe.ini"
  9261. path="$/MyProduct/myFile.cs"
  9262. comment="NAnt checkin"
  9263. />
  9264. ]]></code>
  9265. </example>
  9266. </member>
  9267. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Comment">
  9268. <summary>
  9269. The comment for the new version.
  9270. </summary>
  9271. </member>
  9272. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.LocalPath">
  9273. <summary>
  9274. The path to the local working directory.
  9275. </summary>
  9276. </member>
  9277. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Recursive">
  9278. <summary>
  9279. Determines whether to perform a recursive checkin.
  9280. The default is <see langword="true" />.
  9281. </summary>
  9282. </member>
  9283. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Writable">
  9284. <summary>
  9285. Determines whether to leave the file(s) as writable.
  9286. The default is <see langword="false" />.
  9287. </summary>
  9288. </member>
  9289. <member name="T:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask">
  9290. <summary>
  9291. Task used to checkout files from Visual Source Safe.
  9292. </summary>
  9293. <example>
  9294. <para>Checkout the latest files from a local sourcesafe database.</para>
  9295. <code><![CDATA[
  9296. <vsscheckout
  9297. user="myusername"
  9298. password="mypassword"
  9299. localpath="C:\Dev\Latest"
  9300. recursive="true"
  9301. writable="true"
  9302. dbpath="C:\VSS\srcsafe.ini"
  9303. path="$/MyProduct"
  9304. />
  9305. ]]></code>
  9306. </example>
  9307. <example>
  9308. <para>Checkout a file from a remote sourcesafe database. Put it in a relative directory.</para>
  9309. <code><![CDATA[
  9310. <vsscheckout
  9311. user="myusername"
  9312. password="mypassword"
  9313. localpath="Latest"
  9314. recursive="false"
  9315. writable="true"
  9316. dbpath="\\MyServer\VSS\srcsafe.ini"
  9317. path="$/MyProduct/myFile.cs"
  9318. />
  9319. ]]></code>
  9320. </example>
  9321. </member>
  9322. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.LocalPath">
  9323. <summary>
  9324. The path to the local working directory.
  9325. </summary>
  9326. </member>
  9327. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.Recursive">
  9328. <summary>
  9329. Determines whether to perform a recursive checkout.
  9330. The default is <see langword="true" />.
  9331. </summary>
  9332. </member>
  9333. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.Writable">
  9334. <summary>
  9335. Determines whether to leave the file(s) as writable.
  9336. The default is <see langword="true" />.
  9337. </summary>
  9338. </member>
  9339. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.FileTimestamp">
  9340. <summary>
  9341. Set the behavior for timestamps of local files. The default is
  9342. <see cref="F:FileTimestamp.Current" />.
  9343. </summary>
  9344. </member>
  9345. <member name="T:NAnt.Contrib.Tasks.SourceSafe.DeleteTask">
  9346. <summary>
  9347. Used to delete or Destroy files or projects in Visual Source Safe.
  9348. </summary>
  9349. <example>
  9350. <para>Delete a project from a local sourcesafe database.</para>
  9351. <code><![CDATA[
  9352. <vssdelete
  9353. user="myusername"
  9354. password="mypassword"
  9355. dbpath="C:\VSS\srcsafe.ini"
  9356. path="$/MyProduct"
  9357. />
  9358. ]]></code>
  9359. </example>
  9360. <example>
  9361. <para>Delete a file from the remote sourcesafe database.</para>
  9362. <code><![CDATA[
  9363. <vsscheckin
  9364. user="myusername"
  9365. password="mypassword"
  9366. dbpath="\\MyServer\VSS\srcsafe.ini"
  9367. path="$/MyProduct/myFile.cs"
  9368. />
  9369. ]]></code>
  9370. </example>
  9371. <example>
  9372. <para>Destroy a project from a local sourcesafe database.</para>
  9373. <code><![CDATA[
  9374. <vssdelete
  9375. user="myusername"
  9376. password="mypassword"
  9377. dbpath="C:\VSS\srcsafe.ini"
  9378. path="$/MyProduct"
  9379. Destroy="true"
  9380. />
  9381. ]]></code>
  9382. </example>
  9383. <example>
  9384. <para>Destroy a file from the remote sourcesafe database.</para>
  9385. <code><![CDATA[
  9386. <vssdelete
  9387. user="myusername"
  9388. password="mypassword"
  9389. dbpath="\\MyServer\VSS\srcsafe.ini"
  9390. path="$/MyProduct/myFile.cs"
  9391. Destroy="true"
  9392. />
  9393. ]]></code>
  9394. </example>
  9395. </member>
  9396. <member name="M:NAnt.Contrib.Tasks.SourceSafe.DeleteTask.DeleteItem">
  9397. <summary>
  9398. Deletes the item unless <see cref="P:NAnt.Contrib.Tasks.SourceSafe.DeleteTask.Destroy"/> is <see langword="true"/>
  9399. then the item is destroyed.
  9400. </summary>
  9401. </member>
  9402. <member name="P:NAnt.Contrib.Tasks.SourceSafe.DeleteTask.Destroy">
  9403. <summary>
  9404. Determines whether or not the item is Destroyed.
  9405. The default is <see langword="false" />.
  9406. </summary>
  9407. </member>
  9408. <member name="T:NAnt.Contrib.Tasks.SourceSafe.DiffTask">
  9409. <summary>
  9410. Used to generate differences in a vss database. It will show all changes to a project
  9411. after the specified label.
  9412. </summary>
  9413. <remarks>
  9414. This only shows differences between the current version and the version specified.
  9415. </remarks>
  9416. <example>
  9417. <code><![CDATA[
  9418. <vssdiff
  9419. dbpath='ss.ini'
  9420. path='$/My Project'
  9421. label='My Label'
  9422. user='ssuser'
  9423. outputfile='diff.xml'
  9424. />
  9425. ]]></code>
  9426. </example>
  9427. </member>
  9428. <member name="P:NAnt.Contrib.Tasks.SourceSafe.DiffTask.Label">
  9429. <summary>
  9430. The value of the label to compare to. Required.
  9431. </summary>
  9432. </member>
  9433. <member name="P:NAnt.Contrib.Tasks.SourceSafe.DiffTask.OutputFile">
  9434. <summary>
  9435. The output file to generate (xml)
  9436. </summary>
  9437. </member>
  9438. <member name="T:NAnt.Contrib.Tasks.SourceSafe.GetTask">
  9439. <summary>
  9440. Used to retrieve an item or project from a Visual Source Safe database.
  9441. </summary>
  9442. <example>
  9443. <para>Get the latest files from a local sourcesafe database.</para>
  9444. <code><![CDATA[
  9445. <vssget
  9446. user="myusername"
  9447. password="mypassword"
  9448. localpath="C:\Dev\Latest"
  9449. recursive="true"
  9450. replace="true"
  9451. writable="true"
  9452. dbpath="C:\VSS\srcsafe.ini"
  9453. path="$/MyProduct"
  9454. />
  9455. ]]></code>
  9456. </example>
  9457. <example>
  9458. <para>Get the latest version of a file from a remote sourcesafe database. Put it in a relative directory.</para>
  9459. <code><![CDATA[
  9460. <vssget
  9461. user="myusername"
  9462. password="mypassword"
  9463. localpath="Latest"
  9464. recursive="true"
  9465. replace="true"
  9466. writable="true"
  9467. dbpath="\\MyServer\VSS\srcsafe.ini"
  9468. path="$/MyProduct/myFile.cs"
  9469. />
  9470. ]]></code>
  9471. </example>
  9472. <example>
  9473. <para>Get the latest version of a file from a remote sourcesafe database. Remove any deleted files from local image.</para>
  9474. <code><![CDATA[
  9475. <vssget
  9476. user="myusername"
  9477. password="mypassword"
  9478. localpath="C:\Dev\Latest"
  9479. recursive="true"
  9480. replace="true"
  9481. writable="true"
  9482. removedeleted="true"
  9483. dbpath="\\MyServer\VSS\srcsafe.ini"
  9484. path="$/MyProduct/myFile.cs"
  9485. />
  9486. ]]></code>
  9487. </example>
  9488. </member>
  9489. <member name="M:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeletedFromLocalImage">
  9490. <summary>
  9491. Checks to see if we should remove local copies of deleted files, and starts
  9492. the scan.
  9493. </summary>
  9494. </member>
  9495. <member name="M:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeletedFromLocalImage(SourceSafeTypeLib.IVSSItem,System.String)">
  9496. <summary>
  9497. Scans the Project Item for deleted files and removes their local
  9498. copies from the local image of the project. Obeys the recursive setting
  9499. (and thus optionally calls itself recursively).
  9500. </summary>
  9501. <param name="item">The VSS Item (project) to check for deletions</param>
  9502. <param name="localPathPrefix">The path to the folder of the item being processed</param>
  9503. </member>
  9504. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.LocalPath">
  9505. <summary>
  9506. The path to the local working directory.
  9507. </summary>
  9508. </member>
  9509. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Recursive">
  9510. <summary>
  9511. Determines whether to perform the get recursively.
  9512. The default is <see langword="true" />.
  9513. </summary>
  9514. </member>
  9515. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Replace">
  9516. <summary>
  9517. Determines whether to replace writable files.
  9518. The default is <see langword="false" />.
  9519. </summary>
  9520. </member>
  9521. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Writable">
  9522. <summary>
  9523. Determines whether the files will be writable.
  9524. The default is <see langword="false" />.
  9525. </summary>
  9526. </member>
  9527. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeleted">
  9528. <summary>
  9529. If <see cref="T:System.IO.Path"/> refers to a project, determines whether files
  9530. marked "deleted" in the repository will be removed from the local
  9531. copy. The default is <see langword="false"/>.
  9532. </summary>
  9533. </member>
  9534. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.UseModificationTime">
  9535. <summary>
  9536. Determines whether the timestamp on the local copy
  9537. will be the modification time (if false or omitted,
  9538. the checkout time will be used)
  9539. </summary>
  9540. </member>
  9541. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.FileTimestamp">
  9542. <summary>
  9543. Set the behavior for timestamps of local files. The default is
  9544. <see cref="F:FileTimestamp.Current" />.
  9545. </summary>
  9546. </member>
  9547. <member name="T:NAnt.Contrib.Tasks.SourceSafe.History">
  9548. <summary>
  9549. Generates an XML file showing all changes made to a Visual SourceSafe
  9550. project/file between specified labels or dates (by a given user).
  9551. </summary>
  9552. <example>
  9553. <para>
  9554. Write all changes between "Release1" and "Release2" to XML file
  9555. "changelog.xml".
  9556. </para>
  9557. <code>
  9558. <![CDATA[
  9559. <vsshistory
  9560. dbpath="C:\VSS\srcsafe.ini"
  9561. path="$/My Project"
  9562. fromlabel="Release1"
  9563. tolabel="Release2"
  9564. output="changelog.xml" />
  9565. ]]>
  9566. </code>
  9567. </example>
  9568. <example>
  9569. <para>
  9570. Write all changes between January 1st 2004 and March 31st 2004 to XML
  9571. file "history.xml".
  9572. </para>
  9573. <code>
  9574. <![CDATA[
  9575. <vsshistory
  9576. dbpath="C:\VSS\srcsafe.ini"
  9577. path="$/My Project"
  9578. fromdate="01/01/2004"
  9579. todate="03/31/2004"
  9580. output="history.xml"
  9581. />
  9582. ]]>
  9583. </code>
  9584. </example>
  9585. </member>
  9586. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.FromLabel">
  9587. <summary>
  9588. The value of the label to start comparing to. If it is not included,
  9589. the compare will start with the very first history item.
  9590. </summary>
  9591. </member>
  9592. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.ToLabel">
  9593. <summary>
  9594. The value of the label to compare up to. If it is not included,
  9595. the compare will end with the last history item.
  9596. </summary>
  9597. </member>
  9598. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.FromDate">
  9599. <summary>
  9600. Start date for comparison.
  9601. </summary>
  9602. </member>
  9603. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.ToDate">
  9604. <summary>
  9605. End date for comparison.
  9606. </summary>
  9607. </member>
  9608. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Output">
  9609. <summary>
  9610. Output file to save history to (as XML).
  9611. </summary>
  9612. </member>
  9613. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Recursive">
  9614. <summary>
  9615. Determines whether to perform the comparison recursively.
  9616. The default is <see langword="true" />.
  9617. </summary>
  9618. </member>
  9619. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.User">
  9620. <summary>
  9621. Name of the user whose changes you want to see.
  9622. </summary>
  9623. </member>
  9624. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.VersionFlags">
  9625. <summary>
  9626. Gets the flags that should be used to retrieve the history of
  9627. <see cref="T:System.IO.Path"/>.
  9628. </summary>
  9629. </member>
  9630. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Login">
  9631. <summary>
  9632. Override to avoid exposing the corresponding attribute to build
  9633. authors.
  9634. </summary>
  9635. </member>
  9636. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Version">
  9637. <summary>
  9638. Override to avoid exposing the corresponding attribute to build
  9639. authors.
  9640. </summary>
  9641. </member>
  9642. <member name="T:NAnt.Contrib.Tasks.SourceSafe.LabelTask">
  9643. <summary>
  9644. Used to apply a label to a Visual Source Safe item.
  9645. </summary>
  9646. <example>
  9647. <para>Label all files in a local sourcesafe database. (Automatically applies the label recursively)</para>
  9648. <code><![CDATA[
  9649. <vsslabel
  9650. user="myusername"
  9651. password="mypassword"
  9652. dbpath="C:\VSS\srcsafe.ini"
  9653. path="$/MyProduct"
  9654. comment="NAnt label"
  9655. label="myLabel"
  9656. />
  9657. ]]></code>
  9658. </example>
  9659. <example>
  9660. <para>Label a file in a remote sourcesafe database.</para>
  9661. <code><![CDATA[
  9662. <vsslabel
  9663. user="myusername"
  9664. password="mypassword"
  9665. dbpath="\\MyServer\VSS\srcsafe.ini"
  9666. path="$/MyProduct/myFile.cs"
  9667. comment="NAnt label"
  9668. label="myLabel"
  9669. />
  9670. ]]></code>
  9671. </example>
  9672. </member>
  9673. <member name="P:NAnt.Contrib.Tasks.SourceSafe.LabelTask.Comment">
  9674. <summary>
  9675. The label comment.
  9676. </summary>
  9677. </member>
  9678. <member name="P:NAnt.Contrib.Tasks.SourceSafe.LabelTask.Label">
  9679. <summary>
  9680. The name of the label.
  9681. </summary>
  9682. </member>
  9683. <member name="T:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask">
  9684. <summary>
  9685. Task is used to undo a checkout from SourceSafe
  9686. </summary>
  9687. <example>
  9688. <para>Undo a checkout of all of the files from a local sourcesafe database.</para>
  9689. <code><![CDATA[
  9690. <vssundocheckout
  9691. user="myusername"
  9692. password="mypassword"
  9693. localpath="C:\Dev\Latest"
  9694. recursive="true"
  9695. dbpath="C:\VSS\srcsafe.ini"
  9696. path="$/MyProduct"
  9697. />
  9698. ]]></code>
  9699. </example>
  9700. <example>
  9701. <para>Checkout a file from a remote sourcesafe database. Put it in a relative directory.</para>
  9702. <code><![CDATA[
  9703. <vssundocheckout
  9704. user="myusername"
  9705. password="mypassword"
  9706. localpath="Latest"
  9707. recursive="false"
  9708. dbpath="\\MyServer\VSS\srcsafe.ini"
  9709. path="$/MyProduct/myFile.cs"
  9710. />
  9711. ]]></code>
  9712. </example>
  9713. </member>
  9714. <member name="P:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask.LocalPath">
  9715. <summary>
  9716. The path to the local working directory. This is required if you wish to
  9717. have your local file replaced with the latest version from SourceSafe.
  9718. </summary>
  9719. </member>
  9720. <member name="P:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask.Recursive">
  9721. <summary>
  9722. Determines whether to perform a recursive undo of the checkout.
  9723. The default is <see langword="true" />.
  9724. </summary>
  9725. </member>
  9726. <member name="T:NAnt.Contrib.Tasks.StarTeam.LabelTask">
  9727. <summary>
  9728. Allows creation of view labels in StarTeam repositories.
  9729. </summary>
  9730. <remarks>
  9731. <para>Often when building projects you wish to label the source control repository.</para>
  9732. <para>By default this task creates view labels with the build option turned on.</para>
  9733. <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel </para>
  9734. <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
  9735. </remarks>
  9736. <example>
  9737. <para>Creates a label in a StarTeam repository.</para>
  9738. <code>
  9739. <![CDATA[
  9740. <!--
  9741. constructs a 'url' containing connection information to pass to the task
  9742. alternatively you can set each attribute manually
  9743. -->
  9744. <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
  9745. <stlabel label="3.1 (label title goes here)" description="This is a label description" url="${ST.url}" />
  9746. ]]>
  9747. </code>
  9748. </example>
  9749. </member>
  9750. <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamTask">
  9751. <summary>
  9752. Base star team task.
  9753. </summary>
  9754. <remarks>
  9755. <para>
  9756. Common super class for all StarTeam tasks. At this level of the hierarchy we are concerned only with obtaining a
  9757. connection to the StarTeam server. The subclass <see cref="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask"/>, abstracts tree-walking
  9758. behavior common to many subtasks.
  9759. </para>
  9760. <para>This class ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html </para>
  9761. <para>You need to have the StarTeam SDK installed for StarTeam tasks to function correctly.</para>
  9762. </remarks>
  9763. <seealso cref="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask"/>
  9764. <author> <a href="mailto:jcyip@thoughtworks.com">Jason Yip</a></author>
  9765. <author> <a href="mailto:stevec@ignitesports.com">Steve Cohen</a></author>
  9766. </member>
  9767. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._username">
  9768. <value> The username of the connection</value>
  9769. </member>
  9770. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._password">
  9771. <value> The username of the connection</value>
  9772. </member>
  9773. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._servername">
  9774. <value> name of Starteam server to connect to</value>
  9775. </member>
  9776. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._serverport">
  9777. <value> port of Starteam server to connect to</value>
  9778. </member>
  9779. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._projectname">
  9780. <value> name of Starteam project to connect to</value>
  9781. </member>
  9782. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._viewname">
  9783. <value> name of Starteam view to connect to</value>
  9784. </member>
  9785. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._server">
  9786. <value>The starteam server through which all activities will be done.</value>
  9787. </member>
  9788. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.createSnapshotView(StarTeam.StView)">
  9789. <summary>
  9790. Derived classes must override this method to instantiate a view configured appropriately to its task.
  9791. </summary>
  9792. <param name="rawview">the unconfigured <code>View</code></param>
  9793. <returns>the view appropriately configured.</returns>
  9794. </member>
  9795. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.openView">
  9796. <summary>
  9797. All tasks will call on this method to connect to StarTeam and open the view for processing.
  9798. </summary>
  9799. <returns>the a view to be used for processing.</returns>
  9800. <seealso cref="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.createSnapshotView(StarTeam.StView)"/>
  9801. </member>
  9802. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.getUserName(System.Int32)">
  9803. <summary> Returns the name of the user or a blank string if the user is not found.</summary>
  9804. <param name="userID">a user's ID</param>
  9805. <returns>the name of the user</returns>
  9806. </member>
  9807. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.servername">
  9808. <summary>
  9809. Name of StarTeamServer.
  9810. </summary>
  9811. <remarks>
  9812. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9813. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9814. </remarks>
  9815. </member>
  9816. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.serverport">
  9817. <summary>
  9818. Port number of the StarTeam connection.
  9819. </summary>
  9820. <remarks>
  9821. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9822. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9823. </remarks>
  9824. </member>
  9825. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.projectname">
  9826. <summary>
  9827. The name of the StarTeam project to be acted on
  9828. </summary>
  9829. <remarks>
  9830. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9831. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9832. </remarks>
  9833. </member>
  9834. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.viewname">
  9835. <summary>
  9836. The name of the StarTeam view to be acted on.
  9837. </summary>
  9838. <remarks>
  9839. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9840. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9841. </remarks>
  9842. </member>
  9843. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.username">
  9844. <summary>
  9845. The StarTeam user name used for login.
  9846. </summary>
  9847. <remarks>
  9848. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9849. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9850. </remarks>
  9851. </member>
  9852. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.password">
  9853. <summary>
  9854. The password used for login.
  9855. </summary>
  9856. <remarks>
  9857. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9858. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9859. </remarks>
  9860. </member>
  9861. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url">
  9862. <summary>
  9863. One stop to set all parameters needed to connect to a StarTeam server.
  9864. </summary>
  9865. <remarks>
  9866. <para>If you do not wish to specify a url you can set each parameter individually.
  9867. You must set all connection parameters for the task to be able to connect to the StarTeam server.</para>
  9868. </remarks>
  9869. <example>
  9870. <para>Here is how to configure the url string.</para>
  9871. <code>servername:portnum/project/view</code>
  9872. <para>You can optionally specify a username and password.</para>
  9873. <code>username:password@servername:portnum/project/view</code>
  9874. </example>
  9875. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.servername"/>
  9876. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.serverport"/>
  9877. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.projectname"/>
  9878. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.viewname"/>
  9879. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.username"/>
  9880. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.password"/>
  9881. </member>
  9882. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._labelName">
  9883. <summary> The name of the label to be set in Starteam.</summary>
  9884. </member>
  9885. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._description">
  9886. <summary> The label description to be set in Starteam.</summary>
  9887. </member>
  9888. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isBuildLabel">
  9889. <summary> Is the label being created a build label.</summary>
  9890. </member>
  9891. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._labelAsOfDate">
  9892. <summary> If set the datetime to set the label as of.</summary>
  9893. </member>
  9894. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isAsOfDateSet">
  9895. <summary> Kludgy flag to keep track if date has been set.
  9896. Please kill this if you can. Here based on experiences I have had with VB.NET</summary>
  9897. </member>
  9898. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isRevision">
  9899. <summary> Does user wish to make a revision label?</summary>
  9900. </member>
  9901. <member name="M:NAnt.Contrib.Tasks.StarTeam.LabelTask.createSnapshotView(StarTeam.StView)">
  9902. <summary>
  9903. Override of base-class abstract function creates an appropriately configured view.
  9904. For labels this a view configured as of this.lastBuild.
  9905. </summary>
  9906. <param name="raw">the unconfigured <code>View</code></param>
  9907. <returns>the snapshot <code>View</code> appropriately configured.</returns>
  9908. </member>
  9909. <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label">
  9910. <summary>
  9911. The name to be given to the label; required.
  9912. </summary>
  9913. </member>
  9914. <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.BuildLabel">
  9915. <summary> Should label be marked build : default is true</summary>
  9916. </member>
  9917. <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.RevisionLabel">
  9918. <summary>
  9919. Should label created be a revision label. The default is
  9920. <see langword="false"/>.
  9921. </summary>
  9922. <remarks>
  9923. <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.BuildLabel"/> has no effect if this is set to <see langword="true"/>
  9924. as revision labels cannot have a build status.
  9925. </remarks>
  9926. </member>
  9927. <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Description">
  9928. <summary> Optional description of the label to be stored in the StarTeam project.</summary>
  9929. </member>
  9930. <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.LastBuild">
  9931. <summary>
  9932. Optional: If this property is set the label will be created as of the datetime specified.
  9933. Please provide a datetime format that can be parsed via
  9934. <see cref="M:System.DateTime.Parse(System.String,System.IFormatProvider)"/>.
  9935. </summary>
  9936. <remarks>
  9937. This property is ignored when <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.RevisionLabel"/> set to
  9938. <see langword="true"/>.
  9939. </remarks>
  9940. </member>
  9941. <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel">
  9942. <summary>
  9943. Task for supporting labeling of repositories with incremented version
  9944. numbers. The version number calculated will be concatenated to the
  9945. <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label"/>.
  9946. </summary>
  9947. <remarks>
  9948. <para>
  9949. Instruments root of repository with <c>versionnumber.xml</c> file.
  9950. </para>
  9951. <para>
  9952. If this file is not present, it is created and checked into StarTeam.
  9953. The default version number is 1.0.0. By default the build number is
  9954. incremented. Properties are present to allow setting and incrementing
  9955. of major, minor, and build versions.
  9956. </para>
  9957. <para>
  9958. When label is created, properties are set to expose version information
  9959. and the new label :
  9960. </para>
  9961. <list type="bullet">
  9962. <item>
  9963. <description>label</description>
  9964. </item>
  9965. <item>
  9966. <description>Version.text</description>
  9967. </item>
  9968. <item>
  9969. <description>Version.major</description>
  9970. </item>
  9971. <item>
  9972. <description>Version.minor</description>
  9973. </item>
  9974. <item>
  9975. <description>Version.build</description>
  9976. </item>
  9977. </list>
  9978. <note>
  9979. Incrementing or setting major or minor versions does NOT reset the
  9980. build version.
  9981. </note>
  9982. </remarks>
  9983. <example>
  9984. <para>Increment the build version.</para>
  9985. <code>
  9986. <![CDATA[
  9987. <stautolabel url="${ST.url}" />
  9988. ]]>
  9989. </code>
  9990. </example>
  9991. <example>
  9992. <para>Set the major version.</para>
  9993. <code>
  9994. <![CDATA[
  9995. <stautolabel majorversion="2" url="${ST.url}" />
  9996. ]]>
  9997. </code>
  9998. </example>
  9999. <example>
  10000. <para>Increment the minor version.</para>
  10001. <code>
  10002. <![CDATA[
  10003. <stautolabel incrementminor="true" url="${ST.url}" />
  10004. ]]>
  10005. </code>
  10006. </example>
  10007. <example>
  10008. <para>Example <c>versionnumber.xml</c> file.</para>
  10009. <code>
  10010. <![CDATA[
  10011. <?xml version="1.0"?>
  10012. <stautolabel>
  10013. <version major="1" minor="0" build="0" />
  10014. </stautolabel>
  10015. ]]>
  10016. </code>
  10017. </example>
  10018. </member>
  10019. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.ExecuteTask">
  10020. <summary>
  10021. Looks for versionnumber.xml at root of repository.
  10022. Updates the xml in this file to correspond with properties set by user and checks in changes.
  10023. A label is then created based on properties set.
  10024. </summary>
  10025. <remarks>
  10026. Default behavior is to <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementBuild"/> number.
  10027. If user sets <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MajorVersion"/>, <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MinorVersion"/>, or <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.BuildVersion"/> no incrementing is done
  10028. and the exact version set and/or read from versionnumber.xml is used.
  10029. <para>The title of the Label is the <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label"/> property concatenated with the version number Major.Minor.Build</para>
  10030. </remarks>
  10031. </member>
  10032. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.getVersionStFile(StarTeam.StView)">
  10033. <summary>
  10034. Locate the <c>versionnumber.xml</c> file in the repository. If it
  10035. is not present, the file is created. The file is checked out
  10036. exclusively for editing.
  10037. </summary>
  10038. <param name="snapshot">StarTeam view we are working with.</param>
  10039. <returns>
  10040. StarTeam file handle containing version xml.
  10041. </returns>
  10042. </member>
  10043. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.createVersionStFile(StarTeam.StFolder)">
  10044. <summary>
  10045. Creates the versionumber.xml file in the repository.
  10046. </summary>
  10047. <param name="stFolder">StarTeam folder desired to put the versionnumber.xml files into</param>
  10048. <returns>StarTeam File handle to the created file.</returns>
  10049. </member>
  10050. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.VersionFile">
  10051. <summary>
  10052. Allows user to specify the filename where the version xml is stored.
  10053. The default is <c>versionnumber.xml</c>.
  10054. </summary>
  10055. </member>
  10056. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMajor">
  10057. <summary>
  10058. Increment major version number. The default is <see langword="false"/>.
  10059. If <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MajorVersion"/> is set, this property is ignored.
  10060. </summary>
  10061. </member>
  10062. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMinor">
  10063. <summary>
  10064. Increment minor version number. The default is <see langword="false"/>.
  10065. If <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MinorVersion"/> is set, this property is ignored.
  10066. </summary>
  10067. </member>
  10068. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementBuild">
  10069. <summary>
  10070. Increment build version number. The default is <see langword="true"/>.
  10071. If <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.BuildVersion"/> is set, this property is ignored.
  10072. </summary>
  10073. </member>
  10074. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MajorVersion">
  10075. <summary>
  10076. Major version number used for label. If this value is set,
  10077. <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMajor"/> is ignored.
  10078. </summary>
  10079. </member>
  10080. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MinorVersion">
  10081. <summary>
  10082. Minor version number used for label. If this value is set,
  10083. <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMinor"/> is ignored.
  10084. </summary>
  10085. </member>
  10086. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.BuildVersion">
  10087. <summary>
  10088. Build version number used for label.
  10089. If this value is set. <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementBuild"/> is ignored.
  10090. </summary>
  10091. </member>
  10092. <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin">
  10093. <summary>
  10094. Task to check in files to StarTeam repositories.
  10095. </summary>
  10096. <remarks>
  10097. <para>You add files to the repository that are not controlled by setting <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.adduncontrolled"/>.</para>
  10098. <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stcheckin </para>
  10099. <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
  10100. </remarks>
  10101. <example>
  10102. <para>Recursively checks in all files in the project.</para>
  10103. <code>
  10104. <![CDATA[
  10105. <!--
  10106. constructs a 'url' containing connection information to pass to the task
  10107. alternatively you can set each attribute manually
  10108. -->
  10109. <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
  10110. <stcheckin forced="true" rootstarteamfolder="/" recursive="true" url="${ST.url}" />
  10111. ]]>
  10112. </code>
  10113. </example>
  10114. </member>
  10115. <member name="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask">
  10116. <summary>
  10117. Base for tree based star team tasks.
  10118. </summary>
  10119. <remarks>
  10120. <para>
  10121. Abstracts tree-walking behavior common to many subtasks.
  10122. </para>
  10123. <para>
  10124. This class provides tree iteration functionality. Derived classes will implement their specific task
  10125. functionally using the visitor pattern, specifically by implementing the method <see cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.visit(StarTeam.StFolder,System.IO.FileInfo)"/>
  10126. </para>
  10127. <para>This class ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html </para>
  10128. <para>You need to have the StarTeam SDK installed for StarTeam tasks to function correctly.</para>
  10129. </remarks>
  10130. </member>
  10131. <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.ExecuteTask">
  10132. <summary>
  10133. Does the work of opening the supplied Starteam view and calling
  10134. the <see cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.visit(StarTeam.StFolder,System.IO.FileInfo)"/> method setting the pattern in motion to perform the task.
  10135. </summary>
  10136. </member>
  10137. <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.getLabelID(StarTeam.StView)">
  10138. <summary>
  10139. Helper method calls on the StarTeam API to retrieve an ID number for the specified view, corresponding to this.label.
  10140. </summary>
  10141. <returns>The Label identifier or <c>-1</c> if no label was provided.</returns>
  10142. </member>
  10143. <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.visit(StarTeam.StFolder,System.IO.FileInfo)">
  10144. <summary> Derived classes must override this class to define actual processing to be performed on each folder in the tree defined for the task</summary>
  10145. <param name="rootStarteamFolder">the StarTeam folderto be visited</param>
  10146. <param name="rootLocalFolder">the local mapping of rootStarteamFolder</param>
  10147. </member>
  10148. <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.testPreconditions">
  10149. <summary>
  10150. Derived classes must override this method to define tests for any preconditons required by the task.
  10151. This method is called at the beginning of the ExecuteTask method.
  10152. </summary>
  10153. <seealso cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.ExecuteTask"/>
  10154. </member>
  10155. <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.listLocalFiles(System.IO.FileInfo)">
  10156. <summary>
  10157. Gets the collection of the local file names in the supplied directory.
  10158. We need to check this collection against what we find in Starteam to
  10159. understand what we need to do in order to synch with the repository.
  10160. </summary>
  10161. <remarks>
  10162. The goal is to keep track of which local files are not controlled by StarTeam.
  10163. </remarks>
  10164. <param name="localFolder">Local folder to scan</param>
  10165. <returns>hashtable whose keys represent a file or directory in localFolder.</returns>
  10166. </member>
  10167. <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.delistLocalFile(System.Collections.Hashtable,System.IO.FileInfo)">
  10168. <summary>
  10169. Removes file being worked with from the <see cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.listLocalFiles(System.IO.FileInfo)"/> generated hashtable.
  10170. </summary>
  10171. <remarks>
  10172. The goal is to keep track of which local files are not controlled by StarTeam.
  10173. </remarks>
  10174. <param name="localFiles">Hashtable of the current directory's file|dire</param>
  10175. <param name="thisfile">file to remove from list.</param>
  10176. </member>
  10177. <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.IsIncluded(System.String)">
  10178. <summary>
  10179. Evaluates defined <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Includes"/> and <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Excludes"/> patterns against a filename.
  10180. </summary>
  10181. <param name="filePath"></param>
  10182. <returns></returns>
  10183. </member>
  10184. <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.ToRegexPattern(System.String)">
  10185. <summary>
  10186. Lifted/Modified from <see cref="T:NAnt.Core.DirectoryScanner"/> to convert patterns to match filenames to regularexpressions.
  10187. </summary>
  10188. <param name="nantPattern">Search pattern - meant to be just a filename with no path info</param>
  10189. <remarks>The directory seperation code in here most likely is overkill.</remarks>
  10190. <returns>Regular expresssion for searching matching file names</returns>
  10191. </member>
  10192. <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.populatePatterns(System.Collections.Specialized.StringCollection,System.Collections.Specialized.StringCollection@)">
  10193. <summary>
  10194. Convert path patterns to regularexpression patterns. Stored in the given string collection.
  10195. </summary>
  10196. <param name="paths">collection of paths to expand into regular expressions</param>
  10197. <param name="patterns">collection to store the given regularexpression patterns</param>
  10198. </member>
  10199. <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.rootstarteamfolder">
  10200. <summary>
  10201. Root StarTeam folder to begin operations on. Defaults to the root of the view.
  10202. </summary>
  10203. </member>
  10204. <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.RootLocalFolder">
  10205. <summary>
  10206. Root Local folder where files are to be checkout/in or manipulated. Defaults to the StarTeam default folder.
  10207. </summary>
  10208. </member>
  10209. <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Includes">
  10210. <summary>
  10211. Accepts comma de-limited list of expressions to include in tree operations.
  10212. If nothing is set ALL filespecs are included.
  10213. </summary>
  10214. <example>
  10215. <para>Match all C# files in the directory</para>
  10216. <code>*.cs</code>
  10217. </example>
  10218. <remarks>
  10219. Expressions should be just for filename matching.
  10220. Technically relative directory information is accepted but will never match.
  10221. </remarks>
  10222. </member>
  10223. <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Excludes">
  10224. <summary>
  10225. Accepts comma de-limited list of expressions to exclude from tree operations.
  10226. If nothing is specified. NO filespecs are excluded.
  10227. </summary>
  10228. <example>
  10229. <para>Match <b>No</b> C# files in the directory</para>
  10230. <code>*.cs</code>
  10231. </example>
  10232. <remarks>
  10233. <para>
  10234. If a excludes pattern is set with no <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Includes"/> patterns present includes defaults to "*"
  10235. </para>
  10236. Expressions should be just for filename matching.
  10237. Technically relative directory information is accepted but will never match.
  10238. </remarks>
  10239. </member>
  10240. <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.recursive">
  10241. <summary>
  10242. Default : true - should tasks recurse through tree.
  10243. </summary>
  10244. </member>
  10245. <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Forced">
  10246. <summary>
  10247. Default : false - force check in/out actions regardless of the status that StarTeam is maintaining for the file.
  10248. </summary>
  10249. <remarks>
  10250. <para>If <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.RootLocalFolder"/> is set then this property should be set <c>true</c>.
  10251. Otherwise the checkout will be based on how the repository compares to local target folder.
  10252. </para>
  10253. <para>Note that if forced is not on. Files with status Modified and Merge will not be processed.</para>
  10254. </remarks>
  10255. </member>
  10256. <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Label">
  10257. <summary>
  10258. Label used for checkout. If no label is set latest state of repository is checked out.
  10259. </summary>
  10260. <remarks>
  10261. The label must exist in starteam or an exception will be thrown.
  10262. </remarks>
  10263. </member>
  10264. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.starTeamLockTypeStatics">
  10265. <summary>classes used to access static values</summary>
  10266. </member>
  10267. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.starteamFolderFactory">
  10268. <summary>Facotry classes used when files and folders are added to the repository. Populated when adduncontrolled is enabled.</summary>
  10269. </member>
  10270. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._createFolders">
  10271. <value> will folders be created for new items found with the checkin.</value>
  10272. </member>
  10273. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._comment">
  10274. <value> The comment which will be stored with the checkin.</value>
  10275. </member>
  10276. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._addUncontrolled">
  10277. <value> holder for the add Uncontrolled attribute. If true, all local files not in StarTeam will be added to the repository.</value>
  10278. </member>
  10279. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._lockStatus">
  10280. <value> This attribute tells whether unlocked files on checkin (so that other users may access them) checkout or to
  10281. leave the checkout status alone (default).
  10282. </value>
  10283. </member>
  10284. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.createSnapshotView(StarTeam.StView)">
  10285. <summary>
  10286. Override of base-class abstract function creates an appropriately configured view. For checkins this is
  10287. always the current or "tip" view.
  10288. </summary>
  10289. <param name="raw">the unconfigured <code>View</code></param>
  10290. <returns>the snapshot <code>View</code> appropriately configured.</returns>
  10291. </member>
  10292. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.testPreconditions">
  10293. <summary> Implements base-class abstract function to define tests for any preconditons required by the task</summary>
  10294. </member>
  10295. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.visit(StarTeam.StFolder,System.IO.FileInfo)">
  10296. <summary> Implements base-class abstract function to perform the checkin operation on the files in each folder of the tree.</summary>
  10297. <param name="starteamFolder">the StarTeam folder to which files will be checked in</param>
  10298. <param name="targetFolder">local folder from which files will be checked in</param>
  10299. </member>
  10300. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.addUncontrolledItems(System.Collections.Hashtable,StarTeam.StFolder)">
  10301. <summary> Adds to the StarTeam repository everything on the local machine that is not currently in the repository.</summary>
  10302. <param name="localFiles">Hasttable containing files missing in the repository for the current folder</param>
  10303. <param name="folder">StarTeam folder to which these items are to be added.</param>
  10304. </member>
  10305. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.add(StarTeam.StFolder,System.IO.FileInfo)">
  10306. <summary> Adds the file or directpry to the repository.</summary>
  10307. <param name="parentFolder">StarTeam folder underwhich items will be added.</param>
  10308. <param name="file">the file or directory to add</param>
  10309. <returns>true if the file was successfully added otherwise false.</returns>
  10310. </member>
  10311. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.adduncontrolled">
  10312. <summary>
  10313. if true, any files or folders NOT in StarTeam will be added to the repository. Defaults to "false".
  10314. </summary>
  10315. </member>
  10316. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.unlocked">
  10317. <summary>
  10318. Set to do an unlocked checkout; optional, default is false;
  10319. If true, file will be unlocked so that other users may change it. If false, lock status will not change.
  10320. </summary>
  10321. </member>
  10322. <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout">
  10323. <summary>
  10324. Task to check out files from StarTeam repositories.
  10325. </summary>
  10326. <remarks>
  10327. <para>You can check out by <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Label"/> and control the type of lock with <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.locktype"/>.</para>
  10328. <para>You can delete files that are not in source control by setting <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.deleteuncontrolled"/>.</para>
  10329. <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stcheckout </para>
  10330. <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
  10331. </remarks>
  10332. <example>
  10333. <para>Recursively checks out all files in the project with an exclusive lock.</para>
  10334. <code>
  10335. <![CDATA[
  10336. <!--
  10337. constructs a 'url' containing connection information to pass to the task
  10338. alternatively you can set each attribute manually
  10339. -->
  10340. <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
  10341. <stcheckout locktype="exclusive" rootstarteamfolder="/" recursive="true" url="${ST.url}" />
  10342. ]]>
  10343. </code>
  10344. </example>
  10345. </member>
  10346. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout._createDirs">
  10347. <value> holder for the createDirs property.</value>
  10348. </member>
  10349. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout._deleteUncontrolled">
  10350. <value> holder for the deleteUncontrolled property.</value>
  10351. </member>
  10352. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout._lockStatus">
  10353. <value> holder for the lockstatus property. </value>
  10354. </member>
  10355. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.createSnapshotView(StarTeam.StView)">
  10356. <summary>
  10357. Override of base-class abstract function creates an appropriately configured view for checkout.
  10358. If a label is specified it is used otherwise the current view of the repository is used.
  10359. </summary>
  10360. <param name="raw">the unconfigured <code>StarTeam View</code></param>
  10361. <returns>the snapshot <code>StarTeam View</code> appropriately configured.</returns>
  10362. </member>
  10363. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.testPreconditions">
  10364. <summary> Implements base-class abstract function to define tests for any preconditons required by the task</summary>
  10365. </member>
  10366. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.visit(StarTeam.StFolder,System.IO.FileInfo)">
  10367. <summary>
  10368. Implements base-class abstract function to perform the checkout operation on the files in each folder of the tree.
  10369. </summary>
  10370. <param name="starteamFolder">the StarTeam folder from which files to be checked out</param>
  10371. <param name="targetFolder">the local mapping of the starteam folder</param>
  10372. </member>
  10373. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.deleteUncontrolledItems(System.Collections.Hashtable)">
  10374. <summary>
  10375. Deletes everything on the local machine that is not in the repository.
  10376. </summary>
  10377. <param name="localFiles">Hashtable containing filenames to be deleted</param>
  10378. </member>
  10379. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.delete(System.IO.FileInfo)">
  10380. <summary> Utility method to delete the file (and it's children) from the local drive.</summary>
  10381. <param name="file">the file or directory to delete.</param>
  10382. <returns>was the file successfully deleted</returns>
  10383. </member>
  10384. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.createworkingdirs">
  10385. <summary>
  10386. Default : true - Create directories that are in the Starteam repository even if they are empty.
  10387. </summary>
  10388. </member>
  10389. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.deleteuncontrolled">
  10390. <summary>
  10391. <b>Not fully tested CAREFUL</b> Default : false - Should all local files <b>NOT</b> in StarTeam be deleted?
  10392. </summary>
  10393. </member>
  10394. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.locktype">
  10395. <summary>
  10396. What type of lock to apply to files checked out.
  10397. <list type="bullet">
  10398. <listheader>
  10399. <term>LockType</term>
  10400. </listheader>
  10401. <item>
  10402. <term>unchanged</term>
  10403. <description>default: do not make any changes to the lock state of items.</description>
  10404. </item>
  10405. <item>
  10406. <term>exclusive</term>
  10407. <description>Exclusively lock items. No other users can update the object while it is exclusively locked.</description>
  10408. </item>
  10409. <item>
  10410. <term>nonexclusive</term>
  10411. <description>Put a non-exclusive lock on the item.</description>
  10412. </item>
  10413. <item>
  10414. <term>unlocked</term>
  10415. <description>Remove locks from all items checked out. This accompanied by force would effectively override a lock and replace local contents with the current version.</description>
  10416. </item>
  10417. </list>
  10418. </summary>
  10419. </member>
  10420. <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamLabel">
  10421. <summary>
  10422. Allows creation of view labels in StarTeam repositories.
  10423. </summary>
  10424. <remarks>
  10425. <para>Often when building projects you wish to label the source control repository.</para>
  10426. <para>By default this task creates view labels with the build option turned on.</para>
  10427. <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel </para>
  10428. <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
  10429. </remarks>
  10430. <example>
  10431. <para>Creates a label in a StarTeam repository.</para>
  10432. <code>
  10433. <![CDATA[
  10434. <!--
  10435. constructs a 'url' containing connection information to pass to the task
  10436. alternatively you can set each attribute manually
  10437. -->
  10438. <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
  10439. <stlabel label="3.1 (label title goes here)" description="This is a label description" url="${ST.url}" />
  10440. ]]>
  10441. </code>
  10442. </example>
  10443. </member>
  10444. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamLabel.ExecuteTask">
  10445. <summary>
  10446. This method does the work of creating the new view and checking it
  10447. into Starteam.
  10448. </summary>
  10449. </member>
  10450. <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamList">
  10451. <summary>
  10452. List items in StarTeam repositories.
  10453. </summary>
  10454. <remarks>
  10455. <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlist </para>
  10456. <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
  10457. </remarks>
  10458. <example>
  10459. <para>Lists all files in a StarTeam repository.</para>
  10460. <code>
  10461. <![CDATA[
  10462. <!--
  10463. constructs a 'url' containing connection information to pass to the task
  10464. alternatively you can set each attribute manually
  10465. -->
  10466. <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
  10467. <stlist rootstarteamfolder="/" recursive="true" url="${ST.url}" />
  10468. ]]>
  10469. </code>
  10470. </example>
  10471. </member>
  10472. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamList.createSnapshotView(StarTeam.StView)">
  10473. <summary>
  10474. Override of base-class abstract function creates an appropriately configured view for checkoutlists.
  10475. The current view or a view of the label specified <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Label"/>.
  10476. </summary>
  10477. <param name="raw">the unconfigured <c>View</c></param>
  10478. <returns>the snapshot <c>View</c> appropriately configured.</returns>
  10479. </member>
  10480. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamList.testPreconditions">
  10481. <summary>Required base-class abstract function implementation is a no-op here.</summary>
  10482. </member>
  10483. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamList.visit(StarTeam.StFolder,System.IO.FileInfo)">
  10484. <summary> Implements base-class abstract function to perform the checkout
  10485. operation on the files in each folder of the tree.</summary>
  10486. <param name="starteamFolder">the StarTeam folder from which files to be checked out</param>
  10487. <param name="targetFolder">the local mapping of rootStarteamFolder</param>
  10488. </member>
  10489. <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch">
  10490. <summary>
  10491. Processes <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see> batch files.
  10492. </summary>
  10493. <remarks>
  10494. Processes the batch commands found in the input file. Each line in the
  10495. input file should contain a single Surround SCM command including proper
  10496. command line options. The sscm command, Surround SCM server address,
  10497. port number, username and password are not required for each command line.
  10498. </remarks>
  10499. <example>
  10500. <para>
  10501. Run the batch file <c>${src}/sscm.batch</c> on the server at localhost,
  10502. port 4900 with username 'administrator' and a blank password. All script
  10503. output is directed to the console.
  10504. </para>
  10505. <code>
  10506. &lt;sscmbatch
  10507. serverconnect=&quot;localhost:4900&quot;
  10508. serverlogin=&quot;administrator:&quot;
  10509. input=&quot;${src}/sscm.batch&quot;
  10510. /&gt;
  10511. </code>
  10512. </example>
  10513. <example>
  10514. <para>
  10515. Run the batch file <c>${src}/sscm.batch</c> on the server at localhost,
  10516. port 4900 with username 'administrator' and a blank password. All script
  10517. output is redirected to <c>${dist}/sscm.batch.out</c>.
  10518. </para>
  10519. <code>
  10520. &lt;sscmbatch
  10521. serverconnect=&quot;localhost:4900&quot;
  10522. serverconnect=&quot;administrator:&quot;
  10523. input=&quot;${src}/sscm.batch&quot;
  10524. output=&quot;${dist}/sscm.batch.out&quot;
  10525. /&gt;
  10526. </code>
  10527. </example>
  10528. </member>
  10529. <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask">
  10530. <summary>
  10531. <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
  10532. abstract task base.
  10533. </summary>
  10534. </member>
  10535. <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.WriteCommandLineArguments(System.Text.StringBuilder)">
  10536. <summary>
  10537. Writes the task-specific arguments to the specified
  10538. <see cref="T:System.Text.StringBuilder"/>.
  10539. </summary>
  10540. <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
  10541. </member>
  10542. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ServerConnect">
  10543. <summary>
  10544. The address and port number of the Surround SCM server host computer.
  10545. Format is server:port. If not entered, the last saved connection
  10546. parameters are used.
  10547. </summary>
  10548. </member>
  10549. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ServerLogin">
  10550. <summary>
  10551. The username and password used to login to the Surround SCM server.
  10552. Format is username:password. If not entered, the last saved login
  10553. parameters are used.
  10554. </summary>
  10555. </member>
  10556. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ExeName">
  10557. <summary>
  10558. Override ExeName paramater to sscm.exe for Surround SCM.
  10559. </summary>
  10560. </member>
  10561. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ProgramArguments">
  10562. <summary>
  10563. Gets the command line arguments for the external program.
  10564. </summary>
  10565. <value>
  10566. The command line arguments for the external program.
  10567. </value>
  10568. </member>
  10569. <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch.WriteCommandLineArguments(System.Text.StringBuilder)">
  10570. <summary>
  10571. Writes the task-specific arguments to the specified
  10572. <see cref="T:System.Text.StringBuilder"/>.
  10573. </summary>
  10574. <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
  10575. </member>
  10576. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch.InputFile">
  10577. <summary>
  10578. File to read commands from.
  10579. </summary>
  10580. </member>
  10581. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch.OutputFile">
  10582. <summary>
  10583. File to direct all standard output to. When executing commands from
  10584. the input file, all output is written to this file instead of being
  10585. displayed on the screen.
  10586. </summary>
  10587. </member>
  10588. <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch">
  10589. <summary>
  10590. Creates new branches for <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>.
  10591. </summary>
  10592. <example>
  10593. <para>
  10594. Create a new Baseline branch 'Widget 1.0' from branch 'Mainline',
  10595. repository 'Mainline/Widget' with the given comments. All files
  10596. are branched at the tip version.
  10597. </para>
  10598. <code>
  10599. &lt;sscmbranch
  10600. serverconnect=&quot;localhost:4900&quot;
  10601. serverlogin=&quot;administrator:&quot;
  10602. branch=&quot;Widget 1.0&quot;
  10603. repository=&quot;Mainline/Widget&quot;
  10604. parent=&quot;Mainline&quot;
  10605. comment=&quot;Branch for continuing Widget 1.0 development&quot;
  10606. type=&quot;baseline&quot;
  10607. /&gt;
  10608. </code>
  10609. </example>
  10610. <example>
  10611. <para>
  10612. Create a new Workspace branch 'MyWidgetDevelopment' from branch
  10613. 'Widget 1.0', repository 'Mainline/Widget'. All files are branched
  10614. at the tip version.
  10615. </para>
  10616. <code>
  10617. &lt;sscmbranch
  10618. serverconnect=&quot;localhost:4900&quot;
  10619. serverlogin=&quot;administrator:&quot;
  10620. branch=&quot;MyWidgetDevelopment&quot;
  10621. repository=&quot;Mainline/Widget&quot;
  10622. parent=&quot;Widget 1.0&quot;
  10623. /&gt;
  10624. </code>
  10625. </example>
  10626. <example>
  10627. <para>
  10628. Create a new Snapshot branch 'Build as of 12-1-03' from branch
  10629. 'Widget 1.0', repository 'Mainline/Widget' with the given comments.
  10630. All files are branched at their version as of 12-01-03.
  10631. </para>
  10632. <code>
  10633. &lt;sscmbranch
  10634. serverconnect=&quot;localhost:4900&quot;
  10635. serverlogin=&quot;administrator:&quot;
  10636. name=&quot;Build as of 12-1-03&quot;
  10637. repository=&quot;Mainline/Widget&quot;
  10638. branch=&quot;Widget 1.0&quot;
  10639. comment=&quot;Snapshot of source as it was on December 1st, 2003&quot;
  10640. timestamp=&quot;2003120300:00:00&quot;
  10641. type=&quot;snapshot&quot;
  10642. /&gt;
  10643. </code>
  10644. </example>
  10645. </member>
  10646. <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.WriteCommandLineArguments(System.Text.StringBuilder)">
  10647. <summary>
  10648. Writes the task-specific arguments to the specified
  10649. <see cref="T:System.Text.StringBuilder"/>.
  10650. </summary>
  10651. <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
  10652. </member>
  10653. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Branch">
  10654. <summary>
  10655. The name of the branch you want to create.
  10656. </summary>
  10657. </member>
  10658. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Repository">
  10659. <summary>
  10660. The full repository path.
  10661. </summary>
  10662. </member>
  10663. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ParentBranch">
  10664. <summary>
  10665. The parent branch you want to create the new, child branch from.
  10666. If not specified, the mainline branch is used.
  10667. </summary>
  10668. </member>
  10669. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Comment">
  10670. <summary>
  10671. Specifies a comment for the branch operation.
  10672. </summary>
  10673. </member>
  10674. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByLabel">
  10675. <summary>
  10676. Specifies which parent branch file versions are copied into the
  10677. child branch.
  10678. </summary>
  10679. </member>
  10680. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByTimestamp">
  10681. <summary>
  10682. Specifies which parent branch file versions are copied into the
  10683. child branch. Format is yyyymmddhh:mm:ss. If <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByLabel"/>
  10684. attribute is specified, this parameter is ignored.
  10685. </summary>
  10686. </member>
  10687. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.IncludeRemoved">
  10688. <summary>
  10689. Include removed files when creating a branch with the
  10690. <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByLabel"/> or <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByTimestamp"/> option.
  10691. The default is <see langword="true"/>.
  10692. </summary>
  10693. </member>
  10694. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Type">
  10695. <summary>
  10696. Specifies the type of branch you want to create. Possible values are
  10697. <c>workspace</c>, <c>baseline</c>, or <c>snapshot</c>. The default is
  10698. <c>workspace</c>.
  10699. </summary>
  10700. </member>
  10701. <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin">
  10702. <summary>
  10703. Checks in files in <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
  10704. repository.
  10705. </summary>
  10706. <remarks>
  10707. Check in updated Surround SCM files with changes, removes the lock on
  10708. the files, and makes changes available to other users.
  10709. </remarks>
  10710. <example>
  10711. <para>
  10712. Check In all files and repositories from repository 'Mainline/Widget'
  10713. recursively from the 'Widget 1.0' branch to the working directory setup
  10714. for user 'administrator'. This call outputs the progress of the Check In
  10715. to the console.
  10716. </para>
  10717. <code>
  10718. &lt;sscmcheckin
  10719. serverconnect=&quot;localhost:4900&quot;
  10720. serverlogin=&quot;administrator:&quot;
  10721. file=&quot;/&quot;
  10722. branch=&quot;Widget 1.0&quot;
  10723. repository=&quot;Mainline/Widget&quot;
  10724. recursive=&quot;true&quot;
  10725. comment=&quot;I made some changes&quot;
  10726. /&gt;
  10727. </code>
  10728. </example>
  10729. <example>
  10730. <para>
  10731. Check in file 'Mainline/Widget/Widget.java' from the 'Widget 1.0'
  10732. branch from the working directory setup for user 'administrator'
  10733. with comment 'I made some changes'. Set the 'Release 1.1.1' label
  10734. to this new version, even if the label already exists on an earlier
  10735. version.
  10736. </para>
  10737. <code>
  10738. &lt;sscmcheckin
  10739. serverconnect=&quot;localhost:4900&quot;
  10740. serverlogin=&quot;administrator:&quot;
  10741. file=&quot;Widget.java&quot;
  10742. branch=&quot;Widget 1.0&quot;
  10743. repository=&quot;Mainline/Widget&quot;
  10744. comment=&quot;I made some changes&quot;
  10745. label=&quot;Release 1.1.1&quot;
  10746. overwritelabel=&quot;true&quot;
  10747. /&gt;
  10748. </code>
  10749. </example>
  10750. </member>
  10751. <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.WriteCommandLineArguments(System.Text.StringBuilder)">
  10752. <summary>
  10753. Writes the task-specific arguments to the specified
  10754. <see cref="T:System.Text.StringBuilder"/>.
  10755. </summary>
  10756. <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
  10757. </member>
  10758. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Branch">
  10759. <summary>
  10760. Surround SCM branch name. The default is pulled from the local
  10761. working directory.
  10762. </summary>
  10763. </member>
  10764. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Repository">
  10765. <summary>
  10766. Surround SCM repository path. The default is pulled from the local
  10767. working directory.
  10768. </summary>
  10769. </member>
  10770. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.File">
  10771. <summary>
  10772. File or repository name. Can be / or empty, which means the
  10773. repository specified by the repository option or the default
  10774. repository.
  10775. </summary>
  10776. </member>
  10777. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Comment">
  10778. <summary>
  10779. Comment for the check-in.
  10780. </summary>
  10781. </member>
  10782. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.SkipAutomerge">
  10783. <summary>
  10784. Force check in without merge. Ignores code changes checked in after
  10785. the user's last checkout or merge. The default is <see langword="false" />.
  10786. </summary>
  10787. </member>
  10788. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.GetLocal">
  10789. <summary>
  10790. Get file after check in. The default is <see langword="true" />.
  10791. </summary>
  10792. </member>
  10793. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.KeepLocked">
  10794. <summary>
  10795. Keep the lock after check in. The default is <see langword="false" />.
  10796. </summary>
  10797. </member>
  10798. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Label">
  10799. <summary>
  10800. A label for the check in code.
  10801. </summary>
  10802. </member>
  10803. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.OverwriteLabel">
  10804. <summary>
  10805. Overwrite previous label on file. The default is
  10806. <see langword="false" />.
  10807. </summary>
  10808. </member>
  10809. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Quiet">
  10810. <summary>
  10811. Do not list repository and local full path of the Surround
  10812. SCM server. The default is <see langword="false" />.
  10813. </summary>
  10814. </member>
  10815. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Recursive">
  10816. <summary>
  10817. Recursively check in all files and sub-repositories.
  10818. The default is <see langword="false" />.
  10819. </summary>
  10820. </member>
  10821. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.TtpDatabase">
  10822. <summary>
  10823. The TestTrack Pro database configuration name.
  10824. </summary>
  10825. </member>
  10826. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.TtpLogin">
  10827. <summary>
  10828. The TestTrack Pro username and password.
  10829. </summary>
  10830. </member>
  10831. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.TtpDefects">
  10832. <summary>
  10833. The TestTrack Pro defect number(s) for attachment. Format is "#:#:#:#".
  10834. </summary>
  10835. </member>
  10836. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Writable">
  10837. <summary>
  10838. Make file writable after check in. The default is
  10839. <see langword="false" />.
  10840. </summary>
  10841. </member>
  10842. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.ForceUpdate">
  10843. <summary>
  10844. Update version even if no changes. The default is
  10845. <see langword="false" />.
  10846. </summary>
  10847. </member>
  10848. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.DeleteLocal">
  10849. <summary>
  10850. Remove local file after check in. The default is
  10851. <see langword="false" />.
  10852. </summary>
  10853. </member>
  10854. <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout">
  10855. <summary>
  10856. Checks out files from a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
  10857. repository.
  10858. </summary>
  10859. <remarks>
  10860. You can check out single files, multiple files, or a full repository.
  10861. Surround SCM creates a read-write copy of the files in the working
  10862. directory.
  10863. </remarks>
  10864. <example>
  10865. <para>
  10866. Check Out all files and repositories from repository 'Mainline/Widget'
  10867. recursively from the 'Widget 1.0' branch to the working directory setup
  10868. for user 'administrator'. This call forces the file retrieval from the
  10869. server even if the local file is current and overwrites any writable
  10870. local files with the server copy.
  10871. </para>
  10872. <code>
  10873. &lt;sscmcheckout
  10874. serverconnect=&quot;localhost:4900&quot;
  10875. serverlogin=&quot;administrator:&quot;
  10876. file=&quot;/&quot;
  10877. branch=&quot;Widget 1.0&quot;
  10878. repository=&quot;Mainline/Widget&quot;
  10879. recursive=&quot;true&quot;
  10880. force=&quot;true&quot;
  10881. comment=&quot;This is my Check Out comment&quot;
  10882. /&gt;
  10883. </code>
  10884. </example>
  10885. <example>
  10886. <para>
  10887. Check Out version 1 of the file 'Mainline/Widget/Widget.java' exclusively
  10888. from the 'Widget 1.0' branch to the working directory setup for user
  10889. 'administrator'. Writable local files are not overwritten, even if they
  10890. are out of date.
  10891. </para>
  10892. <code>
  10893. &lt;sscmcheckout
  10894. serverconnect=&quot;localhost:4900&quot;
  10895. serverlogin=&quot;administrator:&quot;
  10896. quiet=&quot;true&quot;
  10897. file=&quot;Widget.java&quot;
  10898. branch=&quot;Widget 1.0&quot;
  10899. repository=&quot;Mainline/Widget&quot;
  10900. overwrite=&quot;false&quot;
  10901. writable=&quot;true&quot;
  10902. version=&quot;1&quot;
  10903. exclusive=&quot;true&quot;
  10904. /&gt;
  10905. </code>
  10906. </example>
  10907. </member>
  10908. <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.WriteCommandLineArguments(System.Text.StringBuilder)">
  10909. <summary>
  10910. Writes the task-specific arguments to the specified
  10911. <see cref="T:System.Text.StringBuilder"/>.
  10912. </summary>
  10913. <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
  10914. </member>
  10915. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Branch">
  10916. <summary>
  10917. Surround SCM branch name. The default is pulled from the local
  10918. working directory.
  10919. </summary>
  10920. </member>
  10921. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Repository">
  10922. <summary>
  10923. Surround SCM repository path. The default is pulled from the local
  10924. working directory.
  10925. </summary>
  10926. </member>
  10927. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.File">
  10928. <summary>
  10929. File or repository name. Can be / or empty, which means the
  10930. repository specified by the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Repository"/> attribute
  10931. or the default repository.
  10932. </summary>
  10933. </member>
  10934. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Comment">
  10935. <summary>
  10936. Comment for the check-out.
  10937. </summary>
  10938. </member>
  10939. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Force">
  10940. <summary>
  10941. Force file retrieval from server regardless of the local copy status.
  10942. The default is <see langword="false" />.
  10943. </summary>
  10944. </member>
  10945. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Quiet">
  10946. <summary>
  10947. Do not list repository and local full path of the Surround SCM server.
  10948. The default is <see langword="false" />.
  10949. </summary>
  10950. </member>
  10951. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Recursive">
  10952. <summary>
  10953. Recursively get files and sub-repositories. The default is
  10954. <see langword="false" />.
  10955. </summary>
  10956. </member>
  10957. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Overwrite">
  10958. <summary>
  10959. Specifies whether to overwrite local writable files. The default is
  10960. <see langword="false" />.
  10961. </summary>
  10962. </member>
  10963. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Timestamp">
  10964. <summary>
  10965. Specifies how to set the local file's date/time. Possible values are
  10966. <c>current</c>, <c>modify</c> or <c>checkin</c>.
  10967. </summary>
  10968. </member>
  10969. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Exclusive">
  10970. <summary>
  10971. Exclusively lock the files. The default is <see langword="false" />.
  10972. </summary>
  10973. </member>
  10974. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Version">
  10975. <summary>
  10976. Specifies the file version to check out. Ignored if no specific
  10977. filename is set using the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.File"/> attribute.
  10978. </summary>
  10979. </member>
  10980. <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze">
  10981. <summary>
  10982. Freezes branches in a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
  10983. repository.
  10984. </summary>
  10985. <remarks>
  10986. Freezing a branch prevents any code changes being made to files in the
  10987. branch. When a branch is frozen, it is locked and no changes can be
  10988. made to it.
  10989. </remarks>
  10990. <example>
  10991. <para>
  10992. Freeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the
  10993. server at localhost, port 4900 with username 'administrator' and a
  10994. blank password.
  10995. </para>
  10996. <code>
  10997. &lt;sscmfreeze
  10998. serverconnect=&quot;localhost:4900&quot;
  10999. serverlogin=&quot;administrator:&quot;
  11000. mainline=&quot;Mainline&quot;
  11001. branch=&quot;Widget 1.0&quot;
  11002. /&gt;
  11003. </code>
  11004. </example>
  11005. </member>
  11006. <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze.WriteCommandLineArguments(System.Text.StringBuilder)">
  11007. <summary>
  11008. Writes the task-specific arguments to the specified
  11009. <see cref="T:System.Text.StringBuilder"/>.
  11010. </summary>
  11011. <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
  11012. </member>
  11013. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze.Branch">
  11014. <summary>
  11015. Surround SCM branch name.
  11016. </summary>
  11017. </member>
  11018. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze.Mainline">
  11019. <summary>
  11020. Surround SCM mainline branch name. The default is pulled from the
  11021. local working directory.
  11022. </summary>
  11023. </member>
  11024. <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet">
  11025. <summary>
  11026. Gets files from a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
  11027. repository.
  11028. </summary>
  11029. <remarks>
  11030. You can get a single file, multiple files, or a repository. A read-only
  11031. copy of the file is created in the specified directory.
  11032. </remarks>
  11033. <example>
  11034. <para>
  11035. Get all files and repositories from repository 'Mainline/Widget'
  11036. recursively from the 'Widget 1.0' branch to the working directory
  11037. setup for user 'administrator'. This call forces the file retrieval
  11038. from the server even if the local file is current and overwrites any
  11039. local files that are writable with the server copy.
  11040. </para>
  11041. <code>
  11042. &lt;sscmget
  11043. serverconnect=&quot;localhost:4900&quot;
  11044. serverlogin=&quot;administrator:&quot;
  11045. file=&quot;/&quot;
  11046. branch=&quot;Widget 1.0&quot;
  11047. repository=&quot;Mainline/Widget&quot;
  11048. recursive=&quot;true&quot;
  11049. force=&quot;true&quot;
  11050. overwrite=&quot;true&quot;
  11051. /&gt;
  11052. </code>
  11053. </example>
  11054. <example>
  11055. <para>
  11056. Get version 1 of the file 'Mainline/Widget/Widget.java' from the
  11057. 'Widget 1.0' branch to the working directory setup for user 'administrator'.
  11058. Writable local files are not overwritten, even if they are out of date.
  11059. </para>
  11060. <code>
  11061. &lt;sscmget
  11062. serverconnect=&quot;localhost:4900&quot;
  11063. serverlogin=&quot;administrator:&quot;
  11064. quiet=&quot;true&quot;
  11065. file=&quot;Widget.java&quot;
  11066. branch=&quot;Widget 1.0&quot;
  11067. repository=&quot;Mainline/Widget&quot;
  11068. overwrite=&quot;false&quot;
  11069. writable=&quot;true&quot;
  11070. version=&quot;1&quot;
  11071. /&gt;
  11072. </code>
  11073. </example>
  11074. <example>
  11075. <para>
  11076. Get all files and repositories labeled with 'Release 1.0.0' (even those
  11077. removed from Surround) from repository 'Mainline/Widget' recursively
  11078. from the 'Widget 1.0' branch to the '${build}/src' directory. Writable
  11079. local files are overwritten with the server copy.
  11080. </para>
  11081. <code>
  11082. &lt;sscmget
  11083. serverconnect=&quot;localhost:4900&quot;
  11084. serverlogin=&quot;administrator:&quot;
  11085. quiet=&quot;true&quot;
  11086. file=&quot;/&quot;
  11087. branch=&quot;Widget 1.0&quot;
  11088. repository=&quot;Mainline/Widget&quot;
  11089. recursive=&quot;true&quot;
  11090. label=&quot;Release 1.0.1&quot;
  11091. destdir=&quot;${build}/src&quot;
  11092. overwrite=&quot;true&quot;
  11093. /&gt;
  11094. </code>
  11095. </example>
  11096. </member>
  11097. <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.WriteCommandLineArguments(System.Text.StringBuilder)">
  11098. <summary>
  11099. Writes the task-specific arguments to the specified
  11100. <see cref="T:System.Text.StringBuilder"/>.
  11101. </summary>
  11102. <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
  11103. </member>
  11104. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Branch">
  11105. <summary>
  11106. Surround SCM branch name. The default is pulled from the local
  11107. working directory.
  11108. </summary>
  11109. </member>
  11110. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Repository">
  11111. <summary>
  11112. Surround SCM repository path. The default is pulled from the local
  11113. working directory.
  11114. </summary>
  11115. </member>
  11116. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File">
  11117. <summary>
  11118. File or repository name. Can be / or empty, which means the repository
  11119. specified by the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Repository"/> attribute or the default
  11120. repository.
  11121. </summary>
  11122. </member>
  11123. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.DestinationDirectory">
  11124. <summary>
  11125. The local directory you want to get the files to. If
  11126. <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File"/> is a repository, a subrepository with the same
  11127. name as the repository is created and files are copied to it. If
  11128. <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File"/> is specified as / or not set, files are copied to
  11129. the local directory. If not specified, files are copied to the
  11130. working directory.
  11131. </summary>
  11132. </member>
  11133. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Writable">
  11134. <summary>
  11135. Make local file editable or writable. The default is
  11136. <see langword="false" />.
  11137. </summary>
  11138. </member>
  11139. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Force">
  11140. <summary>
  11141. Force file retrieval from server regardless of the local copy status.
  11142. The default is <see langword="false" />.
  11143. </summary>
  11144. </member>
  11145. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.ByLabel">
  11146. <summary>
  11147. Label to search for when getting a file. If a file version is
  11148. specified, this parameter is ignored.
  11149. </summary>
  11150. </member>
  11151. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.ByTimestamp">
  11152. <summary>
  11153. Timestamp to use when getting files. Format is yyyymmddhh:mm:ss.
  11154. If <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.ByLabel"/> is specified, this parameter is ignored.
  11155. Requires Surround SCM 3.0 or later.
  11156. </summary>
  11157. </member>
  11158. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.IncludeRemoved">
  11159. <summary>
  11160. Include removed files when getting files by label or timestamp.
  11161. The default is <see langword="true" />. Ignored if a label or
  11162. timestamp is not specified.
  11163. </summary>
  11164. </member>
  11165. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Quiet">
  11166. <summary>
  11167. Do not list repository and local full path of files. The default is
  11168. <see langword="false" />.
  11169. </summary>
  11170. </member>
  11171. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Recursive">
  11172. <summary>
  11173. Recursively get files and sub-repositories. The default is
  11174. <see langword="false" />.
  11175. </summary>
  11176. </member>
  11177. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Overwrite">
  11178. <summary>
  11179. Specifies whether to overwrite local writable files. The default is
  11180. <see langword="false" />.
  11181. </summary>
  11182. </member>
  11183. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Timestamp">
  11184. <summary>
  11185. Specifies how to set the local file's date/time. Possible values are
  11186. <c>current</c>, <c>modify</c> or <c>checkin</c>.
  11187. </summary>
  11188. </member>
  11189. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Version">
  11190. <summary>
  11191. The file version to get. Ignored if a filename is not specified in
  11192. the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File"/> attribute.
  11193. </summary>
  11194. </member>
  11195. <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel">
  11196. <summary>
  11197. Creates file or repository labels for a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
  11198. repository.
  11199. </summary>
  11200. <remarks>
  11201. Labels provide a way to mark a specific version of a file or repository.
  11202. You can create labels for single files, multiple files, or all files in
  11203. a repository. When you create a label, a new entry is created in the history.
  11204. The file, and the version number, do not change. Existing 'Release 1.0.1'
  11205. labels on a file will be moved to the tip version of the file.
  11206. </remarks>
  11207. <example>
  11208. <para>
  11209. Label all files under the 'Mainline/Widget' repository recursively in
  11210. the 'Widget 1.0' branch with 'Release 1.0.1' and the given comment.
  11211. </para>
  11212. <code>
  11213. &lt;sscmlabel
  11214. serverconnect=&quot;localhost:4900&quot;
  11215. serverlogin=&quot;administrator:&quot;
  11216. branch=&quot;Widget 1.0&quot;
  11217. repository=&quot;Mainline/Widget&quot;
  11218. file=&quot;readme.txt&quot;
  11219. recursive=&quot;true&quot;
  11220. label=&quot;Release 1.0.1&quot;
  11221. overwritelabel=&quot;false&quot;
  11222. comment=&quot;This labels the final build for the release of Widget 1.0.1.&quot;
  11223. /&gt;
  11224. </code>
  11225. </example>
  11226. <example>
  11227. <para>
  11228. Label all files under the 'Mainline/Widget' repository recursively in
  11229. the 'Widget 1.0' branch with 'Release 1.0.1' and no comments.
  11230. </para>
  11231. <code>
  11232. &lt;sscmlabel
  11233. serverconnect=&quot;localhost:4900&quot;
  11234. serverlogin=&quot;administrator:&quot;
  11235. branch=&quot;Widget 1.0&quot;
  11236. repository=&quot;Mainline/Widget&quot;
  11237. file=&quot;readme.txt&quot;
  11238. recursive=&quot;true&quot;
  11239. label=&quot;Release 1.0.1&quot;
  11240. /&gt;
  11241. </code>
  11242. </example>
  11243. <example>
  11244. <para>
  11245. Label version 4 of the file 'Mainline/Widget/Widget.java' in the
  11246. 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. An
  11247. existing 'Release 1.0.1' label on this file to be moved to version 4
  11248. of the file.
  11249. </para>
  11250. <code>
  11251. &lt;sscmlabel
  11252. serverconnect=&quot;localhost:4900&quot;
  11253. serverlogin=&quot;administrator:&quot;
  11254. branch=&quot;Widget 1.0&quot;
  11255. repository=&quot;Mainline/Widget&quot;
  11256. file=&quot;readme.txt&quot;
  11257. label=&quot;Release 1.0.1&quot;
  11258. overwritelabel=&quot; true&quot;
  11259. comment=&quot; This labels the final build for the release of Widget 1.0.1.&quot;
  11260. version=&quot; 4&quot;
  11261. /&gt;
  11262. </code>
  11263. </example>
  11264. </member>
  11265. <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.WriteCommandLineArguments(System.Text.StringBuilder)">
  11266. <summary>
  11267. Writes the task-specific arguments to the specified
  11268. <see cref="T:System.Text.StringBuilder"/>.
  11269. </summary>
  11270. <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
  11271. </member>
  11272. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Branch">
  11273. <summary>
  11274. Surround SCM branch name. The default is pulled from the local
  11275. working directory.
  11276. </summary>
  11277. </member>
  11278. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Repository">
  11279. <summary>
  11280. Surround SCM repository path. The default is pulled from the local
  11281. working directory.
  11282. </summary>
  11283. </member>
  11284. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.File">
  11285. <summary>
  11286. File or repository name. Can be / or empty, which means the
  11287. repository specified by the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Repository"/> attribute
  11288. or the default repository.
  11289. </summary>
  11290. </member>
  11291. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Label">
  11292. <summary>
  11293. The new label to create.
  11294. </summary>
  11295. </member>
  11296. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Recursive">
  11297. <summary>
  11298. Recursively label all files. The default is <see langword="false" />.
  11299. </summary>
  11300. </member>
  11301. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Overwrite">
  11302. <summary>
  11303. Overwrite the existing label. The default is <see langword="false" />.
  11304. </summary>
  11305. </member>
  11306. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Comment">
  11307. <summary>
  11308. Comment for the label.
  11309. </summary>
  11310. </member>
  11311. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Version">
  11312. <summary>
  11313. The file version to label. Ignored if a filename is not specified in
  11314. the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.File"/> attribute.
  11315. </summary>
  11316. </member>
  11317. <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze">
  11318. <summary>
  11319. Unlocks frozen branches for a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
  11320. repository.
  11321. </summary>
  11322. <example>
  11323. <para>
  11324. Unfreeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the
  11325. server at localhost, port 4900 with username 'administrator' and a
  11326. blank password.
  11327. </para>
  11328. <code>
  11329. &lt;sscmunfreeze
  11330. serverconnect=&quot;localhost:4900&quot;
  11331. serverlogin=&quot;administrator:&quot;
  11332. mainline=&quot;Mainline&quot;
  11333. branch=&quot;Widget 1.0&quot;
  11334. /&gt;
  11335. </code>
  11336. </example>
  11337. </member>
  11338. <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze.WriteCommandLineArguments(System.Text.StringBuilder)">
  11339. <summary>
  11340. Writes the task-specific arguments to the specified
  11341. <see cref="T:System.Text.StringBuilder"/>.
  11342. </summary>
  11343. <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
  11344. </member>
  11345. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze.Branch">
  11346. <summary>
  11347. Surround SCM branch name.
  11348. </summary>
  11349. </member>
  11350. <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze.Mainline">
  11351. <summary>
  11352. Surround SCM mainline branch name. The default is pulled from the local working directory.
  11353. </summary>
  11354. </member>
  11355. <member name="T:NAnt.Contrib.Tasks.Svn.AbstractSvnTask">
  11356. <summary>
  11357. A base class for creating tasks for executing CVS client commands on a
  11358. CVS repository.
  11359. </summary>
  11360. </member>
  11361. <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_HOME">
  11362. <summary>
  11363. An environment variable that holds path information about where
  11364. svn is located.
  11365. </summary>
  11366. </member>
  11367. <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.ARG_PREFIX">
  11368. <summary>
  11369. The prefix used for command arguments.
  11370. </summary>
  11371. </member>
  11372. <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_EXE">
  11373. <summary>
  11374. The name of the svn executable.
  11375. </summary>
  11376. </member>
  11377. <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_RSH">
  11378. <summary>
  11379. Environment variable that holds the executable name that is used for
  11380. ssh communication.
  11381. </summary>
  11382. </member>
  11383. <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_PASSFILE">
  11384. <summary>
  11385. Name of the password file that is used to cash password settings.
  11386. </summary>
  11387. </member>
  11388. <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.#ctor">
  11389. <summary>
  11390. Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.Svn.AbstractSvnTask"/>
  11391. class.
  11392. </summary>
  11393. </member>
  11394. <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.PrepareProcess(System.Diagnostics.Process)">
  11395. <summary>
  11396. Build up the command line arguments, determine which executable is being
  11397. used and find the path to that executable and set the working
  11398. directory.
  11399. </summary>
  11400. <param name="process">The process to prepare.</param>
  11401. </member>
  11402. <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.AppendCommandOptions">
  11403. <summary>
  11404. Append the command line options or commen names for the options
  11405. to the generic options collection. This is then piped to the
  11406. command line as a switch.
  11407. </summary>
  11408. </member>
  11409. <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.GetSvnExePath">
  11410. <summary>
  11411. Gets the full path of the svn executable.
  11412. </summary>
  11413. <exception cref="T:NAnt.Core.BuildException">
  11414. Exception is thrown when Subversion client
  11415. executable cannot be found.
  11416. </exception>
  11417. <returns>
  11418. The full path of the svn executable.
  11419. </returns>
  11420. </member>
  11421. <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SetPropertiesDefaults">
  11422. <summary>
  11423. Set default values for non-requiered parameters.
  11424. </summary>
  11425. </member>
  11426. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.VcsExeName">
  11427. <summary>
  11428. The name of the executable.
  11429. </summary>
  11430. </member>
  11431. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.PassFileName">
  11432. <summary>
  11433. The name of the password file.
  11434. </summary>
  11435. </member>
  11436. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.VcsHomeEnv">
  11437. <summary>
  11438. Name of the home environment variable.
  11439. </summary>
  11440. </member>
  11441. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SshEnv">
  11442. <summary>
  11443. The name of the ssh/ rsh environment variable.
  11444. </summary>
  11445. </member>
  11446. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.ExeName">
  11447. <summary>
  11448. The full path of the svn executable.
  11449. </summary>
  11450. </member>
  11451. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Root">
  11452. <summary>
  11453. <para>
  11454. TODO: Add more documentation when I understand all svn root possibilities/
  11455. protocols.
  11456. The svn root is usually in the form of a URL from which the server, protocol
  11457. and path information can be derived. Although the path to the repository
  11458. can also be determined from this the information is more implicit
  11459. than explicit. For example a subversion root URL of:
  11460. http://svn.collab.net/repos/svn/trunk/doc/book/tools
  11461. would have the following components:
  11462. protocol: http/ web_dav
  11463. username: anonymous
  11464. servername: svn.collab.net
  11465. repository: /repos/svn
  11466. server path: /trunk/doc/book/tools
  11467. In addition the revision path or branch can also be determined as
  11468. subversion stores this information as a seperate physical directory.
  11469. In this example:
  11470. revision: trunk
  11471. </para>
  11472. </summary>
  11473. </member>
  11474. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.UserName">
  11475. <summary>
  11476. The user performing the checkout.
  11477. </summary>
  11478. </member>
  11479. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Password">
  11480. <summary>
  11481. The pasword to use to login to svn.
  11482. </summary>
  11483. </member>
  11484. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Interactive">
  11485. <summary>
  11486. Indicates whether the task should be interactive or not. This is
  11487. set to <see langword="false" /> by default, and I don't see a reason
  11488. to expose this to the NAnt task.
  11489. </summary>
  11490. </member>
  11491. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Ssh">
  11492. <summary>
  11493. The executable to use for ssh communication.
  11494. </summary>
  11495. </member>
  11496. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.CommandName">
  11497. <summary>
  11498. The command to execute.
  11499. </summary>
  11500. </member>
  11501. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Quiet">
  11502. <summary>
  11503. Specifies whether to print as little information as possible.
  11504. The default is <see langword="false" />.
  11505. </summary>
  11506. </member>
  11507. <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.IsRootUsed">
  11508. <summary>
  11509. Determines if the root is used for the command based on
  11510. the command name. Returns <code>true</code> if the root
  11511. is used, otherwise returns <code>false</code>.
  11512. </summary>
  11513. </member>
  11514. <member name="T:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask">
  11515. <summary>
  11516. Executes the svn checkout command.
  11517. </summary>
  11518. <example>
  11519. <para>Checkout Gentle.NET.</para>
  11520. <code>
  11521. <![CDATA[
  11522. <svn-update
  11523. destination="c:/dev/src/gentle.net"
  11524. uri="http://www.mertner.com/svn/repos/projects/gentle"
  11525. recursive="true"
  11526. verbose="false"
  11527. username="anonymoose"
  11528. password="Canada"
  11529. revision="HEAD"
  11530. cache-auth="false"
  11531. config-dir="c:\home"
  11532. />
  11533. ]]>
  11534. </code>
  11535. </example>
  11536. </member>
  11537. <member name="M:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.#ctor">
  11538. <summary>
  11539. Initialize the task, and set the default parameters.
  11540. </summary>
  11541. </member>
  11542. <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.CommandName">
  11543. <summary>
  11544. Gets the svn command to execute.
  11545. </summary>
  11546. <value>
  11547. The svn command to execute. The default value is "checkout".
  11548. </value>
  11549. </member>
  11550. <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.Recursive">
  11551. <summary>
  11552. <see langword="true" /> if the command should be executed recursively.
  11553. The default is <see langword="true" />.
  11554. </summary>
  11555. </member>
  11556. <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.Revision">
  11557. <summary>
  11558. The revision to checkout. If no revision is specified then subversion
  11559. will return the <code>HEAD</code>.
  11560. </summary>
  11561. <remarks>
  11562. A revision argument can be one of:
  11563. NUMBER revision number
  11564. "{" DATE "}" revision at start of the date
  11565. "HEAD" latest in repository
  11566. "BASE" base rev of item's working copy
  11567. "COMMITTED" last commit at or before BASE
  11568. "PREV" revision just before COMMITTED
  11569. </remarks>
  11570. </member>
  11571. <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.CacheAuth">
  11572. <summary>
  11573. <see langword="true" /> if the authentiction token should be cached
  11574. locally.
  11575. </summary>
  11576. </member>
  11577. <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.ConfigDir">
  11578. <summary>
  11579. The location of the configuration directory.
  11580. </summary>
  11581. </member>
  11582. <member name="T:NAnt.Contrib.Tasks.Svn.SvnTask">
  11583. <summary>
  11584. Executes the svn command specified by the command attribute.
  11585. </summary>
  11586. <example>
  11587. <para>Checkout Gentle.NET.</para>
  11588. <code>
  11589. <![CDATA[
  11590. <svn command="checkout"
  11591. destination="c:\dev\src\gentle.net"
  11592. svnroot="http://www.mertner.com/svn/repos/projects/gentle"
  11593. password="" />
  11594. ]]>
  11595. </code>
  11596. </example>
  11597. </member>
  11598. <member name="P:NAnt.Contrib.Tasks.Svn.SvnTask.CommandName">
  11599. <summary>
  11600. The svn command to execute.
  11601. </summary>
  11602. </member>
  11603. <member name="T:NAnt.Contrib.Tasks.Svn.SvnUpdateTask">
  11604. <summary>
  11605. Executes the svn update specified by the command attribute.
  11606. </summary>
  11607. <example>
  11608. <para>Update Gentle.NET.</para>
  11609. <code>
  11610. <![CDATA[
  11611. <svn-update
  11612. destination="c:\dev\src\gentle.net"
  11613. uri="http://www.mertner.com/svn/repos/projects/gentle"
  11614. recursive="true"
  11615. quiet="true"
  11616. username="anonymoose"
  11617. password="Canada"
  11618. revision="HEAD"
  11619. cach-auth="false"
  11620. config-dir="c:\home"
  11621. />
  11622. ]]>
  11623. </code>
  11624. </example>
  11625. </member>
  11626. <member name="P:NAnt.Contrib.Tasks.Svn.SvnUpdateTask.CommandName">
  11627. <summary>
  11628. Gets the svn command to execute.
  11629. </summary>
  11630. <value>
  11631. The svn command to execute. The default value is "update".
  11632. </value>
  11633. </member>
  11634. <member name="T:NAnt.Contrib.Tasks.Web.ApplicationPool">
  11635. <summary>
  11636. Allows an IIS application pool to be controlled.
  11637. </summary>
  11638. <example>
  11639. <para>
  11640. Starts the &quot;StsAdminAppPool&quot; application pool on server
  11641. &quot;SV-ARD-WEB&quot;.
  11642. </para>
  11643. <code>
  11644. <![CDATA[
  11645. <iisapppool action="Start" pool="StsAdminPool" server="SV-ARD-WEB" />
  11646. ]]>
  11647. </code>
  11648. </example>
  11649. <example>
  11650. <para>
  11651. Stops and restarts the &quot;DefaultAppPool&quot; application pool
  11652. on server &quot;SV-ARD-WEB&quot;.
  11653. </para>
  11654. <code>
  11655. <![CDATA[
  11656. <iisapppool action="Restart" pool="DefaultAppPool" server="SV-ARD-WEB" />
  11657. ]]>
  11658. </code>
  11659. </example>
  11660. </member>
  11661. <member name="P:NAnt.Contrib.Tasks.Web.ApplicationPool.Server">
  11662. <summary>
  11663. The name of the server on which to perform the action. The default
  11664. is the local computer.
  11665. </summary>
  11666. </member>
  11667. <member name="P:NAnt.Contrib.Tasks.Web.ApplicationPool.PoolName">
  11668. <summary>
  11669. The name of the application pool on which to perform the action.
  11670. </summary>
  11671. </member>
  11672. <member name="P:NAnt.Contrib.Tasks.Web.ApplicationPool.Action">
  11673. <summary>
  11674. The action that should be performed on the application pool.
  11675. </summary>
  11676. </member>
  11677. <member name="T:NAnt.Contrib.Tasks.Web.ApplicationPool.ApplicationPoolAction">
  11678. <summary>
  11679. Defines the actions that can be performed on an application pool.
  11680. </summary>
  11681. </member>
  11682. <member name="F:NAnt.Contrib.Tasks.Web.ApplicationPool.ApplicationPoolAction.Start">
  11683. <summary>
  11684. Starts the application pool.
  11685. </summary>
  11686. </member>
  11687. <member name="F:NAnt.Contrib.Tasks.Web.ApplicationPool.ApplicationPoolAction.Stop">
  11688. <summary>
  11689. Stops the application pool.
  11690. </summary>
  11691. </member>
  11692. <member name="F:NAnt.Contrib.Tasks.Web.ApplicationPool.ApplicationPoolAction.Restart">
  11693. <summary>
  11694. Stops and restarts the application pool.
  11695. </summary>
  11696. </member>
  11697. <member name="F:NAnt.Contrib.Tasks.Web.ApplicationPool.ApplicationPoolAction.Recycle">
  11698. <summary>
  11699. Recycles an application pool.
  11700. </summary>
  11701. </member>
  11702. <member name="T:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory">
  11703. <summary>
  11704. Creates or modifies a virtual directory of a web site hosted on Internet
  11705. Information Server.
  11706. </summary>
  11707. <remarks>
  11708. <para>
  11709. If the virtual directory does not exist it is created, and if it already
  11710. exists it is modified. Only the IIS-properties specified will be set. If set
  11711. by other means (e.g. the Management Console), the unspecified properties retain their current value,
  11712. otherwise they are inherited from the parent.
  11713. </para>
  11714. <para>
  11715. For a list of optional parameters see <see href="ms-help://MS.VSCC/MS.MSDNVS/iisref/html/psdk/asp/aore8v5e.htm">IIsWebVirtualDir</see>.
  11716. </para>
  11717. <para>
  11718. More information on metabase parameters is available <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/iissdk/iis/alphabeticmetabasepropertylist.asp">here</see>.
  11719. </para>
  11720. </remarks>
  11721. <example>
  11722. <para>
  11723. Create a virtual directory named <c>Temp</c> pointing to <c>c:\temp</c>
  11724. on the local machine.
  11725. </para>
  11726. <code>
  11727. <![CDATA[
  11728. <mkiisdir dirpath="c:\temp" vdirname="Temp" />
  11729. ]]>
  11730. </code>
  11731. </example>
  11732. <example>
  11733. <para>
  11734. Create a virtual directory named <c>Temp</c> pointing to <c>c:\temp</c>
  11735. on machine <c>Staging</c>.
  11736. </para>
  11737. <code>
  11738. <![CDATA[
  11739. <mkiisdir iisserver="Staging" dirpath="c:\temp" vdirname="Temp" />
  11740. ]]>
  11741. </code>
  11742. </example>
  11743. <example>
  11744. <para>
  11745. Configure the home directory of for http://svc.here.dev/ to point to
  11746. D:\Develop\Here and require authentication
  11747. </para>
  11748. <code>
  11749. <![CDATA[
  11750. <mkiisdir iisserver="svc.here.dev" dirpath="D:\Develop\Here" vdirname="/" authanonymous="false"/>
  11751. ]]>
  11752. </code>
  11753. </example>
  11754. <example>
  11755. <para>
  11756. Create a virtual directory named <c>WebServices/Dev</c> pointing to
  11757. <c>c:\MyProject\dev</c> on the web site running on port <c>81</c> of
  11758. machine <c>MyHost</c>.
  11759. </para>
  11760. <code>
  11761. <![CDATA[
  11762. <mkiisdir iisserver="MyHost:81" dirpath="c:\MyProject\dev" vdirname="WebServices/Dev" />
  11763. ]]>
  11764. </code>
  11765. Note that if <c>WebServices</c> is neither an existing virtual directory nor an
  11766. existing physical subdirectory of the web root, your IIS Management Console
  11767. will get confused. Even though <c>http://MyHost:81/WebServices/Dev/theService.asmx</c>
  11768. may be a perfectly working webservice, the Management Console will not show it.
  11769. </example>
  11770. </member>
  11771. <member name="T:NAnt.Contrib.Tasks.Web.WebBase">
  11772. <summary>
  11773. Base class for all IIS-related task.
  11774. </summary>
  11775. <remarks>
  11776. Basically this class hold the logic to determine the IIS version as well
  11777. as the IIS server/port determination/checking logic.
  11778. </remarks>
  11779. </member>
  11780. <member name="P:NAnt.Contrib.Tasks.Web.WebBase.VirtualDirectory">
  11781. <summary>
  11782. Name of the IIS virtual directory.
  11783. </summary>
  11784. </member>
  11785. <member name="P:NAnt.Contrib.Tasks.Web.WebBase.Server">
  11786. <summary>
  11787. The IIS server, which can be specified using the format <c>[host]:[port]</c>.
  11788. The default is <c>localhost:80</c>.
  11789. </summary>
  11790. <remarks>
  11791. <para>
  11792. This allows for targeting a specific virtual site on a physical box.
  11793. </para>
  11794. </remarks>
  11795. </member>
  11796. <member name="P:NAnt.Contrib.Tasks.Web.WebBase.Website">
  11797. <summary>
  11798. The website on the IIS server.
  11799. </summary>
  11800. <remarks>
  11801. <para>
  11802. This allows for targeting a specific virtual site on a physical box.
  11803. </para>
  11804. </remarks>
  11805. </member>
  11806. <member name="P:NAnt.Contrib.Tasks.Web.WebBase.Version">
  11807. <summary>
  11808. Gets the version of IIS corresponding with the current OS.
  11809. </summary>
  11810. <value>
  11811. The version of IIS corresponding with the current OS.
  11812. </value>
  11813. </member>
  11814. <member name="T:NAnt.Contrib.Tasks.Web.WebBase.IISVersion">
  11815. <summary>
  11816. Defines the IIS versions supported by the IIS tasks.
  11817. </summary>
  11818. </member>
  11819. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppFriendlyName">
  11820. <summary>
  11821. The user-friendly name of the package or application.
  11822. </summary>
  11823. </member>
  11824. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirPath">
  11825. <summary>
  11826. The file system path.
  11827. </summary>
  11828. </member>
  11829. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute">
  11830. <summary>
  11831. Indicates whether the file or the contents of the folder may be
  11832. executed, regardless of file type. The default is <see langword="false" />.
  11833. </summary>
  11834. </member>
  11835. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteExecute">
  11836. <summary>
  11837. Indicates whether remote requests to execute applications are denied;
  11838. only requests from the same computer as the IIS server succeed if
  11839. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute"/> is set to <see langword="true"/>. You
  11840. cannot set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteExecute"/> to <see langword="false"/>
  11841. to enable remote requests, and set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute"/> to
  11842. <see langword="false"/> to disable local requests. The default is
  11843. <see langword="false"/>.
  11844. </summary>
  11845. </member>
  11846. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteRead">
  11847. <summary>
  11848. Indicates whether remote requests to view files are denied;
  11849. only requests from the same computer as the IIS server succeed if
  11850. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute"/> is set to <see langword="true"/>. You
  11851. cannot set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteRead"/> to <see langword="false"/>
  11852. to enable remote requests, and set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessRead"/> to
  11853. <see langword="false"/> to disable local requests. The default is
  11854. <see langword="false"/>.
  11855. </summary>
  11856. </member>
  11857. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteScript">
  11858. <summary>
  11859. A value of true indicates that remote requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests.
  11860. </summary>
  11861. </member>
  11862. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteWrite">
  11863. <summary>
  11864. indicates that remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests.
  11865. </summary>
  11866. </member>
  11867. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessRead">
  11868. <summary>
  11869. Indicates whether the file or the contents of the folder may be
  11870. read. The default is <see langword="true" />.
  11871. </summary>
  11872. </member>
  11873. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSource">
  11874. <summary>
  11875. Indicates whether users are allowed to access source code if either
  11876. Read or Write permissions are set. The default is <see langword="false" />.
  11877. </summary>
  11878. </member>
  11879. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessScript">
  11880. <summary>
  11881. Indicates whether the file or the contents of the folder may be
  11882. executed if they are script files or static content. The default
  11883. is <see langword="true" />.
  11884. </summary>
  11885. </member>
  11886. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSsl">
  11887. <summary>
  11888. Indicates whether file access requires SSL file permission processing,
  11889. with or without a client certificate. The default is <see langword="false" />.
  11890. </summary>
  11891. </member>
  11892. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccesssSl128">
  11893. <summary>
  11894. Indicates whether file access requires SSL file permission processing
  11895. with a minimum key size of 128 bits, with or without a client
  11896. certificate. The default is <see langword="false" />.
  11897. </summary>
  11898. </member>
  11899. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslMapCert">
  11900. <summary>
  11901. Indicates whether SSL file permission processing maps a client
  11902. certificate to a Microsoft Windows ® operating system user-account.
  11903. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert"/> must also be set to
  11904. <see langword="true"/> for the mapping to occur. The default is
  11905. <see langword="false"/>.
  11906. </summary>
  11907. </member>
  11908. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert">
  11909. <summary>
  11910. Indicates whether SSL file access processing requests a certificate
  11911. from the client. The default is <see langword="false" />.
  11912. </summary>
  11913. </member>
  11914. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslRequireCert">
  11915. <summary>
  11916. Indicates whether SSL file access processing requests a certificate
  11917. from the client. If the client provides no certificate, the connection
  11918. is closed. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert"/> must also be set to
  11919. <see langword="true"/> when using <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslRequireCert"/>.
  11920. The default is <see langword="false"/>.
  11921. </summary>
  11922. </member>
  11923. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessWrite">
  11924. <summary>
  11925. Indicates whether users are allowed to upload files and their
  11926. associated properties to the enabled directory on your server or
  11927. to change content in a Write-enabled file. The default is
  11928. <see langword="false" />.
  11929. </summary>
  11930. </member>
  11931. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AnonymousPasswordSync">
  11932. <summary>
  11933. Indicates whether IIS should handle the user password for anonymous
  11934. users attempting to access resources. The default is
  11935. <see langword="false" />.
  11936. </summary>
  11937. </member>
  11938. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppCreate">
  11939. <summary>
  11940. Specifies what type of application to create for this virtual directory.
  11941. The default is <see cref="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.Pooled"/>.
  11942. </summary>
  11943. </member>
  11944. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppAllowClientDebug">
  11945. <summary>
  11946. Specifies whether ASP client-side debugging is enabled. The default
  11947. is <see langword="false" />.
  11948. </summary>
  11949. </member>
  11950. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppAllowDebugging">
  11951. <summary>
  11952. Specifies whether ASP debugging is enabled on the server. The default
  11953. is <see langword="false" />.
  11954. </summary>
  11955. </member>
  11956. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppPoolId">
  11957. <summary>
  11958. Specifies the application pool where the application is routed
  11959. (IIS 6.0 or higher).
  11960. </summary>
  11961. </member>
  11962. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspAllowSessionState">
  11963. <summary>
  11964. Enables session state persistence for the ASP application. The
  11965. default is <see langword="true" />.
  11966. </summary>
  11967. </member>
  11968. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspBufferingOn">
  11969. <summary>
  11970. Specifies whether output from an ASP application will be buffered.
  11971. If <see langword="true" />, all output from the application is
  11972. collected in the buffer before the buffer is flushed to the client.
  11973. With buffering on, the ASP application has to completely process the
  11974. ASP script before the client receives any output. The default is
  11975. <see langword="true" />.
  11976. </summary>
  11977. </member>
  11978. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableApplicationRestart">
  11979. <summary>
  11980. Determines whether an ASP application can be automatically restarted.
  11981. When changes are made to Global.asa or metabase properties that affect
  11982. an application, the application will not restart unless the
  11983. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableApplicationRestart"/> property is set to
  11984. <see langword="false"/>. The default is <see langword="true"/>.
  11985. </summary>
  11986. <remarks>
  11987. When this property is changed from <see langword="false"/> to
  11988. <see langword="true"/>, the application immediately restarts.
  11989. </remarks>
  11990. </member>
  11991. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableAspHtmlFallback">
  11992. <summary>
  11993. Controls the behavior of ASP when a new request is to be rejected
  11994. due to a full request queue. If <see langword="true" />, an .htm file
  11995. with a similar name as the requested .asp file, will be sent instead
  11996. of the .asp file. The naming convention for the .htm file is the
  11997. name of the .asp file with _asp appended. The default is
  11998. <see langword="false" />.
  11999. </summary>
  12000. </member>
  12001. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableChunkedEncoding">
  12002. <summary>
  12003. Specifies whether HTTP 1.1 chunked transfer encoding is enabled for
  12004. the World Wide Web Publishing Service (WWW service). The default is
  12005. <see langword="false" />.
  12006. </summary>
  12007. </member>
  12008. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog">
  12009. <summary>
  12010. Specifies which ASP errors are written to the Windows event log.
  12011. </summary>
  12012. <remarks>
  12013. <para>
  12014. ASP errors are written to the client browser and to the IIS log files
  12015. by default. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
  12016. by default, and is modified by <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> in
  12017. the following way:
  12018. </para>
  12019. <para>
  12020. If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="false"/>,
  12021. then ASP errors are not written to the Windows event log, regardless
  12022. of the value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>.
  12023. </para>
  12024. <para>
  12025. If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>,
  12026. and if IIS fails to write an item to the IIS log file, the item is
  12027. written to the Windows event log as a warning, regardless of the
  12028. value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>.
  12029. </para>
  12030. <para>
  12031. If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
  12032. and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="false"/>,
  12033. then only the most serious ASP errors are sent to the Windows event log.
  12034. Serious ASP error numbers are: 100, 101, 102, 103, 104, 105, 106, 107,
  12035. 115, 190, 191, 192, 193, 194, 240, 241, and 242.
  12036. </para>
  12037. <para>
  12038. If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
  12039. and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="true"/>,
  12040. then all ASP errors are written to the Windows event log.
  12041. </para>
  12042. </remarks>
  12043. </member>
  12044. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableParentPaths">
  12045. <summary>
  12046. Specifies whether an ASP page allows paths relative to the current
  12047. directory. The default is <see langword="true" />.
  12048. </summary>
  12049. </member>
  12050. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableTypelibCache">
  12051. <summary>
  12052. Specifies whether type libraries are cached on the server. The
  12053. default is <see langword="true" />.
  12054. </summary>
  12055. <remarks>
  12056. <para>
  12057. The World Wide Web Publishing Service (WWW service) setting for
  12058. this property is applicable to all in-process and pooled out-of-process
  12059. application nodes, at all levels.
  12060. </para>
  12061. <para>
  12062. Metabase settings at the Web server level or lower are ignored
  12063. for in-process and pooled out-of-process applications. However,
  12064. settings at the Web server level or lower are used if that node
  12065. is an isolated out-of-process application.
  12066. </para>
  12067. </remarks>
  12068. </member>
  12069. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspExceptionCatchEnable">
  12070. <summary>
  12071. Specifies whether ASP pages trap exceptions thrown by components.
  12072. If set to <see langword="false" />, the Microsoft Script Debugger tool
  12073. does not catch exceptions sent by the component that you are debugging.
  12074. The default is <see langword="true" />.
  12075. </summary>
  12076. </member>
  12077. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests">
  12078. <summary>
  12079. Controls whether the Web server writes ASP errors to the application
  12080. section of the Windows event log. The default is <see langword="true"/>.
  12081. </summary>
  12082. <remarks>
  12083. <para>
  12084. ASP errors are written to the client browser and to the IIS log files
  12085. by default. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
  12086. by default, and is modified by <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> in
  12087. the following way:
  12088. </para>
  12089. <para>
  12090. If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="false"/>,
  12091. then ASP errors are not written to the Windows event log, regardless
  12092. of the value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>.
  12093. </para>
  12094. <para>
  12095. If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>,
  12096. and if IIS fails to write an item to the IIS log file, the item is
  12097. written to the Windows event log as a warning, regardless of the
  12098. value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>.
  12099. </para>
  12100. <para>
  12101. If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
  12102. and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="false"/>,
  12103. then only the most serious ASP errors are sent to the Windows event log.
  12104. Serious ASP error numbers are: 100, 101, 102, 103, 104, 105, 106, 107,
  12105. 115, 190, 191, 192, 193, 194, 240, 241, and 242.
  12106. </para>
  12107. <para>
  12108. If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
  12109. and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="true"/>,
  12110. then all ASP errors are written to the Windows event log.
  12111. </para>
  12112. </remarks>
  12113. </member>
  12114. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspScriptErrorSentToBrowser">
  12115. <summary>
  12116. Specifies whether the Web server writes debugging specifics
  12117. (file name, error, line number, description) to the client browser,
  12118. in addition to logging them to the Windows Event Log. The default
  12119. is <see langword="true" />.
  12120. </summary>
  12121. </member>
  12122. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspThreadGateEnabled">
  12123. <summary>
  12124. Indicates whether IIS thread gating is enabled (only applies to IIS 4 and 5).
  12125. The default is <see langword="false" />.
  12126. </summary>
  12127. <remarks>
  12128. IIS performs thread gating to dynamically control the number of
  12129. concurrently executing threads, in response to varying load conditions.
  12130. </remarks>
  12131. </member>
  12132. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspTrackThreadingModel">
  12133. <summary>
  12134. Specifies whether IIS checks the threading model of any components
  12135. that your application creates. The default is <see langword="false" />.
  12136. </summary>
  12137. </member>
  12138. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthAnonymous">
  12139. <summary>
  12140. Specifies Anonymous authentication as one of the possible authentication
  12141. schemes returned to clients as being available. The default is
  12142. <see langword="true" />.
  12143. </summary>
  12144. </member>
  12145. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthBasic">
  12146. <summary>
  12147. Specifies Basic authentication as one of the possible authentication
  12148. schemes returned to clients as being available. The default is
  12149. <see langword="false" />.
  12150. </summary>
  12151. </member>
  12152. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthNtlm">
  12153. <summary>
  12154. Specifies Integrated Windows authentication as one of the possible
  12155. authentication schemes returned to clients as being available. The
  12156. default is <see langword="false" />.
  12157. </summary>
  12158. </member>
  12159. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthPersistSingleRequest">
  12160. <summary>
  12161. Specifies that authentication persists only for a single request on
  12162. a connection. IIS resets the authentication at the end of each request,
  12163. and forces re-authentication on the next request of the session.
  12164. </summary>
  12165. <remarks>
  12166. [IIS 6.0] When the AuthPersistSingleRequest flag is set to true when
  12167. using NTLM authentication, IIS 6.0 automatically reauthenticates every
  12168. request, even those on the same connection.
  12169. </remarks>
  12170. </member>
  12171. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthPersistSingleRequestIfProxy">
  12172. <summary>
  12173. Specifies authentication will persist only across single requests
  12174. on a connection if the connection is by proxy. Applies to IIS 5.0
  12175. and 5.1. The default is <see langword="false" />
  12176. </summary>
  12177. <remarks>
  12178. IIS will reset the authentication at the end of the request if the current authenticated
  12179. request is by proxy and it is not the special case where IIS is running MSPROXY
  12180. </remarks>
  12181. </member>
  12182. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthPersistSingleRequestAlwaysIfProxy">
  12183. <summary>
  12184. Specifies whether authentication is valid for a single request
  12185. if by proxy. IIS will reset the authentication at the end of the
  12186. request and force re-authentication on the next request if the
  12187. current authenticated request is by proxy of any type. Applies to
  12188. IIS 5.0 and 5.1. The default is <see langword="false" />.
  12189. </summary>
  12190. </member>
  12191. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CacheControlNoCache">
  12192. <summary>
  12193. Specifies whether the HTTP 1.1 directive to prevent caching of content
  12194. should be sent to clients. The default is <see langword="false" />.
  12195. </summary>
  12196. </member>
  12197. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CacheIsapi">
  12198. <summary>
  12199. Indicates whether ISAPI extensions are cached in memory after first
  12200. use. The default is <see langword="true" />.
  12201. </summary>
  12202. </member>
  12203. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.ContentIndexed">
  12204. <summary>
  12205. Specifies whether the installed content indexer should index content
  12206. under this directory tree. The default is <see langword="true" />.
  12207. </summary>
  12208. </member>
  12209. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CpuAppEnabled">
  12210. <summary>
  12211. Specifies whether process accounting and throttling should be performed
  12212. for ISAPI extensions and ASP applications. The default is
  12213. <see langword="true" />.
  12214. </summary>
  12215. </member>
  12216. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CpuCgiEnabled">
  12217. <summary>
  12218. Indicates whether IIS should perform process accounting for CGI
  12219. applications. The default is <see langword="true" />.
  12220. </summary>
  12221. </member>
  12222. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CreateCgiWithNewConsole">
  12223. <summary>
  12224. Indicates whether a CGI application runs in its own console. The
  12225. default is <see langword="false" />.
  12226. </summary>
  12227. </member>
  12228. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CreateProcessAsUser">
  12229. <summary>
  12230. Specifies whether a CGI process is created in the system context
  12231. or in the context of the requesting user. The default is
  12232. <see langword="true" />.
  12233. </summary>
  12234. </member>
  12235. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowDate">
  12236. <summary>
  12237. Specifies whether date information is displayed when browsing
  12238. directories. The default is <see langword="true" />.
  12239. </summary>
  12240. </member>
  12241. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowExtension">
  12242. <summary>
  12243. Specifies whether file extensions are displayed when browsing
  12244. directories. The default is <see langword="true" />.
  12245. </summary>
  12246. </member>
  12247. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowLongDate">
  12248. <summary>
  12249. Specifies whether date information is displayed in extended format
  12250. when displaying directories. The default is <see langword="true" />.
  12251. </summary>
  12252. </member>
  12253. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowSize">
  12254. <summary>
  12255. Specifies whether file size information is displayed when displaying
  12256. directories. The default is <see langword="true" />.
  12257. </summary>
  12258. </member>
  12259. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowTime">
  12260. <summary>
  12261. Specifies whether file creation time is displayed when browsing
  12262. directories. The default is <see langword="true" />.
  12263. </summary>
  12264. </member>
  12265. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DontLog">
  12266. <summary>
  12267. Specifies whether client requests are written to the IIS log files.
  12268. The default is <see langword="false" />.
  12269. </summary>
  12270. </member>
  12271. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableDefaultDoc">
  12272. <summary>
  12273. When set to true, the default document (specified by the DefaultDoc property) for a directory is loaded when the directory is browsed.
  12274. </summary>
  12275. </member>
  12276. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableDirBrowsing">
  12277. <summary>
  12278. Specifies whether directory browsing is enabled. The default is
  12279. <see langword="false" />.
  12280. </summary>
  12281. </member>
  12282. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableDocFooter">
  12283. <summary>
  12284. Enables or disables custom footers. The default is
  12285. <see langword="false" />.
  12286. </summary>
  12287. </member>
  12288. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableReverseDns">
  12289. <summary>
  12290. Enables or disables reverse Domain Name Server (DNS) lookups for
  12291. the World Wide Web Publishing Service (WWW service). The default is
  12292. <see langword="false" />.
  12293. </summary>
  12294. </member>
  12295. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.SsiExecDisable">
  12296. <summary>
  12297. Specifies whether server-side include (SSI) #exec directives are
  12298. disabled under this path. The default is <see langword="false" />.
  12299. </summary>
  12300. </member>
  12301. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.UncAuthenticationPassthrough">
  12302. <summary>
  12303. </summary>
  12304. </member>
  12305. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspScriptErrorMessage">
  12306. <summary>
  12307. </summary>
  12308. </member>
  12309. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DefaultDoc">
  12310. <summary>
  12311. One or more file names of default documents that will be returned to
  12312. the client if no file name is included in the client's request.
  12313. </summary>
  12314. </member>
  12315. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.UncUserName">
  12316. <summary>
  12317. Specifies the user name for Universal Naming Convention (UNC) virtual
  12318. roots.
  12319. </summary>
  12320. </member>
  12321. <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.UncPassword">
  12322. <summary>
  12323. Specifies the encrypted password used to gain access to UNC
  12324. (Universal Naming Convention) virtual roots.
  12325. </summary>
  12326. </member>
  12327. <member name="T:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType">
  12328. <summary>
  12329. The different ways a (virtual) directory in IIS can be configured
  12330. as an application.
  12331. </summary>
  12332. </member>
  12333. <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.None">
  12334. <summary>
  12335. Virtual directory is not configured as an application.
  12336. </summary>
  12337. </member>
  12338. <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.InProcess">
  12339. <summary>
  12340. Virtual directory is configured as an in-process application.
  12341. </summary>
  12342. </member>
  12343. <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.Pooled">
  12344. <summary>
  12345. Virtual directory is configured as a pooled out-of-process
  12346. application. For IIS4 this is the same as <see cref="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.OutOfProcess"/>.
  12347. </summary>
  12348. </member>
  12349. <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.OutOfProcess">
  12350. <summary>
  12351. Virtual directory is configured as an out-of-process application.
  12352. </summary>
  12353. </member>
  12354. <member name="T:NAnt.Contrib.Tasks.Web.DeleteVirtualDirectory">
  12355. <summary>
  12356. Deletes a virtual directory from a given web site hosted on Internet
  12357. Information Server.
  12358. </summary>
  12359. <example>
  12360. <para>
  12361. Delete a virtual directory named <c>Temp</c> from the web site running
  12362. on port <c>80</c> of the local machine. If more than one web site is
  12363. running on port <c>80</c>, take the web site bound to the hostname
  12364. <c>localhost</c> if existent or bound to no hostname otherwise.
  12365. </para>
  12366. <code>
  12367. <![CDATA[
  12368. <deliisdir vdirname="Temp" />
  12369. ]]>
  12370. </code>
  12371. </example>
  12372. <example>
  12373. <para>
  12374. Delete a virtual directory named <c>Temp</c> from the website running
  12375. on port <c>81</c> of machine <c>MyHost</c>.
  12376. </para>
  12377. <code>
  12378. <![CDATA[
  12379. <deliisdir iisserver="MyHost:81" vdirname="Temp" />
  12380. ]]>
  12381. </code>
  12382. </example>
  12383. </member>
  12384. <member name="T:NAnt.Contrib.Tasks.Web.VirtualDirectoryInfo">
  12385. <summary>
  12386. Lists the configuration settings of a specified virtual directory in a
  12387. web site hosted on Internet Information Server.
  12388. </summary>
  12389. <example>
  12390. <para>
  12391. List the settings of a virtual directory named <c>Temp</c>.
  12392. </para>
  12393. <code>
  12394. <![CDATA[
  12395. <iisdirinfo vdirname="Temp" />
  12396. ]]>
  12397. </code>
  12398. </example>
  12399. </member>
  12400. <member name="T:NAnt.Contrib.Tasks.ADSIBaseTask">
  12401. <summary>
  12402. Base NAnt task for working with ADSI. This task contains only the path of the ADSI
  12403. object that you want to work with.
  12404. </summary>
  12405. </member>
  12406. <member name="P:NAnt.Contrib.Tasks.ADSIBaseTask.Path">
  12407. <summary>
  12408. The ADSI path of the location where we want to work with.
  12409. </summary>
  12410. </member>
  12411. <member name="T:NAnt.Contrib.Tasks.ADSIGetPropertyTask">
  12412. <summary>
  12413. Used to get the value of a property from an ADSI object.
  12414. </summary>
  12415. </member>
  12416. <member name="M:NAnt.Contrib.Tasks.ADSIGetPropertyTask.ExecuteTask">
  12417. <summary>
  12418. Sets the specified property
  12419. </summary>
  12420. </member>
  12421. <member name="P:NAnt.Contrib.Tasks.ADSIGetPropertyTask.PropName">
  12422. <summary>
  12423. The name of the property to get.
  12424. </summary>
  12425. </member>
  12426. <member name="P:NAnt.Contrib.Tasks.ADSIGetPropertyTask.StoreIn">
  12427. <summary>
  12428. The name of the property to store the value in.
  12429. </summary>
  12430. </member>
  12431. <member name="T:NAnt.Contrib.Tasks.ADSISetPropertyTask">
  12432. <summary>
  12433. Sets a property on an ADSI object.
  12434. </summary>
  12435. <remarks>
  12436. This task uses a heuristic to determine the type of the property in ADSI. The following cases are notable:
  12437. <list type="bulleted">
  12438. <item>If the property does not exist on the item, it is inserted as a string.</item>
  12439. <item>If the property already exists, this method will attempt to preserve
  12440. the type of the property. The types this method knows about are String,
  12441. Boolean, and Int32.</item>
  12442. <item>If the property exists and is an array, the value is added to
  12443. the array, but only if it is not already present.</item>
  12444. </list>
  12445. </remarks>
  12446. <example>
  12447. <code>
  12448. <![CDATA[
  12449. <adsisetprop path="${iis.path}/Root" propname="AuthAnonymous" propvalue="true" />
  12450. ]]>
  12451. </code>
  12452. </example>
  12453. <example>
  12454. <code>
  12455. <![CDATA[
  12456. <adsisetprop path="${iis.path}/Root/GWSSample">
  12457. <properties>
  12458. <option name="AuthBasic" value="false" />
  12459. <option name="AuthNTLM" value="true" />
  12460. </properties>
  12461. </adsisetprop>
  12462. ]]>
  12463. </code>
  12464. </example>
  12465. </member>
  12466. <member name="M:NAnt.Contrib.Tasks.ADSISetPropertyTask.ExecuteTask">
  12467. <summary>
  12468. Sets the specified property
  12469. </summary>
  12470. </member>
  12471. <member name="M:NAnt.Contrib.Tasks.ADSISetPropertyTask.SetProperty(System.DirectoryServices.DirectoryEntry,System.String,System.String)">
  12472. <summary>
  12473. Sets the named property on the specified <see cref="T:System.DirectoryServices.DirectoryEntry"/>
  12474. to the given value.
  12475. </summary>
  12476. <param name="entry">The <see cref="T:System.DirectoryServices.DirectoryEntry"/> we're modifying.</param>
  12477. <param name="propertyName">The name of the property to set.</param>
  12478. <param name="propertyValue">The value to set the property to.</param>
  12479. <remarks>
  12480. The following cases are notable:
  12481. <list type="bulleted">
  12482. <item>
  12483. If the property does not exist on the item, it is inserted as a
  12484. string.
  12485. </item>
  12486. <item>
  12487. If the property already exists, this method will attempt to preserve
  12488. the type of the property. The types this method knows about are
  12489. <see cref="T:System.String"/>, <see creef="bool"/>, and <see cref="T:System.Int32"/>.
  12490. </item>
  12491. <item>
  12492. If the property exists and is an array, the value is added to the
  12493. array, but only if it's not already present.
  12494. </item>
  12495. </list>
  12496. </remarks>
  12497. </member>
  12498. <member name="P:NAnt.Contrib.Tasks.ADSISetPropertyTask.PropertyName">
  12499. <summary>
  12500. The name of the property to set.
  12501. </summary>
  12502. </member>
  12503. <member name="P:NAnt.Contrib.Tasks.ADSISetPropertyTask.PropertyValue">
  12504. <summary>
  12505. The new value of the property.
  12506. </summary>
  12507. </member>
  12508. <member name="T:NAnt.Contrib.Tasks.Astyle">
  12509. <summary>
  12510. Formats source code in a given directory to a specified code format.
  12511. </summary>
  12512. <remarks>
  12513. <para>
  12514. Most examples inline have been produced by Tal Davidson and team and
  12515. are part of the astyle documentation. They have been included in
  12516. the task documentation as an easy reference.
  12517. </para>
  12518. NOTE: This task relies on the astyle.exe file being in your path variable.
  12519. Please download the astyle.exe from http://astyle.sourceforge.net.
  12520. </remarks>
  12521. <example>
  12522. <code>
  12523. <![CDATA[
  12524. <astyle style="NAnt" cleanup="true">
  12525. <sources>
  12526. <include name="**/**.cs" />
  12527. </sources>
  12528. </astyle>
  12529. ]]>
  12530. </code>
  12531. </example>
  12532. </member>
  12533. <member name="F:NAnt.Contrib.Tasks.Astyle.DEFAULT_STYLE">
  12534. <summary>
  12535. The default style seems to be the closest to C# standards.
  12536. </summary>
  12537. </member>
  12538. <member name="M:NAnt.Contrib.Tasks.Astyle.PrepareProcess(System.Diagnostics.Process)">
  12539. <summary>
  12540. Build up the command line arguments, determine which executable is
  12541. being used and find the path to that executable and set the working
  12542. directory.
  12543. </summary>
  12544. <param name="process">The process to prepare.</param>
  12545. </member>
  12546. <member name="M:NAnt.Contrib.Tasks.Astyle.SetCommandOption(System.String,System.String,System.Boolean)">
  12547. <summary>
  12548. Adds a new command option if none exists. If one does exist then
  12549. the use switch is toggled on or of.
  12550. </summary>
  12551. <param name="name">The common name of the option.</param>
  12552. <param name="value">The option value or command line switch of the option.</param>
  12553. <param name="on"><see langword="true" /> if the option should be appended to the commandline, otherwise <see langword="false" />.</param>
  12554. </member>
  12555. <member name="M:NAnt.Contrib.Tasks.Astyle.AppendCommandOptions">
  12556. <summary>
  12557. Append the command line options or commen names for the options
  12558. to the generic options collection. This is then piped to the
  12559. command line as a switch.
  12560. </summary>
  12561. </member>
  12562. <member name="M:NAnt.Contrib.Tasks.Astyle.AppendFiles">
  12563. <summary>
  12564. Append the files specified in the fileset to the command line argument.
  12565. </summary>
  12566. </member>
  12567. <member name="P:NAnt.Contrib.Tasks.Astyle.CommandOptions">
  12568. <summary>
  12569. A collection of command line option switches.
  12570. </summary>
  12571. </member>
  12572. <member name="P:NAnt.Contrib.Tasks.Astyle.Sources">
  12573. <summary>
  12574. Used to select the files to copy.
  12575. </summary>
  12576. </member>
  12577. <member name="P:NAnt.Contrib.Tasks.Astyle.CommandLineArguments">
  12578. <summary>
  12579. The command-line arguments for the program.
  12580. </summary>
  12581. </member>
  12582. <member name="P:NAnt.Contrib.Tasks.Astyle.Style">
  12583. <summary>
  12584. Indicate the preset style to use.
  12585. <list type="table">
  12586. <item>ansi
  12587. <code>
  12588. namespace foospace
  12589. {
  12590. int Foo()
  12591. {
  12592. if (isBar)
  12593. {
  12594. bar();
  12595. return 1;
  12596. }
  12597. else
  12598. return 0;
  12599. }
  12600. }
  12601. </code>
  12602. </item>
  12603. <item>kr ( Kernighan&amp;Ritchie )
  12604. <code>
  12605. namespace foospace {
  12606. int Foo() {
  12607. if (isBar) {
  12608. bar();
  12609. return 1;
  12610. } else
  12611. return 0;
  12612. }
  12613. }
  12614. </code>
  12615. </item>
  12616. <item>linux
  12617. <code>
  12618. namespace foospace
  12619. {
  12620. int Foo()
  12621. {
  12622. if (isBar) {
  12623. bar();
  12624. return 1;
  12625. } else
  12626. return 0;
  12627. }
  12628. }
  12629. </code>
  12630. </item>
  12631. <item>gnu
  12632. <code>
  12633. namespace foospace
  12634. {
  12635. int Foo()
  12636. {
  12637. if (isBar)
  12638. {
  12639. bar();
  12640. return 1;
  12641. }
  12642. else
  12643. return 0;
  12644. }
  12645. }
  12646. </code>
  12647. </item>
  12648. <item>java
  12649. <code>
  12650. class foospace {
  12651. int Foo() {
  12652. if (isBar) {
  12653. bar();
  12654. return 1;
  12655. } else
  12656. return 0;
  12657. }
  12658. }
  12659. </code>
  12660. </item>
  12661. <item>NAnt
  12662. <code>
  12663. namespace foospace {
  12664. class foo() {
  12665. #region Protected Static Fields
  12666. private int Foo() {
  12667. if (isBar) {
  12668. bar();
  12669. return 1;
  12670. } else {
  12671. return 0;
  12672. }
  12673. }
  12674. #endregion
  12675. }
  12676. </code>
  12677. </item>
  12678. </list>
  12679. </summary>
  12680. </member>
  12681. <member name="P:NAnt.Contrib.Tasks.Astyle.CleanUp">
  12682. <summary>
  12683. Astyle leaves the original files around, renamed with a different
  12684. suffix. Setting this to <code>true</code>
  12685. will remove these files.
  12686. </summary>
  12687. </member>
  12688. <member name="P:NAnt.Contrib.Tasks.Astyle.Suffix">
  12689. <summary>
  12690. The suffix to append to original files, defaults to <c>.orig</c>
  12691. if not specified.
  12692. </summary>
  12693. </member>
  12694. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNumSpaces">
  12695. <summary>
  12696. Indicate the maximum number of spaces to indent relative to a
  12697. previous line.
  12698. </summary>
  12699. </member>
  12700. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNumTabs">
  12701. <summary>
  12702. Indicate that tabs should be used to indent sources. The number
  12703. specified indicates the maximum number of spaces the tab character
  12704. will represent.
  12705. </summary>
  12706. </member>
  12707. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNumTabsForce">
  12708. <summary>
  12709. Indent using tab characters. Treat each tab as # spaces. Uses tabs as
  12710. indents in areas '--indent=tab' prefers to use spaces, such as
  12711. inside multi-line statements.
  12712. </summary>
  12713. </member>
  12714. <member name="P:NAnt.Contrib.Tasks.Astyle.ConvertTabs">
  12715. <summary>
  12716. <see langword="true" /> to convert tabs to spaces.
  12717. </summary>
  12718. </member>
  12719. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentClass">
  12720. <summary>
  12721. <see langword="true" /> if class statements should be indented.
  12722. <code>
  12723. The default:
  12724. class Foo
  12725. {
  12726. public:
  12727. Foo();
  12728. virtual ~Foo();
  12729. };
  12730. becomes:
  12731. class Foo
  12732. {
  12733. public:
  12734. Foo();
  12735. virtual ~Foo();
  12736. };
  12737. </code>
  12738. </summary>
  12739. </member>
  12740. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentSwitch">
  12741. <summary>
  12742. <see langword="true" /> if switch statements should be indented.
  12743. <code>
  12744. The default:
  12745. switch (foo)
  12746. {
  12747. case 1:
  12748. a += 2;
  12749. break;
  12750. default:
  12751. a += 2;
  12752. break;
  12753. }
  12754. becomes:
  12755. switch (foo)
  12756. {
  12757. case 1:
  12758. a += 2;
  12759. break;
  12760. default:
  12761. a += 2;
  12762. break;
  12763. }
  12764. </code>
  12765. </summary>
  12766. </member>
  12767. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentCase">
  12768. <summary>
  12769. <see langword="true" /> if case statements should be indented.
  12770. <code>
  12771. The default:
  12772. switch (foo)
  12773. {
  12774. case 1:
  12775. {
  12776. a += 2;
  12777. break;
  12778. }
  12779. default:
  12780. {
  12781. a += 2;
  12782. break;
  12783. }
  12784. }
  12785. becomes:
  12786. switch (foo)
  12787. {
  12788. case 1:
  12789. {
  12790. a += 2;
  12791. break;
  12792. }
  12793. default:
  12794. {
  12795. a += 2;
  12796. break;
  12797. }
  12798. }
  12799. </code>
  12800. </summary>
  12801. </member>
  12802. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentBracket">
  12803. <summary>
  12804. <code>true</code> if bracket statements should be indented.
  12805. <code>
  12806. The default:
  12807. if (isFoo)
  12808. {
  12809. bar();
  12810. }
  12811. else
  12812. {
  12813. anotherBar();
  12814. }
  12815. becomes:
  12816. if (isFoo)
  12817. {
  12818. bar();
  12819. }
  12820. else
  12821. {
  12822. anotherBar();
  12823. }
  12824. </code>
  12825. </summary>
  12826. </member>
  12827. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentBlock">
  12828. <summary>
  12829. <see langword="true" /> if block statements should be indented.
  12830. The default:
  12831. if (isFoo)
  12832. {
  12833. bar();
  12834. }
  12835. else
  12836. anotherBar();
  12837. becomes:
  12838. if (isFoo)
  12839. {
  12840. bar();
  12841. }
  12842. else
  12843. anotherBar();
  12844. </summary>
  12845. </member>
  12846. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNamespaces">
  12847. <summary>
  12848. <see langword="true" /> if namespace statements should be indented.
  12849. <code>
  12850. The default:
  12851. namespace foospace
  12852. {
  12853. class Foo
  12854. {
  12855. public:
  12856. Foo();
  12857. virtual ~Foo();
  12858. };
  12859. }
  12860. becomes:
  12861. namespace foospace
  12862. {
  12863. class Foo
  12864. {
  12865. public:
  12866. Foo();
  12867. virtual ~Foo();
  12868. };
  12869. }
  12870. </code>
  12871. </summary>
  12872. </member>
  12873. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentLabels">
  12874. <summary>
  12875. <see langword="true" /> if label statements should be indented.
  12876. <code>
  12877. The default:
  12878. int foospace()
  12879. {
  12880. while (isFoo)
  12881. {
  12882. ...
  12883. goto error;
  12884. error:
  12885. ...
  12886. }
  12887. }
  12888. becomes:
  12889. int foospace()
  12890. {
  12891. while (isFoo)
  12892. {
  12893. ...
  12894. goto error;
  12895. error:
  12896. ...
  12897. }
  12898. }
  12899. </code>
  12900. </summary>
  12901. </member>
  12902. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentMax">
  12903. <summary>
  12904. Indicate the maximum number of spaces to indent relative to a
  12905. previous line.
  12906. </summary>
  12907. </member>
  12908. <member name="P:NAnt.Contrib.Tasks.Astyle.IndentMin">
  12909. <summary>
  12910. Indicate the maximum number of spaces to indent relative to a
  12911. previous line.
  12912. </summary>
  12913. </member>
  12914. <member name="P:NAnt.Contrib.Tasks.Astyle.FillEmptyLines">
  12915. <summary>
  12916. <see langword="true" /> if empty lines should be filled with the
  12917. whitespace of the previous line.
  12918. </summary>
  12919. </member>
  12920. <member name="P:NAnt.Contrib.Tasks.Astyle.BracketsNewLine">
  12921. <summary>
  12922. <see langword="true" /> if brackets should be put on a new line.
  12923. <code>
  12924. if (isFoo)
  12925. {
  12926. bar();
  12927. }
  12928. else
  12929. {
  12930. anotherBar();
  12931. }
  12932. </code>
  12933. </summary>
  12934. </member>
  12935. <member name="P:NAnt.Contrib.Tasks.Astyle.BracketsAttach">
  12936. <summary>
  12937. <see langword="true" /> if brackets should be attached.
  12938. <code>
  12939. if (isFoo){
  12940. bar();
  12941. } else {
  12942. anotherBar();
  12943. }
  12944. </code>
  12945. </summary>
  12946. </member>
  12947. <member name="P:NAnt.Contrib.Tasks.Astyle.BracketsLinux">
  12948. <summary>
  12949. <see langword="true" /> if brackets should be put on a new line and
  12950. indented.
  12951. <code>
  12952. namespace foospace
  12953. {
  12954. int Foo()
  12955. {
  12956. if (isBar) {
  12957. bar();
  12958. return 1;
  12959. } else
  12960. return 0;
  12961. }
  12962. }
  12963. </code>
  12964. </summary>
  12965. </member>
  12966. <member name="P:NAnt.Contrib.Tasks.Astyle.BreakClosing">
  12967. <summary>
  12968. <see langword="true" /> if the line after a bracket (i.e. an else
  12969. statement after the closing if) should be placed on the next line.
  12970. <code>
  12971. if (isFoo){
  12972. bar();
  12973. }else {
  12974. anotherBar();
  12975. }
  12976. becomes:
  12977. if (isFoo) {
  12978. bar();
  12979. }
  12980. else {
  12981. anotherBar();
  12982. }
  12983. </code>
  12984. </summary>
  12985. </member>
  12986. <member name="P:NAnt.Contrib.Tasks.Astyle.BreakBlocks">
  12987. <summary>
  12988. <see langword="true" /> to break block statements with an empty line.
  12989. <code>
  12990. isFoo = true;
  12991. if (isFoo) {
  12992. bar();
  12993. } else {
  12994. anotherBar();
  12995. }
  12996. isBar = false;
  12997. becomes:
  12998. isFoo = true;
  12999. if (isFoo) {
  13000. bar();
  13001. } else {
  13002. anotherBar();
  13003. }
  13004. isBar = false;
  13005. </code>
  13006. </summary>
  13007. </member>
  13008. <member name="P:NAnt.Contrib.Tasks.Astyle.BreakBlocksAll">
  13009. <summary>
  13010. <see langword="true" /> to break all block statements, even on
  13011. nested ifs with an empty line.
  13012. <code>
  13013. isFoo = true;
  13014. if (isFoo) {
  13015. bar();
  13016. } else {
  13017. anotherBar();
  13018. }
  13019. isBar = false;
  13020. becomes:
  13021. isFoo = true;
  13022. if (isFoo) {
  13023. bar();
  13024. } else {
  13025. anotherBar();
  13026. }
  13027. isBar = false;
  13028. </code>
  13029. </summary>
  13030. </member>
  13031. <member name="P:NAnt.Contrib.Tasks.Astyle.BreakElseif">
  13032. <summary>
  13033. <see langword="true" /> to put the if component of an else if on a
  13034. new line.
  13035. <code>
  13036. if (isFoo) {
  13037. bar();
  13038. } else if (isBar()){
  13039. anotherBar();
  13040. }
  13041. becomes:
  13042. if (isFoo) {
  13043. bar();
  13044. } else
  13045. if (isBar()){
  13046. anotherBar();
  13047. }
  13048. </code>
  13049. </summary>
  13050. </member>
  13051. <member name="P:NAnt.Contrib.Tasks.Astyle.PadOperators">
  13052. <summary>
  13053. <see langword="true" /> to pad operators with a space.
  13054. <code>
  13055. if (isFoo)
  13056. a = bar((b-c)*a,*d--);
  13057. becomes:
  13058. if (isFoo)
  13059. a = bar((b - c) * a, *d--);
  13060. </code>
  13061. </summary>
  13062. </member>
  13063. <member name="P:NAnt.Contrib.Tasks.Astyle.PadParenthesis">
  13064. <summary>
  13065. <see langword="true" /> to pad parenthesis with a space.
  13066. <code>
  13067. if (isFoo)
  13068. a = bar((b-c)*a,*d--);
  13069. becomes:
  13070. if ( isFoo )
  13071. a = bar( ( b-c )*a, *d-- );
  13072. </code>
  13073. </summary>
  13074. </member>
  13075. <member name="P:NAnt.Contrib.Tasks.Astyle.PadAll">
  13076. <summary>
  13077. <see langword="true" /> to pad operators and parenthesis.
  13078. <code>
  13079. if (isFoo)
  13080. a = bar((b-c)*a,*d--);
  13081. becomes:
  13082. if ( isFoo )
  13083. a = bar( ( b - c ) * a, *d-- );
  13084. </code>
  13085. </summary>
  13086. </member>
  13087. <member name="P:NAnt.Contrib.Tasks.Astyle.NoBreakComplex">
  13088. <summary>
  13089. <see langword="true" /> to keep complex statements on the same line.
  13090. <code>
  13091. if (isFoo)
  13092. {
  13093. isFoo = false; cout &lt;&lt; isFoo &lt;&lt; endl;
  13094. }
  13095. remains as is.
  13096. if (isFoo) DoBar();
  13097. remains as is.
  13098. </code>
  13099. </summary>
  13100. </member>
  13101. <member name="P:NAnt.Contrib.Tasks.Astyle.NoBreakSingleLineBlocks">
  13102. <summary>
  13103. <see langword="true" /> to keep single line statements on the same line.
  13104. <code>
  13105. if (isFoo)
  13106. { isFoo = false; cout &lt;&lt; isFoo &lt;&lt; endl; }
  13107. remains as is.
  13108. </code>
  13109. </summary>
  13110. </member>
  13111. <member name="P:NAnt.Contrib.Tasks.Astyle.ProgramArguments">
  13112. <summary>
  13113. Gets the command-line arguments for the external program.
  13114. </summary>
  13115. <value>
  13116. The command-line arguments for the external program.
  13117. </value>
  13118. </member>
  13119. <member name="T:NAnt.Contrib.Tasks.COMRegisterTask">
  13120. <summary>
  13121. Register COM servers or type libraries.
  13122. </summary>
  13123. <remarks>
  13124. <para>
  13125. COM register task will try and register any type of COM related file
  13126. that needs registering.
  13127. </para>
  13128. <para>Executable files (.exe) will be registered as exe servers, type
  13129. libaries (.tlb) registered with RegisterTypeLib and for all other
  13130. filetypes it will attempt to register them as dll servers.
  13131. </para>
  13132. </remarks>
  13133. <example>
  13134. <para>Register a single dll server.</para>
  13135. <code>
  13136. <![CDATA[
  13137. <comregister file="myComServer.dll" />
  13138. ]]>
  13139. </code>
  13140. </example>
  13141. <example>
  13142. <para>Register a single exe server </para>
  13143. <code>
  13144. <![CDATA[
  13145. <comregister file="myComServer.exe" />
  13146. ]]>
  13147. </code>
  13148. </example>
  13149. <example>
  13150. <para>Register a set of COM files at once.</para>
  13151. <code>
  13152. <![CDATA[
  13153. <comregister unregister="false">
  13154. <fileset>
  13155. <include name="an_ExeServer.exe" />
  13156. <include name="a_TypeLibrary.tlb" />
  13157. <include name="a_DllServer.dll" />
  13158. <include name="an_OcxServer.ocx" />
  13159. </fileset>
  13160. </comregister>
  13161. ]]>
  13162. </code>
  13163. </example>
  13164. </member>
  13165. <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.RegisterDllServer(System.String)">
  13166. <summary>
  13167. Register an inproc COM server, usually a .dll or .ocx
  13168. </summary>
  13169. <param name="path"></param>
  13170. </member>
  13171. <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.RegisterTypelib(System.String)">
  13172. <summary>
  13173. Register a COM type library
  13174. </summary>
  13175. <param name="path"></param>
  13176. </member>
  13177. <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.RegisterExeServer(System.String)">
  13178. <summary>
  13179. Register exe servers.
  13180. </summary>
  13181. <param name="path"></param>
  13182. </member>
  13183. <member name="P:NAnt.Contrib.Tasks.COMRegisterTask.File">
  13184. <summary>
  13185. The name of the file to register. This is provided as an alternate
  13186. to using the task's fileset.
  13187. </summary>
  13188. </member>
  13189. <member name="P:NAnt.Contrib.Tasks.COMRegisterTask.Unregister">
  13190. <summary>Unregistering this time. ( /u paramater )Default is "false".</summary>
  13191. </member>
  13192. <member name="P:NAnt.Contrib.Tasks.COMRegisterTask.COMRegisterFileSet">
  13193. <summary>
  13194. The set of files to register.
  13195. </summary>
  13196. </member>
  13197. <member name="T:NAnt.Contrib.Tasks.COMRegisterTask.DynamicPInvoke">
  13198. <summary>
  13199. Helper class to synamically build an assembly with the correct
  13200. P/Invoke signature
  13201. </summary>
  13202. </member>
  13203. <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.DynamicPInvoke.DynamicDllFuncInvoke(System.String,System.String)">
  13204. <summary>
  13205. Register a given dll.
  13206. </summary>
  13207. <param name="dll"></param>
  13208. <param name="entrypoint"></param>
  13209. <returns></returns>
  13210. </member>
  13211. <member name="T:NAnt.Contrib.Tasks.ChangeDirectory">
  13212. <summary>
  13213. Changes the current working directory.
  13214. </summary>
  13215. <example>
  13216. <para>
  13217. Changes the current working directory to the &quot;subdir&quot;
  13218. directory, relative to the project base directory.
  13219. </para>
  13220. <code>
  13221. <![CDATA[
  13222. <cd dir="subdir" />
  13223. ]]>
  13224. </code>
  13225. </example>
  13226. </member>
  13227. <member name="M:NAnt.Contrib.Tasks.ChangeDirectory.ExecuteTask">
  13228. <summary>
  13229. Changes the current directory.
  13230. </summary>
  13231. </member>
  13232. <member name="P:NAnt.Contrib.Tasks.ChangeDirectory.Directory">
  13233. <summary>
  13234. The path to which the current working directory should be set.
  13235. </summary>
  13236. </member>
  13237. <member name="T:NAnt.Contrib.Tasks.ChecksumTask">
  13238. <summary>
  13239. Calculates checksums for a set of files.
  13240. Loosely based on Ant's Checksum task.
  13241. </summary>
  13242. <remarks>
  13243. This task takes a set of input files in a fileset
  13244. and calculates a checksum for each one of them.
  13245. You can specify the algorithm to use when calculating
  13246. the checksum value (MD5 or SHA1, for example).
  13247. The calculated value is saved to a file with the same
  13248. name as the input file and an added extension either
  13249. based on the algorithm name (e.g. .MD5), or whatever
  13250. is specified through the fileext attribute.
  13251. </remarks>
  13252. <example>
  13253. <code>
  13254. <![CDATA[
  13255. <checksum algorithm="MD5" fileext="MD5">
  13256. <fileset>
  13257. <include name="${outputdir}\*.dll"/>
  13258. </fileset>
  13259. </checksum>
  13260. ]]>
  13261. </code>
  13262. </example>
  13263. </member>
  13264. <member name="M:NAnt.Contrib.Tasks.ChecksumTask.InitializeTask(System.Xml.XmlNode)">
  13265. <summary>
  13266. Initializes task and ensures the supplied attributes are valid.
  13267. </summary>
  13268. <param name="taskNode">Xml node used to define this task instance.</param>
  13269. </member>
  13270. <member name="M:NAnt.Contrib.Tasks.ChecksumTask.ExecuteTask">
  13271. <summary>
  13272. This is where the work is done
  13273. </summary>
  13274. </member>
  13275. <member name="M:NAnt.Contrib.Tasks.ChecksumTask.WriteChecksum(System.String,System.String)">
  13276. <summary>
  13277. Writes a checksum to a destination file
  13278. </summary>
  13279. <param name="filename"></param>
  13280. <param name="checksum"></param>
  13281. </member>
  13282. <member name="P:NAnt.Contrib.Tasks.ChecksumTask.Algorithm">
  13283. <summary>
  13284. Name of Algorithm to use when calculating
  13285. the checksum. Can be MD5 or SHA1.
  13286. </summary>
  13287. </member>
  13288. <member name="P:NAnt.Contrib.Tasks.ChecksumTask.FileExtension">
  13289. <summary>
  13290. The generated checksum file's name will be the
  13291. original filename with "." and fileext
  13292. added to it. Defaults to the
  13293. algorithm name being used
  13294. </summary>
  13295. </member>
  13296. <member name="P:NAnt.Contrib.Tasks.ChecksumTask.FileSet">
  13297. <summary>
  13298. Set of files to use as input
  13299. </summary>
  13300. </member>
  13301. <member name="T:NAnt.Contrib.Tasks.ChooseTask">
  13302. <summary>
  13303. <para>
  13304. Executes an alternate set of tasks depending on conditions that are
  13305. individually set on each group of tasks.
  13306. </para>
  13307. </summary>
  13308. <remarks>
  13309. <para>
  13310. The <see cref="T:NAnt.Contrib.Tasks.ChooseTask"/> selects one among a number of possible
  13311. alternatives. It consists of a sequence of <c>&lt;when&gt;</c> elements
  13312. followed by an optional <c>&lt;otherwise&gt;</c> element.
  13313. </para>
  13314. <para>
  13315. Each <c>&lt;when&gt;</c> element has a single attribute, test, which
  13316. specifies an expression. The content of the <c>&lt;when&gt;</c> and
  13317. <c>&lt;otherwise&gt;</c> elements is a set of nested tasks.
  13318. </para>
  13319. <para>
  13320. The content of the first, and only the first, <c>&lt;when&gt;</c>
  13321. element whose test is <see langword="true"/> is executed. If no
  13322. <c>&lt;when&gt;</c> element is <see langword="true"/>, the
  13323. content of the <c>&lt;otherwise&gt;</c> element is executed.
  13324. If no <c>&lt;when&gt;</c> element is <see langword="true"/>, and no
  13325. <c>&lt;otherwise&gt;</c> element is present, nothing is done.
  13326. </para>
  13327. </remarks>
  13328. <example>
  13329. <para>
  13330. Execute alternate set of tasks depending on the configuration being
  13331. built.
  13332. </para>
  13333. <code>
  13334. <![CDATA[
  13335. <choose>
  13336. <when test="${build.config == 'Debug'}">
  13337. <!-- compile app in debug configuration -->
  13338. ...
  13339. </when>
  13340. <when test="${build.config == 'Release'}">
  13341. <!-- compile app in release configuration -->
  13342. ...
  13343. </when>
  13344. <otherwise>
  13345. <fail>Build configuration '${build.config}' is not supported!</fail>
  13346. </otherwise>
  13347. </choose>
  13348. ]]>
  13349. </code>
  13350. </example>
  13351. </member>
  13352. <member name="M:NAnt.Contrib.Tasks.ChooseTask.AddCondition(NAnt.Contrib.Tasks.When)">
  13353. <summary>
  13354. One or more alternative sets of tasks to execute.
  13355. </summary>
  13356. <param name="when">The set of tasks to add.</param>
  13357. </member>
  13358. <member name="M:NAnt.Contrib.Tasks.ChooseTask.AddFallback(NAnt.Contrib.Tasks.NestedTaskContainer)">
  13359. <summary>
  13360. The set of tasks to execute if none of the <see cref="T:NAnt.Contrib.Tasks.When"/>
  13361. elements are <see langword="true"/>.
  13362. </summary>
  13363. </member>
  13364. <member name="P:NAnt.Contrib.Tasks.ChooseTask.IsFallbackDefined">
  13365. <summary>
  13366. Gets a value indicating whether a fallback element is defined.
  13367. </summary>
  13368. <value>
  13369. <see langword="true" /> if a fallback element is defined; otherwise,
  13370. <see langword="false" />.
  13371. </value>
  13372. </member>
  13373. <member name="T:NAnt.Contrib.Tasks.When">
  13374. <summary>
  13375. Groups a set of tasks to execute when a condition is met.
  13376. </summary>
  13377. </member>
  13378. <member name="T:NAnt.Contrib.Tasks.NestedTaskContainer">
  13379. <summary>
  13380. Executes embedded tasks in the order in which they are defined.
  13381. </summary>
  13382. </member>
  13383. <member name="M:NAnt.Contrib.Tasks.NestedTaskContainer.ExecuteChildTasks">
  13384. <summary>
  13385. Creates and executes the embedded (child XML nodes) elements.
  13386. </summary>
  13387. </member>
  13388. <member name="P:NAnt.Contrib.Tasks.NestedTaskContainer.CustomXmlProcessing">
  13389. <summary>
  13390. Gets a value indicating whether the element is performing additional
  13391. processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
  13392. initialize the element.
  13393. </summary>
  13394. <value>
  13395. <see langword="true"/>, as a <see cref="T:NAnt.Contrib.Tasks.NestedTaskContainer"/> is
  13396. responsable for creating tasks from the nested build elements.
  13397. </value>
  13398. </member>
  13399. <member name="P:NAnt.Contrib.Tasks.When.Test">
  13400. <summary>
  13401. Used to test arbitrary boolean expression.
  13402. </summary>
  13403. </member>
  13404. <member name="T:NAnt.Contrib.Tasks.CodeStatsTask">
  13405. <summary>
  13406. Generates statistics from source code.
  13407. </summary>
  13408. <remarks>
  13409. Scans files in a fileset counting lines.
  13410. </remarks>
  13411. <example>
  13412. <para>
  13413. Generate statistics for a set of C# and VB.NET sources, applying
  13414. different labels for both.
  13415. </para>
  13416. <code>
  13417. <![CDATA[
  13418. <codestats output="test.xml" append="true" buildname="MyBuildName">
  13419. <counts>
  13420. <count label="C#">
  13421. <fileset>
  13422. <include name="**/*.cs" />
  13423. </fileset>
  13424. </count>
  13425. <count label="VB">
  13426. <fileset>
  13427. <include name="**\*.vb" />
  13428. </fileset>
  13429. </count>
  13430. </counts>
  13431. </codestats>
  13432. ]]>
  13433. </code>
  13434. </example>
  13435. <example>
  13436. <para>
  13437. Generate statistics for all C# sources and only output a summary to
  13438. the log.
  13439. </para>
  13440. <code>
  13441. <![CDATA[
  13442. <codestats output="test.xml" verbose="true" summarize="true">
  13443. <counts>
  13444. <count label="C#">
  13445. <fileset>
  13446. <include name="**\*.cs" />
  13447. </fileset>
  13448. </count>
  13449. </counts>
  13450. </codestats>
  13451. ]]>
  13452. </code>
  13453. </example>
  13454. </member>
  13455. <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.CodeStats">
  13456. <summary>
  13457. Set of line counters to enable.
  13458. </summary>
  13459. </member>
  13460. <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.BuildName">
  13461. <summary>
  13462. An identifier to be able to track which build last updated the
  13463. code stats file.
  13464. </summary>
  13465. </member>
  13466. <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.AppendFile">
  13467. <summary>
  13468. Specifies whether the results should be appended to the output file.
  13469. The default is <see langword="false" />.
  13470. </summary>
  13471. </member>
  13472. <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.Summarize">
  13473. <summary>
  13474. If you only want to show summary stats for the whole fileset
  13475. </summary>
  13476. </member>
  13477. <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.OutputFile">
  13478. <summary>
  13479. The name of the file to save the output to (in XML).
  13480. </summary>
  13481. </member>
  13482. <member name="T:NAnt.Contrib.Tasks.ConcatTask">
  13483. <summary>
  13484. A task that concatenates a set of files.
  13485. Loosely based on Ant's Concat task.
  13486. </summary>
  13487. <remarks>
  13488. <para>
  13489. This task takes a set of input files in a fileset
  13490. and concatenates them into a single file. You can
  13491. either replace the output file, or append to it
  13492. by using the append attribute.
  13493. </para>
  13494. <para>
  13495. The order the files are concatenated in is not
  13496. especified.
  13497. </para>
  13498. </remarks>
  13499. <example>
  13500. <code>
  13501. <![CDATA[
  13502. <concat destfile="${outputdir}\Full.txt" append="true">
  13503. <fileset>
  13504. <include name="${outputdir}\Test-*.txt" />
  13505. </fileset>
  13506. </concat>
  13507. ]]>
  13508. </code>
  13509. </example>
  13510. </member>
  13511. <member name="M:NAnt.Contrib.Tasks.ConcatTask.InitializeTask(System.Xml.XmlNode)">
  13512. <summary>
  13513. Initializes task and ensures the supplied attributes are valid.
  13514. </summary>
  13515. <param name="taskNode">Xml node used to define this task instance.</param>
  13516. </member>
  13517. <member name="M:NAnt.Contrib.Tasks.ConcatTask.ExecuteTask">
  13518. <summary>
  13519. This is where the work is done
  13520. </summary>
  13521. </member>
  13522. <member name="M:NAnt.Contrib.Tasks.ConcatTask.OpenDestinationFile">
  13523. <summary>
  13524. Opens the destination file according
  13525. to the specified flags
  13526. </summary>
  13527. <returns></returns>
  13528. </member>
  13529. <member name="M:NAnt.Contrib.Tasks.ConcatTask.AppendFiles(System.IO.FileStream)">
  13530. <summary>
  13531. Appends all specified files
  13532. </summary>
  13533. <param name="output">File to write to</param>
  13534. </member>
  13535. <member name="P:NAnt.Contrib.Tasks.ConcatTask.DestinationFile">
  13536. <summary>
  13537. Name of the destination file.
  13538. </summary>
  13539. </member>
  13540. <member name="P:NAnt.Contrib.Tasks.ConcatTask.Append">
  13541. <summary>
  13542. Specifies whether to append to the destination file.
  13543. The default is <see langword="false" />.
  13544. </summary>
  13545. </member>
  13546. <member name="P:NAnt.Contrib.Tasks.ConcatTask.FileSet">
  13547. <summary>
  13548. Set of files to use as input.
  13549. </summary>
  13550. </member>
  13551. <member name="T:NAnt.Contrib.Tasks.DependsTask">
  13552. <summary>
  13553. On execution guarantees the listed dependencies are resolved before continuing. It is
  13554. particularly useful for handling dynamic dependencies that change based on some input
  13555. conditions/parameters, or when the dependencies are not known until runtime.
  13556. </summary>
  13557. <remarks>The depends task never forces the execution of any target that has already been executed. It works just like the depends attribute of a <see cref="T:NAnt.Core.Target"/>.</remarks>
  13558. </member>
  13559. <member name="M:NAnt.Contrib.Tasks.DependsTask.ExecuteTask">
  13560. <summary>
  13561. Executes the specified task.
  13562. </summary>
  13563. </member>
  13564. <member name="P:NAnt.Contrib.Tasks.DependsTask.DependsCollection">
  13565. <summary>
  13566. A space or comma separated dependency list of targets.
  13567. </summary>
  13568. <remarks>
  13569. Expressions get evaluated when the task is executed.
  13570. </remarks>
  13571. </member>
  13572. <member name="T:NAnt.Contrib.Tasks.DicsoTask">
  13573. <summary>
  13574. Discovers the URLs of XML web services on a web server and saves documents
  13575. related to them to the local disk. The resulting .discomap, .wsdl, and .xsd files
  13576. can be used with the <see cref="T:NAnt.Contrib.Tasks.WsdlTask"/> to produce web service clients and
  13577. and abstract web service servers using ASP.NET.
  13578. </summary>
  13579. <example>
  13580. <para>Generate a proxy class for a web service.</para>
  13581. <code>
  13582. <![CDATA[
  13583. <disco
  13584. path="http://www.somewhere.com/myservice.wsdl"
  13585. language="CS"
  13586. namespace="MyCompany.MyService"
  13587. outfile="MyService.cs"
  13588. />
  13589. ]]>
  13590. </code>
  13591. </example>
  13592. </member>
  13593. <member name="M:NAnt.Contrib.Tasks.DicsoTask.ExecuteTask">
  13594. <summary>
  13595. Discover the details for the specified web service.
  13596. </summary>
  13597. </member>
  13598. <member name="P:NAnt.Contrib.Tasks.DicsoTask.Path">
  13599. <summary>The URL or Path to discover.</summary>
  13600. </member>
  13601. <member name="P:NAnt.Contrib.Tasks.DicsoTask.NoLogo">
  13602. <summary>Suppresses the banner.</summary>
  13603. </member>
  13604. <member name="P:NAnt.Contrib.Tasks.DicsoTask.NoSave">
  13605. <summary>Do not save the discovered documents to the local disk.</summary>
  13606. </member>
  13607. <member name="P:NAnt.Contrib.Tasks.DicsoTask.OutputDir">
  13608. <summary>The output directory to save discovered documents in.</summary>
  13609. </member>
  13610. <member name="P:NAnt.Contrib.Tasks.DicsoTask.Username">
  13611. <summary>Username of an account with credentials to access a
  13612. server that requires authentication.</summary>
  13613. </member>
  13614. <member name="P:NAnt.Contrib.Tasks.DicsoTask.Password">
  13615. <summary>Password of an account with credentials to access a
  13616. server that requires authentication.</summary>
  13617. </member>
  13618. <member name="P:NAnt.Contrib.Tasks.DicsoTask.Domain">
  13619. <summary>Domain of an account with credentials to access a
  13620. server that requires authentication.</summary>
  13621. </member>
  13622. <member name="P:NAnt.Contrib.Tasks.DicsoTask.Proxy">
  13623. <summary>URL of a proxy server to use for HTTP requests.
  13624. The default is to use the system proxy setting.</summary>
  13625. </member>
  13626. <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProxyUsername">
  13627. <summary>Username of an account with credentials to access a
  13628. proxy that requires authentication.</summary>
  13629. </member>
  13630. <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProxyPassword">
  13631. <summary>Password of an account with credentials to access a
  13632. proxy that requires authentication.</summary>
  13633. </member>
  13634. <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProxyDomain">
  13635. <summary>Domain of an account with credentials to access a
  13636. proxy that requires authentication.</summary>
  13637. </member>
  13638. <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProgramArguments">
  13639. <summary>
  13640. Gets the command-line arguments for the external program.
  13641. </summary>
  13642. <value>
  13643. The command-line arguments for the external program.
  13644. </value>
  13645. </member>
  13646. <member name="T:NAnt.Contrib.Tasks.FxCopTask">
  13647. <summary>
  13648. Analyzes managed code assemblies and reports information about the
  13649. assemblies, such as possible design, localization, performance, and
  13650. security improvements.
  13651. </summary>
  13652. <remarks>
  13653. <note>
  13654. this task relies on fxcopcmd.exe being in your PATH environment variable.
  13655. You can download the latest FxCop from <see href="http://www.gotdotnet.com/team/fxcop/" />.
  13656. </note>
  13657. </remarks>
  13658. <example>
  13659. <code>
  13660. <![CDATA[
  13661. <fxcop directOutputToConsole="true" projectFile="${build.dir}\Sample.fxcop">
  13662. <targets>
  13663. <include name="${build.dir}\bin\*.dll" />
  13664. </targets>
  13665. <rules>
  13666. <include name="${build.dir}\rules\*.dll" />
  13667. </rules>
  13668. </fxcop>
  13669. ]]>
  13670. </code>
  13671. </example>
  13672. </member>
  13673. <member name="M:NAnt.Contrib.Tasks.FxCopTask.#ctor">
  13674. <summary>
  13675. Creates a new <see cref="T:NAnt.Contrib.Tasks.FxCopTask"/> instance.
  13676. </summary>
  13677. </member>
  13678. <member name="M:NAnt.Contrib.Tasks.FxCopTask.PrepareProcess(System.Diagnostics.Process)">
  13679. <summary>
  13680. Performs logic before the external process is started
  13681. </summary>
  13682. <param name="process">Process.</param>
  13683. </member>
  13684. <member name="M:NAnt.Contrib.Tasks.FxCopTask.ExecuteTask">
  13685. <summary>
  13686. Executes the task.
  13687. </summary>
  13688. </member>
  13689. <member name="M:NAnt.Contrib.Tasks.FxCopTask.BuildArguments">
  13690. <summary>
  13691. Builds the arguments to pass to the exe.
  13692. </summary>
  13693. </member>
  13694. <member name="P:NAnt.Contrib.Tasks.FxCopTask.ApplyOutXsl">
  13695. <summary>
  13696. Applies the XSL transformation specified in /outXsl to the analysis report before saving the file.
  13697. </summary>
  13698. </member>
  13699. <member name="P:NAnt.Contrib.Tasks.FxCopTask.DirectOutputToConsole">
  13700. <summary>
  13701. Directs analysis output to the console or to the Output window in Visual Studio .NET. By default, the XSL file FxCopConsoleOutput.xsl is applied to the output before it is displayed.
  13702. </summary>
  13703. </member>
  13704. <member name="P:NAnt.Contrib.Tasks.FxCopTask.ConsoleXslFilename">
  13705. <summary>
  13706. Specifies the XSL or XSLT file that contains a transformation to be applied to the analysis output before it is displayed in the console.
  13707. </summary>
  13708. </member>
  13709. <member name="P:NAnt.Contrib.Tasks.FxCopTask.DependencyDirectories">
  13710. <summary>
  13711. Specifies additional directories to search for assembly dependencies. FxCopCmd always searches the target assembly directory and the current working directory.
  13712. </summary>
  13713. </member>
  13714. <member name="P:NAnt.Contrib.Tasks.FxCopTask.TargetAssemblies">
  13715. <summary>
  13716. Specifies the target assembly to analyze.
  13717. </summary>
  13718. </member>
  13719. <member name="P:NAnt.Contrib.Tasks.FxCopTask.ImportFiles">
  13720. <summary>
  13721. Specifies the name of an analysis report or project file to import. Any messages in the imported file that are marked as excluded are not included in the analysis results.
  13722. </summary>
  13723. </member>
  13724. <member name="P:NAnt.Contrib.Tasks.FxCopTask.AnalysisReportFilename">
  13725. <summary>
  13726. Specifies the file name for the analysis report.
  13727. </summary>
  13728. </member>
  13729. <member name="P:NAnt.Contrib.Tasks.FxCopTask.OutputXslFilename">
  13730. <summary>
  13731. Specifies the XSL or XSLT file that is referenced by the xml-stylesheet processing instruction in the analysis report.
  13732. </summary>
  13733. </member>
  13734. <member name="P:NAnt.Contrib.Tasks.FxCopTask.PlatformDirectory">
  13735. <summary>
  13736. Specifies the location of the version of Mscorlib.dll that was used when building the target assemblies if this version is not installed on the computer running FxCopCmd.
  13737. </summary>
  13738. </member>
  13739. <member name="P:NAnt.Contrib.Tasks.FxCopTask.ProjectFile">
  13740. <summary>
  13741. Specifies the filename of FxCop project file.
  13742. </summary>
  13743. </member>
  13744. <member name="P:NAnt.Contrib.Tasks.FxCopTask.RuleLibraries">
  13745. <summary>
  13746. Specifies the filename(s) of FxCop project file(s).
  13747. </summary>
  13748. </member>
  13749. <member name="P:NAnt.Contrib.Tasks.FxCopTask.IncludeSummaryReport">
  13750. <summary>
  13751. Includes a summary report with the informational messages returned by FxCopCmd.
  13752. </summary>
  13753. </member>
  13754. <member name="P:NAnt.Contrib.Tasks.FxCopTask.TypeList">
  13755. <summary>
  13756. Comma-separated list of type names to analyze. This option disables analysis of assemblies, namespaces, and resources; only the specified types and their members are included in the analysis.
  13757. Use the wildcard character '*' at the end of the name to select multiple types.
  13758. </summary>
  13759. </member>
  13760. <member name="P:NAnt.Contrib.Tasks.FxCopTask.SaveResults">
  13761. <summary>
  13762. Saves the results of the analysis in the project file.
  13763. </summary>
  13764. </member>
  13765. <member name="P:NAnt.Contrib.Tasks.FxCopTask.FailOnAnalysisError">
  13766. <summary>
  13767. Determines if the task should fail when analysis errors occur
  13768. </summary>
  13769. </member>
  13770. <member name="P:NAnt.Contrib.Tasks.FxCopTask.BaseDirectory">
  13771. <summary>
  13772. The directory in which the command will be executed.
  13773. </summary>
  13774. <value>
  13775. The directory in which the command will be executed. The default
  13776. is the project's base directory.
  13777. </value>
  13778. <remarks>
  13779. <para>
  13780. It will be evaluated relative to the project's
  13781. base directory if it is relative.
  13782. </para>
  13783. </remarks>
  13784. </member>
  13785. <member name="P:NAnt.Contrib.Tasks.FxCopTask.ProgramArguments">
  13786. <summary>
  13787. Gets the program arguments.
  13788. </summary>
  13789. </member>
  13790. <member name="T:NAnt.Contrib.Tasks.GacInstallTask">
  13791. <summary>
  13792. Installs assemblies into the Global Assembly Cache (GAC) by using the
  13793. <c>gacutil</c> SDK tool.
  13794. </summary>
  13795. <remarks>
  13796. <para>
  13797. Assemblies can be installed to the GAC with or without reference counting.
  13798. The full details of reference counting can be found in the SDK
  13799. documentation.
  13800. </para>
  13801. </remarks>
  13802. <example>
  13803. <para>Installs <c>Shared.dll</c> into the GAC.</para>
  13804. <code>
  13805. <![CDATA[
  13806. <gac-install>
  13807. <assemblies>
  13808. <include name="Shared.dll" />
  13809. </assemblies>
  13810. </gac-install>
  13811. ]]>
  13812. </code>
  13813. </example>
  13814. <example>
  13815. <para>
  13816. Installs <c>Shared.dll</c> and <c>MyWeb.dll</c> into the GAC.
  13817. </para>
  13818. <code>
  13819. <![CDATA[
  13820. <gac-install>
  13821. <assemblies>
  13822. <include name="Shared.dll" />
  13823. <include name="MyWeb.dll" />
  13824. </assemblies>
  13825. </gac-install>
  13826. ]]>
  13827. </code>
  13828. </example>
  13829. <example>
  13830. <para>
  13831. Installs <c>Shared.dll</c> and <c>MyWeb.dll</c> into the GAC and
  13832. specifies reference information.
  13833. </para>
  13834. <code>
  13835. <![CDATA[
  13836. <gac-install>
  13837. <reference scheme-type="Opaque" scheme-id="MyID" scheme-description="My description" />
  13838. <assemblies>
  13839. <include name="Shared.dll" />
  13840. <include name="MyWeb.dll" />
  13841. </assemblies>
  13842. </gacinstall>
  13843. ]]>
  13844. </code>
  13845. </example>
  13846. </member>
  13847. <member name="T:NAnt.Contrib.Tasks.GacTaskBase">
  13848. <summary>
  13849. Base class functionality for the GAC tasks.
  13850. </summary>
  13851. <remarks>
  13852. Concrete GAC tasks extend this class in order to obtain common functionality.
  13853. </remarks>
  13854. </member>
  13855. <member name="F:NAnt.Contrib.Tasks.GacTaskBase._currentAssembly">
  13856. <summary>
  13857. Stores the details of the assembly currently being operated against. This could be a name or
  13858. path, depending on the concrete task.
  13859. </summary>
  13860. </member>
  13861. <member name="F:NAnt.Contrib.Tasks.GacTaskBase._force">
  13862. <summary>
  13863. See <see cref="P:NAnt.Contrib.Tasks.GacTaskBase.Force"/>.
  13864. </summary>
  13865. </member>
  13866. <member name="F:NAnt.Contrib.Tasks.GacTaskBase._reference">
  13867. <summary>
  13868. See <see cref="P:NAnt.Contrib.Tasks.GacTaskBase.Reference"/>.
  13869. </summary>
  13870. </member>
  13871. <member name="M:NAnt.Contrib.Tasks.GacTaskBase.#ctor">
  13872. <summary>
  13873. Constructs and initialises an instance of <c>GacTask</c>.
  13874. </summary>
  13875. </member>
  13876. <member name="M:NAnt.Contrib.Tasks.GacTaskBase.StartProcess">
  13877. <summary>
  13878. Starts the process that is wrapped by this GAC task.
  13879. </summary>
  13880. <remarks>
  13881. Provided only to seal the implementation of <c>StartProcess()</c>.
  13882. </remarks>
  13883. <returns>The process that was started.</returns>
  13884. </member>
  13885. <member name="M:NAnt.Contrib.Tasks.GacTaskBase.InitializeTask(System.Xml.XmlNode)">
  13886. <summary>
  13887. Validates the task's configuration.
  13888. </summary>
  13889. <param name="taskNode">The task node.</param>
  13890. </member>
  13891. <member name="M:NAnt.Contrib.Tasks.GacTaskBase.ExecuteTask">
  13892. <summary>
  13893. Executes the task.
  13894. </summary>
  13895. <remarks>
  13896. Provided only to seal the implementation of <c>ExecuteTask()</c>.
  13897. </remarks>
  13898. </member>
  13899. <member name="M:NAnt.Contrib.Tasks.GacTaskBase.AppendProgramArguments(System.Text.StringBuilder)">
  13900. <summary>
  13901. Appends any task-specific program arguments.
  13902. </summary>
  13903. <param name="sb">The <c>StringBuilder</c> on which to append program arguments.</param>
  13904. <remarks>
  13905. Subclasses must override this method to return the arguments with which to run the GAC task.
  13906. </remarks>
  13907. </member>
  13908. <member name="M:NAnt.Contrib.Tasks.GacTaskBase.BeforeExecuteTask">
  13909. <summary>
  13910. Invoked prior to invoking <c>ExecuteTask()</c> on the base class.
  13911. </summary>
  13912. <remarks>
  13913. Allows, for example, subclasses to output useful information to the log.
  13914. </remarks>
  13915. </member>
  13916. <member name="P:NAnt.Contrib.Tasks.GacTaskBase.Force">
  13917. <summary>
  13918. Gets or sets a value indicating whether the GAC operation will be forced.
  13919. </summary>
  13920. <remarks>
  13921. The exact meaning of this property is dependent on the subclass. As such, subclasses should override this
  13922. property to provide a valid description.
  13923. </remarks>
  13924. </member>
  13925. <member name="P:NAnt.Contrib.Tasks.GacTaskBase.Reference">
  13926. <summary>
  13927. Specifies reference details to use when working with the GAC.
  13928. </summary>
  13929. </member>
  13930. <member name="P:NAnt.Contrib.Tasks.GacTaskBase.AssemblyList">
  13931. <summary>
  13932. Concrete GAC tasks must override this property to return an array of assembly names or paths
  13933. upon which to operate.
  13934. </summary>
  13935. </member>
  13936. <member name="P:NAnt.Contrib.Tasks.GacTaskBase.ExeName">
  13937. <summary>
  13938. Gets the executable name for the <c>gacutil</c> command-line tool.
  13939. </summary>
  13940. </member>
  13941. <member name="P:NAnt.Contrib.Tasks.GacTaskBase.ReferenceSpecified">
  13942. <summary>
  13943. Specifies whether a reference was specified for the GAC task.
  13944. </summary>
  13945. </member>
  13946. <member name="P:NAnt.Contrib.Tasks.GacTaskBase.CurrentAssembly">
  13947. <summary>
  13948. Gets the current assembly being operated against.
  13949. </summary>
  13950. </member>
  13951. <member name="P:NAnt.Contrib.Tasks.GacTaskBase.ProgramArguments">
  13952. <summary>
  13953. Gets the program arguments with which to run the <c>gacutil</c> process.
  13954. </summary>
  13955. </member>
  13956. <member name="F:NAnt.Contrib.Tasks.GacInstallTask._assemblies">
  13957. <summary>
  13958. See <see cref="P:NAnt.Contrib.Tasks.GacInstallTask.Assemblies"/>.
  13959. </summary>
  13960. </member>
  13961. <member name="M:NAnt.Contrib.Tasks.GacInstallTask.#ctor">
  13962. <summary>
  13963. Constructs and initialises an instance of the <c>GacInstallTask</c>.
  13964. </summary>
  13965. </member>
  13966. <member name="M:NAnt.Contrib.Tasks.GacInstallTask.AppendProgramArguments(System.Text.StringBuilder)">
  13967. <summary>
  13968. Appends any install-specific arguments.
  13969. </summary>
  13970. <param name="sb">The <c>StringBuilder</c> to append arguments to.</param>
  13971. </member>
  13972. <member name="M:NAnt.Contrib.Tasks.GacInstallTask.BeforeExecuteTask">
  13973. <summary>
  13974. Outputs log information.
  13975. </summary>
  13976. </member>
  13977. <member name="P:NAnt.Contrib.Tasks.GacInstallTask.Assemblies">
  13978. <summary>
  13979. Specifies the assemblies to install.
  13980. </summary>
  13981. </member>
  13982. <member name="P:NAnt.Contrib.Tasks.GacInstallTask.AssemblyList">
  13983. <summary>
  13984. Gets the assembly list to install.
  13985. </summary>
  13986. </member>
  13987. <member name="P:NAnt.Contrib.Tasks.GacInstallTask.Force">
  13988. <summary>
  13989. If <see langword="true" />, the specified assemblies will be forcibly
  13990. installed. Any existing duplicate assemblies in the GAC will be
  13991. overwritten. The default is <see langword="false" />.
  13992. </summary>
  13993. </member>
  13994. <member name="T:NAnt.Contrib.Tasks.GacTask">
  13995. <summary>
  13996. Manipulates the contents of the global assembly cache.
  13997. </summary>
  13998. <remarks>
  13999. <para>
  14000. This tasks provides some of the same functionality as the gacutil tool
  14001. provided in the .NET Framework SDK.
  14002. </para>
  14003. <para>
  14004. Specifically, the <see cref="T:NAnt.Contrib.Tasks.GacTask"/> allows you to install assemblies
  14005. into the cache and remove them from the cache.
  14006. </para>
  14007. <para>
  14008. Refer to the <see href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrfglobalassemblycacheutilitygacutilexe.htm">
  14009. Global Assembly Cache Tool (Gacutil.exe)</see> for more information.
  14010. </para>
  14011. </remarks>
  14012. <example>
  14013. <para>
  14014. Inserts assembly <c>mydll.dll</c> into the global assembly cache.
  14015. </para>
  14016. <code>
  14017. <![CDATA[
  14018. <gac assembly="mydll.dll" action="install" />
  14019. ]]>
  14020. </code>
  14021. </example>
  14022. <example>
  14023. <para>
  14024. Removes the assembly <c>hello</c> from the global assembly cache and
  14025. the native image cache.
  14026. </para>
  14027. <code>
  14028. <![CDATA[
  14029. <gac assembly="hello" action="uninstall" />
  14030. ]]>
  14031. </code>
  14032. <para>
  14033. Note that the previous command might remove more than one assembly
  14034. from the assembly cache because the assembly name is not fully
  14035. specified. For example, if both version 1.0.0.0 and 3.2.2.1 of
  14036. <c>hello</c> are installed in the cache, both of the assemblies will
  14037. be removed from the global assembly cache.
  14038. </para>
  14039. </example>
  14040. <example>
  14041. <para>
  14042. Use the following example to avoid removing more than one assembly.
  14043. This command removes only the hello assembly that matches the fully
  14044. specified version number, culture, and public key.
  14045. </para>
  14046. <code>
  14047. <![CDATA[
  14048. <gac assembly="hello,Version=1.0.0.1,Culture=de,PublicKeyToken=45e343aae32233ca" action="uninstall" />
  14049. ]]>
  14050. </code>
  14051. </example>
  14052. </member>
  14053. <member name="P:NAnt.Contrib.Tasks.GacTask.AssemblyName">
  14054. <summary>
  14055. The name of a file that contains an assembly manifest.
  14056. </summary>
  14057. </member>
  14058. <member name="P:NAnt.Contrib.Tasks.GacTask.ActionType">
  14059. <summary>
  14060. Defines the action to take with the assembly. The default is
  14061. <see cref="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.install"/>.
  14062. </summary>
  14063. </member>
  14064. <member name="P:NAnt.Contrib.Tasks.GacTask.AssemblyFileSet">
  14065. <summary>
  14066. Fileset are used to define multiple assemblies.
  14067. </summary>
  14068. </member>
  14069. <member name="T:NAnt.Contrib.Tasks.GacTask.ActionTypes">
  14070. <summary>
  14071. Defines the actions that can be performed on an assembly using the
  14072. <see cref="T:NAnt.Contrib.Tasks.GacTask"/>.
  14073. </summary>
  14074. </member>
  14075. <member name="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.install">
  14076. <summary>
  14077. Installs an assembly into the global assembly cache.
  14078. </summary>
  14079. </member>
  14080. <member name="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.overwrite">
  14081. <summary>
  14082. Installs an assembly into the global assembly cache. If an assembly
  14083. with the same name already exists in the global assembly cache, it is
  14084. overwritten.
  14085. </summary>
  14086. </member>
  14087. <member name="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.uninstall">
  14088. <summary>
  14089. Uninstalls an assembly from the global assembly cache.
  14090. </summary>
  14091. </member>
  14092. <member name="T:NAnt.Contrib.Tasks.GacUninstallTask">
  14093. <summary>
  14094. Uninstalls assemblies from the Global Assembly Cache (GAC) by using the
  14095. <c>gacutil</c> SDK tool.
  14096. </summary>
  14097. <remarks>
  14098. <para>
  14099. Assemblies are specified via an <see cref="T:NAnt.Contrib.Types.AssemblySet"/>. Individual
  14100. assemblies are specified by their identity information. Only a name is
  14101. required but, optionally, the assembly version, culture and public key
  14102. token may be specified.
  14103. </para>
  14104. <para>
  14105. Assemblies can be uninstalled from the GAC with or without reference
  14106. counting. The full details of reference counting can be found in the
  14107. SDK documentation.
  14108. </para>
  14109. </remarks>
  14110. <example>
  14111. <para>Uninstalls <c>Shared</c> assembly from the GAC.</para>
  14112. <code>
  14113. <![CDATA[
  14114. <gac-uninstall>
  14115. <assemblies>
  14116. <assembly name="Shared" />
  14117. </assemblies>
  14118. </gac-uninstall>
  14119. ]]>
  14120. </code>
  14121. </example>
  14122. <example>
  14123. <para>
  14124. Uninstalls <c>Shared</c> and <c>MyWeb</c> from the GAC.
  14125. </para>
  14126. <code>
  14127. <![CDATA[
  14128. <gac-uninstall>
  14129. <assemblies>
  14130. <assembly name="Shared" />
  14131. <assembly name="MyWeb" />
  14132. </assemblies>
  14133. </gac-uninstall>
  14134. ]]>
  14135. </code>
  14136. </example>
  14137. <example>
  14138. <para>
  14139. Decrements references to <c>Shared</c> in the GAC and uninstalls if
  14140. the reference count reaches zero.
  14141. </para>
  14142. <code>
  14143. <![CDATA[
  14144. <gac-uninstall>
  14145. <reference scheme-type="Opaque" scheme-id="MyID" scheme-description="My description" />
  14146. <assemblies>
  14147. <assembly name="Shared" />
  14148. </assemblies>
  14149. </gac-uninstall>
  14150. ]]>
  14151. </code>
  14152. </example>
  14153. <example>
  14154. <para>
  14155. Uninstalls version <c>2.1.7.9201</c> of <c>Shared</c> plus the
  14156. Australian-cultured <c>MyWeb</c> from the GAC.
  14157. </para>
  14158. <code>
  14159. <![CDATA[
  14160. <gac-uninstall>
  14161. <assemblies>
  14162. <assembly name="Shared" version="2.1.7.9201" />
  14163. <assembly name="MyWeb" culture="en-AU" />
  14164. </assemblies>
  14165. </gac-uninstall>
  14166. ]]>
  14167. </code>
  14168. </example>
  14169. <example>
  14170. <para>
  14171. Uninstalls the neutrally-cultured, version <c>1.0.5000.0</c> of
  14172. <c>System.Xml</c> from the native image cache. The assembly must
  14173. also have a public key token of <c>b77a5c561934e08a</c> to be
  14174. uninstalled.
  14175. </para>
  14176. <code>
  14177. <![CDATA[
  14178. <gac-uninstall native="true">
  14179. <assemblies>
  14180. <assembly name="System.Xml" version="1.0.5000.0" public-key-token="b77a5c561934e08a" culture="Neutral" />
  14181. </assemblies>
  14182. </gac-uninstall>
  14183. ]]>
  14184. </code>
  14185. </example>
  14186. </member>
  14187. <member name="F:NAnt.Contrib.Tasks.GacUninstallTask._native">
  14188. <summary>
  14189. See <see cref="P:NAnt.Contrib.Tasks.GacUninstallTask.Native"/>.
  14190. </summary>
  14191. </member>
  14192. <member name="F:NAnt.Contrib.Tasks.GacUninstallTask._assemblies">
  14193. <summary>
  14194. See <see cref="P:NAnt.Contrib.Tasks.GacUninstallTask.Assemblies"/>.
  14195. </summary>
  14196. </member>
  14197. <member name="M:NAnt.Contrib.Tasks.GacUninstallTask.#ctor">
  14198. <summary>
  14199. Constructs an instance of the <c>GacUninstallTask</c>.
  14200. </summary>
  14201. </member>
  14202. <member name="M:NAnt.Contrib.Tasks.GacUninstallTask.AppendProgramArguments(System.Text.StringBuilder)">
  14203. <summary>
  14204. Appends any install-specific arguments.
  14205. </summary>
  14206. <param name="sb"></param>
  14207. </member>
  14208. <member name="M:NAnt.Contrib.Tasks.GacUninstallTask.BeforeExecuteTask">
  14209. <summary>
  14210. Outputs log information.
  14211. </summary>
  14212. </member>
  14213. <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.Native">
  14214. <summary>
  14215. If <see langword="true" />, specifies that the assemblies should be
  14216. uninstalled from the native image cache. The default is <see langword="false" />.
  14217. </summary>
  14218. </member>
  14219. <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.Assemblies">
  14220. <summary>
  14221. Specifies the assemblies to uninstall.
  14222. </summary>
  14223. </member>
  14224. <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.AssemblyList">
  14225. <summary>
  14226. Gets the assembly list to uninstall.
  14227. </summary>
  14228. </member>
  14229. <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.Force">
  14230. <summary>
  14231. If <see langword="true" />, the specified assemblies will be forcibly
  14232. removed from the GAC. All references to the specified assemblies will
  14233. be removed from the GAC prior to removing the assemblies themselves.
  14234. The default is <see langword="false" />.
  14235. </summary>
  14236. <remarks>
  14237. You cannot use this option to remove an assembly that was installed using Microsoft Windows Installer.
  14238. </remarks>
  14239. </member>
  14240. <member name="T:NAnt.Contrib.Tasks.HxCompTask">
  14241. <summary>
  14242. Compiles a Microsoft HTML Help 2.0 Project.
  14243. </summary>
  14244. <example>
  14245. <para>Compile a help file.</para>
  14246. <code>
  14247. <![CDATA[
  14248. <hxcomp contents="MyContents.HxC" output="MyHelpFile.HxS" projectroot="HelpSourceFolder" />
  14249. ]]>
  14250. </code>
  14251. </example>
  14252. </member>
  14253. <member name="P:NAnt.Contrib.Tasks.HxCompTask.Contents">
  14254. <summary>
  14255. The name of the contents (.HxC) file.
  14256. </summary>
  14257. </member>
  14258. <member name="P:NAnt.Contrib.Tasks.HxCompTask.LogFile">
  14259. <summary>
  14260. ANSI/DBCS log filename.
  14261. </summary>
  14262. </member>
  14263. <member name="P:NAnt.Contrib.Tasks.HxCompTask.UnicodeLogFile">
  14264. <summary>
  14265. Unicode log filename.
  14266. </summary>
  14267. </member>
  14268. <member name="P:NAnt.Contrib.Tasks.HxCompTask.ProjectRoot">
  14269. <summary>
  14270. Root directory containing Help 2.0 project files.
  14271. </summary>
  14272. </member>
  14273. <member name="P:NAnt.Contrib.Tasks.HxCompTask.OutputFile">
  14274. <summary>
  14275. Output (.HxS) filename.
  14276. </summary>
  14277. </member>
  14278. <member name="P:NAnt.Contrib.Tasks.HxCompTask.NoInformation">
  14279. <summary>
  14280. Generate no informational messages.
  14281. </summary>
  14282. </member>
  14283. <member name="P:NAnt.Contrib.Tasks.HxCompTask.NoErrors">
  14284. <summary>
  14285. Generate no error messages.
  14286. </summary>
  14287. </member>
  14288. <member name="P:NAnt.Contrib.Tasks.HxCompTask.NoWarnings">
  14289. <summary>
  14290. Generate no warning messages.
  14291. </summary>
  14292. </member>
  14293. <member name="P:NAnt.Contrib.Tasks.HxCompTask.UncompileFile">
  14294. <summary>
  14295. File to be decompiled.
  14296. </summary>
  14297. </member>
  14298. <member name="P:NAnt.Contrib.Tasks.HxCompTask.UncompileOutputDir">
  14299. <summary>
  14300. Directory to place decompiled files into.
  14301. </summary>
  14302. </member>
  14303. <member name="P:NAnt.Contrib.Tasks.HxCompTask.ProgramArguments">
  14304. <summary>
  14305. Arguments of program to execute
  14306. </summary>
  14307. </member>
  14308. <member name="T:NAnt.Contrib.Tasks.HxRegTask">
  14309. <summary>
  14310. Registers a Microsoft HTML Help 2.0 Collection.
  14311. </summary>
  14312. <example>
  14313. <para>Register a help namespace.</para>
  14314. <code>
  14315. <![CDATA[
  14316. <hxreg namespace="MyProduct.MyHelp" title="MyProductHelp" collection="MyHelp.HxC" helpfile="MyHelp.HxS" />
  14317. ]]>
  14318. </code>
  14319. </example>
  14320. </member>
  14321. <member name="P:NAnt.Contrib.Tasks.HxRegTask.Namespace">
  14322. <summary>Help collection namespace.</summary>
  14323. </member>
  14324. <member name="P:NAnt.Contrib.Tasks.HxRegTask.Title">
  14325. <summary>Title identifier.</summary>
  14326. </member>
  14327. <member name="P:NAnt.Contrib.Tasks.HxRegTask.Collection">
  14328. <summary>Collection (.HxC) filename. </summary>
  14329. </member>
  14330. <member name="P:NAnt.Contrib.Tasks.HxRegTask.Description">
  14331. <summary>Description of the namespace.</summary>
  14332. </member>
  14333. <member name="P:NAnt.Contrib.Tasks.HxRegTask.HelpFile">
  14334. <summary>Help (.HxS) filename.</summary>
  14335. </member>
  14336. <member name="P:NAnt.Contrib.Tasks.HxRegTask.Index">
  14337. <summary>Index (.HxI) filename.</summary>
  14338. </member>
  14339. <member name="P:NAnt.Contrib.Tasks.HxRegTask.SearchFile">
  14340. <summary>Combined full-text search (.HxQ) filename.</summary>
  14341. </member>
  14342. <member name="P:NAnt.Contrib.Tasks.HxRegTask.AttrIndex">
  14343. <summary>Combined attribute index (.HxR) filename.</summary>
  14344. </member>
  14345. <member name="P:NAnt.Contrib.Tasks.HxRegTask.Language">
  14346. <summary>Language ID.</summary>
  14347. </member>
  14348. <member name="P:NAnt.Contrib.Tasks.HxRegTask.Alias">
  14349. <summary>Alias.</summary>
  14350. </member>
  14351. <member name="P:NAnt.Contrib.Tasks.HxRegTask.CommandFile">
  14352. <summary>Filename of a file containing HxReg commands.</summary>
  14353. </member>
  14354. <member name="P:NAnt.Contrib.Tasks.HxRegTask.UnRegister">
  14355. <summary>Unregister a namespace, title, or alias.</summary>
  14356. </member>
  14357. <member name="P:NAnt.Contrib.Tasks.HxRegTask.ProgramArguments">
  14358. <summary>
  14359. Arguments of program to execute
  14360. </summary>
  14361. </member>
  14362. <member name="T:NAnt.Contrib.Tasks.IniReadTask">
  14363. <summary>
  14364. Reads String values in INI files.
  14365. </summary>
  14366. <para>Reads the value for <c>AutoRefresh</c> in the <c>MS Transaction Server</c> section
  14367. of the <c>VendorMISMO2.ini</c> ini file. Stores the value in the "myvar" property.</para>
  14368. <example>
  14369. <code>
  14370. <![CDATA[
  14371. <iniread property="myvar" filename="VendorMISMO2.ini" section="MS Transaction Server" key="AutoRefresh" default="1"/>
  14372. ]]>
  14373. </code>
  14374. <para>The file contents look like this:</para>
  14375. <code>
  14376. [MS Transaction Server]
  14377. Executable="VendorMISMO2.dll"
  14378. AutoRefresh=1
  14379. </code>
  14380. </example>
  14381. </member>
  14382. <member name="P:NAnt.Contrib.Tasks.IniReadTask.FileName">
  14383. <summary>
  14384. INI File to Write To.
  14385. </summary>
  14386. </member>
  14387. <member name="P:NAnt.Contrib.Tasks.IniReadTask.Key">
  14388. <summary>
  14389. Key to set the value for.
  14390. </summary>
  14391. </member>
  14392. <member name="P:NAnt.Contrib.Tasks.IniReadTask.Default">
  14393. <summary>
  14394. value to set.
  14395. </summary>
  14396. </member>
  14397. <member name="P:NAnt.Contrib.Tasks.IniReadTask.Section">
  14398. <summary>
  14399. Section in the INI file.
  14400. </summary>
  14401. </member>
  14402. <member name="P:NAnt.Contrib.Tasks.IniReadTask.Property">
  14403. <summary>
  14404. property where we store the return value.
  14405. </summary>
  14406. </member>
  14407. <member name="T:NAnt.Contrib.Tasks.IniWriteTask">
  14408. <summary>
  14409. Sets String values in INI files.
  14410. </summary>
  14411. <example>
  14412. <para>Set the value for <c>Executable</c> in the <c>VendorMISMO2.ini</c> ini file</para>
  14413. <code>
  14414. <![CDATA[
  14415. <iniwrite filename="VendorMISMO2.ini" section="MS Transaction Server" key="Executable" value="VendorMISMO2.dll"/>
  14416. ]]>
  14417. </code>
  14418. <para>The file contents look like this:</para>
  14419. <code>
  14420. [MS Transaction Server]
  14421. Executable="VendorMISMO2.dll"
  14422. AutoRefresh=1
  14423. </code>
  14424. </example>
  14425. </member>
  14426. <member name="P:NAnt.Contrib.Tasks.IniWriteTask.FileName">
  14427. <summary>
  14428. INI File to Write To.
  14429. </summary>
  14430. </member>
  14431. <member name="P:NAnt.Contrib.Tasks.IniWriteTask.Key">
  14432. <summary>
  14433. Key to set the value for.
  14434. </summary>
  14435. </member>
  14436. <member name="P:NAnt.Contrib.Tasks.IniWriteTask.Value">
  14437. <summary>
  14438. value to set.
  14439. </summary>
  14440. </member>
  14441. <member name="P:NAnt.Contrib.Tasks.IniWriteTask.Section">
  14442. <summary>
  14443. Section in the INI file.
  14444. </summary>
  14445. </member>
  14446. <member name="T:NAnt.Contrib.Tasks.MsbuildTask">
  14447. <summary>
  14448. Builds the specified targets in the project file using <c>MSBuild</c>.
  14449. </summary>
  14450. <remarks>
  14451. <para>
  14452. If a project file is not specified, MSBuild searches the current
  14453. working directory for a file that has a file extension that ends in
  14454. "proj" and uses that file.
  14455. </para>
  14456. </remarks>
  14457. </member>
  14458. <member name="M:NAnt.Contrib.Tasks.MsbuildTask.ExecuteTask">
  14459. <summary>
  14460. Starts the external process and captures its output.
  14461. </summary>
  14462. </member>
  14463. <member name="P:NAnt.Contrib.Tasks.MsbuildTask.ProjectFile">
  14464. <summary>
  14465. The project to build.
  14466. </summary>
  14467. </member>
  14468. <member name="P:NAnt.Contrib.Tasks.MsbuildTask.Properties">
  14469. <summary>
  14470. Set or override these project-level properties.
  14471. </summary>
  14472. </member>
  14473. <member name="P:NAnt.Contrib.Tasks.MsbuildTask.Target">
  14474. <summary>
  14475. Build these targets in this project. Use a semicolon or a comma
  14476. comma to separate multiple targets.
  14477. </summary>
  14478. </member>
  14479. <member name="P:NAnt.Contrib.Tasks.MsbuildTask.NoAutoResponse">
  14480. <summary>
  14481. Do not auto-include the MSBuild.rsp file.
  14482. </summary>
  14483. </member>
  14484. <member name="P:NAnt.Contrib.Tasks.MsbuildTask.Verbosity">
  14485. <summary>
  14486. Specifies the amount of information to display in the MSBuild log.
  14487. </summary>
  14488. </member>
  14489. <member name="P:NAnt.Contrib.Tasks.MsbuildTask.ProgramArguments">
  14490. <summary>
  14491. Gets the command line arguments for the external program.
  14492. </summary>
  14493. <value>
  14494. The command line arguments for the external program.
  14495. </value>
  14496. </member>
  14497. <member name="M:NAnt.Contrib.Tasks.MsbuildTask.VerbosityLevelConverter.#ctor">
  14498. <summary>
  14499. Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.MsbuildTask.VerbosityLevelConverter"/>
  14500. class.
  14501. </summary>
  14502. </member>
  14503. <member name="M:NAnt.Contrib.Tasks.MsbuildTask.VerbosityLevelConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
  14504. <summary>
  14505. Converts the given object to the type of this converter, using the
  14506. specified context and culture information.
  14507. </summary>
  14508. <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
  14509. <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
  14510. <param name="value">The <see cref="T:System.Object"/> to convert.</param>
  14511. <returns>
  14512. An <see cref="T:System.Object"/> that represents the converted value.
  14513. </returns>
  14514. </member>
  14515. <member name="T:NAnt.Contrib.Tasks.MgmtClassGenTask">
  14516. <summary>
  14517. A task that generates strongly typed WMI classes using
  14518. <c>mgmtclassgen.exe</c>.
  14519. </summary>
  14520. <remarks>
  14521. The Management Strongly Typed Class Generator
  14522. enables you to quickly generate an early-bound
  14523. managed class for a specified Windows Management
  14524. Instrumentation (WMI) class. The generated
  14525. class simplifies the code you must write to access
  14526. an instance of the WMI class.
  14527. </remarks>
  14528. <example>
  14529. <code>
  14530. <![CDATA[
  14531. <mgmtclassgen
  14532. wmiclass="Win32_LogicalDisk"
  14533. language="CS"
  14534. machine="SomeMachine"
  14535. path="Root\cimv2"
  14536. namespace="Winterdom.WMI"
  14537. out="${outputdir}\LogicalDisk.cs"
  14538. username="Administrator"
  14539. password="password"
  14540. />
  14541. ]]>
  14542. </code>
  14543. </example>
  14544. </member>
  14545. <member name="M:NAnt.Contrib.Tasks.MgmtClassGenTask.InitializeTask(System.Xml.XmlNode)">
  14546. <summary>
  14547. Initializes task and ensures the supplied attributes are valid.
  14548. </summary>
  14549. <param name="taskNode">Xml node used to define this task instance.</param>
  14550. </member>
  14551. <member name="M:NAnt.Contrib.Tasks.MgmtClassGenTask.ExecuteTask">
  14552. <summary>
  14553. This is where the work is done
  14554. </summary>
  14555. </member>
  14556. <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.WmiClass">
  14557. <summary>
  14558. Specifies the name of the WMI class
  14559. to generate the strongly typed class
  14560. </summary>
  14561. </member>
  14562. <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Language">
  14563. <summary>
  14564. Specifies the language in which to generate
  14565. the class. Possible values are: CS, VB, JS
  14566. </summary>
  14567. </member>
  14568. <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Machine">
  14569. <summary>
  14570. Specifies the machine to connect to.
  14571. </summary>
  14572. </member>
  14573. <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Path">
  14574. <summary>
  14575. Specifies the path to the WMI namespace
  14576. that contains the class.
  14577. </summary>
  14578. </member>
  14579. <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Namespace">
  14580. <summary>
  14581. Namespace of the generated .NET class
  14582. </summary>
  14583. </member>
  14584. <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.OutFile">
  14585. <summary>
  14586. Path of the file to generate
  14587. </summary>
  14588. </member>
  14589. <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Username">
  14590. <summary>
  14591. User name to use when connecting to
  14592. the specified machine
  14593. </summary>
  14594. </member>
  14595. <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Password">
  14596. <summary>
  14597. Password to use when connecting to the
  14598. specified machine
  14599. </summary>
  14600. </member>
  14601. <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.ProgramFileName">
  14602. <summary>
  14603. Filename of program to execute
  14604. </summary>
  14605. </member>
  14606. <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.ProgramArguments">
  14607. <summary>
  14608. Arguments of program to execute
  14609. </summary>
  14610. </member>
  14611. <member name="T:NAnt.Contrib.Tasks.NGenTask">
  14612. <summary>
  14613. Pre-translates native code for an assembly containing IL (Intermediary
  14614. Language bytecode) on the Windows platform.
  14615. </summary>
  14616. <example>
  14617. <code>
  14618. <![CDATA[
  14619. <ngen assembly="MyAssembly.dll" />
  14620. ]]>
  14621. </code>
  14622. </example>
  14623. </member>
  14624. <member name="M:NAnt.Contrib.Tasks.NGenTask.InitializeTask(System.Xml.XmlNode)">
  14625. <summary>
  14626. Initializes task and ensures the supplied attributes are valid.
  14627. </summary>
  14628. <param name="taskNode">Xml node used to define this task instance.</param>
  14629. </member>
  14630. <member name="P:NAnt.Contrib.Tasks.NGenTask.Assembly">
  14631. <summary>Assembly path or display name.</summary>
  14632. </member>
  14633. <member name="P:NAnt.Contrib.Tasks.NGenTask.Show">
  14634. <summary>If existing images should be shown.</summary>
  14635. </member>
  14636. <member name="P:NAnt.Contrib.Tasks.NGenTask.Delete">
  14637. <summary>If existing images should be deleted.</summary>
  14638. </member>
  14639. <member name="P:NAnt.Contrib.Tasks.NGenTask.Debug">
  14640. <summary>If an image should be generated which
  14641. can be used under a debugger.</summary>
  14642. </member>
  14643. <member name="P:NAnt.Contrib.Tasks.NGenTask.DebugOptimized">
  14644. <summary>If an image should be generated which
  14645. can be used under a debugger in optimized
  14646. debugging mode.</summary>
  14647. </member>
  14648. <member name="P:NAnt.Contrib.Tasks.NGenTask.Profiled">
  14649. <summary>If an image should be generated which
  14650. can be used under a profiler.</summary>
  14651. </member>
  14652. <member name="P:NAnt.Contrib.Tasks.NGenTask.ProgramArguments">
  14653. <summary>
  14654. Arguments of program to execute
  14655. </summary>
  14656. </member>
  14657. <member name="T:NAnt.Contrib.Tasks.NUnitReportTask">
  14658. <summary>
  14659. A task that generates a summary HTML
  14660. from a set of NUnit xml report files.
  14661. Loosely based on Erik Hatcher JUnitReport for Ant.
  14662. </summary>
  14663. <remarks>
  14664. This task can generate a combined HTML report out of a
  14665. set of NUnit result files generated using the
  14666. XML Result Formatter.
  14667. By default, NUnitReport will generate the combined
  14668. report using the NUnitSummary.xsl file located at the
  14669. assembly's location, but you can specify a different
  14670. XSLT template to use with the <code>xslfile</code>
  14671. attribute.
  14672. Also, all the properties defined in the current
  14673. project will be passed down to the XSLT file as
  14674. template parameters, so you can access properties
  14675. such as nant.project.name, nant.version, etc.
  14676. </remarks>
  14677. <example>
  14678. <code><![CDATA[
  14679. <nunitreport
  14680. out="${outputdir}\TestSummary.html"
  14681. >
  14682. <fileset>
  14683. <include name="${outputdir}\Test-*.xml" />
  14684. </fileset>
  14685. </nunitreport>
  14686. ]]></code>
  14687. </example>
  14688. </member>
  14689. <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.InitializeTask(System.Xml.XmlNode)">
  14690. <summary>
  14691. Initializes task and ensures the supplied attributes are valid.
  14692. </summary>
  14693. <param name="taskNode">Xml node used to define this task instance.</param>
  14694. </member>
  14695. <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.ExecuteTask">
  14696. <summary>
  14697. This is where the work is done
  14698. </summary>
  14699. </member>
  14700. <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.CreateSummaryXmlDoc">
  14701. <summary>
  14702. Initializes the XmlDocument instance
  14703. used to summarize the test results
  14704. </summary>
  14705. <returns></returns>
  14706. </member>
  14707. <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.GetPropertyList">
  14708. <summary>
  14709. Builds an XsltArgumentList with all
  14710. the properties defined in the
  14711. current project as XSLT parameters.
  14712. </summary>
  14713. <returns>Property List</returns>
  14714. </member>
  14715. <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.LoadTransform">
  14716. <summary>
  14717. Loads the XSLT Transform
  14718. </summary>
  14719. <remarks>
  14720. This method will load the file specified
  14721. through the the xslfile attribute, or
  14722. the default transformation included
  14723. as a managed resource.
  14724. </remarks>
  14725. <returns>The Transformation to use</returns>
  14726. </member>
  14727. <member name="P:NAnt.Contrib.Tasks.NUnitReportTask.OutFilename">
  14728. <summary>
  14729. Name of Output HTML file.
  14730. </summary>
  14731. </member>
  14732. <member name="P:NAnt.Contrib.Tasks.NUnitReportTask.XslFile">
  14733. <summary>
  14734. XSLT file used to generate the report.
  14735. </summary>
  14736. </member>
  14737. <member name="P:NAnt.Contrib.Tasks.NUnitReportTask.XmlFileSet">
  14738. <summary>
  14739. Set of XML files to use as input
  14740. </summary>
  14741. </member>
  14742. <member name="T:NAnt.Contrib.Tasks.NUnitReportTask.LocalResXmlResolver">
  14743. <summary>
  14744. Custom XmlResolver used to load the
  14745. XSLT files out of this assembly resources.
  14746. </summary>
  14747. </member>
  14748. <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.LocalResXmlResolver.GetEntity(System.Uri,System.String,System.Type)">
  14749. <summary>
  14750. Loads the XSLT file
  14751. </summary>
  14752. <param name="absoluteUri"></param>
  14753. <param name="role"></param>
  14754. <param name="objToReturn"></param>
  14755. <returns></returns>
  14756. </member>
  14757. <member name="T:NAnt.Contrib.Tasks.RecordTask">
  14758. <summary>
  14759. A task that records the build's output to a file. Loosely based on Ant's
  14760. <a href="http://ant.apache.org/manual/CoreTasks/recorder.html">Record</a>
  14761. task.
  14762. </summary>
  14763. <remarks>
  14764. This task allows you to record the build's output, or parts of it to a
  14765. file. You can start and stop recording at any place in the build process.
  14766. </remarks>
  14767. <example>
  14768. <code>
  14769. <![CDATA[
  14770. <record name="${outputdir}\Buildlog.txt" level="Info" action="Start"/>
  14771. <record name="${outputdir}\Buildlog.txt" action="Close"/>
  14772. ]]>
  14773. </code>
  14774. </example>
  14775. </member>
  14776. <member name="M:NAnt.Contrib.Tasks.RecordTask.ExecuteTask">
  14777. <summary>
  14778. This is where the work is done.
  14779. </summary>
  14780. </member>
  14781. <member name="P:NAnt.Contrib.Tasks.RecordTask.LogName">
  14782. <summary>
  14783. Name of destination file.
  14784. </summary>
  14785. </member>
  14786. <member name="P:NAnt.Contrib.Tasks.RecordTask.Action">
  14787. <summary>
  14788. Action to apply to this log instance - either <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Start"/>,
  14789. <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Stop"/>, <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Close"/> or
  14790. <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Flush"/>.
  14791. </summary>
  14792. </member>
  14793. <member name="P:NAnt.Contrib.Tasks.RecordTask.AutoFlush">
  14794. <summary>
  14795. Determines whether the recorder will flush it's buffer after every
  14796. write to it. The default is <see langword="false"/>.
  14797. </summary>
  14798. <remarks>
  14799. Effective only with the <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Start"/> action.
  14800. </remarks>
  14801. </member>
  14802. <member name="P:NAnt.Contrib.Tasks.RecordTask.ThresholdLevel">
  14803. <summary>
  14804. Determine the level of logging - either <see cref="F:NAnt.Core.Level.Debug"/>,
  14805. <see cref="F:NAnt.Core.Level.Verbose"/>, <see cref="F:NAnt.Core.Level.Info"/>,
  14806. <see cref="F:NAnt.Core.Level.Warning"/> or <see cref="F:NAnt.Core.Level.Error"/>.
  14807. The default is <see cref="F:NAnt.Core.Level.Info"/>.
  14808. </summary>
  14809. <remarks>
  14810. Effective only with the <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Start"/> action.
  14811. </remarks>
  14812. </member>
  14813. <member name="T:NAnt.Contrib.Tasks.RegasmTask">
  14814. <summary>
  14815. Registers an assembly for use from COM clients.
  14816. </summary>
  14817. <remarks>
  14818. <para>
  14819. Refer to the <see href="ms-help://MS.VSCC/MS.MSDNVS/cptools/html/cpgrfassemblyregistrationtoolregasmexe.htm">Regasm</see>
  14820. documentation for more information on the regasm tool.
  14821. </para>
  14822. </remarks>
  14823. <example>
  14824. <para>
  14825. Register a single assembly.
  14826. </para>
  14827. <code>
  14828. <![CDATA[
  14829. <regasm assembly="myAssembly.dll" />
  14830. ]]>
  14831. </code>
  14832. </example>
  14833. <example>
  14834. <para>
  14835. Register an assembly while exporting a typelibrary.
  14836. </para>
  14837. <code>
  14838. <![CDATA[
  14839. <regasm assembly="myAssembly.dll" typelib="myAssembly.tlb" />
  14840. ]]>
  14841. </code>
  14842. </example>
  14843. <example>
  14844. <para>
  14845. Register a set of assemblies at once.
  14846. </para>
  14847. <code>
  14848. <![CDATA[
  14849. <regasm unregister="false" codebase="true">
  14850. <fileset>
  14851. <include name="**/*.dll" />
  14852. <exclude name="notanassembly.dll" />
  14853. </fileset>
  14854. </regasm>
  14855. ]]>
  14856. </code>
  14857. </example>
  14858. </member>
  14859. <member name="P:NAnt.Contrib.Tasks.RegasmTask.AssemblyFile">
  14860. <summary>
  14861. The name of the file to register. This is provided as an alternate
  14862. to using the task's fileset.
  14863. </summary>
  14864. </member>
  14865. <member name="P:NAnt.Contrib.Tasks.RegasmTask.RegistryFile">
  14866. <summary>
  14867. Registry file to export to instead of entering the types directly
  14868. into the registry. If a fileset is used then the entries are all
  14869. collated into this file.
  14870. </summary>
  14871. </member>
  14872. <member name="P:NAnt.Contrib.Tasks.RegasmTask.CodeBase">
  14873. <summary>
  14874. Set the code base registry setting.
  14875. </summary>
  14876. </member>
  14877. <member name="P:NAnt.Contrib.Tasks.RegasmTask.ExportTypelib">
  14878. <summary>
  14879. Export a typelib and register it. The typelib will have the same
  14880. name as the source assembly unless the <see cref="P:NAnt.Contrib.Tasks.RegasmTask.TypeLib"/>
  14881. attribute is used.
  14882. </summary>
  14883. </member>
  14884. <member name="P:NAnt.Contrib.Tasks.RegasmTask.Registered">
  14885. <summary>
  14886. Only refer to already registered type libraries.
  14887. </summary>
  14888. </member>
  14889. <member name="P:NAnt.Contrib.Tasks.RegasmTask.TypeLib">
  14890. <summary>
  14891. Export the assembly to the specified type library and register it.
  14892. This attribute is ignored when a fileset is specified.
  14893. </summary>
  14894. </member>
  14895. <member name="P:NAnt.Contrib.Tasks.RegasmTask.Unregister">
  14896. <summary>
  14897. Unregister the assembly. The default is <see langword="false" />.
  14898. </summary>
  14899. </member>
  14900. <member name="P:NAnt.Contrib.Tasks.RegasmTask.RegasmFileSet">
  14901. <summary>
  14902. The set of files to register.
  14903. </summary>
  14904. </member>
  14905. <member name="T:NAnt.Contrib.Tasks.SchemaValidatorAttribute">
  14906. <summary>
  14907. Indicates that class should be validated by an XML Schema.
  14908. </summary>
  14909. <remarks>None.</remarks>
  14910. </member>
  14911. <member name="M:NAnt.Contrib.Tasks.SchemaValidatorAttribute.#ctor(System.Type)">
  14912. <summary>
  14913. Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.SchemaValidatorAttribute"/>
  14914. class.
  14915. </summary>
  14916. <param name="schemaType">The <see cref="T:System.Type"/> of the object created by <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> to represent the root node of your task.</param>
  14917. </member>
  14918. <member name="M:NAnt.Contrib.Tasks.SchemaValidatorAttribute.#ctor(System.Type,System.String)">
  14919. <summary>
  14920. Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.SchemaValidatorAttribute"/>
  14921. class.
  14922. </summary>
  14923. <param name="schemaType">The <see cref="T:System.Type"/> of the object created by <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> to represent the root node of your task.</param>
  14924. <param name="xmlNamespace"></param>
  14925. </member>
  14926. <member name="P:NAnt.Contrib.Tasks.SchemaValidatorAttribute.ValidatorType">
  14927. <summary>
  14928. Gets or sets the <see cref="T:System.Type"/> of the object created by
  14929. <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> to represent the root node of your task.
  14930. </summary>
  14931. <value>
  14932. The <see cref="T:System.Type"/> of the object created by <see cref="T:NAnt.Contrib.Tasks.XsdTask"/>
  14933. to represent the root node of your task.
  14934. </value>
  14935. </member>
  14936. <member name="T:NAnt.Contrib.Tasks.SchemeType">
  14937. <summary>
  14938. Defines possible reference counting scheme types for the <see cref="T:NAnt.Contrib.Tasks.GacTask">GAC</see> tasks.
  14939. </summary>
  14940. </member>
  14941. <member name="F:NAnt.Contrib.Tasks.SchemeType.None">
  14942. <summary>
  14943. Specifies that no reference counting scheme will be used when performing the GAC task.
  14944. </summary>
  14945. </member>
  14946. <member name="F:NAnt.Contrib.Tasks.SchemeType.UninstallKey">
  14947. <summary>
  14948. Specifies that registry-related reference counting will be used when performing the GAC task.
  14949. </summary>
  14950. <remarks>
  14951. When the scheme type is set to <c>UninstallKey</c>, the related scheme ID should be set to the name of the application
  14952. set in the <c>HKLM\Software\Microsoft\Windows\CurrentVersion</c> registry key.
  14953. </remarks>
  14954. </member>
  14955. <member name="F:NAnt.Contrib.Tasks.SchemeType.FilePath">
  14956. <summary>
  14957. Specifies that file-based reference counting will be used when performing the GAC task.
  14958. </summary>
  14959. <remarks>
  14960. When the scheme type is set to <c>FilePath</c>, the related scheme ID should be set to the full path to the executable
  14961. file that installs the assembly.
  14962. </remarks>
  14963. </member>
  14964. <member name="F:NAnt.Contrib.Tasks.SchemeType.Opaque">
  14965. <summary>
  14966. Specifies that custom information will be supplied to accommodate reference counting.
  14967. </summary>
  14968. <remarks>
  14969. When the scheme type is set to <c>Opaque</c>, the related scheme ID can be set to any custom piece of information.
  14970. </remarks>
  14971. </member>
  14972. <member name="T:NAnt.Contrib.Tasks.ScpTask">
  14973. <summary>
  14974. Copies a file to a remote server using scp.
  14975. </summary>
  14976. <remarks>
  14977. <para>Copies a file using scp to a remote server.</para>
  14978. <para>The Username Environment variable is used.</para>
  14979. </remarks>
  14980. <example>
  14981. <para>Copy a single file to a remote server and path.</para>
  14982. <code>
  14983. <![CDATA[
  14984. <scp file="myfile.zip" server="myServer" path="~" />
  14985. ]]>
  14986. </code>
  14987. </example>
  14988. </member>
  14989. <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramName">
  14990. <summary>
  14991. The program to execute. The default is "scp".
  14992. </summary>
  14993. </member>
  14994. <member name="P:NAnt.Contrib.Tasks.ScpTask.Options">
  14995. <summary>
  14996. The command line arguments.
  14997. </summary>
  14998. </member>
  14999. <member name="P:NAnt.Contrib.Tasks.ScpTask.FileName">
  15000. <summary>
  15001. The file to transfer.
  15002. </summary>
  15003. </member>
  15004. <member name="P:NAnt.Contrib.Tasks.ScpTask.ServerName">
  15005. <summary>
  15006. The server to send the file to.
  15007. </summary>
  15008. </member>
  15009. <member name="P:NAnt.Contrib.Tasks.ScpTask.RemotePath">
  15010. <summary>
  15011. The path on the remote server. The default is "~".
  15012. </summary>
  15013. </member>
  15014. <member name="P:NAnt.Contrib.Tasks.ScpTask.UserName">
  15015. <summary>
  15016. The username to connect as. The default is the value of the
  15017. <c>USERNAME</c> environment variable.
  15018. </summary>
  15019. </member>
  15020. <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramPathSep">
  15021. <summary>
  15022. The path separator used by the program. The default is "/".
  15023. </summary>
  15024. </member>
  15025. <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramFileName">
  15026. <summary>
  15027. Gets the filename of the external program to start.
  15028. </summary>
  15029. <value>
  15030. The filename of the external program.
  15031. </value>
  15032. </member>
  15033. <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramArguments">
  15034. <summary>
  15035. Gets the command-line arguments for the external program.
  15036. </summary>
  15037. <value>
  15038. The command-line arguments for the external program.
  15039. </value>
  15040. </member>
  15041. <member name="P:NAnt.Contrib.Tasks.ScpTask.BaseDirectory">
  15042. <summary>
  15043. The directory in which the command will be executed.
  15044. </summary>
  15045. </member>
  15046. <member name="T:NAnt.Contrib.Tasks.SlingshotTask">
  15047. <summary>
  15048. Converts a Visual Studio.NET Solution to a NAnt build file or nmake file.
  15049. </summary>
  15050. <example>
  15051. <para>
  15052. Convert the solution <c>MySolution.sln</c> to the NAnt build file
  15053. <c>MySolution.build</c> and call the new build file.
  15054. </para>
  15055. <code>
  15056. <![CDATA[
  15057. <slingshot solution="MySolution.sln" format="nant" output="MySolution.build">
  15058. <parameters>
  15059. <option name="build.basedir" value="..\bin"/>
  15060. </parameters>
  15061. </slingshot>
  15062. <nant buildfile="MySolution.build"/>
  15063. ]]>
  15064. </code>
  15065. </example>
  15066. <example>
  15067. <para>
  15068. Convert the solution <c>MySolution.sln</c> to the NAnt build file
  15069. <c>MySolution.build</c>. As the solution contains one or more web
  15070. projects, one or more maps needs to be specified.
  15071. </para>
  15072. <code>
  15073. <![CDATA[
  15074. <slingshot solution="MySolution.sln" format="nant" output="MySolution.build">
  15075. <parameters>
  15076. <option name="build.basedir" value="..\bin"/>
  15077. </parameters>
  15078. <maps>
  15079. <option name="http://localhost" value="C:\Inetpub\wwwroot"/>
  15080. </maps>
  15081. </slingshot>
  15082. ]]>
  15083. </code>
  15084. </example>
  15085. </member>
  15086. <member name="M:NAnt.Contrib.Tasks.SlingshotTask.CreateSolutionWriter(System.String)">
  15087. <summary>
  15088. Creates the <see cref="T:SLiNgshoT.Core.SolutionWriter"/> for the specified format.
  15089. </summary>
  15090. <returns>
  15091. The <see cref="T:SLiNgshoT.Core.SolutionWriter"/> for the specified format, or
  15092. <see langword="null"/> if an unknown format was specified.
  15093. </returns>
  15094. </member>
  15095. <member name="M:NAnt.Contrib.Tasks.SlingshotTask.OptionCollectionToHashtable(NAnt.Core.Types.OptionCollection,System.String)">
  15096. <summary>
  15097. Converts an <see cref="T:NAnt.Core.Types.OptionCollection"/> to a <see cref="T:System.Collections.Hashtable"/>.
  15098. </summary>
  15099. </member>
  15100. <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Solution">
  15101. <summary>
  15102. The Visual Studio.NET solution file to convert.
  15103. </summary>
  15104. </member>
  15105. <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Format">
  15106. <summary>
  15107. The output file format - either <c>nant</c> or <c>nmake</c>.
  15108. </summary>
  15109. </member>
  15110. <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Output">
  15111. <summary>
  15112. The output file name.
  15113. </summary>
  15114. </member>
  15115. <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Maps">
  15116. <summary>
  15117. Mappings from URI to directories. These are required for web projects.
  15118. </summary>
  15119. </member>
  15120. <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Parameters">
  15121. <summary>
  15122. Parameters to pass to SLiNgshoT. The parameter <c>build.basedir</c> is required.
  15123. </summary>
  15124. </member>
  15125. <member name="T:NAnt.Contrib.Tasks.SqlTask">
  15126. <summary>
  15127. A task to execute arbitrary SQL statements against a OLEDB data source.
  15128. </summary>
  15129. <remarks>
  15130. You can specify a set of sql statements inside the
  15131. sql element, or execute them from a text file that contains them. You can also
  15132. choose to execute the statements in a single batch, or execute them one by one
  15133. (even inside a transaction, if you want to).
  15134. </remarks>
  15135. <example>
  15136. <para>
  15137. Execute a set of statements inside a transaction.
  15138. </para>
  15139. <code>
  15140. <![CDATA[
  15141. <sql
  15142. connstring="Provider=SQLOLEDB;Data Source=localhost; Initial Catalog=Pruebas; Integrated Security=SSPI"
  15143. transaction="true"
  15144. delimiter=";"
  15145. delimstyle="Normal"
  15146. >
  15147. INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('My Job', 22, 45);
  15148. INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('Other Job', 09, 43);
  15149. SELECT * FROM jobs;
  15150. </sql>
  15151. ]]>
  15152. </code>
  15153. </example>
  15154. <example>
  15155. <para>
  15156. Execute a set of statements from a file and write all query results
  15157. to a file.
  15158. </para>
  15159. <code>
  15160. <![CDATA[
  15161. <sql
  15162. connstring="Provider=SQLOLEDB;Data Source=localhost; Initial Catalog=Pruebas; Integrated Security=SSPI"
  15163. transaction="true"
  15164. delimiter=";"
  15165. delimstyle="Normal"
  15166. print="true"
  15167. source="sql.txt"
  15168. output="${outputdir}/results.txt"
  15169. />
  15170. ]]>
  15171. </code>
  15172. </example>
  15173. <example>
  15174. <para>
  15175. Execute a SQL script generated by SQL Server Enterprise Manager.
  15176. </para>
  15177. <code>
  15178. <![CDATA[
  15179. <sql
  15180. connstring="Provider=SQLOLEDB;Data Source=localhost; Initial Catalog=Pruebas; Integrated Security=SSPI"
  15181. transaction="true"
  15182. delimiter="GO"
  15183. delimstyle="Line"
  15184. print="true"
  15185. source="pubs.xml"
  15186. batch="false"
  15187. output="${outputdir}/results.txt"
  15188. />
  15189. ]]>
  15190. </code>
  15191. </example>
  15192. </member>
  15193. <member name="M:NAnt.Contrib.Tasks.SqlTask.InitializeTask(System.Xml.XmlNode)">
  15194. <summary>
  15195. Initializes task and ensures the supplied attributes are valid.
  15196. </summary>
  15197. <param name="taskNode">XML node used to define this task instance.</param>
  15198. </member>
  15199. <member name="M:NAnt.Contrib.Tasks.SqlTask.ExecuteTask">
  15200. <summary>
  15201. This is where the work is done.
  15202. </summary>
  15203. </member>
  15204. <member name="M:NAnt.Contrib.Tasks.SqlTask.ExecuteStatements(NAnt.Contrib.Util.SqlHelper)">
  15205. <summary>
  15206. Executes the SQL Statements one by one.
  15207. </summary>
  15208. <param name="sqlHelper"></param>
  15209. </member>
  15210. <member name="M:NAnt.Contrib.Tasks.SqlTask.ExecuteStatementsInBatch(NAnt.Contrib.Util.SqlHelper)">
  15211. <summary>
  15212. Executes the SQL statements in a single batch.
  15213. </summary>
  15214. <param name="sqlHelper"></param>
  15215. </member>
  15216. <member name="M:NAnt.Contrib.Tasks.SqlTask.ProcessResults(System.Data.IDataReader,System.IO.TextWriter)">
  15217. <summary>
  15218. Process a result set.
  15219. </summary>
  15220. <param name="results">Result set.</param>
  15221. <param name="writer"><see cref="T:System.IO.TextWriter"/> to write output to.</param>
  15222. </member>
  15223. <member name="P:NAnt.Contrib.Tasks.SqlTask.ConnectionString">
  15224. <summary>
  15225. Connection string used to access database.
  15226. This should be an OleDB connection string.
  15227. </summary>
  15228. </member>
  15229. <member name="P:NAnt.Contrib.Tasks.SqlTask.Encoding">
  15230. <summary>
  15231. The encoding of the files containing SQL statements. The default is
  15232. the system's current ANSI code page.
  15233. </summary>
  15234. </member>
  15235. <member name="P:NAnt.Contrib.Tasks.SqlTask.Source">
  15236. <summary>
  15237. File where the sql statements are defined.
  15238. </summary>
  15239. <remarks>
  15240. You cannot specify both a source and an inline set of statements.
  15241. </remarks>
  15242. </member>
  15243. <member name="P:NAnt.Contrib.Tasks.SqlTask.Delimiter">
  15244. <summary>
  15245. String that separates statements from one another.
  15246. </summary>
  15247. </member>
  15248. <member name="P:NAnt.Contrib.Tasks.SqlTask.Batch">
  15249. <summary>
  15250. If true, the statements will be executed as a single batch.
  15251. If false, they will be executed one by one. Default is true.
  15252. </summary>
  15253. </member>
  15254. <member name="P:NAnt.Contrib.Tasks.SqlTask.ExpandProperties">
  15255. <summary>
  15256. If true, the any nant-style properties on the sql will be
  15257. expanded before execution. Default is true.
  15258. </summary>
  15259. </member>
  15260. <member name="P:NAnt.Contrib.Tasks.SqlTask.CommandTimeout">
  15261. <summary>
  15262. Command timeout to use when creating commands.
  15263. </summary>
  15264. </member>
  15265. <member name="P:NAnt.Contrib.Tasks.SqlTask.DelimiterStyle">
  15266. <summary>
  15267. Kind of delimiter used. Allowed values are Normal or Line.
  15268. </summary>
  15269. <remarks>
  15270. Delimiters can be of two kinds: Normal delimiters are
  15271. always specified inline, so they permit having two
  15272. different statements in the same line. Line delimiters,
  15273. however, need to be in a line by their own.
  15274. Default is Normal.
  15275. </remarks>
  15276. </member>
  15277. <member name="P:NAnt.Contrib.Tasks.SqlTask.Print">
  15278. <summary>
  15279. If set to true, results from the statements will be
  15280. output to the build log.
  15281. </summary>
  15282. </member>
  15283. <member name="P:NAnt.Contrib.Tasks.SqlTask.Output">
  15284. <summary>
  15285. If set, the results from the statements will be output to the
  15286. specified file.
  15287. </summary>
  15288. </member>
  15289. <member name="P:NAnt.Contrib.Tasks.SqlTask.UseTransaction">
  15290. <summary>
  15291. If set to <see langword="true" />, all statements will be executed
  15292. within a single transaction. The default is <see langword="true" />.
  15293. </summary>
  15294. </member>
  15295. <member name="P:NAnt.Contrib.Tasks.SqlTask.Append">
  15296. <summary>
  15297. Whether output should be appended to or overwrite
  15298. an existing file. The default is <see langword="false" />.
  15299. </summary>
  15300. </member>
  15301. <member name="P:NAnt.Contrib.Tasks.SqlTask.ShowHeaders">
  15302. <summary>
  15303. If set to <see langword="true" />, prints headers for result sets.
  15304. The default is <see langword="true" />.
  15305. </summary>
  15306. </member>
  15307. <member name="P:NAnt.Contrib.Tasks.SqlTask.QuoteChar">
  15308. <summary>
  15309. The character(s) to surround result columns with when printing, the
  15310. default is an empty string.
  15311. </summary>
  15312. </member>
  15313. <member name="P:NAnt.Contrib.Tasks.SqlTask.OutputWriter">
  15314. <summary>
  15315. Gets the underlying <see cref="T:System.IO.TextWriter"/> to which output will
  15316. be written if <see cref="P:NAnt.Contrib.Tasks.SqlTask.Output"/> is set.
  15317. </summary>
  15318. <value>
  15319. A <see cref="T:System.IO.TextWriter"/> for the file specified in <see cref="P:NAnt.Contrib.Tasks.SqlTask.Output"/>,
  15320. or <see langword="null"/> if <see cref="P:NAnt.Contrib.Tasks.SqlTask.Output"/> is not set.
  15321. </value>
  15322. </member>
  15323. <member name="T:NAnt.Contrib.Tasks.TryCatchTask">
  15324. <summary>
  15325. Executes a set of tasks, and optionally catches a build exception to
  15326. allow recovery or rollback steps to be taken, or to define some steps
  15327. to be taken regardless if the tasks succeed or fail, or both.
  15328. </summary>
  15329. <remarks>
  15330. <para>
  15331. The tasks defined in the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>&gt;</c> block
  15332. will be executed in turn, as they normally would in a target.
  15333. </para>
  15334. <para>
  15335. If a <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>&gt;</c> block is defined, the
  15336. tasks in that block will be executed in turn only if one of the tasks
  15337. in the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>&gt;</c> block fails. This
  15338. failure will then be suppressed by the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>&gt;</c>
  15339. block.
  15340. </para>
  15341. <para>
  15342. The message associated with the failure can also be caught in a
  15343. property for use within the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>&gt;</c>
  15344. block. The original contents of the property will be restored upon
  15345. exiting the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>&gt;</c> block.
  15346. </para>
  15347. <para>
  15348. If a <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>&gt;</c> block is defined, the
  15349. tasks in that block will be executed after the tasks in both the
  15350. <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>&gt;</c> and <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>&gt;</c>
  15351. blocks have been executed, regardless of whether any task fails in
  15352. either block.
  15353. </para>
  15354. </remarks>
  15355. <example>
  15356. <code>
  15357. <![CDATA[
  15358. <trycatch>
  15359. <try>
  15360. <echo message="In try" />
  15361. <fail message="Failing!" />
  15362. </try>
  15363. <catch>
  15364. <echo message="In catch" />
  15365. </catch>
  15366. <finally>
  15367. <echo message="Finally done" />
  15368. </finally>
  15369. </trycatch>
  15370. ]]>
  15371. </code>
  15372. <para>
  15373. The output of this example will be:
  15374. </para>
  15375. <code>
  15376. In try
  15377. In catch
  15378. Finally done
  15379. </code>
  15380. <para>
  15381. The failure in the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>&gt;</c> block will
  15382. not cause the build to fail.
  15383. </para>
  15384. </example>
  15385. <example>
  15386. <code>
  15387. <![CDATA[
  15388. <trycatch>
  15389. <try>
  15390. <echo message="In try" />
  15391. <fail message="Just because..." />
  15392. </try>
  15393. <catch property="failure">
  15394. <echo message="Caught failure: ${failure}" />
  15395. <fail message="Bad catch" />
  15396. </catch>
  15397. <finally>
  15398. <echo message="Finally done" />
  15399. </finally>
  15400. </trycatch>
  15401. ]]>
  15402. </code>
  15403. <para>
  15404. The output of this example will be:
  15405. </para>
  15406. <code>
  15407. In try
  15408. Caught failure: Just because...
  15409. Finally done
  15410. Build failed: Bad catch
  15411. </code>
  15412. <para>
  15413. Like the above, the failure in the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>&gt;</c>
  15414. block does not cause the build to fail. The failure in the
  15415. <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>&gt;</c> block does, however.
  15416. Note that the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>&gt;</c> block is
  15417. executed even though the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>&gt;</c>
  15418. block failed.
  15419. </para>
  15420. </example>
  15421. <example>
  15422. <code>
  15423. <![CDATA[
  15424. <trycatch>
  15425. <try>
  15426. <echo message="In try" />
  15427. <fail message="yet again" />
  15428. </try>
  15429. <catch property="failure">
  15430. <echo message="Caught failure ${failure}" />
  15431. <fail message="Bad catch" />
  15432. </catch>
  15433. <finally>
  15434. <echo message="Finally done ${failure}" />
  15435. </finally>
  15436. </trycatch>
  15437. ]]>
  15438. </code>
  15439. <para>
  15440. The output of this example will be:
  15441. </para>
  15442. <code>
  15443. In try
  15444. Caught failure yet again
  15445. Build failed: Property 'failure' has not been set.
  15446. </code>
  15447. <para>
  15448. The <see cref="T:NAnt.Core.Tasks.EchoTask"/> in the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>&gt;</c>
  15449. block failed because the "failure" property was not defined
  15450. after exiting the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>&gt;</c> block.
  15451. Note that the failure in the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>&gt;</c>
  15452. block has eclipsed the failure in the <c>&lt;<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>&gt;</c>
  15453. block.
  15454. </para>
  15455. </example>
  15456. <example>
  15457. <code>
  15458. <![CDATA[
  15459. <trycatch>
  15460. <try>
  15461. <property name="temp.file" value="${path::get-temp-file-name()}" />
  15462. <do-stuff to="${temp.file}" />
  15463. <fail message="Oops..." />
  15464. </try>
  15465. <finally>
  15466. <echo message="Cleaning up..." />
  15467. <if test="${property::exists('temp.file')}">
  15468. <delete file="${temp.file}" />
  15469. </if>
  15470. </finally>
  15471. </trycatch>
  15472. ]]>
  15473. </code>
  15474. <para>
  15475. A more concrete example, that will always clean up the generated
  15476. temporary file after it has been created.
  15477. </para>
  15478. </example>
  15479. </member>
  15480. <member name="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock">
  15481. <summary>
  15482. The tasks in this block will be executed as a normal part of
  15483. the build script.
  15484. </summary>
  15485. </member>
  15486. <member name="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock">
  15487. <summary>
  15488. The tasks in this block will be executed if any task in the try
  15489. block fails.
  15490. </summary>
  15491. </member>
  15492. <member name="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock">
  15493. <summary>
  15494. The tasks in this block will always be executed, regardless of
  15495. what happens in the try and catch blocks.
  15496. </summary>
  15497. <remarks>
  15498. Note that any failure in any of the tasks in this block will
  15499. prevent any subsequent tasks from executing.
  15500. </remarks>
  15501. </member>
  15502. <member name="P:NAnt.Contrib.Tasks.TryCatchTask.CatchElement.Property">
  15503. <summary>
  15504. Defines the name of the property to save the message describing
  15505. the failure that has been caught.
  15506. </summary>
  15507. <remarks>
  15508. <para>
  15509. The failure message is only available in the context of the catch
  15510. block. If you wish to preserve the message, you will need to save
  15511. it into another property.
  15512. </para>
  15513. <para>
  15514. Readonly properties cannot be overridden by this mechanism.
  15515. </para>
  15516. </remarks>
  15517. </member>
  15518. <member name="T:NAnt.Contrib.Tasks.TypedCollectionTask">
  15519. <summary>Generates collection classes based on a given XML specification file. Code generation is in the specified language.</summary>
  15520. <remarks>
  15521. <para>See the <a href="http://www.sellsbrothers.com/tools/">CollectionGen tool page</a> for more information.</para>
  15522. </remarks>
  15523. <example>
  15524. <code>
  15525. <![CDATA[
  15526. <typedcollection language="CSharp">
  15527. <fileset>
  15528. <include name="collections.xml" />
  15529. </fileset>
  15530. </typedcollection>
  15531. ]]>
  15532. </code>
  15533. </example>
  15534. </member>
  15535. <member name="M:NAnt.Contrib.Tasks.TypedCollectionTask.GenerateCollectionClasses(System.String,System.String)">
  15536. <summary>
  15537. The actual generation work is done here.
  15538. </summary>
  15539. <param name="path"></param>
  15540. <param name="language"></param>
  15541. </member>
  15542. <member name="P:NAnt.Contrib.Tasks.TypedCollectionTask.Language">
  15543. <summary>The language to generate collection classes for. Valid values are "CSharp" or "VB".</summary>
  15544. </member>
  15545. <member name="P:NAnt.Contrib.Tasks.TypedCollectionTask.FileName">
  15546. <summary>The name of the template file for collection generation. This is provided as an alternate to using the task's fileset.</summary>
  15547. </member>
  15548. <member name="P:NAnt.Contrib.Tasks.TypedCollectionTask.TypedCollFileSet">
  15549. <summary>
  15550. All files in this fileset will be run thru the collection generator.
  15551. </summary>
  15552. </member>
  15553. <member name="T:NAnt.Contrib.Tasks.ValidateXmlTask">
  15554. <summary>
  15555. Validates a set of XML files based on a set of XML Schemas (XSD).
  15556. </summary>
  15557. <example>
  15558. <code>
  15559. <![CDATA[
  15560. <validatexml>
  15561. <schemas>
  15562. <schema source="rcf-schema.xsd" />
  15563. <schema namespace="urn:schemas-company-com:base" source="base-schema.xsd" />
  15564. </schemas>
  15565. <files>
  15566. <include name="*.xml" />
  15567. </files>
  15568. </validatexml>
  15569. ]]>
  15570. </code>
  15571. </example>
  15572. </member>
  15573. <member name="M:NAnt.Contrib.Tasks.ValidateXmlTask.ExecuteTask">
  15574. <summary>
  15575. This is where the work is done.
  15576. </summary>
  15577. </member>
  15578. <member name="P:NAnt.Contrib.Tasks.ValidateXmlTask.XmlFiles">
  15579. <summary>
  15580. The XML files that must be validated.
  15581. </summary>
  15582. </member>
  15583. <member name="P:NAnt.Contrib.Tasks.ValidateXmlTask.Schemas">
  15584. <summary>
  15585. The XML Schemas (XSD) to use for validation.
  15586. </summary>
  15587. </member>
  15588. <member name="T:NAnt.Contrib.Tasks.Vb6Task">
  15589. <summary>
  15590. Compiles Microsoft Visual Basic 6 programs.
  15591. </summary>
  15592. <remarks>
  15593. <para>
  15594. Uses the VB6.EXE executable included with the Visual Basic 6
  15595. environment.
  15596. </para>
  15597. <para>
  15598. The compiler uses the settings and source files specified in the
  15599. project or group file.
  15600. </para>
  15601. </remarks>
  15602. <example>
  15603. <para>
  15604. Build the project <c>HelloWorld.vbp</c> in the <c>build</c> directory.
  15605. </para>
  15606. <code>
  15607. <![CDATA[
  15608. <vb6 project="HelloWorld.vbp" outdir="build" />
  15609. ]]>
  15610. </code>
  15611. </example>
  15612. </member>
  15613. <member name="M:NAnt.Contrib.Tasks.Vb6Task.ExecuteTask">
  15614. <summary>
  15615. Compiles the Visual Basic project or project group.
  15616. </summary>
  15617. </member>
  15618. <member name="M:NAnt.Contrib.Tasks.Vb6Task.ParseGroupFile(System.IO.FileInfo)">
  15619. <summary>
  15620. Parses a VB group file and extract the file names of the sub-projects
  15621. in the group.
  15622. </summary>
  15623. <param name="groupFile">The file name of the group file.</param>
  15624. <returns>
  15625. A string collection containing the list of sub-projects in the group.
  15626. </returns>
  15627. </member>
  15628. <member name="M:NAnt.Contrib.Tasks.Vb6Task.ProjectNeedsCompiling(System.String)">
  15629. <summary>
  15630. Determines if a VB project needs to be recompiled by comparing the timestamp of
  15631. the project's files and references to the timestamp of the last built version.
  15632. </summary>
  15633. <param name="projectFile">The file name of the project file.</param>
  15634. <returns>
  15635. <see langword="true" /> if the project should be compiled; otherwise,
  15636. <see langword="false" />.
  15637. </returns>
  15638. </member>
  15639. <member name="M:NAnt.Contrib.Tasks.Vb6Task.VB6GetTypeLibFile(System.Guid,System.UInt16,System.UInt16,System.UInt32)">
  15640. <summary>
  15641. VB6 uses a special algorithm to search for the typelib file. It doesn't
  15642. rely on the API function QueryPathOfRegTypeLib, because VB could use a newer
  15643. version of the TLB.
  15644. The algorithm used by VB is not perfect and has some flaws, which you could
  15645. get a newer version even if your requested version is installed. This is because
  15646. the algorithm iterates the registry beneath the Guid - entry by entry - from the
  15647. beginning and returns the first TLB version that is higher or equal to the
  15648. requested version.
  15649. pseudo code:
  15650. 1. open the key HKEY_CLASSES_ROOT\TypeLib\{Guid}
  15651. 2. If the key exists:
  15652. 3. Foreach version under the key that has the requested culture entry:
  15653. 4. If the version higher or equal to the requested version:
  15654. 5. Get the TLB filename and returns it
  15655. </summary>
  15656. <param name="guid">The guid of the tlb to look for</param>
  15657. <param name="major">The major version number of the tlb</param>
  15658. <param name="minor16">The minor version number of the tlb. If you parse minor from a string, treat the string as hex value.</param>
  15659. <param name="lcid">The culture id</param>
  15660. <returns>null if couldn't find a match, otherwise it returns the file.</returns>
  15661. </member>
  15662. <member name="M:NAnt.Contrib.Tasks.Vb6Task.ParseProjectFile(System.String,NAnt.Core.Types.FileSet,NAnt.Core.Types.FileSet)">
  15663. <summary>
  15664. Parses a VB project file and extracts the source files, reference files, and
  15665. the name of the compiled file for the project.
  15666. </summary>
  15667. <param name="projectFile">The filename of the project file.</param>
  15668. <param name="sources">
  15669. A fileset representing the source files of the project, which will
  15670. populated by the method.
  15671. </param>
  15672. <param name="references">
  15673. A fileset representing the references of the project, which will
  15674. populated by the method.
  15675. </param>
  15676. <returns>A string containing the output file name for the project.</returns>
  15677. </member>
  15678. <member name="P:NAnt.Contrib.Tasks.Vb6Task.OutDir">
  15679. <summary>
  15680. Output directory for the compilation target.
  15681. </summary>
  15682. </member>
  15683. <member name="P:NAnt.Contrib.Tasks.Vb6Task.ProjectFile">
  15684. <summary>
  15685. Visual Basic project or group file.
  15686. </summary>
  15687. </member>
  15688. <member name="P:NAnt.Contrib.Tasks.Vb6Task.CheckReferences">
  15689. <summary>
  15690. Determines whether project references are checked when deciding
  15691. whether the project needs to be recompiled. The default is
  15692. <see langword="true" />.
  15693. </summary>
  15694. </member>
  15695. <member name="P:NAnt.Contrib.Tasks.Vb6Task.ErrorFile">
  15696. <summary>
  15697. The file to which the Visual Basic compiler should log errors.
  15698. </summary>
  15699. </member>
  15700. <member name="P:NAnt.Contrib.Tasks.Vb6Task.Conditionals">
  15701. <summary>
  15702. Tells Visual Basic which values to use for conditional compilation
  15703. constants.
  15704. </summary>
  15705. </member>
  15706. <member name="P:NAnt.Contrib.Tasks.Vb6Task.ProgramFileName">
  15707. <summary>
  15708. Gets the filename of the external program to start.
  15709. </summary>
  15710. <value>
  15711. The filename of the external program.
  15712. </value>
  15713. </member>
  15714. <member name="P:NAnt.Contrib.Tasks.Vb6Task.ProgramArguments">
  15715. <summary>
  15716. Gets the command-line arguments for the external program.
  15717. </summary>
  15718. <value>
  15719. The command-line arguments for the external program.
  15720. </value>
  15721. </member>
  15722. <member name="T:NAnt.Contrib.Tasks.VersionTask">
  15723. <summary>
  15724. Increments a four-part version number stored in a text file. The resulting
  15725. version number is written back to the file and exposed using NAnt properties.
  15726. </summary>
  15727. <remarks>
  15728. <para>
  15729. The version number format in the text file is
  15730. Major.Minor.Build.Revision, e.g. 1.0.5.25.
  15731. </para>
  15732. <list type="table">
  15733. <item>
  15734. <term>Major</term>
  15735. <description>Set in file.</description>
  15736. </item>
  15737. <item>
  15738. <term>Minor</term>
  15739. <description>Set in file.</description>
  15740. </item>
  15741. <item>
  15742. <term>Build</term>
  15743. <description>Can be incremented by setting the <see cref="P:NAnt.Contrib.Tasks.VersionTask.BuildType"/> parameter.</description>
  15744. </item>
  15745. <item>
  15746. <term>Revision</term>
  15747. <description>Can be incremented by setting the <see cref="P:NAnt.Contrib.Tasks.VersionTask.RevisionType"/> parameter.</description>
  15748. </item>
  15749. </list>
  15750. <para>The following NAnt properties are created:</para>
  15751. <list type="table">
  15752. <item>
  15753. <term><c>prefix</c>.version</term>
  15754. <description>The complete version number, i.e. Major.Minor.Build.Revision</description>
  15755. </item>
  15756. <item>
  15757. <term><c>prefix</c>.major</term>
  15758. <description>The major component of the version number.</description>
  15759. </item>
  15760. <item>
  15761. <term><c>prefix</c>.minor</term>
  15762. <description>The minor component of the version number.</description>
  15763. </item>
  15764. <item>
  15765. <term><c>prefix</c>.build</term>
  15766. <description>The build component of the version number.</description>
  15767. </item>
  15768. <item>
  15769. <term><c>prefix</c>.revision</term>
  15770. <description>The revision component of the version number.</description>
  15771. </item>
  15772. </list>
  15773. </remarks>
  15774. </member>
  15775. <member name="M:NAnt.Contrib.Tasks.VersionTask.ReadVersionFromFile">
  15776. <summary>
  15777. Reads a version string from <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/> and returns it as a
  15778. <see cref="T:System.Version"/> instance.
  15779. </summary>
  15780. <returns>
  15781. A <see cref="T:System.Version"/> instance representing the version string in
  15782. <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/>.
  15783. </returns>
  15784. </member>
  15785. <member name="M:NAnt.Contrib.Tasks.VersionTask.WriteVersionToFile(System.Version)">
  15786. <summary>
  15787. Writes the specified version to <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/>.
  15788. </summary>
  15789. <param name="version">The version to write to <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/>.</param>
  15790. </member>
  15791. <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateMonthDayBuildNumber">
  15792. <summary>
  15793. Calculates the build number based on the number of months since the
  15794. start date.
  15795. </summary>
  15796. <returns>
  15797. The build number based on the number of months since the start date.
  15798. </returns>
  15799. </member>
  15800. <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateSecondsSinceMidnight">
  15801. <summary>
  15802. Calculates the number of seconds since midnight.
  15803. start date.
  15804. </summary>
  15805. <returns>
  15806. The number of seconds since midnight.
  15807. </returns>
  15808. </member>
  15809. <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateBuildNumber(System.Int32)">
  15810. <summary>
  15811. Calculates the build number of the version number based on
  15812. <see cref="P:NAnt.Contrib.Tasks.VersionTask.BuildType"/>.
  15813. </summary>
  15814. <returns>
  15815. The build number.
  15816. </returns>
  15817. </member>
  15818. <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateVersion">
  15819. <summary>
  15820. Calculates the complete version.
  15821. </summary>
  15822. <returns>
  15823. The version.
  15824. </returns>
  15825. </member>
  15826. <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateRevisionNumber(System.Version,System.Int32)">
  15827. <summary>
  15828. Calculates the revision number of the version number based on RevisionType specified
  15829. </summary>
  15830. <returns>
  15831. The revision number.
  15832. </returns>
  15833. </member>
  15834. <member name="P:NAnt.Contrib.Tasks.VersionTask.Prefix">
  15835. <summary>
  15836. The string to prefix the properties with. The default is
  15837. <c>'buildnumber.'</c>.
  15838. </summary>
  15839. </member>
  15840. <member name="P:NAnt.Contrib.Tasks.VersionTask.StartDate">
  15841. <summary>
  15842. Start of project. Date from which to calculate build number.
  15843. Required if <see cref="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.MonthDay"/> is used as
  15844. <see cref="P:NAnt.Contrib.Tasks.VersionTask.BuildType"/>.
  15845. </summary>
  15846. </member>
  15847. <member name="P:NAnt.Contrib.Tasks.VersionTask.Path">
  15848. <summary>
  15849. Path to the file containing the current version number. The default
  15850. file is <c>'build.number'</c> in the project base directory.
  15851. </summary>
  15852. </member>
  15853. <member name="P:NAnt.Contrib.Tasks.VersionTask.BuildType">
  15854. <summary>
  15855. The algorithm for generating build number. The default is
  15856. <see cref="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.MonthDay"/>.
  15857. </summary>
  15858. </member>
  15859. <member name="P:NAnt.Contrib.Tasks.VersionTask.RevisionType">
  15860. <summary>
  15861. The algorithm for generating revision number. The default is
  15862. <see cref="F:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm.Automatic"/>.
  15863. </summary>
  15864. </member>
  15865. <member name="T:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm">
  15866. <summary>
  15867. Defines possible algorithms to generate the build number.
  15868. </summary>
  15869. </member>
  15870. <member name="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.MonthDay">
  15871. <summary>
  15872. Use the number of months since start of project * 100 + current
  15873. day in month as build number.
  15874. </summary>
  15875. </member>
  15876. <member name="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.Increment">
  15877. <summary>
  15878. Increment an existing build number.
  15879. </summary>
  15880. </member>
  15881. <member name="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.NoIncrement">
  15882. <summary>
  15883. Use an existing build number (and do not increment it).
  15884. </summary>
  15885. </member>
  15886. <member name="T:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm">
  15887. <summary>
  15888. Defines possible algorithms to generate the revision number.
  15889. </summary>
  15890. </member>
  15891. <member name="F:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm.Automatic">
  15892. <summary>
  15893. Use the number of seconds since the start of today / 10.
  15894. </summary>
  15895. </member>
  15896. <member name="F:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm.Increment">
  15897. <summary>
  15898. Increment an existing revision number.
  15899. </summary>
  15900. </member>
  15901. <member name="T:NAnt.Contrib.Tasks.WsdlTask">
  15902. <summary>Generates code for web service clients and xml web services
  15903. using ASP.NET from WSDL contract files, XSD Schemas and .discomap
  15904. discovery documents. Can be used in conjunction with .disco files.</summary>
  15905. <example>
  15906. <para>Generate a proxy class for a web service.</para>
  15907. <code><![CDATA[<wsdl path="http://www.somewhere.com/myservice.wsdl"
  15908. language="CS" namespace="MyCompany.MyService" outfile="MyService.cs" />]]></code>
  15909. </example>
  15910. </member>
  15911. <member name="P:NAnt.Contrib.Tasks.WsdlTask.Path">
  15912. <summary>URL or Path to a WSDL, XSD, or .discomap document.</summary>
  15913. </member>
  15914. <member name="P:NAnt.Contrib.Tasks.WsdlTask.NoLogo">
  15915. <summary>Suppresses the banner.</summary>
  15916. </member>
  15917. <member name="P:NAnt.Contrib.Tasks.WsdlTask.Language">
  15918. <summary>Language of generated code. 'CS', 'VB', 'JS',
  15919. or the fully-qualified name of a class implementing
  15920. System.CodeDom.Compiler.CodeDomCompiler. </summary>
  15921. </member>
  15922. <member name="P:NAnt.Contrib.Tasks.WsdlTask.ForServer">
  15923. <summary>Compiles server-side ASP.NET abstract classes
  15924. based on the web service contract. The default is to
  15925. create client side proxy classes. </summary>
  15926. </member>
  15927. <member name="P:NAnt.Contrib.Tasks.WsdlTask.Namespace">
  15928. <summary>Microsoft.NET namespace of generated classes.</summary>
  15929. </member>
  15930. <member name="P:NAnt.Contrib.Tasks.WsdlTask.OutFile">
  15931. <summary>Output filename of the created proxy. Default name is derived from the service name.</summary>
  15932. </member>
  15933. <member name="P:NAnt.Contrib.Tasks.WsdlTask.Protocol">
  15934. <summary>Override default protocol to implement. Choose from 'SOAP',
  15935. 'HttpGet', 'HttpPost', or a custom protocol as specified in the
  15936. configuration file.</summary>
  15937. </member>
  15938. <member name="P:NAnt.Contrib.Tasks.WsdlTask.Username">
  15939. <summary>Username of an account with credentials to access a
  15940. server that requires authentication.</summary>
  15941. </member>
  15942. <member name="P:NAnt.Contrib.Tasks.WsdlTask.Password">
  15943. <summary>Password of an account with credentials to access a
  15944. server that requires authentication.</summary>
  15945. </member>
  15946. <member name="P:NAnt.Contrib.Tasks.WsdlTask.Domain">
  15947. <summary>Domain of an account with credentials to access a
  15948. server that requires authentication.</summary>
  15949. </member>
  15950. <member name="P:NAnt.Contrib.Tasks.WsdlTask.Proxy">
  15951. <summary>URL of a proxy server to use for HTTP requests.
  15952. The default is to use the system proxy setting.</summary>
  15953. </member>
  15954. <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProxyUsername">
  15955. <summary>Username of an account with credentials to access a
  15956. proxy that requires authentication.</summary>
  15957. </member>
  15958. <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProxyPassword">
  15959. <summary>Password of an account with credentials to access a
  15960. proxy that requires authentication.</summary>
  15961. </member>
  15962. <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProxyDomain">
  15963. <summary>Domain of an account with credentials to access a
  15964. proxy that requires authentication.</summary>
  15965. </member>
  15966. <member name="P:NAnt.Contrib.Tasks.WsdlTask.UrlKey">
  15967. <summary>Configuration key to use in the code generation to
  15968. read the default value for the Url property. The default is
  15969. not to read from the config file.</summary>
  15970. </member>
  15971. <member name="P:NAnt.Contrib.Tasks.WsdlTask.BaseUrl">
  15972. <summary>Base Url to use when calculating the Url fragment.
  15973. The UrlKey attribute must also be specified. </summary>
  15974. </member>
  15975. <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProgramArguments">
  15976. <summary>
  15977. Gets the command-line arguments for the external program.
  15978. </summary>
  15979. <value>
  15980. The command-line arguments for the external program.
  15981. </value>
  15982. </member>
  15983. <member name="T:NAnt.Contrib.Tasks.XsdTask">
  15984. <summary>
  15985. The <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> generates XML schema or common language runtime
  15986. classes from XDR, XML, and XSD files, or from classes in a runtime assembly.
  15987. </summary>
  15988. <remarks>
  15989. <para>
  15990. The following operations can be performed :
  15991. </para>
  15992. <list type="table">
  15993. <listheader>
  15994. <term>Operation</term>
  15995. <description>Description</description>
  15996. </listheader>
  15997. <item>
  15998. <term>XDR to XSD</term>
  15999. <description>
  16000. Generates an XML schema from an XML-Data-Reduced schema file.
  16001. XDR is an early XML-based schema format.
  16002. </description>
  16003. </item>
  16004. <item>
  16005. <term>XML to XSD</term>
  16006. <description>
  16007. Generates an XML schema from an XML file.
  16008. </description>
  16009. </item>
  16010. <item>
  16011. <term>XSD to DataSet</term>
  16012. <description>
  16013. Generates common language runtime <see cref="T:System.Data.DataSet"/>
  16014. classes from an XSD schema file. The generated classes
  16015. provide a rich object model for regular XML data.
  16016. </description>
  16017. </item>
  16018. <item>
  16019. <term>XSD to Classes</term>
  16020. <description>
  16021. Generates runtime classes from an XSD schema file. The
  16022. generated classes can be used in conjunction with
  16023. <see cref="T:System.Xml.Serialization.XmlSerializer"/> to
  16024. read and write XML code that follows the schema.
  16025. </description>
  16026. </item>
  16027. <item>
  16028. <term>Classes to XSD</term>
  16029. <description>
  16030. Generates an XML schema from a type or types in a runtime
  16031. assembly file. The generated schema defines the XML format
  16032. used by <see cref="T:System.Xml.Serialization.XmlSerializer"/>.
  16033. </description>
  16034. </item>
  16035. </list>
  16036. </remarks>
  16037. <example>
  16038. <para>Compile a XML Schema.</para>
  16039. <code>
  16040. <![CDATA[
  16041. <xsd
  16042. schema="MySchema.xsd"
  16043. element="MyRootElement"
  16044. language="CS"
  16045. namespace="MyCompany.MySchema"
  16046. outputdir="build\bin"
  16047. uri="http://MySchema'sTargetNamespace" />
  16048. ]]>
  16049. </code>
  16050. </example>
  16051. <example>
  16052. <para>Generate an XML Schema from an assembly.</para>
  16053. <code>
  16054. <![CDATA[
  16055. <xsd assembly="MyAssembly.dll" outputdir="build\Schemas" />
  16056. ]]>
  16057. </code>
  16058. </example>
  16059. <example>
  16060. <para>Generate an XML Schema from an XML document.</para>
  16061. <code>
  16062. <![CDATA[
  16063. <xsd xmldoc="MyDoc.xml" outputdir="build\Schemas" />
  16064. ]]>
  16065. </code>
  16066. </example>
  16067. <example>
  16068. <para>Generate an XML Schema from an XDR Schema.</para>
  16069. <code>
  16070. <![CDATA[
  16071. <xsd xdr="MyOldSchema.xdr" outputdir="build\Schemas" />
  16072. ]]>
  16073. </code>
  16074. </example>
  16075. </member>
  16076. <member name="M:NAnt.Contrib.Tasks.XsdTask.InitializeTask(System.Xml.XmlNode)">
  16077. <summary>
  16078. Validates the <see cref="T:NAnt.Core.Task"/>.
  16079. </summary>
  16080. <param name="taskNode">The <see cref="T:System.Xml.XmlNode"/> used to initialize the <see cref="T:NAnt.Core.Task"/>.</param>
  16081. </member>
  16082. <member name="P:NAnt.Contrib.Tasks.XsdTask.Schema">
  16083. <summary>
  16084. XML Schema (.xsd) filename.
  16085. </summary>
  16086. </member>
  16087. <member name="P:NAnt.Contrib.Tasks.XsdTask.Target">
  16088. <summary>
  16089. Target of XML Schema compilation - either <c>classes</c> or
  16090. <c>dataset</c>. The default is <c>classes</c>.
  16091. </summary>
  16092. </member>
  16093. <member name="P:NAnt.Contrib.Tasks.XsdTask.Element">
  16094. <summary>
  16095. XML element in the Schema to process.
  16096. </summary>
  16097. <remarks>
  16098. TO-DO : turn this into collection of elements !
  16099. </remarks>
  16100. </member>
  16101. <member name="P:NAnt.Contrib.Tasks.XsdTask.Language">
  16102. <summary>
  16103. The language to use for the generated code - either <c>CS</c>,
  16104. <c>VB</c>, <c>JS</c>, <c>VJC</c> or the fully-qualified name of a
  16105. class implementing <see cref="T:System.CodeDom.Compiler.CodeDomProvider"/>.
  16106. </summary>
  16107. </member>
  16108. <member name="P:NAnt.Contrib.Tasks.XsdTask.Namespace">
  16109. <summary>
  16110. Specifies the runtime namespace for the generated types. The default
  16111. namespace is <c>Schemas</c>.
  16112. </summary>
  16113. </member>
  16114. <member name="P:NAnt.Contrib.Tasks.XsdTask.OutputDir">
  16115. <summary>
  16116. The output directory in which to place generated files.
  16117. </summary>
  16118. </member>
  16119. <member name="P:NAnt.Contrib.Tasks.XsdTask.Assembly">
  16120. <summary>
  16121. Assembly (.dll or .exe) to generate an XML Schema for.
  16122. </summary>
  16123. </member>
  16124. <member name="P:NAnt.Contrib.Tasks.XsdTask.Types">
  16125. <summary>
  16126. Types in the assembly for which an XML schema is being created.
  16127. By default all types in the assembly will be included.
  16128. </summary>
  16129. <remarks>
  16130. TO-DO : turn this into collection of types !
  16131. </remarks>
  16132. </member>
  16133. <member name="P:NAnt.Contrib.Tasks.XsdTask.Uri">
  16134. <summary>
  16135. Specifies the URI for the elements in the <see cref="P:NAnt.Contrib.Tasks.XsdTask.Schema"/> to
  16136. generate code for.
  16137. </summary>
  16138. </member>
  16139. <member name="P:NAnt.Contrib.Tasks.XsdTask.XmlDoc">
  16140. <summary>
  16141. XML document to generate an XML Schema for.
  16142. </summary>
  16143. </member>
  16144. <member name="P:NAnt.Contrib.Tasks.XsdTask.Xdr">
  16145. <summary>
  16146. XDR Schema to generate an XML Schema for.
  16147. </summary>
  16148. </member>
  16149. <member name="P:NAnt.Contrib.Tasks.XsdTask.ProgramArguments">
  16150. <summary>
  16151. Gets the command-line arguments for the external program.
  16152. </summary>
  16153. <value>
  16154. The command-line arguments for the external program.
  16155. </value>
  16156. </member>
  16157. <member name="T:NAnt.Contrib.Types.BizTalk.ServiceStatus">
  16158. <summary>
  16159. Indicates the status of a service.
  16160. </summary>
  16161. </member>
  16162. <member name="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Unbound">
  16163. <summary>
  16164. The service is unbound.
  16165. </summary>
  16166. </member>
  16167. <member name="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Bound">
  16168. <summary>
  16169. The service is bound.
  16170. </summary>
  16171. </member>
  16172. <member name="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Stopped">
  16173. <summary>
  16174. The service is enlisted, but not started.
  16175. </summary>
  16176. </member>
  16177. <member name="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Started">
  16178. <summary>
  16179. The service is started.
  16180. </summary>
  16181. </member>
  16182. <member name="T:NAnt.Contrib.Types.ClearCase.TypeKindConverter">
  16183. <summary>
  16184. Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that supports converting
  16185. a <see cref="T:NAnt.Contrib.Types.ClearCase.TypeKind"/> to a string value that can be used in
  16186. ClearCase commandline tools.
  16187. </summary>
  16188. </member>
  16189. <member name="M:NAnt.Contrib.Types.ClearCase.TypeKindConverter.#ctor">
  16190. <summary>
  16191. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.ClearCase.TypeKindConverter"/>
  16192. class.
  16193. </summary>
  16194. </member>
  16195. <member name="M:NAnt.Contrib.Types.ClearCase.TypeKindConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
  16196. <summary>
  16197. Introduces specialized behavior for converting a <see cref="T:NAnt.Contrib.Types.ClearCase.TypeKind"/>
  16198. value to a string that can be used in ClearCase commandline tools.
  16199. </summary>
  16200. <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
  16201. <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
  16202. <param name="value">The <see cref="T:System.Object"/> to convert.</param>
  16203. <param name="destinationType">The <see cref="T:System.Type"/> which <paramref name="value"/> should be converted to.</param>
  16204. <returns>
  16205. An <see cref="T:System.Object"/> that represents the converted value.
  16206. </returns>
  16207. </member>
  16208. <member name="T:NAnt.Contrib.Types.NUnit2Report.ReportFormat">
  16209. <summary>
  16210. Defines the report types supported by <see cref="T:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask"/>.
  16211. </summary>
  16212. </member>
  16213. <member name="F:NAnt.Contrib.Types.NUnit2Report.ReportFormat.Frames">
  16214. <summary>
  16215. Report with separate HTML frames.
  16216. </summary>
  16217. </member>
  16218. <member name="F:NAnt.Contrib.Types.NUnit2Report.ReportFormat.NoFrames">
  16219. <summary>
  16220. Frameless report.
  16221. </summary>
  16222. </member>
  16223. <member name="T:NAnt.Contrib.Types.PVCS.Entity">
  16224. <summary>
  16225. Represents an entity in an <see cref="T:NAnt.Contrib.Types.PVCS.EntitySet"/>.
  16226. </summary>
  16227. </member>
  16228. <member name="F:NAnt.Contrib.Types.PVCS.Entity._name">
  16229. <see cref="P:NAnt.Contrib.Types.PVCS.Entity.Name"/>
  16230. </member>
  16231. <member name="F:NAnt.Contrib.Types.PVCS.Entity._if">
  16232. <see cref="P:NAnt.Contrib.Types.PVCS.Entity.If"/>
  16233. </member>
  16234. <member name="F:NAnt.Contrib.Types.PVCS.Entity._unless">
  16235. <see cref="P:NAnt.Contrib.Types.PVCS.Entity.Unless"/>
  16236. </member>
  16237. <member name="M:NAnt.Contrib.Types.PVCS.Entity.#ctor">
  16238. <summary>
  16239. Constructs and initializes an instance of <c>Entity</c>.
  16240. </summary>
  16241. </member>
  16242. <member name="P:NAnt.Contrib.Types.PVCS.Entity.Name">
  16243. <summary>
  16244. The path for the entity.
  16245. </summary>
  16246. </member>
  16247. <member name="P:NAnt.Contrib.Types.PVCS.Entity.If">
  16248. <summary>
  16249. If <c>true</c> then the entity will be included. The default is <c>true</c>.
  16250. </summary>
  16251. </member>
  16252. <member name="P:NAnt.Contrib.Types.PVCS.Entity.Unless">
  16253. <summary>
  16254. Opposite of <see cref="P:NAnt.Contrib.Types.PVCS.Entity.If"/>. If <c>false</c> then the entity will be included. The default is
  16255. <c>false</c>.
  16256. </summary>
  16257. </member>
  16258. <member name="T:NAnt.Contrib.Types.PVCS.EntitySet">
  16259. <summary>
  16260. Represents a set of entities to include in a PVCS project database task.
  16261. </summary>
  16262. <seealso cref="T:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask"/>
  16263. </member>
  16264. <member name="F:NAnt.Contrib.Types.PVCS.EntitySet._entityPaths">
  16265. <see cref="P:NAnt.Contrib.Types.PVCS.EntitySet.EntityPaths"/>
  16266. </member>
  16267. <member name="M:NAnt.Contrib.Types.PVCS.EntitySet.#ctor">
  16268. <summary>
  16269. Constructs and initializes an instance of <c>EntitySet</c>.
  16270. </summary>
  16271. </member>
  16272. <member name="P:NAnt.Contrib.Types.PVCS.EntitySet.EntityPaths">
  16273. <summary>
  16274. Gets the collection of entity paths assigned to this entity set.
  16275. </summary>
  16276. </member>
  16277. <member name="P:NAnt.Contrib.Types.PVCS.EntitySet.Entities">
  16278. <summary>
  16279. The entities to include in the project task.
  16280. </summary>
  16281. </member>
  16282. <member name="T:NAnt.Contrib.Types.Assembly">
  16283. <summary>
  16284. Represents a single assembly in an <see cref="T:NAnt.Contrib.Types.AssemblySet"/>.
  16285. </summary>
  16286. </member>
  16287. <member name="F:NAnt.Contrib.Types.Assembly._culture">
  16288. <summary>
  16289. See <see cref="P:NAnt.Contrib.Types.Assembly.Culture"/>.
  16290. </summary>
  16291. </member>
  16292. <member name="F:NAnt.Contrib.Types.Assembly._if">
  16293. <summary>
  16294. See <see cref="P:NAnt.Contrib.Types.Assembly.If"/>.
  16295. </summary>
  16296. </member>
  16297. <member name="F:NAnt.Contrib.Types.Assembly._name">
  16298. <summary>
  16299. See <see cref="P:NAnt.Contrib.Types.Assembly.Name"/>.
  16300. </summary>
  16301. </member>
  16302. <member name="F:NAnt.Contrib.Types.Assembly._publicKeyToken">
  16303. <summary>
  16304. See <see cref="P:NAnt.Contrib.Types.Assembly.PublicKeyToken"/>.
  16305. </summary>
  16306. </member>
  16307. <member name="F:NAnt.Contrib.Types.Assembly._unless">
  16308. <summary>
  16309. See <see cref="P:NAnt.Contrib.Types.Assembly.Unless"/>.
  16310. </summary>
  16311. </member>
  16312. <member name="F:NAnt.Contrib.Types.Assembly._version">
  16313. <summary>
  16314. See <see cref="P:NAnt.Contrib.Types.Assembly.Version"/>.
  16315. </summary>
  16316. </member>
  16317. <member name="M:NAnt.Contrib.Types.Assembly.#ctor">
  16318. <summary>
  16319. Constructs and initializes an instance of <c>Assembly</c>.
  16320. </summary>
  16321. </member>
  16322. <member name="M:NAnt.Contrib.Types.Assembly.ToString">
  16323. <summary>
  16324. Converts this <c>Assembly</c> object into it's <c>string</c> representation.
  16325. </summary>
  16326. <returns></returns>
  16327. </member>
  16328. <member name="P:NAnt.Contrib.Types.Assembly.Culture">
  16329. <summary>
  16330. The culture for the assembly.
  16331. </summary>
  16332. </member>
  16333. <member name="P:NAnt.Contrib.Types.Assembly.If">
  16334. <summary>
  16335. If <c>true</c> then the assembly will be included. The default is <c>true</c>.
  16336. </summary>
  16337. </member>
  16338. <member name="P:NAnt.Contrib.Types.Assembly.Name">
  16339. <summary>
  16340. The name of the assembly.
  16341. </summary>
  16342. </member>
  16343. <member name="P:NAnt.Contrib.Types.Assembly.PublicKeyToken">
  16344. <summary>
  16345. The public key token of the assembly.
  16346. </summary>
  16347. </member>
  16348. <member name="P:NAnt.Contrib.Types.Assembly.Unless">
  16349. <summary>
  16350. Opposite of <see cref="P:NAnt.Contrib.Types.Assembly.If"/>. If <c>false</c> then the assembly will be included. The default is
  16351. <c>false</c>.
  16352. </summary>
  16353. </member>
  16354. <member name="P:NAnt.Contrib.Types.Assembly.Version">
  16355. <summary>
  16356. The version of the assembly.
  16357. </summary>
  16358. </member>
  16359. <member name="T:NAnt.Contrib.Types.AssemblySet">
  16360. <summary>
  16361. Represents a set of assemblies via their identity information.
  16362. </summary>
  16363. </member>
  16364. <member name="F:NAnt.Contrib.Types.AssemblySet._assemblyCollection">
  16365. <see cref="P:NAnt.Contrib.Types.AssemblySet.AssemblyCollection"/>
  16366. </member>
  16367. <member name="M:NAnt.Contrib.Types.AssemblySet.#ctor">
  16368. <summary>
  16369. Constructs and initializes an instance of <c>AssemblySet</c>.
  16370. </summary>
  16371. </member>
  16372. <member name="P:NAnt.Contrib.Types.AssemblySet.AssemblyCollection">
  16373. <summary>
  16374. Gets the collection of assemblies added to this assembly set.
  16375. </summary>
  16376. </member>
  16377. <member name="P:NAnt.Contrib.Types.AssemblySet.Assemblies">
  16378. <summary>
  16379. The assemblies to include.
  16380. </summary>
  16381. </member>
  16382. <member name="P:NAnt.Contrib.Types.CodeStatsCount.FileSet">
  16383. <summary>
  16384. The set of files to work on.
  16385. </summary>
  16386. </member>
  16387. <member name="P:NAnt.Contrib.Types.CodeStatsCount.Label">
  16388. <summary>
  16389. The label to apply to the results.
  16390. </summary>
  16391. </member>
  16392. <member name="T:NAnt.Contrib.Types.CodeStatsCountCollection">
  16393. <summary>
  16394. Contains a collection of <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> elements.
  16395. </summary>
  16396. </member>
  16397. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.#ctor">
  16398. <summary>
  16399. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> class.
  16400. </summary>
  16401. </member>
  16402. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.#ctor(NAnt.Contrib.Types.CodeStatsCountCollection)">
  16403. <summary>
  16404. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> class
  16405. with the specified <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> instance.
  16406. </summary>
  16407. </member>
  16408. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.#ctor(NAnt.Contrib.Types.CodeStatsCount[])">
  16409. <summary>
  16410. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> class
  16411. with the specified array of <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> instances.
  16412. </summary>
  16413. </member>
  16414. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Add(NAnt.Contrib.Types.CodeStatsCount)">
  16415. <summary>
  16416. Adds a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to the end of the collection.
  16417. </summary>
  16418. <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to be added to the end of the collection.</param>
  16419. <returns>The position into which the new element was inserted.</returns>
  16420. </member>
  16421. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.AddRange(NAnt.Contrib.Types.CodeStatsCount[])">
  16422. <summary>
  16423. Adds the elements of a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> array to the end of the collection.
  16424. </summary>
  16425. <param name="items">The array of <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> elements to be added to the end of the collection.</param>
  16426. </member>
  16427. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.AddRange(NAnt.Contrib.Types.CodeStatsCountCollection)">
  16428. <summary>
  16429. Adds the elements of a <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> to the end of the collection.
  16430. </summary>
  16431. <param name="items">The <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> to be added to the end of the collection.</param>
  16432. </member>
  16433. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Contains(NAnt.Contrib.Types.CodeStatsCount)">
  16434. <summary>
  16435. Determines whether a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> is in the collection.
  16436. </summary>
  16437. <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to locate in the collection.</param>
  16438. <returns>
  16439. <see langword="true"/> if <paramref name="item"/> is found in the
  16440. collection; otherwise, <see langword="false"/>.
  16441. </returns>
  16442. </member>
  16443. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Contains(System.String)">
  16444. <summary>
  16445. Determines whether a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> with the specified
  16446. value is in the collection.
  16447. </summary>
  16448. <param name="value">The argument value to locate in the collection.</param>
  16449. <returns>
  16450. <see langword="true"/> if a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> with
  16451. value <paramref name="value"/> is found in the collection; otherwise,
  16452. <see langword="false"/>.
  16453. </returns>
  16454. </member>
  16455. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.CopyTo(NAnt.Contrib.Types.CodeStatsCount[],System.Int32)">
  16456. <summary>
  16457. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  16458. </summary>
  16459. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  16460. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  16461. </member>
  16462. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.IndexOf(NAnt.Contrib.Types.CodeStatsCount)">
  16463. <summary>
  16464. Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> object in the collection.
  16465. </summary>
  16466. <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> object for which the index is returned.</param>
  16467. <returns>
  16468. The index of the specified <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/>. If the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> is not currently a member of the collection, it returns -1.
  16469. </returns>
  16470. </member>
  16471. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Insert(System.Int32,NAnt.Contrib.Types.CodeStatsCount)">
  16472. <summary>
  16473. Inserts a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> into the collection at the specified index.
  16474. </summary>
  16475. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  16476. <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to insert.</param>
  16477. </member>
  16478. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.GetEnumerator">
  16479. <summary>
  16480. Returns an enumerator that can iterate through the collection.
  16481. </summary>
  16482. <returns>
  16483. A <see cref="T:NAnt.Contrib.Types.CodeStatsCountEnumerator"/> for the entire collection.
  16484. </returns>
  16485. </member>
  16486. <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Remove(NAnt.Contrib.Types.CodeStatsCount)">
  16487. <summary>
  16488. Removes a member from the collection.
  16489. </summary>
  16490. <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to remove from the collection.</param>
  16491. </member>
  16492. <member name="P:NAnt.Contrib.Types.CodeStatsCountCollection.Item(System.Int32)">
  16493. <summary>
  16494. Gets or sets the element at the specified index.
  16495. </summary>
  16496. <param name="index">The zero-based index of the element to get or set.</param>
  16497. </member>
  16498. <member name="P:NAnt.Contrib.Types.CodeStatsCountCollection.Item(System.String)">
  16499. <summary>
  16500. Gets the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> with the specified name.
  16501. </summary>
  16502. <param name="value">The name of the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to get.</param>
  16503. </member>
  16504. <member name="T:NAnt.Contrib.Types.CodeStatsCountEnumerator">
  16505. <summary>
  16506. Enumerates the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> elements of a <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/>.
  16507. </summary>
  16508. </member>
  16509. <member name="M:NAnt.Contrib.Types.CodeStatsCountEnumerator.#ctor(NAnt.Contrib.Types.CodeStatsCountCollection)">
  16510. <summary>
  16511. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountEnumerator"/> class
  16512. with the specified <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/>.
  16513. </summary>
  16514. <param name="arguments">The collection that should be enumerated.</param>
  16515. </member>
  16516. <member name="M:NAnt.Contrib.Types.CodeStatsCountEnumerator.MoveNext">
  16517. <summary>
  16518. Advances the enumerator to the next element of the collection.
  16519. </summary>
  16520. <returns>
  16521. <see langword="true" /> if the enumerator was successfully advanced
  16522. to the next element; <see langword="false" /> if the enumerator has
  16523. passed the end of the collection.
  16524. </returns>
  16525. </member>
  16526. <member name="M:NAnt.Contrib.Types.CodeStatsCountEnumerator.Reset">
  16527. <summary>
  16528. Sets the enumerator to its initial position, which is before the
  16529. first element in the collection.
  16530. </summary>
  16531. </member>
  16532. <member name="P:NAnt.Contrib.Types.CodeStatsCountEnumerator.Current">
  16533. <summary>
  16534. Gets the current element in the collection.
  16535. </summary>
  16536. <returns>
  16537. The current element in the collection.
  16538. </returns>
  16539. </member>
  16540. <member name="T:NAnt.Contrib.Types.Filter">
  16541. <summary>
  16542. Individual filter component of <see cref="T:NAnt.Contrib.Types.FilterSet"/>.
  16543. </summary>
  16544. </member>
  16545. <member name="F:NAnt.Contrib.Types.Filter._token">
  16546. <summary>
  16547. Holds the token which will be replaced in the filter operation.
  16548. </summary>
  16549. </member>
  16550. <member name="F:NAnt.Contrib.Types.Filter._value">
  16551. <summary>
  16552. Holsd the value which will replace the token in the filtering operation.
  16553. </summary>
  16554. </member>
  16555. <member name="M:NAnt.Contrib.Types.Filter.#ctor">
  16556. <summary>
  16557. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.Filter"/> class.
  16558. </summary>
  16559. </member>
  16560. <member name="M:NAnt.Contrib.Types.Filter.#ctor(System.String,System.String)">
  16561. <summary>
  16562. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.Filter"/> class with
  16563. the given token and value.
  16564. </summary>
  16565. <param name="token">The token which will be replaced when filtering.</param>
  16566. <param name="value">The value which will replace the token when filtering.</param>
  16567. </member>
  16568. <member name="P:NAnt.Contrib.Types.Filter.Token">
  16569. <summary>
  16570. The token which will be replaced when filtering.
  16571. </summary>
  16572. </member>
  16573. <member name="P:NAnt.Contrib.Types.Filter.Value">
  16574. <summary>
  16575. The value which will replace the token when filtering.
  16576. </summary>
  16577. </member>
  16578. <member name="T:NAnt.Contrib.Types.FilterCollection">
  16579. <summary>
  16580. Contains a collection of <see cref="T:NAnt.Contrib.Types.Filter"/> elements.
  16581. </summary>
  16582. </member>
  16583. <member name="M:NAnt.Contrib.Types.FilterCollection.#ctor">
  16584. <summary>
  16585. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterCollection"/> class.
  16586. </summary>
  16587. </member>
  16588. <member name="M:NAnt.Contrib.Types.FilterCollection.#ctor(NAnt.Contrib.Types.FilterCollection)">
  16589. <summary>
  16590. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterCollection"/> class
  16591. with the specified <see cref="T:NAnt.Contrib.Types.FilterCollection"/> instance.
  16592. </summary>
  16593. </member>
  16594. <member name="M:NAnt.Contrib.Types.FilterCollection.#ctor(NAnt.Contrib.Types.Filter[])">
  16595. <summary>
  16596. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterCollection"/> class
  16597. with the specified array of <see cref="T:NAnt.Contrib.Types.Filter"/> instances.
  16598. </summary>
  16599. </member>
  16600. <member name="M:NAnt.Contrib.Types.FilterCollection.Add(NAnt.Contrib.Types.Filter)">
  16601. <summary>
  16602. Adds a <see cref="T:NAnt.Contrib.Types.Filter"/> to the end of the collection.
  16603. </summary>
  16604. <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to be added to the end of the collection.</param>
  16605. <returns>The position into which the new element was inserted.</returns>
  16606. </member>
  16607. <member name="M:NAnt.Contrib.Types.FilterCollection.AddRange(NAnt.Contrib.Types.Filter[])">
  16608. <summary>
  16609. Adds the elements of a <see cref="T:NAnt.Contrib.Types.Filter"/> array to the end of the collection.
  16610. </summary>
  16611. <param name="items">The array of <see cref="T:NAnt.Contrib.Types.Filter"/> elements to be added to the end of the collection.</param>
  16612. </member>
  16613. <member name="M:NAnt.Contrib.Types.FilterCollection.AddRange(NAnt.Contrib.Types.FilterCollection)">
  16614. <summary>
  16615. Adds the elements of a <see cref="T:NAnt.Contrib.Types.FilterCollection"/> to the end of the collection.
  16616. </summary>
  16617. <param name="items">The <see cref="T:NAnt.Contrib.Types.FilterCollection"/> to be added to the end of the collection.</param>
  16618. </member>
  16619. <member name="M:NAnt.Contrib.Types.FilterCollection.Contains(NAnt.Contrib.Types.Filter)">
  16620. <summary>
  16621. Determines whether a <see cref="T:NAnt.Contrib.Types.Filter"/> is in the collection.
  16622. </summary>
  16623. <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to locate in the collection.</param>
  16624. <returns>
  16625. <see langword="true"/> if <paramref name="item"/> is found in the
  16626. collection; otherwise, <see langword="false"/>.
  16627. </returns>
  16628. </member>
  16629. <member name="M:NAnt.Contrib.Types.FilterCollection.Contains(System.String)">
  16630. <summary>
  16631. Determines whether a <see cref="T:NAnt.Contrib.Types.Filter"/> with the specified
  16632. token is in the collection.
  16633. </summary>
  16634. <param name="token">The token to locate in the collection.</param>
  16635. <returns>
  16636. <see langword="true"/> if a <see cref="T:NAnt.Contrib.Types.Filter"/> with the given
  16637. token is found in the collection; otherwise, <see langword="false"/>.
  16638. </returns>
  16639. </member>
  16640. <member name="M:NAnt.Contrib.Types.FilterCollection.CopyTo(NAnt.Contrib.Types.Filter[],System.Int32)">
  16641. <summary>
  16642. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  16643. </summary>
  16644. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  16645. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  16646. </member>
  16647. <member name="M:NAnt.Contrib.Types.FilterCollection.IndexOf(NAnt.Contrib.Types.Filter)">
  16648. <summary>
  16649. Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.Filter"/> object in the collection.
  16650. </summary>
  16651. <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> object for which the index is returned.</param>
  16652. <returns>
  16653. The index of the specified <see cref="T:NAnt.Contrib.Types.Filter"/>. If the <see cref="T:NAnt.Contrib.Types.Filter"/> is not currently a member of the collection, it returns -1.
  16654. </returns>
  16655. </member>
  16656. <member name="M:NAnt.Contrib.Types.FilterCollection.Insert(System.Int32,NAnt.Contrib.Types.Filter)">
  16657. <summary>
  16658. Inserts a <see cref="T:NAnt.Contrib.Types.Filter"/> into the collection at the specified index.
  16659. </summary>
  16660. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  16661. <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to insert.</param>
  16662. </member>
  16663. <member name="M:NAnt.Contrib.Types.FilterCollection.GetEnumerator">
  16664. <summary>
  16665. Returns an enumerator that can iterate through the collection.
  16666. </summary>
  16667. <returns>
  16668. A <see cref="T:NAnt.Contrib.Types.FilterEnumerator"/> for the entire collection.
  16669. </returns>
  16670. </member>
  16671. <member name="M:NAnt.Contrib.Types.FilterCollection.Remove(NAnt.Contrib.Types.Filter)">
  16672. <summary>
  16673. Removes a member from the collection.
  16674. </summary>
  16675. <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to remove from the collection.</param>
  16676. </member>
  16677. <member name="P:NAnt.Contrib.Types.FilterCollection.Item(System.Int32)">
  16678. <summary>
  16679. Gets or sets the element at the specified index.
  16680. </summary>
  16681. <param name="index">The zero-based index of the element to get or set.</param>
  16682. </member>
  16683. <member name="P:NAnt.Contrib.Types.FilterCollection.Item(System.String)">
  16684. <summary>
  16685. Gets the <see cref="T:NAnt.Contrib.Types.Filter"/> with the specified token.
  16686. </summary>
  16687. <param name="token">The token to get.</param>
  16688. </member>
  16689. <member name="T:NAnt.Contrib.Types.FilterEnumerator">
  16690. <summary>
  16691. Enumerates the <see cref="T:NAnt.Contrib.Types.Filter"/> elements of a <see cref="T:NAnt.Contrib.Types.FilterCollection"/>.
  16692. </summary>
  16693. </member>
  16694. <member name="M:NAnt.Contrib.Types.FilterEnumerator.#ctor(NAnt.Contrib.Types.FilterCollection)">
  16695. <summary>
  16696. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterEnumerator"/> class
  16697. with the specified <see cref="T:NAnt.Contrib.Types.FilterCollection"/>.
  16698. </summary>
  16699. <param name="arguments">The collection that should be enumerated.</param>
  16700. </member>
  16701. <member name="M:NAnt.Contrib.Types.FilterEnumerator.MoveNext">
  16702. <summary>
  16703. Advances the enumerator to the next element of the collection.
  16704. </summary>
  16705. <returns>
  16706. <see langword="true" /> if the enumerator was successfully advanced
  16707. to the next element; <see langword="false" /> if the enumerator has
  16708. passed the end of the collection.
  16709. </returns>
  16710. </member>
  16711. <member name="M:NAnt.Contrib.Types.FilterEnumerator.Reset">
  16712. <summary>
  16713. Sets the enumerator to its initial position, which is before the
  16714. first element in the collection.
  16715. </summary>
  16716. </member>
  16717. <member name="P:NAnt.Contrib.Types.FilterEnumerator.Current">
  16718. <summary>
  16719. Gets the current element in the collection.
  16720. </summary>
  16721. <returns>
  16722. The current element in the collection.
  16723. </returns>
  16724. </member>
  16725. <member name="T:NAnt.Contrib.Types.FilterSet">
  16726. <summary>
  16727. A set of filters to be applied to something.
  16728. </summary>
  16729. <remarks>
  16730. <para>
  16731. A filter set may have begintoken and endtokens defined.
  16732. </para>
  16733. </remarks>
  16734. </member>
  16735. <member name="F:NAnt.Contrib.Types.FilterSet.DefaultTokenStart">
  16736. <summary>
  16737. The default token start string.
  16738. </summary>
  16739. </member>
  16740. <member name="F:NAnt.Contrib.Types.FilterSet.DefaultTokenEnd">
  16741. <summary>
  16742. The default token end string.
  16743. </summary>
  16744. </member>
  16745. <member name="M:NAnt.Contrib.Types.FilterSet.#ctor">
  16746. <summary>
  16747. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSet"/> class.
  16748. </summary>
  16749. </member>
  16750. <member name="M:NAnt.Contrib.Types.FilterSet.ReplaceTokens(System.String)">
  16751. <summary>
  16752. Does replacement on the given string with token matching.
  16753. </summary>
  16754. <param name="line">The line to process the tokens in.</param>
  16755. <returns>
  16756. The line with the tokens replaced.
  16757. </returns>
  16758. </member>
  16759. <member name="P:NAnt.Contrib.Types.FilterSet.BeginToken">
  16760. <summary>
  16761. The string used to identity the beginning of a token. The default is
  16762. <c>@</c>.
  16763. </summary>
  16764. </member>
  16765. <member name="P:NAnt.Contrib.Types.FilterSet.EndToken">
  16766. <summary>
  16767. The string used to identify the end of a token. The default is
  16768. <c>@</c>.
  16769. </summary>
  16770. </member>
  16771. <member name="P:NAnt.Contrib.Types.FilterSet.Filters">
  16772. <summary>
  16773. The filters to apply.
  16774. </summary>
  16775. </member>
  16776. <member name="T:NAnt.Contrib.Types.FilterSetCollection">
  16777. <summary>
  16778. Contains a collection of <see cref="T:NAnt.Contrib.Types.FilterSet"/> elements.
  16779. </summary>
  16780. </member>
  16781. <member name="M:NAnt.Contrib.Types.FilterSetCollection.#ctor">
  16782. <summary>
  16783. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> class.
  16784. </summary>
  16785. </member>
  16786. <member name="M:NAnt.Contrib.Types.FilterSetCollection.#ctor(NAnt.Contrib.Types.FilterSetCollection)">
  16787. <summary>
  16788. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> class
  16789. with the specified <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> instance.
  16790. </summary>
  16791. </member>
  16792. <member name="M:NAnt.Contrib.Types.FilterSetCollection.#ctor(NAnt.Contrib.Types.FilterSet[])">
  16793. <summary>
  16794. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> class
  16795. with the specified array of <see cref="T:NAnt.Contrib.Types.FilterSet"/> instances.
  16796. </summary>
  16797. </member>
  16798. <member name="M:NAnt.Contrib.Types.FilterSetCollection.Add(NAnt.Contrib.Types.FilterSet)">
  16799. <summary>
  16800. Adds a <see cref="T:NAnt.Contrib.Types.FilterSet"/> to the end of the collection.
  16801. </summary>
  16802. <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to be added to the end of the collection.</param>
  16803. <returns>The position into which the new element was inserted.</returns>
  16804. </member>
  16805. <member name="M:NAnt.Contrib.Types.FilterSetCollection.AddRange(NAnt.Contrib.Types.FilterSet[])">
  16806. <summary>
  16807. Adds the elements of a <see cref="T:NAnt.Contrib.Types.FilterSet"/> array to the end of the collection.
  16808. </summary>
  16809. <param name="items">The array of <see cref="T:NAnt.Contrib.Types.FilterSet"/> elements to be added to the end of the collection.</param>
  16810. </member>
  16811. <member name="M:NAnt.Contrib.Types.FilterSetCollection.AddRange(NAnt.Contrib.Types.FilterSetCollection)">
  16812. <summary>
  16813. Adds the elements of a <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> to the end of the collection.
  16814. </summary>
  16815. <param name="items">The <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> to be added to the end of the collection.</param>
  16816. </member>
  16817. <member name="M:NAnt.Contrib.Types.FilterSetCollection.Contains(NAnt.Contrib.Types.FilterSet)">
  16818. <summary>
  16819. Determines whether a <see cref="T:NAnt.Contrib.Types.FilterSet"/> is in the collection.
  16820. </summary>
  16821. <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to locate in the collection.</param>
  16822. <returns>
  16823. <see langword="true"/> if <paramref name="item"/> is found in the
  16824. collection; otherwise, <see langword="false"/>.
  16825. </returns>
  16826. </member>
  16827. <member name="M:NAnt.Contrib.Types.FilterSetCollection.CopyTo(NAnt.Contrib.Types.FilterSet[],System.Int32)">
  16828. <summary>
  16829. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  16830. </summary>
  16831. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  16832. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  16833. </member>
  16834. <member name="M:NAnt.Contrib.Types.FilterSetCollection.IndexOf(NAnt.Contrib.Types.FilterSet)">
  16835. <summary>
  16836. Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.FilterSet"/> object in the collection.
  16837. </summary>
  16838. <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> object for which the index is returned.</param>
  16839. <returns>
  16840. The index of the specified <see cref="T:NAnt.Contrib.Types.FilterSet"/>. If the <see cref="T:NAnt.Contrib.Types.FilterSet"/> is not currently a member of the collection, it returns -1.
  16841. </returns>
  16842. </member>
  16843. <member name="M:NAnt.Contrib.Types.FilterSetCollection.Insert(System.Int32,NAnt.Contrib.Types.FilterSet)">
  16844. <summary>
  16845. Inserts a <see cref="T:NAnt.Contrib.Types.FilterSet"/> into the collection at the specified index.
  16846. </summary>
  16847. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  16848. <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to insert.</param>
  16849. </member>
  16850. <member name="M:NAnt.Contrib.Types.FilterSetCollection.GetEnumerator">
  16851. <summary>
  16852. Returns an enumerator that can iterate through the collection.
  16853. </summary>
  16854. <returns>
  16855. A <see cref="T:NAnt.Contrib.Types.FilterSetEnumerator"/> for the entire collection.
  16856. </returns>
  16857. </member>
  16858. <member name="M:NAnt.Contrib.Types.FilterSetCollection.Remove(NAnt.Contrib.Types.FilterSet)">
  16859. <summary>
  16860. Removes a member from the collection.
  16861. </summary>
  16862. <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to remove from the collection.</param>
  16863. </member>
  16864. <member name="M:NAnt.Contrib.Types.FilterSetCollection.ReplaceTokens(System.String)">
  16865. <summary>
  16866. Does replacement on the given string with token matching.
  16867. </summary>
  16868. <param name="line">The line to process the tokens in.</param>
  16869. <returns>
  16870. The line with the tokens replaced.
  16871. </returns>
  16872. </member>
  16873. <member name="M:NAnt.Contrib.Types.FilterSetCollection.HasFilters">
  16874. <summary>
  16875. Checks to see if there are filters in the collection of filtersets.
  16876. </summary>
  16877. <returns>
  16878. <see langword="true" /> if there are filters in this collection of
  16879. filtersets; otherwise, <see langword="false" />.
  16880. </returns>
  16881. </member>
  16882. <member name="P:NAnt.Contrib.Types.FilterSetCollection.Item(System.Int32)">
  16883. <summary>
  16884. Gets or sets the element at the specified index.
  16885. </summary>
  16886. <param name="index">The zero-based index of the element to get or set.</param>
  16887. </member>
  16888. <member name="T:NAnt.Contrib.Types.FilterSetEnumerator">
  16889. <summary>
  16890. Enumerates the <see cref="T:NAnt.Contrib.Types.FilterSet"/> elements of a <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.
  16891. </summary>
  16892. </member>
  16893. <member name="M:NAnt.Contrib.Types.FilterSetEnumerator.#ctor(NAnt.Contrib.Types.FilterSetCollection)">
  16894. <summary>
  16895. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetEnumerator"/> class
  16896. with the specified <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.
  16897. </summary>
  16898. <param name="arguments">The collection that should be enumerated.</param>
  16899. </member>
  16900. <member name="M:NAnt.Contrib.Types.FilterSetEnumerator.MoveNext">
  16901. <summary>
  16902. Advances the enumerator to the next element of the collection.
  16903. </summary>
  16904. <returns>
  16905. <see langword="true" /> if the enumerator was successfully advanced
  16906. to the next element; <see langword="false" /> if the enumerator has
  16907. passed the end of the collection.
  16908. </returns>
  16909. </member>
  16910. <member name="M:NAnt.Contrib.Types.FilterSetEnumerator.Reset">
  16911. <summary>
  16912. Sets the enumerator to its initial position, which is before the
  16913. first element in the collection.
  16914. </summary>
  16915. </member>
  16916. <member name="P:NAnt.Contrib.Types.FilterSetEnumerator.Current">
  16917. <summary>
  16918. Gets the current element in the collection.
  16919. </summary>
  16920. <returns>
  16921. The current element in the collection.
  16922. </returns>
  16923. </member>
  16924. <member name="T:NAnt.Contrib.Types.GacReference">
  16925. <summary>
  16926. Used to specify reference information when working with the GAC.
  16927. </summary>
  16928. <remarks>
  16929. <para>
  16930. The full details of GAC references can be found in the SDK documentation.
  16931. </para>
  16932. </remarks>
  16933. </member>
  16934. <member name="F:NAnt.Contrib.Types.GacReference._if">
  16935. <summary>
  16936. See <see cref="P:NAnt.Contrib.Types.GacReference.If"/>.
  16937. </summary>
  16938. </member>
  16939. <member name="F:NAnt.Contrib.Types.GacReference._unless">
  16940. <summary>
  16941. See <see cref="P:NAnt.Contrib.Types.GacReference.Unless"/>.
  16942. </summary>
  16943. </member>
  16944. <member name="F:NAnt.Contrib.Types.GacReference._schemeType">
  16945. <summary>
  16946. See <see cref="P:NAnt.Contrib.Types.GacReference.SchemeType"/>.
  16947. </summary>
  16948. </member>
  16949. <member name="F:NAnt.Contrib.Types.GacReference._schemeId">
  16950. <summary>
  16951. See <see cref="P:NAnt.Contrib.Types.GacReference.SchemeId"/>.
  16952. </summary>
  16953. </member>
  16954. <member name="F:NAnt.Contrib.Types.GacReference._schemeDescription">
  16955. <summary>
  16956. See <see cref="P:NAnt.Contrib.Types.GacReference.SchemeDescription"/>.
  16957. </summary>
  16958. </member>
  16959. <member name="M:NAnt.Contrib.Types.GacReference.#ctor">
  16960. <summary>
  16961. Constructs and initializes an instance of <c>GacReference</c>.
  16962. </summary>
  16963. </member>
  16964. <member name="P:NAnt.Contrib.Types.GacReference.If">
  16965. <summary>
  16966. If <c>true</c> then the entity will be included. The default is <c>true</c>.
  16967. </summary>
  16968. </member>
  16969. <member name="P:NAnt.Contrib.Types.GacReference.SchemeType">
  16970. <summary>
  16971. The scheme type to use when working with GAC references. The default
  16972. is <see cref="F:SchemeType.None" />, which means that references will
  16973. not be used by the GAC task.
  16974. </summary>
  16975. </member>
  16976. <member name="P:NAnt.Contrib.Types.GacReference.SchemeId">
  16977. <summary>
  16978. The scheme ID to use when working with GAC references. This is only
  16979. relevant if a scheme type other than <see cref="F:SchemeType.None" />
  16980. is specified.
  16981. </summary>
  16982. </member>
  16983. <member name="P:NAnt.Contrib.Types.GacReference.SchemeDescription">
  16984. <summary>
  16985. The scheme description to use when working with GAC references. This
  16986. is only relevant if a scheme type other than <see cref="F:SchemeType.None" />
  16987. is specified.
  16988. </summary>
  16989. </member>
  16990. <member name="P:NAnt.Contrib.Types.GacReference.Unless">
  16991. <summary>
  16992. Opposite of <see cref="P:NAnt.Contrib.Types.GacReference.If"/>. If <c>false</c> then the entity will be included. The default is
  16993. <c>false</c>.
  16994. </summary>
  16995. </member>
  16996. <member name="T:NAnt.Contrib.Types.SchemaElement">
  16997. <summary>
  16998. Represents the an element based on a schema definition.
  16999. </summary>
  17000. </member>
  17001. <member name="T:NAnt.Contrib.Types.XmlSchemaReference">
  17002. <summary>
  17003. Represents the schema collection element.
  17004. </summary>
  17005. </member>
  17006. <member name="P:NAnt.Contrib.Types.XmlSchemaReference.Namespace">
  17007. <summary>
  17008. Namespace URI associated with this schema.
  17009. If not present, it is assumed that the
  17010. schema's targetNamespace value is to be used.
  17011. </summary>
  17012. </member>
  17013. <member name="P:NAnt.Contrib.Types.XmlSchemaReference.Source">
  17014. <summary>
  17015. Location of this schema. Could be a
  17016. local file path or an HTTP URL.
  17017. </summary>
  17018. </member>
  17019. <member name="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection">
  17020. <summary>
  17021. Contains a collection of <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> elements.
  17022. </summary>
  17023. </member>
  17024. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.#ctor">
  17025. <summary>
  17026. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> class.
  17027. </summary>
  17028. </member>
  17029. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.#ctor(NAnt.Contrib.Types.XmlSchemaReferenceCollection)">
  17030. <summary>
  17031. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> class
  17032. with the specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> instance.
  17033. </summary>
  17034. </member>
  17035. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.#ctor(NAnt.Contrib.Types.XmlSchemaReference[])">
  17036. <summary>
  17037. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> class
  17038. with the specified array of <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> instances.
  17039. </summary>
  17040. </member>
  17041. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Add(NAnt.Contrib.Types.XmlSchemaReference)">
  17042. <summary>
  17043. Adds a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to the end of the collection.
  17044. </summary>
  17045. <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to be added to the end of the collection.</param>
  17046. <returns>The position into which the new element was inserted.</returns>
  17047. </member>
  17048. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.AddRange(NAnt.Contrib.Types.XmlSchemaReference[])">
  17049. <summary>
  17050. Adds the elements of a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> array to the end of the collection.
  17051. </summary>
  17052. <param name="items">The array of <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> elements to be added to the end of the collection.</param>
  17053. </member>
  17054. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.AddRange(NAnt.Contrib.Types.XmlSchemaReferenceCollection)">
  17055. <summary>
  17056. Adds the elements of a <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> to the end of the collection.
  17057. </summary>
  17058. <param name="items">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> to be added to the end of the collection.</param>
  17059. </member>
  17060. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Contains(NAnt.Contrib.Types.XmlSchemaReference)">
  17061. <summary>
  17062. Determines whether a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> is in the collection.
  17063. </summary>
  17064. <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to locate in the collection.</param>
  17065. <returns>
  17066. <see langword="true"/> if <paramref name="item"/> is found in the
  17067. collection; otherwise, <see langword="false"/>.
  17068. </returns>
  17069. </member>
  17070. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Contains(System.String)">
  17071. <summary>
  17072. Determines whether a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> with the specified
  17073. value is in the collection.
  17074. </summary>
  17075. <param name="value">The argument value to locate in the collection.</param>
  17076. <returns>
  17077. <see langword="true"/> if a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> with
  17078. value <paramref name="value"/> is found in the collection; otherwise,
  17079. <see langword="false"/>.
  17080. </returns>
  17081. </member>
  17082. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.CopyTo(NAnt.Contrib.Types.XmlSchemaReference[],System.Int32)">
  17083. <summary>
  17084. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  17085. </summary>
  17086. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  17087. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  17088. </member>
  17089. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.IndexOf(NAnt.Contrib.Types.XmlSchemaReference)">
  17090. <summary>
  17091. Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> object in the collection.
  17092. </summary>
  17093. <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> object for which the index is returned.</param>
  17094. <returns>
  17095. The index of the specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/>. If the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> is not currently a member of the collection, it returns -1.
  17096. </returns>
  17097. </member>
  17098. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Insert(System.Int32,NAnt.Contrib.Types.XmlSchemaReference)">
  17099. <summary>
  17100. Inserts a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> into the collection at the specified index.
  17101. </summary>
  17102. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  17103. <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to insert.</param>
  17104. </member>
  17105. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.GetEnumerator">
  17106. <summary>
  17107. Returns an enumerator that can iterate through the collection.
  17108. </summary>
  17109. <returns>
  17110. A <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator"/> for the entire collection.
  17111. </returns>
  17112. </member>
  17113. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Remove(NAnt.Contrib.Types.XmlSchemaReference)">
  17114. <summary>
  17115. Removes a member from the collection.
  17116. </summary>
  17117. <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to remove from the collection.</param>
  17118. </member>
  17119. <member name="P:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Item(System.Int32)">
  17120. <summary>
  17121. Gets or sets the element at the specified index.
  17122. </summary>
  17123. <param name="index">The zero-based index of the element to get or set.</param>
  17124. </member>
  17125. <member name="P:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Item(System.String)">
  17126. <summary>
  17127. Gets the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> with the specified name.
  17128. </summary>
  17129. <param name="value">The name of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to get.</param>
  17130. </member>
  17131. <member name="T:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator">
  17132. <summary>
  17133. Enumerates the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> elements of a <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/>.
  17134. </summary>
  17135. </member>
  17136. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.#ctor(NAnt.Contrib.Types.XmlSchemaReferenceCollection)">
  17137. <summary>
  17138. Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator"/> class
  17139. with the specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/>.
  17140. </summary>
  17141. <param name="arguments">The collection that should be enumerated.</param>
  17142. </member>
  17143. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.MoveNext">
  17144. <summary>
  17145. Advances the enumerator to the next element of the collection.
  17146. </summary>
  17147. <returns>
  17148. <see langword="true" /> if the enumerator was successfully advanced
  17149. to the next element; <see langword="false" /> if the enumerator has
  17150. passed the end of the collection.
  17151. </returns>
  17152. </member>
  17153. <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.Reset">
  17154. <summary>
  17155. Sets the enumerator to its initial position, which is before the
  17156. first element in the collection.
  17157. </summary>
  17158. </member>
  17159. <member name="P:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.Current">
  17160. <summary>
  17161. Gets the current element in the collection.
  17162. </summary>
  17163. <returns>
  17164. The current element in the collection.
  17165. </returns>
  17166. </member>
  17167. <member name="T:NAnt.Contrib.Util.ChecksumHelper">
  17168. <summary>
  17169. Helper class to calculate checksums
  17170. of files.
  17171. </summary>
  17172. </member>
  17173. <member name="M:NAnt.Contrib.Util.ChecksumHelper.#ctor(System.String)">
  17174. <summary>
  17175. Create a new instance
  17176. </summary>
  17177. <param name="providerName">Name of hash algorithm to use</param>
  17178. </member>
  17179. <member name="M:NAnt.Contrib.Util.ChecksumHelper.CalculateChecksum(System.String)">
  17180. <summary>
  17181. Calculates a checksum for a given file
  17182. and returns it in a hex string
  17183. </summary>
  17184. <param name="filename">name of the input file</param>
  17185. <returns>hex checksum string</returns>
  17186. </member>
  17187. <member name="M:NAnt.Contrib.Util.ChecksumHelper.ChecksumToString(System.Byte[])">
  17188. <summary>
  17189. Converts a checksum value (a byte array)
  17190. into a Hex-formatted string.
  17191. </summary>
  17192. <param name="checksum">Checksum value to convert</param>
  17193. <returns>Hexified string value</returns>
  17194. </member>
  17195. <member name="T:NAnt.Contrib.Util.IRecorder">
  17196. <summary>
  17197. Recorder interface user with the Record task
  17198. </summary>
  17199. </member>
  17200. <member name="M:NAnt.Contrib.Util.IRecorder.Start">
  17201. <summary>
  17202. Starts recording.
  17203. </summary>
  17204. </member>
  17205. <member name="M:NAnt.Contrib.Util.IRecorder.Stop">
  17206. <summary>
  17207. Stops recording.
  17208. </summary>
  17209. </member>
  17210. <member name="M:NAnt.Contrib.Util.IRecorder.Close">
  17211. <summary>
  17212. Closes the recorder.
  17213. </summary>
  17214. </member>
  17215. <member name="M:NAnt.Contrib.Util.IRecorder.Flush">
  17216. <summary>
  17217. Flushes the recorder.
  17218. </summary>
  17219. </member>
  17220. <member name="P:NAnt.Contrib.Util.IRecorder.Name">
  17221. <summary>
  17222. Gets the name of this recorder (possibly a file name).
  17223. </summary>
  17224. </member>
  17225. <member name="P:NAnt.Contrib.Util.IRecorder.Logger">
  17226. <summary>
  17227. Gets The underlying <see cref="T:NAnt.Core.IBuildLogger"/> instance.
  17228. </summary>
  17229. </member>
  17230. <member name="P:NAnt.Contrib.Util.IRecorder.AutoFlush">
  17231. <summary>
  17232. Defines whether the underlying writer is automatically flushes or
  17233. not.
  17234. </summary>
  17235. </member>
  17236. <member name="T:NAnt.Contrib.Util.RecorderCollection">
  17237. <summary>
  17238. Keeps track of used recorders
  17239. </summary>
  17240. </member>
  17241. <member name="M:NAnt.Contrib.Util.FileLogListener.#ctor(System.String)">
  17242. <summary>
  17243. Initializes a new instance of the <see cref="T:NAnt.Contrib.Util.FileLogListener"/>
  17244. class.
  17245. </summary>
  17246. </member>
  17247. <member name="M:NAnt.Contrib.Util.FileLogListener.Flush">
  17248. <summary>
  17249. Flushes buffered build events or messages to the underlying storage.
  17250. </summary>
  17251. </member>
  17252. <member name="M:NAnt.Contrib.Util.FileLogListener.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
  17253. <summary>
  17254. Signals that a build has started.
  17255. </summary>
  17256. <param name="sender">The source of the event.</param>
  17257. <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
  17258. <remarks>
  17259. This event is fired before any targets have started.
  17260. </remarks>
  17261. </member>
  17262. <member name="M:NAnt.Contrib.Util.FileLogListener.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
  17263. <summary>
  17264. Signals that the last target has finished.
  17265. </summary>
  17266. <param name="sender">The source of the event.</param>
  17267. <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
  17268. <remarks>
  17269. This event will still be fired if an error occurred during the build.
  17270. </remarks>
  17271. </member>
  17272. <member name="M:NAnt.Contrib.Util.FileLogListener.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
  17273. <summary>
  17274. Signals that a target has started.
  17275. </summary>
  17276. <param name="sender">The source of the event.</param>
  17277. <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
  17278. </member>
  17279. <member name="M:NAnt.Contrib.Util.FileLogListener.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
  17280. <summary>
  17281. Signals that a task has finished.
  17282. </summary>
  17283. <param name="sender">The source of the event.</param>
  17284. <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
  17285. <remarks>
  17286. This event will still be fired if an error occurred during the build.
  17287. </remarks>
  17288. </member>
  17289. <member name="M:NAnt.Contrib.Util.FileLogListener.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
  17290. <summary>
  17291. Signals that a task has started.
  17292. </summary>
  17293. <param name="sender">The source of the event.</param>
  17294. <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
  17295. </member>
  17296. <member name="M:NAnt.Contrib.Util.FileLogListener.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
  17297. <summary>
  17298. Signals that a task has finished.
  17299. </summary>
  17300. <param name="sender">The source of the event.</param>
  17301. <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
  17302. <remarks>
  17303. This event will still be fired if an error occurred during the build.
  17304. </remarks>
  17305. </member>
  17306. <member name="M:NAnt.Contrib.Util.FileLogListener.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
  17307. <summary>
  17308. Signals that a message has been logged.
  17309. </summary>
  17310. <param name="sender">The source of the event.</param>
  17311. <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
  17312. <remarks>
  17313. Only messages with a priority higher or equal to the threshold of
  17314. the logger will actually be output in the build log.
  17315. </remarks>
  17316. </member>
  17317. <member name="M:NAnt.Contrib.Util.FileLogListener.Log(System.String)">
  17318. <summary>
  17319. Empty implementation which allows derived classes to receive the
  17320. output that is generated in this logger.
  17321. </summary>
  17322. <param name="message">The message being logged.</param>
  17323. </member>
  17324. <member name="M:NAnt.Contrib.Util.FileLogListener.OutputMessage(NAnt.Core.Level,System.String,System.Int32)">
  17325. <summary>
  17326. Outputs an indented message to the build log if its priority is
  17327. greather than or equal to the <see cref="P:NAnt.Contrib.Util.FileLogListener.Threshold"/> of the
  17328. logger.
  17329. </summary>
  17330. <param name="messageLevel">The priority of the message to output.</param>
  17331. <param name="message">The message to output.</param>
  17332. <param name="indentationLength">The number of characters that the message should be indented.</param>
  17333. </member>
  17334. <member name="M:NAnt.Contrib.Util.FileLogListener.OutputMessage(NAnt.Core.BuildEventArgs)">
  17335. <summary>
  17336. Outputs an indented message to the build log if its priority is
  17337. greather than or equal to the <see cref="P:NAnt.Contrib.Util.FileLogListener.Threshold"/> of the
  17338. logger.
  17339. </summary>
  17340. <param name="e">The event to output.</param>
  17341. </member>
  17342. <member name="M:NAnt.Contrib.Util.FileLogListener.OutputMessage(NAnt.Core.BuildEventArgs,System.Int32)">
  17343. <summary>
  17344. Outputs an indented message to the build log if its priority is
  17345. greather than or equal to the <see cref="P:NAnt.Contrib.Util.FileLogListener.Threshold"/> of the
  17346. logger.
  17347. </summary>
  17348. <param name="e">The event to output.</param>
  17349. <param name="indentationLength">TODO</param>
  17350. </member>
  17351. <member name="P:NAnt.Contrib.Util.FileLogListener.Threshold">
  17352. <summary>
  17353. Gets or sets the highest level of message this logger should respond
  17354. to.
  17355. </summary>
  17356. <value>
  17357. The highest level of message this logger should respond to.
  17358. </value>
  17359. <remarks>
  17360. Only messages with a message level higher than or equal to the given
  17361. level should be written to the log.
  17362. </remarks>
  17363. </member>
  17364. <member name="P:NAnt.Contrib.Util.FileLogListener.EmacsMode">
  17365. <summary>
  17366. Gets or sets a value indicating whether to produce emacs (and other
  17367. editor) friendly output.
  17368. </summary>
  17369. <value>
  17370. <see langword="true" /> if output is to be unadorned so that emacs
  17371. and other editors can parse files names, etc. The default is
  17372. <see langword="false" />.
  17373. </value>
  17374. </member>
  17375. <member name="P:NAnt.Contrib.Util.FileLogListener.OutputWriter">
  17376. <summary>
  17377. Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
  17378. to send its output.
  17379. </summary>
  17380. </member>
  17381. <member name="T:NAnt.Contrib.Util.FileUtils">
  17382. <summary>
  17383. Groups a set of useful file manipulation methods.
  17384. </summary>
  17385. </member>
  17386. <member name="M:NAnt.Contrib.Util.FileUtils.#ctor">
  17387. <summary>
  17388. Initializes a new instance of the <see cref="T:NAnt.Contrib.Util.FileUtils"/> class.
  17389. </summary>
  17390. <remarks>
  17391. Prevents instantiation of the <see cref="T:NAnt.Contrib.Util.FileUtils"/> class.
  17392. </remarks>
  17393. </member>
  17394. <member name="M:NAnt.Contrib.Util.FileUtils.CopyFile(System.String,System.String,System.Text.Encoding,NAnt.Contrib.Types.FilterSetCollection)">
  17395. <summary>
  17396. Copies a file while replacing the tokens identified by the given
  17397. <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.
  17398. </summary>
  17399. <param name="sourceFileName">The file to copy.</param>
  17400. <param name="destinationFileName">The name of the destination file.</param>
  17401. <param name="encoding">The <see cref="T:System.Text.Encoding"/> used when filter-copying the file.</param>
  17402. <param name="filtersets">The collection of filtersets that should be applied to the file.</param>
  17403. </member>
  17404. <member name="M:NAnt.Contrib.Util.FileUtils.MoveFile(System.String,System.String,System.Text.Encoding,NAnt.Contrib.Types.FilterSetCollection)">
  17405. <summary>
  17406. Moves a file while replacing the tokens identified by the given
  17407. <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.
  17408. </summary>
  17409. <param name="sourceFileName">The file to move.</param>
  17410. <param name="destinationFileName">The name of the destination file.</param>
  17411. <param name="encoding">The <see cref="T:System.Text.Encoding"/> used when filter-copying the file.</param>
  17412. <param name="filtersets">The collection of filtersets that should be applied to the file.</param>
  17413. </member>
  17414. <member name="M:NAnt.Contrib.Util.FileUtils.GetRelativePath(System.String,System.String)">
  17415. <summary>
  17416. Given an absolute directory and an absolute file name, returns a
  17417. relative file name.
  17418. </summary>
  17419. <param name="basePath">An absolute directory.</param>
  17420. <param name="absolutePath">An absolute file name.</param>
  17421. <returns>
  17422. A relative file name for the given absolute file name.
  17423. </returns>
  17424. </member>
  17425. <member name="M:NAnt.Contrib.Util.IniFile.GetString(System.String,System.String,System.String)">
  17426. <summary>
  17427. Returns a string from your INI file
  17428. </summary>
  17429. <param name="Section"></param>
  17430. <param name="Key"></param>
  17431. <param name="Default"></param>
  17432. <returns></returns>
  17433. </member>
  17434. <member name="M:NAnt.Contrib.Util.IniFile.WriteString(System.String,System.String,System.String)">
  17435. <summary>
  17436. ' Writes a string to your INI file
  17437. </summary>
  17438. <param name="Section"></param>
  17439. <param name="Key"></param>
  17440. <param name="String"></param>
  17441. </member>
  17442. <member name="M:NAnt.Contrib.Util.IniFile.Flush">
  17443. <summary>
  17444. ' Stores all the cached changes to your INI file
  17445. </summary>
  17446. </member>
  17447. <member name="T:NAnt.Contrib.Util.SqlHelper">
  17448. <summary>
  17449. Helper class used to execute Sql Statements.
  17450. </summary>
  17451. </member>
  17452. <member name="M:NAnt.Contrib.Util.SqlHelper.#ctor(System.String,System.Boolean)">
  17453. <summary>
  17454. Initializes a new instance.
  17455. </summary>
  17456. <param name="connectionString">OleDB Connection string</param>
  17457. <param name="useTransaction">True if you want to use a transaction</param>
  17458. </member>
  17459. <member name="M:NAnt.Contrib.Util.SqlHelper.Close(System.Boolean)">
  17460. <summary>
  17461. Close the connection and terminate
  17462. </summary>
  17463. <param name="commit">true if the transaction should be commited</param>
  17464. </member>
  17465. <member name="M:NAnt.Contrib.Util.SqlHelper.Execute(System.String,System.Int32)">
  17466. <summary>
  17467. Executes a SQL statement.
  17468. </summary>
  17469. <param name="sql">SQL statement to execute</param>
  17470. <param name="cmdTimeout">Command timeout to use</param>
  17471. <returns>Data reader used to check the result</returns>
  17472. </member>
  17473. <member name="P:NAnt.Contrib.Util.SqlHelper.Connection">
  17474. <summary>
  17475. OleDB Connection object
  17476. </summary>
  17477. </member>
  17478. <member name="T:NAnt.Contrib.Util.SqlStatementAdapter">
  17479. <summary>
  17480. Helper class to adapt SQL statements from some
  17481. input into something OLEDB can consume directly
  17482. </summary>
  17483. </member>
  17484. <member name="M:NAnt.Contrib.Util.SqlStatementAdapter.#ctor(NAnt.Contrib.Util.SqlStatementList)">
  17485. <summary>
  17486. Creates a new instance
  17487. </summary>
  17488. </member>
  17489. <member name="M:NAnt.Contrib.Util.SqlStatementAdapter.AdaptSql(System.String)">
  17490. <summary>
  17491. Adapts a set of Sql statements from a string.
  17492. </summary>
  17493. <param name="sql">A string containing the original sql statements</param>
  17494. </member>
  17495. <member name="M:NAnt.Contrib.Util.SqlStatementAdapter.AdaptSqlFile(System.String,System.Text.Encoding)">
  17496. <summary>
  17497. Adapts a set of Sql statements from a string.
  17498. </summary>
  17499. <param name="file">Path of file containing all sql statements</param>
  17500. <param name="encoding">The encoding of the file containing the SQL statements.</param>
  17501. <returns>The new instance</returns>
  17502. </member>
  17503. <member name="T:NAnt.Contrib.Util.DelimiterStyle">
  17504. <summary>
  17505. Determines how the delimiter is interpreted in a SQL string.
  17506. </summary>
  17507. </member>
  17508. <member name="F:NAnt.Contrib.Util.DelimiterStyle.Normal">
  17509. <summary>
  17510. Delimiter can appear anywhere on a line.
  17511. </summary>
  17512. </member>
  17513. <member name="F:NAnt.Contrib.Util.DelimiterStyle.Line">
  17514. <summary>
  17515. Delimiter always appears by itself on a line.
  17516. </summary>
  17517. </member>
  17518. <member name="T:NAnt.Contrib.Util.SqlStatementList">
  17519. <summary>
  17520. Helper class to maintain a list of SQL Statements.
  17521. </summary>
  17522. </member>
  17523. <member name="M:NAnt.Contrib.Util.SqlStatementList.#ctor(System.String,NAnt.Contrib.Util.DelimiterStyle)">
  17524. <summary>
  17525. Initializes a new instance.
  17526. </summary>
  17527. <param name="delimiter">String that separates statements from each other</param>
  17528. <param name="style">Style of the delimiter</param>
  17529. </member>
  17530. <member name="M:NAnt.Contrib.Util.SqlStatementList.ParseSql(System.String)">
  17531. <summary>
  17532. Parses the SQL into the internal list using the specified delimiter
  17533. and delimiter style
  17534. </summary>
  17535. <param name="sql">The SQL string to parse.</param>
  17536. </member>
  17537. <member name="M:NAnt.Contrib.Util.SqlStatementList.ParseSqlFromFile(System.String,System.Text.Encoding)">
  17538. <summary>
  17539. Parses the contents of the file into the
  17540. internal list using the specified delimiter
  17541. and delimiter style
  17542. </summary>
  17543. <param name="file">File name</param>
  17544. <param name="encoding">The encoding of the file containing the SQL statements.</param>
  17545. </member>
  17546. <member name="M:NAnt.Contrib.Util.SqlStatementList.GetEnumerator">
  17547. <summary>
  17548. Allows foreach().
  17549. </summary>
  17550. <returns></returns>
  17551. </member>
  17552. <member name="M:NAnt.Contrib.Util.SqlStatementList.StripComments(System.String)">
  17553. <summary>
  17554. Strips all single line comments
  17555. in the specified sql
  17556. </summary>
  17557. <param name="sql"></param>
  17558. <returns></returns>
  17559. </member>
  17560. <member name="M:NAnt.Contrib.Util.SqlStatementList.ExpandProps(System.String)">
  17561. <summary>
  17562. Expands project properties in the
  17563. sql string
  17564. </summary>
  17565. <param name="sql"></param>
  17566. <returns></returns>
  17567. </member>
  17568. <member name="P:NAnt.Contrib.Util.SqlStatementList.Count">
  17569. <summary>
  17570. Gets the number of statements in the list.
  17571. </summary>
  17572. </member>
  17573. <member name="P:NAnt.Contrib.Util.SqlStatementList.Item(System.Int32)">
  17574. <summary>
  17575. Gets the statement specified by the index.
  17576. </summary>
  17577. </member>
  17578. <member name="P:NAnt.Contrib.Util.SqlStatementList.Properties">
  17579. <summary>
  17580. Project's properties for property expansion
  17581. </summary>
  17582. </member>
  17583. <member name="T:NAnt.Contrib.Schemas.Msi.msi">
  17584. <remarks/>
  17585. </member>
  17586. <member name="T:NAnt.Contrib.Schemas.Msi.MSIBase">
  17587. <remarks/>
  17588. </member>
  17589. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.summaryinformation">
  17590. <remarks/>
  17591. </member>
  17592. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.properties">
  17593. <remarks/>
  17594. </member>
  17595. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.search">
  17596. <remarks/>
  17597. </member>
  17598. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.tables">
  17599. <remarks/>
  17600. </member>
  17601. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.directories">
  17602. <remarks/>
  17603. </member>
  17604. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.environment">
  17605. <remarks/>
  17606. </member>
  17607. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.components">
  17608. <remarks/>
  17609. </member>
  17610. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.dialogs">
  17611. <remarks/>
  17612. </member>
  17613. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.controls">
  17614. <remarks/>
  17615. </member>
  17616. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.controlconditions">
  17617. <remarks/>
  17618. </member>
  17619. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.controlevents">
  17620. <remarks/>
  17621. </member>
  17622. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.registry">
  17623. <remarks/>
  17624. </member>
  17625. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.icons">
  17626. <remarks/>
  17627. </member>
  17628. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.shortcuts">
  17629. <remarks/>
  17630. </member>
  17631. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.binaries">
  17632. <remarks/>
  17633. </member>
  17634. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.customactions">
  17635. <remarks/>
  17636. </member>
  17637. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.sequences">
  17638. <remarks/>
  17639. </member>
  17640. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.actiontext">
  17641. <remarks/>
  17642. </member>
  17643. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.appmappings">
  17644. <remarks/>
  17645. </member>
  17646. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.urlproperties">
  17647. <remarks/>
  17648. </member>
  17649. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.vdirproperties">
  17650. <remarks/>
  17651. </member>
  17652. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.approots">
  17653. <remarks/>
  17654. </member>
  17655. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.iisproperties">
  17656. <remarks/>
  17657. </member>
  17658. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.failonerror">
  17659. <remarks/>
  17660. </member>
  17661. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.output">
  17662. <remarks/>
  17663. </member>
  17664. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.sourcedir">
  17665. <remarks/>
  17666. </member>
  17667. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.template">
  17668. <remarks/>
  17669. </member>
  17670. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.errortemplate">
  17671. <remarks/>
  17672. </member>
  17673. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.verbose">
  17674. <remarks/>
  17675. </member>
  17676. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.debug">
  17677. <remarks/>
  17678. </member>
  17679. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.deterministicguids">
  17680. <remarks/>
  17681. </member>
  17682. <member name="F:NAnt.Contrib.Schemas.Msi.msi.launchconditions">
  17683. <remarks/>
  17684. </member>
  17685. <member name="F:NAnt.Contrib.Schemas.Msi.msi.features">
  17686. <remarks/>
  17687. </member>
  17688. <member name="F:NAnt.Contrib.Schemas.Msi.msi.mergemodules">
  17689. <remarks/>
  17690. </member>
  17691. <member name="F:NAnt.Contrib.Schemas.Msi.msi.license">
  17692. <remarks/>
  17693. </member>
  17694. <member name="F:NAnt.Contrib.Schemas.Msi.msi.banner">
  17695. <remarks/>
  17696. </member>
  17697. <member name="F:NAnt.Contrib.Schemas.Msi.msi.background">
  17698. <remarks/>
  17699. </member>
  17700. <member name="T:NAnt.Contrib.Schemas.Msi.MSILaunchCondition">
  17701. <remarks/>
  17702. </member>
  17703. <member name="F:NAnt.Contrib.Schemas.Msi.MSILaunchCondition.description">
  17704. <remarks/>
  17705. </member>
  17706. <member name="F:NAnt.Contrib.Schemas.Msi.MSILaunchCondition.name">
  17707. <remarks/>
  17708. </member>
  17709. <member name="F:NAnt.Contrib.Schemas.Msi.MSILaunchCondition.condition">
  17710. <remarks/>
  17711. </member>
  17712. <member name="T:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem">
  17713. <remarks/>
  17714. </member>
  17715. <member name="F:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem.module">
  17716. <remarks/>
  17717. </member>
  17718. <member name="F:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem.name">
  17719. <remarks/>
  17720. </member>
  17721. <member name="F:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem.value">
  17722. <remarks/>
  17723. </member>
  17724. <member name="T:NAnt.Contrib.Schemas.Msi.MSIMerge">
  17725. <remarks/>
  17726. </member>
  17727. <member name="F:NAnt.Contrib.Schemas.Msi.MSIMerge.modules">
  17728. <remarks/>
  17729. </member>
  17730. <member name="F:NAnt.Contrib.Schemas.Msi.MSIMerge.configurationitems">
  17731. <remarks/>
  17732. </member>
  17733. <member name="F:NAnt.Contrib.Schemas.Msi.MSIMerge.feature">
  17734. <remarks/>
  17735. </member>
  17736. <member name="T:NAnt.Contrib.Schemas.Msi.NAntFileSet">
  17737. <remarks/>
  17738. </member>
  17739. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.include">
  17740. <remarks/>
  17741. </member>
  17742. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.exclude">
  17743. <remarks/>
  17744. </member>
  17745. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.includesfile">
  17746. <remarks/>
  17747. </member>
  17748. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.excludesfile">
  17749. <remarks/>
  17750. </member>
  17751. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.includes">
  17752. <remarks/>
  17753. </member>
  17754. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.excludes">
  17755. <remarks/>
  17756. </member>
  17757. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.basedir">
  17758. <remarks/>
  17759. </member>
  17760. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.defaultexcludes">
  17761. <remarks/>
  17762. </member>
  17763. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.failonempty">
  17764. <remarks/>
  17765. </member>
  17766. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.refid">
  17767. <remarks/>
  17768. </member>
  17769. <member name="T:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern">
  17770. <remarks/>
  17771. </member>
  17772. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.name">
  17773. <remarks/>
  17774. </member>
  17775. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.frompath">
  17776. <remarks/>
  17777. </member>
  17778. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.asIs">
  17779. <remarks/>
  17780. </member>
  17781. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.asIsSpecified">
  17782. <remarks/>
  17783. </member>
  17784. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.if">
  17785. <remarks/>
  17786. </member>
  17787. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.unless">
  17788. <remarks/>
  17789. </member>
  17790. <member name="T:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile">
  17791. <remarks/>
  17792. </member>
  17793. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile.name">
  17794. <remarks/>
  17795. </member>
  17796. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile.if">
  17797. <remarks/>
  17798. </member>
  17799. <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile.unless">
  17800. <remarks/>
  17801. </member>
  17802. <member name="T:NAnt.Contrib.Schemas.Msi.MSIFeatureCondition">
  17803. <remarks/>
  17804. </member>
  17805. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeatureCondition.expression">
  17806. <remarks/>
  17807. </member>
  17808. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeatureCondition.level">
  17809. <remarks/>
  17810. </member>
  17811. <member name="T:NAnt.Contrib.Schemas.Msi.MSIFeature">
  17812. <remarks/>
  17813. </member>
  17814. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.description">
  17815. <remarks/>
  17816. </member>
  17817. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.conditions">
  17818. <remarks/>
  17819. </member>
  17820. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.feature">
  17821. <remarks/>
  17822. </member>
  17823. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.name">
  17824. <remarks/>
  17825. </member>
  17826. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.attr">
  17827. <remarks/>
  17828. </member>
  17829. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.title">
  17830. <remarks/>
  17831. </member>
  17832. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.display">
  17833. <remarks/>
  17834. </member>
  17835. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.typical">
  17836. <remarks/>
  17837. </member>
  17838. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.directory">
  17839. <remarks/>
  17840. </member>
  17841. <member name="T:NAnt.Contrib.Schemas.Msi.MSIIISProperty">
  17842. <remarks/>
  17843. </member>
  17844. <member name="F:NAnt.Contrib.Schemas.Msi.MSIIISProperty.directory">
  17845. <remarks/>
  17846. </member>
  17847. <member name="F:NAnt.Contrib.Schemas.Msi.MSIIISProperty.attr">
  17848. <remarks/>
  17849. </member>
  17850. <member name="F:NAnt.Contrib.Schemas.Msi.MSIIISProperty.defaultdoc">
  17851. <remarks/>
  17852. </member>
  17853. <member name="T:NAnt.Contrib.Schemas.Msi.MSIAppRoot">
  17854. <remarks/>
  17855. </member>
  17856. <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppRoot.component">
  17857. <remarks/>
  17858. </member>
  17859. <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppRoot.urlproperty">
  17860. <remarks/>
  17861. </member>
  17862. <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppRoot.inprocflag">
  17863. <remarks/>
  17864. </member>
  17865. <member name="T:NAnt.Contrib.Schemas.Msi.MSIVDirProperty">
  17866. <remarks/>
  17867. </member>
  17868. <member name="F:NAnt.Contrib.Schemas.Msi.MSIVDirProperty.name">
  17869. <remarks/>
  17870. </member>
  17871. <member name="F:NAnt.Contrib.Schemas.Msi.MSIVDirProperty.portproperty">
  17872. <remarks/>
  17873. </member>
  17874. <member name="F:NAnt.Contrib.Schemas.Msi.MSIVDirProperty.urlproperty">
  17875. <remarks/>
  17876. </member>
  17877. <member name="T:NAnt.Contrib.Schemas.Msi.MSIURLProperty">
  17878. <remarks/>
  17879. </member>
  17880. <member name="F:NAnt.Contrib.Schemas.Msi.MSIURLProperty.name">
  17881. <remarks/>
  17882. </member>
  17883. <member name="F:NAnt.Contrib.Schemas.Msi.MSIURLProperty.property">
  17884. <remarks/>
  17885. </member>
  17886. <member name="T:NAnt.Contrib.Schemas.Msi.MSIAppMapping">
  17887. <remarks/>
  17888. </member>
  17889. <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.directory">
  17890. <remarks/>
  17891. </member>
  17892. <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.extension">
  17893. <remarks/>
  17894. </member>
  17895. <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.exepath">
  17896. <remarks/>
  17897. </member>
  17898. <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.verbs">
  17899. <remarks/>
  17900. </member>
  17901. <member name="T:NAnt.Contrib.Schemas.Msi.MSIActionTextAction">
  17902. <remarks/>
  17903. </member>
  17904. <member name="F:NAnt.Contrib.Schemas.Msi.MSIActionTextAction.description">
  17905. <remarks/>
  17906. </member>
  17907. <member name="F:NAnt.Contrib.Schemas.Msi.MSIActionTextAction.name">
  17908. <remarks/>
  17909. </member>
  17910. <member name="F:NAnt.Contrib.Schemas.Msi.MSIActionTextAction.template">
  17911. <remarks/>
  17912. </member>
  17913. <member name="T:NAnt.Contrib.Schemas.Msi.MSISequence">
  17914. <remarks/>
  17915. </member>
  17916. <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.type">
  17917. <remarks/>
  17918. </member>
  17919. <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.action">
  17920. <remarks/>
  17921. </member>
  17922. <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.value">
  17923. <remarks/>
  17924. </member>
  17925. <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.condition">
  17926. <remarks/>
  17927. </member>
  17928. <member name="T:NAnt.Contrib.Schemas.Msi.MSISequenceTable">
  17929. <remarks/>
  17930. </member>
  17931. <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.installexecute">
  17932. <remarks/>
  17933. </member>
  17934. <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.installui">
  17935. <remarks/>
  17936. </member>
  17937. <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.adminexecute">
  17938. <remarks/>
  17939. </member>
  17940. <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.adminui">
  17941. <remarks/>
  17942. </member>
  17943. <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.advtexecute">
  17944. <remarks/>
  17945. </member>
  17946. <member name="T:NAnt.Contrib.Schemas.Msi.MSICustomAction">
  17947. <remarks/>
  17948. </member>
  17949. <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.action">
  17950. <remarks/>
  17951. </member>
  17952. <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.type">
  17953. <remarks/>
  17954. </member>
  17955. <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.source">
  17956. <remarks/>
  17957. </member>
  17958. <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.target">
  17959. <remarks/>
  17960. </member>
  17961. <member name="T:NAnt.Contrib.Schemas.Msi.MSIBinary">
  17962. <remarks/>
  17963. </member>
  17964. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBinary.name">
  17965. <remarks/>
  17966. </member>
  17967. <member name="F:NAnt.Contrib.Schemas.Msi.MSIBinary.value">
  17968. <remarks/>
  17969. </member>
  17970. <member name="T:NAnt.Contrib.Schemas.Msi.MSIShortcut">
  17971. <remarks/>
  17972. </member>
  17973. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.description">
  17974. <remarks/>
  17975. </member>
  17976. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.name">
  17977. <remarks/>
  17978. </member>
  17979. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.directory">
  17980. <remarks/>
  17981. </member>
  17982. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.filename">
  17983. <remarks/>
  17984. </member>
  17985. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.component">
  17986. <remarks/>
  17987. </member>
  17988. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.target">
  17989. <remarks/>
  17990. </member>
  17991. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.arguments">
  17992. <remarks/>
  17993. </member>
  17994. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.hotkey">
  17995. <remarks/>
  17996. </member>
  17997. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.icon">
  17998. <remarks/>
  17999. </member>
  18000. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.iconindex">
  18001. <remarks/>
  18002. </member>
  18003. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.iconindexSpecified">
  18004. <remarks/>
  18005. </member>
  18006. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.showcmd">
  18007. <remarks/>
  18008. </member>
  18009. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.showcmdSpecified">
  18010. <remarks/>
  18011. </member>
  18012. <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.wkdir">
  18013. <remarks/>
  18014. </member>
  18015. <member name="T:NAnt.Contrib.Schemas.Msi.MSIIcon">
  18016. <remarks/>
  18017. </member>
  18018. <member name="F:NAnt.Contrib.Schemas.Msi.MSIIcon.name">
  18019. <remarks/>
  18020. </member>
  18021. <member name="F:NAnt.Contrib.Schemas.Msi.MSIIcon.value">
  18022. <remarks/>
  18023. </member>
  18024. <member name="T:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue">
  18025. <remarks/>
  18026. </member>
  18027. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.name">
  18028. <remarks/>
  18029. </member>
  18030. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.value">
  18031. <remarks/>
  18032. </member>
  18033. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.dword">
  18034. <remarks/>
  18035. </member>
  18036. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.id">
  18037. <remarks/>
  18038. </member>
  18039. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.Value">
  18040. <remarks/>
  18041. </member>
  18042. <member name="T:NAnt.Contrib.Schemas.Msi.MSIRegistryKey">
  18043. <remarks/>
  18044. </member>
  18045. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.value">
  18046. <remarks/>
  18047. </member>
  18048. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.path">
  18049. <remarks/>
  18050. </member>
  18051. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.root">
  18052. <remarks/>
  18053. </member>
  18054. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.component">
  18055. <remarks/>
  18056. </member>
  18057. <member name="T:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot">
  18058. <remarks/>
  18059. </member>
  18060. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.dependent">
  18061. <remarks/>
  18062. </member>
  18063. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.machine">
  18064. <remarks/>
  18065. </member>
  18066. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.classes">
  18067. <remarks/>
  18068. </member>
  18069. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.users">
  18070. <remarks/>
  18071. </member>
  18072. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.user">
  18073. <remarks/>
  18074. </member>
  18075. <member name="T:NAnt.Contrib.Schemas.Msi.MSIControlEvent">
  18076. <remarks/>
  18077. </member>
  18078. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.dialog">
  18079. <remarks/>
  18080. </member>
  18081. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.control">
  18082. <remarks/>
  18083. </member>
  18084. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.name">
  18085. <remarks/>
  18086. </member>
  18087. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.argument">
  18088. <remarks/>
  18089. </member>
  18090. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.condition">
  18091. <remarks/>
  18092. </member>
  18093. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.order">
  18094. <remarks/>
  18095. </member>
  18096. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.orderSpecified">
  18097. <remarks/>
  18098. </member>
  18099. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.remove">
  18100. <remarks/>
  18101. </member>
  18102. <member name="T:NAnt.Contrib.Schemas.Msi.MSIControlCondition">
  18103. <remarks/>
  18104. </member>
  18105. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.dialog">
  18106. <remarks/>
  18107. </member>
  18108. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.control">
  18109. <remarks/>
  18110. </member>
  18111. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.action">
  18112. <remarks/>
  18113. </member>
  18114. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.condition">
  18115. <remarks/>
  18116. </member>
  18117. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.remove">
  18118. <remarks/>
  18119. </member>
  18120. <member name="T:NAnt.Contrib.Schemas.Msi.MSIControl">
  18121. <remarks/>
  18122. </member>
  18123. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.name">
  18124. <remarks/>
  18125. </member>
  18126. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.dialog">
  18127. <remarks/>
  18128. </member>
  18129. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.type">
  18130. <remarks/>
  18131. </member>
  18132. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.x">
  18133. <remarks/>
  18134. </member>
  18135. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.y">
  18136. <remarks/>
  18137. </member>
  18138. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.width">
  18139. <remarks/>
  18140. </member>
  18141. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.height">
  18142. <remarks/>
  18143. </member>
  18144. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.attr">
  18145. <remarks/>
  18146. </member>
  18147. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.property">
  18148. <remarks/>
  18149. </member>
  18150. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.text">
  18151. <remarks/>
  18152. </member>
  18153. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.nextcontrol">
  18154. <remarks/>
  18155. </member>
  18156. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.help">
  18157. <remarks/>
  18158. </member>
  18159. <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.remove">
  18160. <remarks/>
  18161. </member>
  18162. <member name="T:NAnt.Contrib.Schemas.Msi.MSIDialog">
  18163. <remarks/>
  18164. </member>
  18165. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.name">
  18166. <remarks/>
  18167. </member>
  18168. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.hcenter">
  18169. <remarks/>
  18170. </member>
  18171. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.vcenter">
  18172. <remarks/>
  18173. </member>
  18174. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.width">
  18175. <remarks/>
  18176. </member>
  18177. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.height">
  18178. <remarks/>
  18179. </member>
  18180. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.attr">
  18181. <remarks/>
  18182. </member>
  18183. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.title">
  18184. <remarks/>
  18185. </member>
  18186. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.firstcontrol">
  18187. <remarks/>
  18188. </member>
  18189. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.defaultcontrol">
  18190. <remarks/>
  18191. </member>
  18192. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.cancelcontrol">
  18193. <remarks/>
  18194. </member>
  18195. <member name="T:NAnt.Contrib.Schemas.Msi.MSIFileOverride">
  18196. <remarks/>
  18197. </member>
  18198. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.file">
  18199. <remarks/>
  18200. </member>
  18201. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.id">
  18202. <remarks/>
  18203. </member>
  18204. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.attr">
  18205. <remarks/>
  18206. </member>
  18207. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.version">
  18208. <remarks/>
  18209. </member>
  18210. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.language">
  18211. <remarks/>
  18212. </member>
  18213. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.checkinterop">
  18214. <remarks/>
  18215. </member>
  18216. <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.installtogac">
  18217. <remarks/>
  18218. </member>
  18219. <member name="T:NAnt.Contrib.Schemas.Msi.MSIKeyFile">
  18220. <remarks/>
  18221. </member>
  18222. <member name="F:NAnt.Contrib.Schemas.Msi.MSIKeyFile.file">
  18223. <remarks/>
  18224. </member>
  18225. <member name="T:NAnt.Contrib.Schemas.Msi.MSIComponent">
  18226. <remarks/>
  18227. </member>
  18228. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.key">
  18229. <remarks/>
  18230. </member>
  18231. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.fileset">
  18232. <remarks/>
  18233. </member>
  18234. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.forceid">
  18235. <remarks/>
  18236. </member>
  18237. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.name">
  18238. <remarks/>
  18239. </member>
  18240. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.id">
  18241. <remarks/>
  18242. </member>
  18243. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.attr">
  18244. <remarks/>
  18245. </member>
  18246. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.directory">
  18247. <remarks/>
  18248. </member>
  18249. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.feature">
  18250. <remarks/>
  18251. </member>
  18252. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.condition">
  18253. <remarks/>
  18254. </member>
  18255. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.fileattr">
  18256. <remarks/>
  18257. </member>
  18258. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.checkinterop">
  18259. <remarks/>
  18260. </member>
  18261. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.installassembliestogac">
  18262. <remarks/>
  18263. </member>
  18264. <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.keepsubdirs">
  18265. <remarks/>
  18266. </member>
  18267. <member name="T:NAnt.Contrib.Schemas.Msi.MSIVariable">
  18268. <remarks/>
  18269. </member>
  18270. <member name="F:NAnt.Contrib.Schemas.Msi.MSIVariable.name">
  18271. <remarks/>
  18272. </member>
  18273. <member name="F:NAnt.Contrib.Schemas.Msi.MSIVariable.append">
  18274. <remarks/>
  18275. </member>
  18276. <member name="F:NAnt.Contrib.Schemas.Msi.MSIVariable.component">
  18277. <remarks/>
  18278. </member>
  18279. <member name="T:NAnt.Contrib.Schemas.Msi.MSIDirectory">
  18280. <remarks/>
  18281. </member>
  18282. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDirectory.directory">
  18283. <remarks/>
  18284. </member>
  18285. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDirectory.name">
  18286. <remarks/>
  18287. </member>
  18288. <member name="F:NAnt.Contrib.Schemas.Msi.MSIDirectory.foldername">
  18289. <remarks/>
  18290. </member>
  18291. <member name="T:NAnt.Contrib.Schemas.Msi.MSIRootDirectory">
  18292. <remarks/>
  18293. </member>
  18294. <member name="F:NAnt.Contrib.Schemas.Msi.MSIRootDirectory.root">
  18295. <remarks/>
  18296. </member>
  18297. <member name="T:NAnt.Contrib.Schemas.Msi.MSITableRowColumnData">
  18298. <remarks/>
  18299. </member>
  18300. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableRowColumnData.name">
  18301. <remarks/>
  18302. </member>
  18303. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableRowColumnData.value">
  18304. <remarks/>
  18305. </member>
  18306. <member name="T:NAnt.Contrib.Schemas.Msi.MSITableRow">
  18307. <remarks/>
  18308. </member>
  18309. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableRow.columns">
  18310. <remarks/>
  18311. </member>
  18312. <member name="T:NAnt.Contrib.Schemas.Msi.MSITableColumn">
  18313. <remarks/>
  18314. </member>
  18315. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.name">
  18316. <remarks/>
  18317. </member>
  18318. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.nullable">
  18319. <remarks/>
  18320. </member>
  18321. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.category">
  18322. <remarks/>
  18323. </member>
  18324. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.categorySpecified">
  18325. <remarks/>
  18326. </member>
  18327. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.type">
  18328. <remarks/>
  18329. </member>
  18330. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.key">
  18331. <remarks/>
  18332. </member>
  18333. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.minvalue">
  18334. <remarks/>
  18335. </member>
  18336. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.minvalueSpecified">
  18337. <remarks/>
  18338. </member>
  18339. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.maxvalue">
  18340. <remarks/>
  18341. </member>
  18342. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.maxvalueSpecified">
  18343. <remarks/>
  18344. </member>
  18345. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.keytable">
  18346. <remarks/>
  18347. </member>
  18348. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.keycolumn">
  18349. <remarks/>
  18350. </member>
  18351. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.keycolumnSpecified">
  18352. <remarks/>
  18353. </member>
  18354. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.set">
  18355. <remarks/>
  18356. </member>
  18357. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.description">
  18358. <remarks/>
  18359. </member>
  18360. <member name="T:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType">
  18361. <remarks/>
  18362. </member>
  18363. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Text">
  18364. <remarks/>
  18365. </member>
  18366. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.UpperCase">
  18367. <remarks/>
  18368. </member>
  18369. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.LowerCase">
  18370. <remarks/>
  18371. </member>
  18372. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Integer">
  18373. <remarks/>
  18374. </member>
  18375. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.DoubleInteger">
  18376. <remarks/>
  18377. </member>
  18378. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.TimeDate">
  18379. <remarks/>
  18380. </member>
  18381. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Identifier">
  18382. <remarks/>
  18383. </member>
  18384. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Property">
  18385. <remarks/>
  18386. </member>
  18387. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Filename">
  18388. <remarks/>
  18389. </member>
  18390. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.WildCardFilename">
  18391. <remarks/>
  18392. </member>
  18393. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Path">
  18394. <remarks/>
  18395. </member>
  18396. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Paths">
  18397. <remarks/>
  18398. </member>
  18399. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.AnyPath">
  18400. <remarks/>
  18401. </member>
  18402. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.DefaultDir">
  18403. <remarks/>
  18404. </member>
  18405. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.RegPath">
  18406. <remarks/>
  18407. </member>
  18408. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Formatted">
  18409. <remarks/>
  18410. </member>
  18411. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Template">
  18412. <remarks/>
  18413. </member>
  18414. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Condition">
  18415. <remarks/>
  18416. </member>
  18417. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.GUID">
  18418. <remarks/>
  18419. </member>
  18420. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Version">
  18421. <remarks/>
  18422. </member>
  18423. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Language">
  18424. <remarks/>
  18425. </member>
  18426. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Binary">
  18427. <remarks/>
  18428. </member>
  18429. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Cabinet">
  18430. <remarks/>
  18431. </member>
  18432. <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Shortcut">
  18433. <remarks/>
  18434. </member>
  18435. <member name="T:NAnt.Contrib.Schemas.Msi.MSITable">
  18436. <remarks/>
  18437. </member>
  18438. <member name="F:NAnt.Contrib.Schemas.Msi.MSITable.columns">
  18439. <remarks/>
  18440. </member>
  18441. <member name="F:NAnt.Contrib.Schemas.Msi.MSITable.rows">
  18442. <remarks/>
  18443. </member>
  18444. <member name="F:NAnt.Contrib.Schemas.Msi.MSITable.name">
  18445. <remarks/>
  18446. </member>
  18447. <member name="T:NAnt.Contrib.Schemas.Msi.searchKeyValue">
  18448. <remarks/>
  18449. </member>
  18450. <member name="F:NAnt.Contrib.Schemas.Msi.searchKeyValue.name">
  18451. <remarks/>
  18452. </member>
  18453. <member name="F:NAnt.Contrib.Schemas.Msi.searchKeyValue.setproperty">
  18454. <remarks/>
  18455. </member>
  18456. <member name="T:NAnt.Contrib.Schemas.Msi.searchKey">
  18457. <remarks/>
  18458. </member>
  18459. <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.value">
  18460. <remarks/>
  18461. </member>
  18462. <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.type">
  18463. <remarks/>
  18464. </member>
  18465. <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.path">
  18466. <remarks/>
  18467. </member>
  18468. <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.root">
  18469. <remarks/>
  18470. </member>
  18471. <member name="T:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64">
  18472. <remarks/>
  18473. </member>
  18474. <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.registry">
  18475. <remarks/>
  18476. </member>
  18477. <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.file">
  18478. <remarks/>
  18479. </member>
  18480. <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.directory">
  18481. <remarks/>
  18482. </member>
  18483. <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.Item64bit">
  18484. <remarks/>
  18485. </member>
  18486. <member name="T:NAnt.Contrib.Schemas.Msi.searchDirfileFile">
  18487. <remarks/>
  18488. </member>
  18489. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.name">
  18490. <remarks/>
  18491. </member>
  18492. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.minversion">
  18493. <remarks/>
  18494. </member>
  18495. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxversion">
  18496. <remarks/>
  18497. </member>
  18498. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.minsize">
  18499. <remarks/>
  18500. </member>
  18501. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.minsizeSpecified">
  18502. <remarks/>
  18503. </member>
  18504. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxsize">
  18505. <remarks/>
  18506. </member>
  18507. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxsizeSpecified">
  18508. <remarks/>
  18509. </member>
  18510. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.mindate">
  18511. <remarks/>
  18512. </member>
  18513. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.mindateSpecified">
  18514. <remarks/>
  18515. </member>
  18516. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxdate">
  18517. <remarks/>
  18518. </member>
  18519. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxdateSpecified">
  18520. <remarks/>
  18521. </member>
  18522. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.languages">
  18523. <remarks/>
  18524. </member>
  18525. <member name="T:NAnt.Contrib.Schemas.Msi.searchDirfile">
  18526. <remarks/>
  18527. </member>
  18528. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.file">
  18529. <remarks/>
  18530. </member>
  18531. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.parent">
  18532. <remarks/>
  18533. </member>
  18534. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.path">
  18535. <remarks/>
  18536. </member>
  18537. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.depth">
  18538. <remarks/>
  18539. </member>
  18540. <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.setproperty">
  18541. <remarks/>
  18542. </member>
  18543. <member name="T:NAnt.Contrib.Schemas.Msi.searchIni">
  18544. <remarks/>
  18545. </member>
  18546. <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.filename">
  18547. <remarks/>
  18548. </member>
  18549. <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.section">
  18550. <remarks/>
  18551. </member>
  18552. <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.key">
  18553. <remarks/>
  18554. </member>
  18555. <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.field">
  18556. <remarks/>
  18557. </member>
  18558. <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.type">
  18559. <remarks/>
  18560. </member>
  18561. <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.setproperty">
  18562. <remarks/>
  18563. </member>
  18564. <member name="T:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw">
  18565. <remarks/>
  18566. </member>
  18567. <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw.directory">
  18568. <remarks/>
  18569. </member>
  18570. <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw.file">
  18571. <remarks/>
  18572. </member>
  18573. <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw.raw">
  18574. <remarks/>
  18575. </member>
  18576. <member name="T:NAnt.Contrib.Schemas.Msi.searchRegistryValue">
  18577. <remarks/>
  18578. </member>
  18579. <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistryValue.name">
  18580. <remarks/>
  18581. </member>
  18582. <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistryValue.setproperty">
  18583. <remarks/>
  18584. </member>
  18585. <member name="T:NAnt.Contrib.Schemas.Msi.searchRegistry">
  18586. <remarks/>
  18587. </member>
  18588. <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.value">
  18589. <remarks/>
  18590. </member>
  18591. <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.type">
  18592. <remarks/>
  18593. </member>
  18594. <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.path">
  18595. <remarks/>
  18596. </member>
  18597. <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.root">
  18598. <remarks/>
  18599. </member>
  18600. <member name="T:NAnt.Contrib.Schemas.Msi.searchApp">
  18601. <remarks/>
  18602. </member>
  18603. <member name="F:NAnt.Contrib.Schemas.Msi.searchApp.componentid">
  18604. <remarks/>
  18605. </member>
  18606. <member name="F:NAnt.Contrib.Schemas.Msi.searchApp.type">
  18607. <remarks/>
  18608. </member>
  18609. <member name="F:NAnt.Contrib.Schemas.Msi.searchApp.setproperty">
  18610. <remarks/>
  18611. </member>
  18612. <member name="T:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFile">
  18613. <remarks/>
  18614. </member>
  18615. <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFile.directory">
  18616. <remarks/>
  18617. </member>
  18618. <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFile.file">
  18619. <remarks/>
  18620. </member>
  18621. <member name="T:NAnt.Contrib.Schemas.Msi.search">
  18622. <remarks/>
  18623. </member>
  18624. <member name="F:NAnt.Contrib.Schemas.Msi.search.app">
  18625. <remarks/>
  18626. </member>
  18627. <member name="F:NAnt.Contrib.Schemas.Msi.search.registry">
  18628. <remarks/>
  18629. </member>
  18630. <member name="F:NAnt.Contrib.Schemas.Msi.search.ini">
  18631. <remarks/>
  18632. </member>
  18633. <member name="F:NAnt.Contrib.Schemas.Msi.search.dirfile">
  18634. <remarks/>
  18635. </member>
  18636. <member name="F:NAnt.Contrib.Schemas.Msi.search.key">
  18637. <remarks/>
  18638. </member>
  18639. <member name="T:NAnt.Contrib.Schemas.Msi.property">
  18640. <remarks/>
  18641. </member>
  18642. <member name="F:NAnt.Contrib.Schemas.Msi.property.name">
  18643. <remarks/>
  18644. </member>
  18645. <member name="F:NAnt.Contrib.Schemas.Msi.property.value">
  18646. <remarks/>
  18647. </member>
  18648. <member name="T:NAnt.Contrib.Schemas.Msi.summaryinformation">
  18649. <remarks/>
  18650. </member>
  18651. <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.title">
  18652. <remarks/>
  18653. </member>
  18654. <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.subject">
  18655. <remarks/>
  18656. </member>
  18657. <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.author">
  18658. <remarks/>
  18659. </member>
  18660. <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.keywords">
  18661. <remarks/>
  18662. </member>
  18663. <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.comments">
  18664. <remarks/>
  18665. </member>
  18666. <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.template">
  18667. <remarks/>
  18668. </member>
  18669. <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.revisionnumber">
  18670. <remarks/>
  18671. </member>
  18672. <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.creatingapplication">
  18673. <remarks/>
  18674. </member>
  18675. <member name="T:NAnt.Contrib.Schemas.Msi.msm">
  18676. <remarks/>
  18677. </member>
  18678. <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduledependencies">
  18679. <remarks/>
  18680. </member>
  18681. <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduleexclusions">
  18682. <remarks/>
  18683. </member>
  18684. <member name="F:NAnt.Contrib.Schemas.Msi.msm.modulesequences">
  18685. <remarks/>
  18686. </member>
  18687. <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduleignoretables">
  18688. <remarks/>
  18689. </member>
  18690. <member name="F:NAnt.Contrib.Schemas.Msi.msm.modulesubstitutions">
  18691. <remarks/>
  18692. </member>
  18693. <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduleconfigurations">
  18694. <remarks/>
  18695. </member>
  18696. <member name="F:NAnt.Contrib.Schemas.Msi.msm.id">
  18697. <remarks/>
  18698. </member>
  18699. <member name="F:NAnt.Contrib.Schemas.Msi.msm.language">
  18700. <remarks/>
  18701. </member>
  18702. <member name="F:NAnt.Contrib.Schemas.Msi.msm.version">
  18703. <remarks/>
  18704. </member>
  18705. <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleDependency">
  18706. <remarks/>
  18707. </member>
  18708. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleDependency.id">
  18709. <remarks/>
  18710. </member>
  18711. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleDependency.language">
  18712. <remarks/>
  18713. </member>
  18714. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleDependency.version">
  18715. <remarks/>
  18716. </member>
  18717. <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion">
  18718. <remarks/>
  18719. </member>
  18720. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.id">
  18721. <remarks/>
  18722. </member>
  18723. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.language">
  18724. <remarks/>
  18725. </member>
  18726. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.minversion">
  18727. <remarks/>
  18728. </member>
  18729. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.maxversion">
  18730. <remarks/>
  18731. </member>
  18732. <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleSequence">
  18733. <remarks/>
  18734. </member>
  18735. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.type">
  18736. <remarks/>
  18737. </member>
  18738. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.action">
  18739. <remarks/>
  18740. </member>
  18741. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.sequence">
  18742. <remarks/>
  18743. </member>
  18744. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.sequenceSpecified">
  18745. <remarks/>
  18746. </member>
  18747. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.baseaction">
  18748. <remarks/>
  18749. </member>
  18750. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.after">
  18751. <remarks/>
  18752. </member>
  18753. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.condition">
  18754. <remarks/>
  18755. </member>
  18756. <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleIgnoreTable">
  18757. <remarks/>
  18758. </member>
  18759. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleIgnoreTable.name">
  18760. <remarks/>
  18761. </member>
  18762. <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution">
  18763. <remarks/>
  18764. </member>
  18765. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.table">
  18766. <remarks/>
  18767. </member>
  18768. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.row">
  18769. <remarks/>
  18770. </member>
  18771. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.column">
  18772. <remarks/>
  18773. </member>
  18774. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.value">
  18775. <remarks/>
  18776. </member>
  18777. <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration">
  18778. <remarks/>
  18779. </member>
  18780. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.name">
  18781. <remarks/>
  18782. </member>
  18783. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.format">
  18784. <remarks/>
  18785. </member>
  18786. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.type">
  18787. <remarks/>
  18788. </member>
  18789. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.contextdata">
  18790. <remarks/>
  18791. </member>
  18792. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.defaultvalue">
  18793. <remarks/>
  18794. </member>
  18795. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.attr">
  18796. <remarks/>
  18797. </member>
  18798. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.displayname">
  18799. <remarks/>
  18800. </member>
  18801. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.description">
  18802. <remarks/>
  18803. </member>
  18804. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.helplocation">
  18805. <remarks/>
  18806. </member>
  18807. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.helpkeyword">
  18808. <remarks/>
  18809. </member>
  18810. <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat">
  18811. <remarks/>
  18812. </member>
  18813. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.text">
  18814. <remarks/>
  18815. </member>
  18816. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.key">
  18817. <remarks/>
  18818. </member>
  18819. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.integer">
  18820. <remarks/>
  18821. </member>
  18822. <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.bitfield">
  18823. <remarks/>
  18824. </member>
  18825. </members>
  18826. </doc>