System.Net.FtpClient.XML 218 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Net.FtpClient</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Net.FtpClient.Extensions.ChecksumExtension">
  8. <summary>
  9. Retrieve checksum of file on the server
  10. </summary>
  11. </member>
  12. <member name="M:System.Net.FtpClient.Extensions.ChecksumExtension.GetChecksum(System.Net.FtpClient.FtpClient,System.String)">
  13. <summary>
  14. Retrieves a checksum of the given file using a checksumming method
  15. that the server supports, if any. The algorithm used goes in this order:
  16. 1. HASH command; server preferred algorithm. See FtpClient.SetHashAlgorithm()
  17. 2. MD5 / XMD5 commands
  18. 3. XSHA1 command
  19. 4. XSHA256 command
  20. 5. XSHA512 command
  21. 6. XCRC command
  22. </summary>
  23. <param name="client">FtpClient Object</param>
  24. <param name="path">Full or relative path of the file to checksum</param>
  25. <returns>FtpHash object containing the value and algorithm. Use the IsValid property to
  26. determine if this command was successfull. FtpCommandException's can be thrown from
  27. the underlying calls.</returns>
  28. <example><code source="..\Examples\GetChecksum.cs" lang="cs" /></example>
  29. </member>
  30. <member name="M:System.Net.FtpClient.Extensions.ChecksumExtension.BeginGetChecksum(System.Net.FtpClient.FtpClient,System.String,System.AsyncCallback,System.Object)">
  31. <summary>
  32. Asynchronusly retrieve a checksum of the specified file. This feature
  33. is non-standard.
  34. </summary>
  35. <param name="client">FtpClient Object</param>
  36. <param name="path">Full or relative path to remote file</param>
  37. <param name="callback">AsyncCallback</param>
  38. <param name="state">State Object</param>
  39. <returns>IAsyncResult</returns>
  40. </member>
  41. <member name="M:System.Net.FtpClient.Extensions.ChecksumExtension.EndGetChecksum(System.IAsyncResult)">
  42. <summary>
  43. Ends an asynchronous call to BeginGetChecksum()
  44. </summary>
  45. <param name="ar">IAsyncResult returned from BeginGetChecksum()</param>
  46. <returns>FtpHash object containing the value and algorithm. Use the IsValid property to
  47. determine if this command was successfull. FtpCommandException's can be thrown from
  48. the underlying calls.</returns>
  49. </member>
  50. <member name="T:System.Net.FtpClient.Extensions.MD5">
  51. <summary>
  52. Implementation of the non-standard MD5 command
  53. </summary>
  54. </member>
  55. <member name="M:System.Net.FtpClient.Extensions.MD5.GetMD5(System.Net.FtpClient.FtpClient,System.String)">
  56. <summary>
  57. Gets the MD5 hash of the specified file using MD5. This is a non-standard extension
  58. to the protocol and may or may not work. A FtpCommandException will be
  59. thrown if the command fails.
  60. </summary>
  61. <param name="client">FtpClient Object</param>
  62. <param name="path">Full or relative path to remote file</param>
  63. <returns>Server response, presumably the MD5 hash.</returns>
  64. </member>
  65. <member name="M:System.Net.FtpClient.Extensions.MD5.BeginGetMD5(System.Net.FtpClient.FtpClient,System.String,System.AsyncCallback,System.Object)">
  66. <summary>
  67. Asynchronusly retrieve a MD5 hash. The MD5 command is non-standard
  68. and not guaranteed to work.
  69. </summary>
  70. <param name="client">FtpClient Object</param>
  71. <param name="path">Full or relative path to remote file</param>
  72. <param name="callback">AsyncCallback</param>
  73. <param name="state">State Object</param>
  74. <returns>IAsyncResult</returns>
  75. </member>
  76. <member name="M:System.Net.FtpClient.Extensions.MD5.EndGetMD5(System.IAsyncResult)">
  77. <summary>
  78. Ends an asynchronous call to BeginGetMD5()
  79. </summary>
  80. <param name="ar">IAsyncResult returned from BeginGetMD5()</param>
  81. <returns>The MD5 hash of the specified file.</returns>
  82. </member>
  83. <member name="T:System.Net.FtpClient.FtpSslValidation">
  84. <summary>
  85. Event is fired when a ssl certificate needs to be validated
  86. </summary>
  87. <param name="control">The contol connection that triggered the event</param>
  88. <param name="e">Event args</param>
  89. </member>
  90. <member name="T:System.Net.FtpClient.FtpClient">
  91. <summary>
  92. FTP Control Connection. Speaks the FTP protocol with the server and
  93. provides facilities for performing basic transactions.
  94. Debugging problems with FTP transactions is much easier to do when
  95. you can see exactly what is sent to the server and the reply
  96. System.Net.FtpClient gets in return. Please review the Debug example
  97. below for information on how to add TraceListeners for capturing
  98. the convorsation between System.Net.FtpClient and the server.
  99. </summary>
  100. <example>The following example illustrates how to assist in debugging
  101. System.Net.FtpClient by getting a transaction log from the server.
  102. <code source="..\Examples\Debug.cs" lang="cs" />
  103. </example>
  104. <example>The following example demonstrates adding a custom file
  105. listing parser in the event that you encounter a list format
  106. not already supported.
  107. <code source="..\Examples\CustomParser.cs" lang="cs" />
  108. </example>
  109. <example>The following example demonstrates how to validate
  110. a SSL certificate when using SSL/TLS.
  111. <code source="..\Examples\ValidateCertificate.cs" lang="cs" />
  112. </example>
  113. <example>The following example demonsrates how to download a file.
  114. <code source="..\Examples\OpenRead.cs" lang="cs" />
  115. </example>
  116. <example>The following example demonstrates how to download a file
  117. using a URI object.
  118. <code source="..\Examples\OpenReadURI.cs" lang="cs" />
  119. </example>
  120. <example>The following example demonstrates how to upload a file.
  121. <code source="..\Examples\OpenWrite.cs" lang="cs" />
  122. </example>
  123. <example>The following example demonstrates how to upload a file
  124. using a URI object.
  125. <code source="..\Examples\OpenWriteURI.cs" lang="cs" />
  126. </example>
  127. <example>The following example demonstrates how to append to a file.
  128. <code source="..\Examples\OpenAppend.cs" lang="cs" />
  129. </example>
  130. <example>The following example demonstrates how to append to a file
  131. using a URI object.
  132. <code source="..\Examples\OpenAppendURI.cs" lang="cs" />
  133. </example>
  134. <example>The following example demonstrates how to get a file
  135. listing from the server.
  136. <code source="..\Examples\GetListing.cs" lang="cs" />
  137. </example>
  138. </member>
  139. <member name="T:System.Net.FtpClient.IFtpClient">
  140. <summary>
  141. FTP Control Connection. Speaks the FTP protocol with the server and
  142. provides facilities for performing basic transactions.
  143. Debugging problems with FTP transactions is much easier to do when
  144. you can see exactly what is sent to the server and the reply
  145. System.Net.FtpClient gets in return. Please review the Debug example
  146. below for information on how to add TraceListeners for capturing
  147. the convorsation between System.Net.FtpClient and the server.
  148. </summary>
  149. <example>The following example illustrates how to assist in debugging
  150. System.Net.FtpClient by getting a transaction log from the server.
  151. <code source="..\Examples\Debug.cs" lang="cs" />
  152. </example>
  153. <example>The following example demonstrates adding a custom file
  154. listing parser in the event that you encounter a list format
  155. not already supported.
  156. <code source="..\Examples\CustomParser.cs" lang="cs" />
  157. </example>
  158. <example>The following example demonstrates how to validate
  159. a SSL certificate when using SSL/TLS.
  160. <code source="..\Examples\ValidateCertificate.cs" lang="cs" />
  161. </example>
  162. <example>The following example demonsrates how to download a file.
  163. <code source="..\Examples\OpenRead.cs" lang="cs" />
  164. </example>
  165. <example>The following example demonstrates how to download a file
  166. using a URI object.
  167. <code source="..\Examples\OpenReadURI.cs" lang="cs" />
  168. </example>
  169. <example>The following example demonstrates how to upload a file.
  170. <code source="..\Examples\OpenWrite.cs" lang="cs" />
  171. </example>
  172. <example>The following example demonstrates how to upload a file
  173. using a URI object.
  174. <code source="..\Examples\OpenWriteURI.cs" lang="cs" />
  175. </example>
  176. <example>The following example demonstrates how to append to a file.
  177. <code source="..\Examples\OpenAppend.cs" lang="cs" />
  178. </example>
  179. <example>The following example demonstrates how to append to a file
  180. using a URI object.
  181. <code source="..\Examples\OpenAppendURI.cs" lang="cs" />
  182. </example>
  183. <example>The following example demonstrates how to get a file
  184. listing from the server.
  185. <code source="..\Examples\GetListing.cs" lang="cs" />
  186. </example>
  187. </member>
  188. <member name="M:System.Net.FtpClient.IFtpClient.HasFeature(System.Net.FtpClient.FtpCapability)">
  189. <summary>
  190. Performs a bitwise and to check if the specified
  191. flag is set on the Capabilities enum property.
  192. </summary>
  193. <param name="cap">The capability to check for</param>
  194. <returns>True if the feature was found</returns>
  195. </member>
  196. <member name="M:System.Net.FtpClient.IFtpClient.Execute(System.String,System.Object[])">
  197. <summary>
  198. Executes a command
  199. </summary>
  200. <param name="command">The command to execute with optional format place holders</param>
  201. <param name="args">Format parameters to the command</param>
  202. <returns>The servers reply to the command</returns>
  203. <example><code source="..\Examples\Execute.cs" lang="cs" /></example>
  204. </member>
  205. <member name="M:System.Net.FtpClient.IFtpClient.Execute(System.String)">
  206. <summary>
  207. Executes a command
  208. </summary>
  209. <param name="command">The command to execute</param>
  210. <returns>The servers reply to the command</returns>
  211. <example><code source="..\Examples\Execute.cs" lang="cs" /></example>
  212. </member>
  213. <member name="M:System.Net.FtpClient.IFtpClient.BeginExecute(System.String,System.AsyncCallback,System.Object)">
  214. <summary>
  215. Performs an asynchronouse execution of the specified command
  216. </summary>
  217. <param name="command">The command to execute</param>
  218. <param name="callback">The AsyncCallback method</param>
  219. <param name="state">State object</param>
  220. <returns>IAsyncResult</returns>
  221. <example><code source="..\Examples\BeginExecute.cs" lang="cs" /></example>
  222. </member>
  223. <member name="M:System.Net.FtpClient.IFtpClient.EndExecute(System.IAsyncResult)">
  224. <summary>
  225. Ends an asynchronous command
  226. </summary>
  227. <param name="ar">IAsyncResult returned from BeginExecute</param>
  228. <returns>FtpReply object (never null).</returns>
  229. <example><code source="..\Examples\BeginExecute.cs" lang="cs" /></example>
  230. </member>
  231. <member name="M:System.Net.FtpClient.IFtpClient.Connect">
  232. <summary>
  233. Connect to the server. Throws ObjectDisposedException if this object has been disposed.
  234. </summary>
  235. <example><code source="..\Examples\Connect.cs" lang="cs" /></example>
  236. </member>
  237. <member name="M:System.Net.FtpClient.IFtpClient.BeginConnect(System.AsyncCallback,System.Object)">
  238. <summary>
  239. Initiates a connection to the server
  240. </summary>
  241. <param name="callback">AsyncCallback method</param>
  242. <param name="state">State object</param>
  243. <returns>IAsyncResult</returns>
  244. <example><code source="..\Examples\BeginConnect.cs" lang="cs" /></example>
  245. </member>
  246. <member name="M:System.Net.FtpClient.IFtpClient.EndConnect(System.IAsyncResult)">
  247. <summary>
  248. Ends an asynchronous connection attempt to the server
  249. </summary>
  250. <param name="ar">IAsyncResult returned from BeginConnect()</param>
  251. <example><code source="..\Examples\BeginConnect.cs" lang="cs" /></example>
  252. </member>
  253. <member name="M:System.Net.FtpClient.IFtpClient.Disconnect">
  254. <summary>
  255. Disconnect from the server
  256. </summary>
  257. </member>
  258. <member name="M:System.Net.FtpClient.IFtpClient.BeginDisconnect(System.AsyncCallback,System.Object)">
  259. <summary>
  260. Initiates a disconnection on the server
  261. </summary>
  262. <param name="callback">AsyncCallback method</param>
  263. <param name="state">State object</param>
  264. <returns>IAsyncResult</returns>
  265. <example><code source="..\Examples\BeginDisconnect.cs" lang="cs" /></example>
  266. </member>
  267. <member name="M:System.Net.FtpClient.IFtpClient.EndDisconnect(System.IAsyncResult)">
  268. <summary>
  269. Ends a call to BeginDisconnect
  270. </summary>
  271. <param name="ar">IAsyncResult returned from BeginDisconnect</param>
  272. <example><code source="..\Examples\BeginConnect.cs" lang="cs" /></example>
  273. </member>
  274. <member name="M:System.Net.FtpClient.IFtpClient.OpenRead(System.String)">
  275. <summary>
  276. Opens the specified file for reading
  277. </summary>
  278. <param name="path">The full or relative path of the file</param>
  279. <returns>A stream for reading the file on the server</returns>
  280. <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
  281. </member>
  282. <member name="M:System.Net.FtpClient.IFtpClient.OpenRead(System.String,System.Net.FtpClient.FtpDataType)">
  283. <summary>
  284. Opens the specified file for reading
  285. </summary>
  286. <param name="path">The full or relative path of the file</param>
  287. <param name="type">ASCII/Binary</param>
  288. <returns>A stream for reading the file on the server</returns>
  289. <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
  290. </member>
  291. <member name="M:System.Net.FtpClient.IFtpClient.OpenRead(System.String,System.Int64)">
  292. <summary>
  293. Opens the specified file for reading
  294. </summary>
  295. <param name="path">The full or relative path of the file</param>
  296. <param name="restart">Resume location</param>
  297. <returns>A stream for reading the file on the server</returns>
  298. <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
  299. </member>
  300. <member name="M:System.Net.FtpClient.IFtpClient.OpenRead(System.String,System.Net.FtpClient.FtpDataType,System.Int64)">
  301. <summary>
  302. Opens the specified file for reading
  303. </summary>
  304. <param name="path">The full or relative path of the file</param>
  305. <param name="type">ASCII/Binary</param>
  306. <param name="restart">Resume location</param>
  307. <returns>A stream for reading the file on the server</returns>
  308. <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
  309. </member>
  310. <member name="M:System.Net.FtpClient.IFtpClient.BeginOpenRead(System.String,System.AsyncCallback,System.Object)">
  311. <summary>
  312. Opens the specified file for reading
  313. </summary>
  314. <param name="path">The full or relative path of the file</param>
  315. <param name="callback">Async Callback</param>
  316. <param name="state">State object</param>
  317. <returns>IAsyncResult</returns>
  318. <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
  319. </member>
  320. <member name="M:System.Net.FtpClient.IFtpClient.BeginOpenRead(System.String,System.Net.FtpClient.FtpDataType,System.AsyncCallback,System.Object)">
  321. <summary>
  322. Opens the specified file for reading
  323. </summary>
  324. <param name="path">The full or relative path of the file</param>
  325. <param name="type">ASCII/Binary</param>
  326. <param name="callback">Async Callback</param>
  327. <param name="state">State object</param>
  328. <returns>IAsyncResult</returns>
  329. <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
  330. </member>
  331. <member name="M:System.Net.FtpClient.IFtpClient.BeginOpenRead(System.String,System.Int64,System.AsyncCallback,System.Object)">
  332. <summary>
  333. Opens the specified file for reading
  334. </summary>
  335. <param name="path">The full or relative path of the file</param>
  336. <param name="restart">Resume location</param>
  337. <param name="callback">Async Callback</param>
  338. <param name="state">State object</param>
  339. <returns>IAsyncResult</returns>
  340. <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
  341. </member>
  342. <member name="M:System.Net.FtpClient.IFtpClient.BeginOpenRead(System.String,System.Net.FtpClient.FtpDataType,System.Int64,System.AsyncCallback,System.Object)">
  343. <summary>
  344. Opens the specified file for reading
  345. </summary>
  346. <param name="path">The full or relative path of the file</param>
  347. <param name="type">ASCII/Binary</param>
  348. <param name="restart">Resume location</param>
  349. <param name="callback">Async Callback</param>
  350. <param name="state">State object</param>
  351. <returns>IAsyncResult</returns>
  352. <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
  353. </member>
  354. <member name="M:System.Net.FtpClient.IFtpClient.EndOpenRead(System.IAsyncResult)">
  355. <summary>
  356. Ends a call to BeginOpenRead()
  357. </summary>
  358. <param name="ar">IAsyncResult returned from BeginOpenRead()</param>
  359. <returns>A readable stream</returns>
  360. <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
  361. </member>
  362. <member name="M:System.Net.FtpClient.IFtpClient.OpenWrite(System.String)">
  363. <summary>
  364. Opens the specified file for writing
  365. </summary>
  366. <param name="path">Full or relative path of the file</param>
  367. <returns>A stream for writing to the file on the server</returns>
  368. <example><code source="..\Examples\OpenWrite.cs" lang="cs" /></example>
  369. </member>
  370. <member name="M:System.Net.FtpClient.IFtpClient.OpenWrite(System.String,System.Net.FtpClient.FtpDataType)">
  371. <summary>
  372. Opens the specified file for writing
  373. </summary>
  374. <param name="path">Full or relative path of the file</param>
  375. <param name="type">ASCII/Binary</param>
  376. <returns>A stream for writing to the file on the server</returns>
  377. <example><code source="..\Examples\OpenWrite.cs" lang="cs" /></example>
  378. </member>
  379. <member name="M:System.Net.FtpClient.IFtpClient.BeginOpenWrite(System.String,System.AsyncCallback,System.Object)">
  380. <summary>
  381. Opens the specified file for writing
  382. </summary>
  383. <param name="path">Full or relative path of the file</param>
  384. <param name="callback">Async callback</param>
  385. <param name="state">State object</param>
  386. <returns>IAsyncResult</returns>
  387. <example><code source="..\Examples\BeginOpenWrite.cs" lang="cs" /></example>
  388. </member>
  389. <member name="M:System.Net.FtpClient.IFtpClient.BeginOpenWrite(System.String,System.Net.FtpClient.FtpDataType,System.AsyncCallback,System.Object)">
  390. <summary>
  391. Opens the specified file for writing
  392. </summary>
  393. <param name="path">Full or relative path of the file</param>
  394. <param name="type">ASCII/Binary</param>
  395. <param name="callback">Async callback</param>
  396. <param name="state">State object</param>
  397. <returns>IAsyncResult</returns>
  398. <example><code source="..\Examples\BeginOpenWrite.cs" lang="cs" /></example>
  399. </member>
  400. <member name="M:System.Net.FtpClient.IFtpClient.EndOpenWrite(System.IAsyncResult)">
  401. <summary>
  402. Ends a call to BeginOpenWrite()
  403. </summary>
  404. <param name="ar">IAsyncResult returned from BeginOpenWrite()</param>
  405. <returns>A writable stream</returns>
  406. <example><code source="..\Examples\BeginOpenWrite.cs" lang="cs" /></example>
  407. </member>
  408. <member name="M:System.Net.FtpClient.IFtpClient.OpenAppend(System.String)">
  409. <summary>
  410. Opens the specified file to be appended to
  411. </summary>
  412. <param name="path">The full or relative path to the file to be opened</param>
  413. <returns>A stream for writing to the file on the server</returns>
  414. <example><code source="..\Examples\OpenAppend.cs" lang="cs" /></example>
  415. </member>
  416. <member name="M:System.Net.FtpClient.IFtpClient.OpenAppend(System.String,System.Net.FtpClient.FtpDataType)">
  417. <summary>
  418. Opens the specified file to be appended to
  419. </summary>
  420. <param name="path">The full or relative path to the file to be opened</param>
  421. <param name="type">ASCII/Binary</param>
  422. <returns>A stream for writing to the file on the server</returns>
  423. <example><code source="..\Examples\OpenAppend.cs" lang="cs" /></example>
  424. </member>
  425. <member name="M:System.Net.FtpClient.IFtpClient.BeginOpenAppend(System.String,System.AsyncCallback,System.Object)">
  426. <summary>
  427. Opens the specified file for writing
  428. </summary>
  429. <param name="path">Full or relative path of the file</param>
  430. <param name="callback">Async callback</param>
  431. <param name="state">State object</param>
  432. <returns>IAsyncResult</returns>
  433. <example><code source="..\Examples\BeginOpenAppend.cs" lang="cs" /></example>
  434. </member>
  435. <member name="M:System.Net.FtpClient.IFtpClient.BeginOpenAppend(System.String,System.Net.FtpClient.FtpDataType,System.AsyncCallback,System.Object)">
  436. <summary>
  437. Opens the specified file for writing
  438. </summary>
  439. <param name="path">Full or relative path of the file</param>
  440. <param name="type">ASCII/Binary</param>
  441. <param name="callback">Async callback</param>
  442. <param name="state">State object</param>
  443. <returns>IAsyncResult</returns>
  444. <example><code source="..\Examples\BeginOpenAppend.cs" lang="cs" /></example>
  445. </member>
  446. <member name="M:System.Net.FtpClient.IFtpClient.EndOpenAppend(System.IAsyncResult)">
  447. <summary>
  448. Ends a call to BeginOpenAppend()
  449. </summary>
  450. <param name="ar">IAsyncResult returned from BeginOpenWrite()</param>
  451. <returns>A writable stream</returns>
  452. <example><code source="..\Examples\BeginOpenAppend.cs" lang="cs" /></example>
  453. </member>
  454. <member name="M:System.Net.FtpClient.IFtpClient.DereferenceLink(System.Net.FtpClient.FtpListItem)">
  455. <summary>
  456. Recursively dereferences a symbolic link. See the
  457. MaximumDereferenceCount property for controlling
  458. how deep this method will recurse before giving up.
  459. </summary>
  460. <param name="item">The symbolic link</param>
  461. <returns>FtpListItem, null if the link can't be dereferenced</returns>
  462. <example><code source="..\Examples\DereferenceLink.cs" lang="cs" /></example>
  463. </member>
  464. <member name="M:System.Net.FtpClient.IFtpClient.DereferenceLink(System.Net.FtpClient.FtpListItem,System.Int32)">
  465. <summary>
  466. Recursively dereferences a symbolic link
  467. </summary>
  468. <param name="item">The symbolic link</param>
  469. <param name="recMax">The maximum depth of recursion that can be performed before giving up.</param>
  470. <returns>FtpListItem, null if the link can't be dereferenced</returns>
  471. <example><code source="..\Examples\DereferenceLink.cs" lang="cs" /></example>
  472. </member>
  473. <member name="M:System.Net.FtpClient.IFtpClient.BeginDereferenceLink(System.Net.FtpClient.FtpListItem,System.Int32,System.AsyncCallback,System.Object)">
  474. <summary>
  475. Derefence a FtpListItem object asynchronously
  476. </summary>
  477. <param name="item">The item to derefence</param>
  478. <param name="recMax">Maximum recursive calls</param>
  479. <param name="callback">AsyncCallback</param>
  480. <param name="state">State Object</param>
  481. <returns>IAsyncResult</returns>
  482. <example><code source="..\Examples\BeginDereferenceLink.cs" lang="cs" /></example>
  483. </member>
  484. <member name="M:System.Net.FtpClient.IFtpClient.BeginDereferenceLink(System.Net.FtpClient.FtpListItem,System.AsyncCallback,System.Object)">
  485. <summary>
  486. Derefence a FtpListItem object asynchronously. See the
  487. MaximumDereferenceCount property for controlling
  488. how deep this method will recurse before giving up.
  489. </summary>
  490. <param name="item">The item to derefence</param>
  491. <param name="callback">AsyncCallback</param>
  492. <param name="state">State Object</param>
  493. <returns>IAsyncResult</returns>
  494. <example><code source="..\Examples\BeginDereferenceLink.cs" lang="cs" /></example>
  495. </member>
  496. <member name="M:System.Net.FtpClient.IFtpClient.EndDereferenceLink(System.IAsyncResult)">
  497. <summary>
  498. Ends a call to BeginDereferenceLink
  499. </summary>
  500. <param name="ar">IAsyncResult</param>
  501. <returns>FtpListItem, null if the link can't be dereferenced</returns>
  502. <example><code source="..\Examples\BeginDereferenceLink.cs" lang="cs" /></example>
  503. </member>
  504. <member name="M:System.Net.FtpClient.IFtpClient.GetObjectInfo(System.String)">
  505. <summary>
  506. Returns information about a file system object. You should check the Capabilities
  507. flags for the FtpCapability.MLSD flag before calling this method. Failing to do
  508. so will result in an InvalidOperationException being thrown when the server
  509. does not support machine listings. Returns null if the server response can't
  510. be parsed or the server returns a failure completion code. The error for a failure
  511. is logged with FtpTrace. No exception is thrown on error because that would negate
  512. the usefullness of this method for checking for the existence of an object.
  513. </summary>
  514. <param name="path">The path of the object to retrieve information about</param>
  515. <returns>A FtpListItem object</returns>
  516. </member>
  517. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetObjectInfo(System.String,System.AsyncCallback,System.Object)">
  518. <summary>
  519. Returns information about a file system object. You should check the Capabilities
  520. flags for the FtpCapability.MLSD flag before calling this method. Failing to do
  521. so will result in an InvalidOperationException being thrown when the server
  522. does not support machine listings. Returns null if the server response can't
  523. be parsed or the server returns a failure completion code. The error for a failure
  524. is logged with FtpTrace. No exception is thrown on error because that would negate
  525. the usefullness of this method for checking for the existence of an object.
  526. </summary>
  527. <param name="path">Path of the item to retrieve information about</param>
  528. <param name="callback">Async Callback</param>
  529. <param name="state">State object</param>
  530. <returns>IAsyncResult</returns>
  531. </member>
  532. <member name="M:System.Net.FtpClient.IFtpClient.EndGetObjectInfo(System.IAsyncResult)">
  533. <summary>
  534. Ends a call to BeginGetObjectInfo
  535. </summary>
  536. <param name="ar">IAsyncResult returned from BeginGetObjectInfo</param>
  537. <returns>FtpListItem if the command succeeded, null if there was a problem.</returns>
  538. </member>
  539. <member name="M:System.Net.FtpClient.IFtpClient.GetListing">
  540. <summary>
  541. Gets a file listing from the server. Each FtpListItem object returned
  542. contains information about the file that was able to be retrieved. If
  543. a DateTime property is equal to DateTime.MinValue then it means the
  544. date in question was not able to be retrieved. If the Size property
  545. is equal to 0 then it means the size of the object could also not
  546. be retrieved.
  547. </summary>
  548. <returns>An array of FtpListItem objects</returns>
  549. <example><code source="..\Examples\GetListing.cs" lang="cs" /></example>
  550. </member>
  551. <member name="M:System.Net.FtpClient.IFtpClient.GetListing(System.String)">
  552. <summary>
  553. Gets a file listing from the server. Each FtpListItem object returned
  554. contains information about the file that was able to be retrieved. If
  555. a DateTime property is equal to DateTime.MinValue then it means the
  556. date in question was not able to be retrieved. If the Size property
  557. is equal to 0 then it means the size of the object could also not
  558. be retrieved.
  559. </summary>
  560. <param name="path">The path of the directory to list</param>
  561. <returns>An array of FtpListItem objects</returns>
  562. <example><code source="..\Examples\GetListing.cs" lang="cs" /></example>
  563. </member>
  564. <member name="M:System.Net.FtpClient.IFtpClient.GetListing(System.String,System.Net.FtpClient.FtpListOption)">
  565. <summary>
  566. Gets a file listing from the server. Each FtpListItem object returned
  567. contains information about the file that was able to be retrieved. If
  568. a DateTime property is equal to DateTime.MinValue then it means the
  569. date in question was not able to be retrieved. If the Size property
  570. is equal to 0 then it means the size of the object could also not
  571. be retrieved.
  572. </summary>
  573. <param name="path">The path of the directory to list</param>
  574. <param name="options">Options that dictacte how a list is performed and what information is gathered.</param>
  575. <returns>An array of FtpListItem objects</returns>
  576. <example><code source="..\Examples\GetListing.cs" lang="cs" /></example>
  577. </member>
  578. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetListing(System.AsyncCallback,System.Object)">
  579. <summary>
  580. Gets a file listing from the server asynchronously
  581. </summary>
  582. <param name="callback">AsyncCallback method</param>
  583. <param name="state">State object</param>
  584. <returns>IAsyncResult</returns>
  585. <example><code source="..\Examples\BeginGetListing.cs" lang="cs" /></example>
  586. </member>
  587. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetListing(System.String,System.AsyncCallback,System.Object)">
  588. <summary>
  589. Gets a file listing from the server asynchronously
  590. </summary>
  591. <param name="path">The path to list</param>
  592. <param name="callback">AsyncCallback method</param>
  593. <param name="state">State object</param>
  594. <returns>IAsyncResult</returns>
  595. <example><code source="..\Examples\BeginGetListing.cs" lang="cs" /></example>
  596. </member>
  597. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetListing(System.String,System.Net.FtpClient.FtpListOption,System.AsyncCallback,System.Object)">
  598. <summary>
  599. Gets a file listing from the server asynchronously
  600. </summary>
  601. <param name="path">The path to list</param>
  602. <param name="options">Options that dictate how the list operation is performed</param>
  603. <param name="callback">AsyncCallback method</param>
  604. <param name="state">State object</param>
  605. <returns>IAsyncResult</returns>
  606. <example><code source="..\Examples\BeginGetListing.cs" lang="cs" /></example>
  607. </member>
  608. <member name="M:System.Net.FtpClient.IFtpClient.EndGetListing(System.IAsyncResult)">
  609. <summary>
  610. Ends an asynchronous file listing
  611. </summary>
  612. <param name="ar">IAsyncResult return from BeginGetListing()</param>
  613. <returns>An array of items retrieved in the listing</returns>
  614. <example><code source="..\Examples\BeginGetListing.cs" lang="cs" /></example>
  615. </member>
  616. <member name="M:System.Net.FtpClient.IFtpClient.GetNameListing">
  617. <summary>
  618. Returns a file/directory listing using the NLST command.
  619. </summary>
  620. <returns>A string array of file and directory names if any were returned.</returns>
  621. </member>
  622. <member name="M:System.Net.FtpClient.IFtpClient.GetNameListing(System.String)">
  623. <summary>
  624. Returns a file/directory listing using the NLST command.
  625. </summary>
  626. <param name="path">The path of the directory to list</param>
  627. <returns>A string array of file and directory names if any were returned.</returns>
  628. <example><code source="..\Examples\GetNameListing.cs" lang="cs" /></example>
  629. </member>
  630. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetNameListing(System.String,System.AsyncCallback,System.Object)">
  631. <summary>
  632. Asynchronously gets a list of file and directory names for the specified path.
  633. </summary>
  634. <param name="path">The path of the directory to list</param>
  635. <param name="callback">Async Callback</param>
  636. <param name="state">State object</param>
  637. <returns>IAsyncResult</returns>
  638. <example><code source="..\Examples\BeginGetNameListing.cs" lang="cs" /></example>
  639. </member>
  640. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetNameListing(System.AsyncCallback,System.Object)">
  641. <summary>
  642. Asynchronously gets a list of file and directory names for the specified path.
  643. </summary>
  644. <param name="callback">Async Callback</param>
  645. <param name="state">State object</param>
  646. <returns>IAsyncResult</returns>
  647. <example><code source="..\Examples\BeginGetNameListing.cs" lang="cs" /></example>
  648. </member>
  649. <member name="M:System.Net.FtpClient.IFtpClient.EndGetNameListing(System.IAsyncResult)">
  650. <summary>
  651. Ends a call to BeginGetNameListing()
  652. </summary>
  653. <param name="ar">IAsyncResult object returned from BeginGetNameListing</param>
  654. <returns>An array of file and directory names if any were returned.</returns>
  655. <example><code source="..\Examples\BeginGetNameListing.cs" lang="cs" /></example>
  656. </member>
  657. <member name="M:System.Net.FtpClient.IFtpClient.SetWorkingDirectory(System.String)">
  658. <summary>
  659. Sets the work directory on the server
  660. </summary>
  661. <param name="path">The path of the directory to change to</param>
  662. <example><code source="..\Examples\SetWorkingDirectory.cs" lang="cs" /></example>
  663. </member>
  664. <member name="M:System.Net.FtpClient.IFtpClient.BeginSetWorkingDirectory(System.String,System.AsyncCallback,System.Object)">
  665. <summary>
  666. Asynchronously changes the working directory on the server
  667. </summary>
  668. <param name="path">The directory to change to</param>
  669. <param name="callback">Async Callback</param>
  670. <param name="state">State object</param>
  671. <returns>IAsyncResult</returns>
  672. <example><code source="..\Examples\BeginSetWorkingDirectory.cs" lang="cs" /></example>
  673. </member>
  674. <member name="M:System.Net.FtpClient.IFtpClient.EndSetWorkingDirectory(System.IAsyncResult)">
  675. <summary>
  676. Ends asynchronous directory change
  677. </summary>
  678. <param name="ar">IAsyncResult returned from BeginSetWorkingDirectory</param>
  679. <example><code source="..\Examples\BeginSetWorkingDirectory.cs" lang="cs" /></example>
  680. </member>
  681. <member name="M:System.Net.FtpClient.IFtpClient.GetWorkingDirectory">
  682. <summary>
  683. Gets the current working directory
  684. </summary>
  685. <returns>The current working directory, ./ if the response couldn't be parsed.</returns>
  686. <example><code source="..\Examples\GetWorkingDirectory.cs" lang="cs" /></example>
  687. </member>
  688. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetWorkingDirectory(System.AsyncCallback,System.Object)">
  689. <summary>
  690. Asynchronously retrieves the working directory
  691. </summary>
  692. <param name="callback">Async callback</param>
  693. <param name="state">State object</param>
  694. <returns>IAsyncResult</returns>
  695. <example><code source="..\Examples\BeginGetWorkingDirectory.cs" lang="cs" /></example>
  696. </member>
  697. <member name="M:System.Net.FtpClient.IFtpClient.EndGetWorkingDirectory(System.IAsyncResult)">
  698. <summary>
  699. Ends an asynchronous call to retrieve the working directory
  700. </summary>
  701. <param name="ar">IAsyncResult returned from BeginGetWorkingDirectory</param>
  702. <returns>The current working directory</returns>
  703. <example><code source="..\Examples\BeginGetWorkingDirectory.cs" lang="cs" /></example>
  704. </member>
  705. <member name="M:System.Net.FtpClient.IFtpClient.GetFileSize(System.String)">
  706. <summary>
  707. Gets the size of the file
  708. </summary>
  709. <param name="path">The full or relative path of the file</param>
  710. <returns>-1 if the command fails, otherwise the file size</returns>
  711. <example><code source="..\Examples\GetFileSize.cs" lang="cs" /></example>
  712. </member>
  713. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetFileSize(System.String,System.AsyncCallback,System.Object)">
  714. <summary>
  715. Asynchronously retrieve the size of the specified file
  716. </summary>
  717. <param name="path">The full or relative path of the file</param>
  718. <param name="callback">Async callback</param>
  719. <param name="state">State object</param>
  720. <returns>IAsyncResult</returns>
  721. <example><code source="..\Examples\BeginGetFileSize.cs" lang="cs" /></example>
  722. </member>
  723. <member name="M:System.Net.FtpClient.IFtpClient.EndGetFileSize(System.IAsyncResult)">
  724. <summary>
  725. Ends a call to BeginGetFileSize()
  726. </summary>
  727. <param name="ar">IAsyncResult returned from BeginGetFileSize</param>
  728. <returns>The size of the file, -1 if there was a problem.</returns>
  729. <example><code source="..\Examples\BeginGetFileSize.cs" lang="cs" /></example>
  730. </member>
  731. <member name="M:System.Net.FtpClient.IFtpClient.GetModifiedTime(System.String)">
  732. <summary>
  733. Gets the modified time of the file
  734. </summary>
  735. <param name="path">The full path to the file</param>
  736. <returns>The modified time, DateTime.MinValue if there was a problem</returns>
  737. <example><code source="..\Examples\GetModifiedTime.cs" lang="cs" /></example>
  738. </member>
  739. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetModifiedTime(System.String,System.AsyncCallback,System.Object)">
  740. <summary>
  741. Gets the modified time of the file
  742. </summary>
  743. <param name="path">The full path to the file</param>
  744. <param name="callback">Async callback</param>
  745. <param name="state">State object</param>
  746. <returns>IAsyncResult</returns>
  747. <example><code source="..\Examples\BeginGetModifiedTime.cs" lang="cs" /></example>
  748. </member>
  749. <member name="M:System.Net.FtpClient.IFtpClient.EndGetModifiedTime(System.IAsyncResult)">
  750. <summary>
  751. Ends a call to BeginGetModifiedTime()
  752. </summary>
  753. <param name="ar">IAsyncResult returned from BeginGetModifiedTime()</param>
  754. <returns>The modified time, DateTime.MinValue if there was a problem</returns>
  755. <example><code source="..\Examples\BeginGetModifiedTime.cs" lang="cs" /></example>
  756. </member>
  757. <member name="M:System.Net.FtpClient.IFtpClient.DeleteFile(System.String)">
  758. <summary>
  759. Deletes a file on the server
  760. </summary>
  761. <param name="path">The full or relative path to the file</param>
  762. <example><code source="..\Examples\DeleteFile.cs" lang="cs" /></example>
  763. </member>
  764. <member name="M:System.Net.FtpClient.IFtpClient.BeginDeleteFile(System.String,System.AsyncCallback,System.Object)">
  765. <summary>
  766. Asynchronously deletes a file from the server
  767. </summary>
  768. <param name="path">The full or relative path to the file</param>
  769. <param name="callback">Async callback</param>
  770. <param name="state">State object</param>
  771. <returns>IAsyncResult</returns>
  772. <example><code source="..\Examples\BeginDeleteFile.cs" lang="cs" /></example>
  773. </member>
  774. <member name="M:System.Net.FtpClient.IFtpClient.EndDeleteFile(System.IAsyncResult)">
  775. <summary>
  776. Ends a call to BeginDeleteFile
  777. </summary>
  778. <param name="ar">IAsyncResult returned from BeginDeleteFile</param>
  779. <example><code source="..\Examples\BeginDeleteFile.cs" lang="cs" /></example>
  780. </member>
  781. <member name="M:System.Net.FtpClient.IFtpClient.DeleteDirectory(System.String)">
  782. <summary>
  783. Deletes the specified directory on the server.
  784. </summary>
  785. <param name="path">The full or relative path of the directory to delete</param>
  786. <example><code source="..\Examples\DeleteDirectory.cs" lang="cs" /></example>
  787. </member>
  788. <member name="M:System.Net.FtpClient.IFtpClient.DeleteDirectory(System.String,System.Boolean)">
  789. <summary>
  790. Delets the specified directory on the server
  791. </summary>
  792. <param name="path">The full or relative path of the directory to delete</param>
  793. <param name="force">If the directory is not empty, remove its contents</param>
  794. <example><code source="..\Examples\DeleteDirectory.cs" lang="cs" /></example>
  795. </member>
  796. <member name="M:System.Net.FtpClient.IFtpClient.DeleteDirectory(System.String,System.Boolean,System.Net.FtpClient.FtpListOption)">
  797. <summary>
  798. Deletes the specified directory on the server
  799. </summary>
  800. <param name="path">The full or relative path of the directory to delete</param>
  801. <param name="force">If the directory is not empty, remove its contents</param>
  802. <param name="options">FtpListOptions for controlling how the directory
  803. contents are retrieved with the force option is true. If you experience problems
  804. the file listing can be fine tuned through this parameter.</param>
  805. <example><code source="..\Examples\DeleteDirectory.cs" lang="cs" /></example>
  806. </member>
  807. <member name="M:System.Net.FtpClient.IFtpClient.BeginDeleteDirectory(System.String,System.AsyncCallback,System.Object)">
  808. <summary>
  809. Asynchronously removes a directory from the server
  810. </summary>
  811. <param name="path">The full or relative path of the directory to delete</param>
  812. <param name="callback">Async callback</param>
  813. <param name="state">State object</param>
  814. <returns>IAsyncResult</returns>
  815. <example><code source="..\Examples\BeginDeleteDirectory.cs" lang="cs" /></example>
  816. </member>
  817. <member name="M:System.Net.FtpClient.IFtpClient.BeginDeleteDirectory(System.String,System.Boolean,System.AsyncCallback,System.Object)">
  818. <summary>
  819. Asynchronously removes a directory from the server
  820. </summary>
  821. <param name="path">The full or relative path of the directory to delete</param>
  822. <param name="force">If the directory is not empty, remove its contents</param>
  823. <param name="callback">Async callback</param>
  824. <param name="state">State object</param>
  825. <returns>IAsyncResult</returns>
  826. <example><code source="..\Examples\BeginDeleteDirectory.cs" lang="cs" /></example>
  827. </member>
  828. <member name="M:System.Net.FtpClient.IFtpClient.BeginDeleteDirectory(System.String,System.Boolean,System.Net.FtpClient.FtpListOption,System.AsyncCallback,System.Object)">
  829. <summary>
  830. Asynchronously removes a directory from the server
  831. </summary>
  832. <param name="path">The full or relative path of the directory to delete</param>
  833. <param name="force">If the directory is not empty, remove its contents</param>
  834. <param name="options">FtpListOptions for controlling how the directory
  835. contents are retrieved with the force option is true. If you experience problems
  836. the file listing can be fine tuned through this parameter.</param>
  837. <param name="callback">Async callback</param>
  838. <param name="state">State object</param>
  839. <returns>IAsyncResult</returns>
  840. <example><code source="..\Examples\BeginDeleteDirectory.cs" lang="cs" /></example>
  841. </member>
  842. <member name="M:System.Net.FtpClient.IFtpClient.EndDeleteDirectory(System.IAsyncResult)">
  843. <summary>
  844. Ends a call to BeginDeleteDirectory()
  845. </summary>
  846. <param name="ar">IAsyncResult returned from BeginDeleteDirectory</param>
  847. <example><code source="..\Examples\BeginDeleteDirectory.cs" lang="cs" /></example>
  848. </member>
  849. <member name="M:System.Net.FtpClient.IFtpClient.DirectoryExists(System.String)">
  850. <summary>
  851. Tests if the specified directory exists on the server. This
  852. method works by trying to change the working directory to
  853. the path specified. If it succeeds, the directory is changed
  854. back to the old working directory and true is returned. False
  855. is returned otherwise and since the CWD failed it is assumed
  856. the working directory is still the same.
  857. </summary>
  858. <param name="path">The path of the directory</param>
  859. <returns>True if it exists, false otherwise.</returns>
  860. <example><code source="..\Examples\DirectoryExists.cs" lang="cs" /></example>
  861. </member>
  862. <member name="M:System.Net.FtpClient.IFtpClient.BeginDirectoryExists(System.String,System.AsyncCallback,System.Object)">
  863. <summary>
  864. Checks if a directory exists on the server asynchronously.
  865. </summary>
  866. <returns>IAsyncResult</returns>
  867. <param name='path'>The full or relative path of the directory to check for</param>
  868. <param name='callback'>Async callback</param>
  869. <param name='state'>State object</param>
  870. <example><code source="..\Examples\BeginDirectoryExists.cs" lang="cs" /></example>
  871. </member>
  872. <member name="M:System.Net.FtpClient.IFtpClient.EndDirectoryExists(System.IAsyncResult)">
  873. <summary>
  874. Ends a call to BeginDirectoryExists
  875. </summary>
  876. <param name="ar">IAsyncResult returned from BeginDirectoryExists</param>
  877. <returns>True if the directory exists. False otherwise.</returns>
  878. <example><code source="..\Examples\BeginDirectoryExists.cs" lang="cs" /></example>
  879. </member>
  880. <member name="M:System.Net.FtpClient.IFtpClient.FileExists(System.String)">
  881. <summary>
  882. Checks if a file exsts on the server by taking a
  883. file listing of the parent directory in the path
  884. and comparing the results the path supplied.
  885. </summary>
  886. <param name="path">The full or relative path to the file</param>
  887. <returns>True if the file exists</returns>
  888. <example><code source="..\Examples\FileExists.cs" lang="cs" /></example>
  889. </member>
  890. <member name="M:System.Net.FtpClient.IFtpClient.FileExists(System.String,System.Net.FtpClient.FtpListOption)">
  891. <summary>
  892. Checks if a file exsts on the server by taking a
  893. file listing of the parent directory in the path
  894. and comparing the results the path supplied.
  895. </summary>
  896. <param name="path">The full or relative path to the file</param>
  897. <param name="options">Options for controling the file listing used to
  898. determine if the file exists.</param>
  899. <returns>True if the file exists</returns>
  900. <example><code source="..\Examples\FileExists.cs" lang="cs" /></example>
  901. </member>
  902. <member name="M:System.Net.FtpClient.IFtpClient.BeginFileExists(System.String,System.AsyncCallback,System.Object)">
  903. <summary>
  904. Checks if a file exsts on the server by taking a
  905. file listing of the parent directory in the path
  906. and comparing the results the path supplied.
  907. </summary>
  908. <param name="path">The full or relative path to the file</param>
  909. <param name="callback">Async callback</param>
  910. <param name="state">State object</param>
  911. <returns>IAsyncResult</returns>
  912. <example><code source="..\Examples\BeginFileExists.cs" lang="cs" /></example>
  913. </member>
  914. <member name="M:System.Net.FtpClient.IFtpClient.BeginFileExists(System.String,System.Net.FtpClient.FtpListOption,System.AsyncCallback,System.Object)">
  915. <summary>
  916. Checks if a file exsts on the server by taking a
  917. file listing of the parent directory in the path
  918. and comparing the results the path supplied.
  919. </summary>
  920. <param name="path">The full or relative path to the file</param>
  921. <param name="options">Options for controling the file listing used to
  922. determine if the file exists.</param>
  923. <param name="callback">Async callback</param>
  924. <param name="state">State object</param>
  925. <returns>IAsyncResult</returns>
  926. <example><code source="..\Examples\BeginFileExists.cs" lang="cs" /></example>
  927. </member>
  928. <member name="M:System.Net.FtpClient.IFtpClient.EndFileExists(System.IAsyncResult)">
  929. <summary>
  930. Ends a call to BeginFileExists
  931. </summary>
  932. <param name="ar">IAsyncResult returned from BeginFileExists</param>
  933. <returns>True if the file exists</returns>
  934. <example><code source="..\Examples\BeginFileExists.cs" lang="cs" /></example>
  935. </member>
  936. <member name="M:System.Net.FtpClient.IFtpClient.CreateDirectory(System.String)">
  937. <summary>
  938. Creates a directory on the server. If the preceding
  939. directories do not exist they are created.
  940. </summary>
  941. <param name="path">The full or relative path to the new directory</param>
  942. <example><code source="..\Examples\CreateDirectory.cs" lang="cs" /></example>
  943. </member>
  944. <member name="M:System.Net.FtpClient.IFtpClient.CreateDirectory(System.String,System.Boolean)">
  945. <summary>
  946. Creates a directory on the server
  947. </summary>
  948. <param name="path">The full or relative path to the directory to create</param>
  949. <param name="force">Try to force all non-existant pieces of the path to be created</param>
  950. <example><code source="..\Examples\CreateDirectory.cs" lang="cs" /></example>
  951. </member>
  952. <member name="M:System.Net.FtpClient.IFtpClient.BeginCreateDirectory(System.String,System.AsyncCallback,System.Object)">
  953. <summary>
  954. Creates a directory asynchronously
  955. </summary>
  956. <param name="path">The full or relative path to the directory to create</param>
  957. <param name="callback">Async callback</param>
  958. <param name="state">State object</param>
  959. <returns>IAsyncResult</returns>
  960. <example><code source="..\Examples\BeginCreateDirectory.cs" lang="cs" /></example>
  961. </member>
  962. <member name="M:System.Net.FtpClient.IFtpClient.BeginCreateDirectory(System.String,System.Boolean,System.AsyncCallback,System.Object)">
  963. <summary>
  964. Creates a directory asynchronously
  965. </summary>
  966. <param name="path">The full or relative path to the directory to create</param>
  967. <param name="force">Try to create the whole path if the preceding directories do not exist</param>
  968. <param name="callback">Async callback</param>
  969. <param name="state">State object</param>
  970. <returns>IAsyncResult</returns>
  971. <example><code source="..\Examples\BeginCreateDirectory.cs" lang="cs" /></example>
  972. </member>
  973. <member name="M:System.Net.FtpClient.IFtpClient.EndCreateDirectory(System.IAsyncResult)">
  974. <summary>
  975. Ends a call to BeginCreateDirectory
  976. </summary>
  977. <param name="ar">IAsyncResult returned from BeginCreateDirectory</param>
  978. <example><code source="..\Examples\BeginCreateDirectory.cs" lang="cs" /></example>
  979. </member>
  980. <member name="M:System.Net.FtpClient.IFtpClient.Rename(System.String,System.String)">
  981. <summary>
  982. Renames an object on the remote file system.
  983. </summary>
  984. <param name="path">The full or relative path to the object</param>
  985. <param name="dest">The old or new full or relative path including the new name of the object</param>
  986. <example><code source="..\Examples\Rename.cs" lang="cs" /></example>
  987. </member>
  988. <member name="M:System.Net.FtpClient.IFtpClient.BeginRename(System.String,System.String,System.AsyncCallback,System.Object)">
  989. <summary>
  990. Asynchronously renames an object on the server
  991. </summary>
  992. <param name="path">The full or relative path to the object</param>
  993. <param name="dest">The old or new full or relative path including the new name of the object</param>
  994. <param name="callback">Async callback</param>
  995. <param name="state">State object</param>
  996. <returns>IAsyncResult</returns>
  997. <example><code source="..\Examples\BeginRename.cs" lang="cs" /></example>
  998. </member>
  999. <member name="M:System.Net.FtpClient.IFtpClient.EndRename(System.IAsyncResult)">
  1000. <summary>
  1001. Ends a call to BeginRename
  1002. </summary>
  1003. <param name="ar">IAsyncResult returned from BeginRename</param>
  1004. <example><code source="..\Examples\BeginRename.cs" lang="cs" /></example>
  1005. </member>
  1006. <member name="M:System.Net.FtpClient.IFtpClient.GetHashAlgorithm">
  1007. <summary>
  1008. Gets the currently selected hash algorith for the HASH
  1009. command. This feature is experimental. See this link
  1010. for details:
  1011. http://tools.ietf.org/html/draft-bryan-ftpext-hash-02
  1012. </summary>
  1013. <returns>The FtpHashType flag or FtpHashType.NONE if there was a problem.</returns>
  1014. <example><code source="..\Examples\GetHashAlgorithm.cs" lang="cs" /></example>
  1015. </member>
  1016. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetHashAlgorithm(System.AsyncCallback,System.Object)">
  1017. <summary>
  1018. Asynchronously get the hash algorithm being used by the HASH command.
  1019. </summary>
  1020. <param name="callback">Async callback</param>
  1021. <param name="state">State object</param>
  1022. <returns>IAsyncResult</returns>
  1023. </member>
  1024. <member name="M:System.Net.FtpClient.IFtpClient.EndGetHashAlgorithm(System.IAsyncResult)">
  1025. <summary>
  1026. Ends a call to BeginGetHashAlgorithm
  1027. </summary>
  1028. <param name="ar">IAsyncResult returned from BeginGetHashAlgorithm</param>
  1029. </member>
  1030. <member name="M:System.Net.FtpClient.IFtpClient.SetHashAlgorithm(System.Net.FtpClient.FtpHashAlgorithm)">
  1031. <summary>
  1032. Tells the server which hash algorith to use
  1033. for the HASH command. If you specifiy an
  1034. algorithm not listed in FtpClient.HashTypes
  1035. a NotImplemented() exectpion will be thrown
  1036. so be sure to query that list of Flags before
  1037. selecting a hash algorithm. Support for the
  1038. HASH command is experimental. Please see
  1039. the following link for more details:
  1040. http://tools.ietf.org/html/draft-bryan-ftpext-hash-02
  1041. </summary>
  1042. <param name="type">Hash Algorithm</param>
  1043. <example><code source="..\Examples\SetHashAlgorithm.cs" lang="cs" /></example>
  1044. </member>
  1045. <member name="M:System.Net.FtpClient.IFtpClient.BeginSetHashAlgorithm(System.Net.FtpClient.FtpHashAlgorithm,System.AsyncCallback,System.Object)">
  1046. <summary>
  1047. Asynchronously sets the hash algorithm type to be used with the HASH command.
  1048. </summary>
  1049. <param name="type">Hash algorithm to use</param>
  1050. <param name="callback">Async Callback</param>
  1051. <param name="state">State object</param>
  1052. <returns>IAsyncResult</returns>
  1053. </member>
  1054. <member name="M:System.Net.FtpClient.IFtpClient.EndSetHashAlgorithm(System.IAsyncResult)">
  1055. <summary>
  1056. Ends an asynchronous call to BeginSetHashAlgorithm
  1057. </summary>
  1058. <param name="ar">IAsyncResult returned from BeginSetHashAlgorithm</param>
  1059. </member>
  1060. <member name="M:System.Net.FtpClient.IFtpClient.GetHash(System.String)">
  1061. <summary>
  1062. Gets the hash of an object on the server using the
  1063. currently selected hash algorithm. Supported
  1064. algorithms, if any, are available in the HashAlgorithms
  1065. property. You should confirm that it's not equal
  1066. to FtpHashAlgorithm.NONE before calling this method
  1067. otherwise the server trigger a FtpCommandException()
  1068. due to a lack of support for the HASH command. You can
  1069. set the algorithm using the SetHashAlgorithm() method and
  1070. you can query the server for the current hash algorithm
  1071. using the GetHashAlgorithm() method.
  1072. This feature is experimental and based on the following draft:
  1073. http://tools.ietf.org/html/draft-bryan-ftpext-hash-02
  1074. </summary>
  1075. <param name="path">Full or relative path of the object to compute the hash for.</param>
  1076. <returns>The hash of the file.</returns>
  1077. <example><code source="..\Examples\GetHash.cs" lang="cs" /></example>
  1078. </member>
  1079. <member name="M:System.Net.FtpClient.IFtpClient.BeginGetHash(System.String,System.AsyncCallback,System.Object)">
  1080. <summary>
  1081. Asynchronously retrieves the hash for the specified file
  1082. </summary>
  1083. <param name="path">The file you want the server to compute the hash for</param>
  1084. <param name="callback">AsyncCallback</param>
  1085. <param name="state">State object</param>
  1086. <returns>IAsyncResult</returns>
  1087. </member>
  1088. <member name="M:System.Net.FtpClient.IFtpClient.EndGetHash(System.IAsyncResult)">
  1089. <summary>
  1090. Ends an asynchronous call to BeginGetHash
  1091. </summary>
  1092. <param name="ar">IAsyncResult returned from BeginGetHash</param>
  1093. </member>
  1094. <member name="M:System.Net.FtpClient.IFtpClient.DisableUTF8">
  1095. <summary>
  1096. Disables UTF8 support and changes the Encoding property
  1097. back to ASCII. If the server returns an error when trying
  1098. to turn UTF8 off a FtpCommandException will be thrown.
  1099. </summary>
  1100. </member>
  1101. <member name="P:System.Net.FtpClient.IFtpClient.IsDisposed">
  1102. <summary>
  1103. Gets a value indicating if this object has already been disposed.
  1104. </summary>
  1105. </member>
  1106. <member name="P:System.Net.FtpClient.IFtpClient.InternetProtocolVersions">
  1107. <summary>
  1108. Flags specifying which versions of the internet protocol to
  1109. support when making a connection. All addresses returned during
  1110. name resolution are tried until a successful connection is made.
  1111. You can fine tune which versions of the internet protocol to use
  1112. by adding or removing flags here. I.e., setting this property
  1113. to FtpIpVersion.IPv4 will cause the connection process to
  1114. ignore IPv6 addresses. The default value is ANY version.
  1115. </summary>
  1116. </member>
  1117. <member name="P:System.Net.FtpClient.IFtpClient.SocketPollInterval">
  1118. <summary>
  1119. Gets or sets the length of time in miliseconds
  1120. that must pass since the last socket activity
  1121. before calling Poll() on the socket to test for
  1122. connectivity. Setting this interval too low will
  1123. have a negative impact on perfomance. Setting this
  1124. interval to 0 disables Poll()'ing all together.
  1125. The default value is 15 seconds.
  1126. </summary>
  1127. </member>
  1128. <member name="P:System.Net.FtpClient.IFtpClient.StaleDataCheck">
  1129. <summary>
  1130. Gets or sets a value indicating whether a test should be performed to
  1131. see if there is stale (unrequested data) sitting on the socket. In some
  1132. cases the control connection may time out but before the server closes
  1133. the connection it might send a 4xx response that was unexpected and
  1134. can cause synchronization errors with transactions. To avoid this
  1135. problem the Execute() method checks to see if there is any data
  1136. available on the socket before executing a command. On Azure hosting
  1137. platforms this check can cause an exception to be thrown. In order
  1138. to work around the exception you can set this property to false
  1139. which will skip the test entirely however doing so eliminates the
  1140. best effort attempt of detecting such scenarios. See this thread
  1141. for more details about the Azure problem:
  1142. https://netftp.codeplex.com/discussions/535879
  1143. </summary>
  1144. </member>
  1145. <member name="P:System.Net.FtpClient.IFtpClient.IsConnected">
  1146. <summary>
  1147. Gets a value indicating if the connection is alive
  1148. </summary>
  1149. </member>
  1150. <member name="P:System.Net.FtpClient.IFtpClient.EnableThreadSafeDataConnections">
  1151. <summary>
  1152. When this value is set to true (default) the control connection
  1153. is cloned and a new connection the server is established for the
  1154. data channel operation. This is a thread safe approach to make
  1155. asynchronous operations on a single control connection transparent
  1156. to the developer.
  1157. </summary>
  1158. </member>
  1159. <member name="P:System.Net.FtpClient.IFtpClient.Encoding">
  1160. <summary>
  1161. Gets or sets the text encoding being used when talking with the server. The default
  1162. value is Encoding.ASCII however upon connection, the client checks
  1163. for UTF8 support and if it's there this property is switched over to
  1164. Encoding.UTF8. Manually setting this value overrides automatic detection
  1165. based on the FEAT list; if you change this value it's always used
  1166. regardless of what the server advertises, if anything.
  1167. </summary>
  1168. </member>
  1169. <member name="P:System.Net.FtpClient.IFtpClient.Host">
  1170. <summary>
  1171. The server to connect to
  1172. </summary>
  1173. </member>
  1174. <member name="P:System.Net.FtpClient.IFtpClient.Port">
  1175. <summary>
  1176. The port to connect to. If this value is set to 0 (Default) the port used
  1177. will be determined by the type of SSL used or if no SSL is to be used it
  1178. will automatically connect to port 21.
  1179. </summary>
  1180. </member>
  1181. <member name="P:System.Net.FtpClient.IFtpClient.Credentials">
  1182. <summary>
  1183. Credentials used for authentication
  1184. </summary>
  1185. </member>
  1186. <member name="P:System.Net.FtpClient.IFtpClient.MaximumDereferenceCount">
  1187. <summary>
  1188. Gets or sets a value that controls the maximum depth
  1189. of recursion that DereferenceLink() will follow symbolic
  1190. links before giving up. You can also specify the value
  1191. to be used as one of the overloaded parameters to the
  1192. DereferenceLink() method. The default value is 20. Specifying
  1193. -1 here means inifinitly try to resolve a link. This is
  1194. not recommended for obvious reasons (stack overflow).
  1195. </summary>
  1196. </member>
  1197. <member name="P:System.Net.FtpClient.IFtpClient.ClientCertificates">
  1198. <summary>
  1199. Client certificates to be used in SSL authentication process
  1200. </summary>
  1201. </member>
  1202. <member name="P:System.Net.FtpClient.IFtpClient.DataConnectionType">
  1203. <summary>
  1204. Data connection type, default is AutoPassive which tries
  1205. a connection with EPSV first and if it fails then tries
  1206. PASV before giving up. If you know exactly which kind of
  1207. connection you need you can slightly increase performance
  1208. by defining a speicific type of passive or active data
  1209. connection here.
  1210. </summary>
  1211. </member>
  1212. <member name="P:System.Net.FtpClient.IFtpClient.UngracefullDisconnection">
  1213. <summary>
  1214. Disconnect from the server without sending QUIT. This helps
  1215. work around IOExceptions caused by buggy connection resets
  1216. when closing the control connection.
  1217. </summary>
  1218. </member>
  1219. <member name="P:System.Net.FtpClient.IFtpClient.ConnectTimeout">
  1220. <summary>
  1221. Gets or sets the length of time in miliseconds to wait for a connection
  1222. attempt to succeed before giving up. Default is 15000 (15 seconds).
  1223. </summary>
  1224. </member>
  1225. <member name="P:System.Net.FtpClient.IFtpClient.ReadTimeout">
  1226. <summary>
  1227. Gets or sets the length of time wait in miliseconds for data to be
  1228. read from the underlying stream. The default value is 15000 (15 seconds).
  1229. </summary>
  1230. </member>
  1231. <member name="P:System.Net.FtpClient.IFtpClient.DataConnectionConnectTimeout">
  1232. <summary>
  1233. Gets or sets the length of time in miliseconds for a data connection
  1234. to be established before giving up. Default is 15000 (15 seconds).
  1235. </summary>
  1236. </member>
  1237. <member name="P:System.Net.FtpClient.IFtpClient.DataConnectionReadTimeout">
  1238. <summary>
  1239. Gets or sets the length of time in miliseconds the data channel
  1240. should wait for the server to send data. Default value is
  1241. 15000 (15 seconds).
  1242. </summary>
  1243. </member>
  1244. <member name="P:System.Net.FtpClient.IFtpClient.SocketKeepAlive">
  1245. <summary>
  1246. Gets or sets a value indicating if SocketOption.KeepAlive should be set on
  1247. the underlying stream's socket. If the connection is alive, the option is
  1248. adjusted in real-time. The value is stored and the KeepAlive option is set
  1249. accordingly upon any new connections. The value set here is also applied to
  1250. all future data streams. It has no affect on cloned control connections or
  1251. data connections already in progress. The default value is false.
  1252. </summary>
  1253. </member>
  1254. <member name="P:System.Net.FtpClient.IFtpClient.Capabilities">
  1255. <summary>
  1256. Gets the server capabilties represented by flags
  1257. </summary>
  1258. </member>
  1259. <member name="P:System.Net.FtpClient.IFtpClient.HashAlgorithms">
  1260. <summary>
  1261. Get the hash types supported by the server, if any. This
  1262. is a recent extension to the protocol that is not fully
  1263. standardized and is not guarateed to work. See here for
  1264. more details:
  1265. http://tools.ietf.org/html/draft-bryan-ftpext-hash-02
  1266. </summary>
  1267. </member>
  1268. <member name="P:System.Net.FtpClient.IFtpClient.EncryptionMode">
  1269. <summary>
  1270. Type of SSL to use, or none. Default is none. Explicit is TLS, Implicit is SSL.
  1271. </summary>
  1272. </member>
  1273. <member name="P:System.Net.FtpClient.IFtpClient.DataConnectionEncryption">
  1274. <summary>
  1275. Indicates if data channel transfers should be encrypted. Only valid if EncryptionMode
  1276. property is not equal to FtpSslMode.None.
  1277. </summary>
  1278. </member>
  1279. <member name="P:System.Net.FtpClient.IFtpClient.SystemType">
  1280. <summary>
  1281. Gets the type of system/server that we're
  1282. connected to.
  1283. </summary>
  1284. </member>
  1285. <member name="E:System.Net.FtpClient.IFtpClient.ValidateCertificate">
  1286. <summary>
  1287. Event is fired to validate SSL certificates. If this event is
  1288. not handled and there are errors validating the certificate
  1289. the connection will be aborted.
  1290. </summary>
  1291. <example><code source="..\Examples\ValidateCertificate.cs" lang="cs" /></example>
  1292. </member>
  1293. <member name="F:System.Net.FtpClient.FtpClient.m_lock">
  1294. <summary>
  1295. Used for internally syncrhonizing access to this
  1296. object from multiple threads
  1297. </summary>
  1298. </member>
  1299. <member name="F:System.Net.FtpClient.FtpClient.m_asyncmethods">
  1300. <summary>
  1301. A list of asynchronoous methods that are in progress
  1302. </summary>
  1303. </member>
  1304. <member name="F:System.Net.FtpClient.FtpClient.m_stream">
  1305. <summary>
  1306. Control connection socket stream
  1307. </summary>
  1308. </member>
  1309. <member name="M:System.Net.FtpClient.FtpClient.HasFeature(System.Net.FtpClient.FtpCapability)">
  1310. <summary>
  1311. Performs a bitwise and to check if the specified
  1312. flag is set on the Capabilities enum property.
  1313. </summary>
  1314. <param name="cap">The capability to check for</param>
  1315. <returns>True if the feature was found</returns>
  1316. </member>
  1317. <member name="M:System.Net.FtpClient.FtpClient.OnValidateCertficate(System.Net.FtpClient.FtpSslValidationEventArgs)">
  1318. <summary>
  1319. Fires the SSL validation event
  1320. </summary>
  1321. <param name="e">Event Args</param>
  1322. </member>
  1323. <member name="M:System.Net.FtpClient.FtpClient.GetAsyncDelegate``1(System.IAsyncResult)">
  1324. <summary>
  1325. Retretieves the delegate for the specified IAsyncResult and removes
  1326. it from the m_asyncmethods collection if the operation is successfull
  1327. </summary>
  1328. <typeparam name="T">Type of delegate to retrieve</typeparam>
  1329. <param name="ar">The IAsyncResult to retrieve the delegate for</param>
  1330. <returns>The delegate that generated the specified IAsyncResult</returns>
  1331. </member>
  1332. <member name="M:System.Net.FtpClient.FtpClient.CloneConnection">
  1333. <summary>
  1334. Clones the control connection for opening multipe data streams
  1335. </summary>
  1336. <returns>A new control connection with the same property settings as this one</returns>
  1337. <example><code source="..\Examples\CloneConnection.cs" lang="cs" /></example>
  1338. </member>
  1339. <member name="M:System.Net.FtpClient.FtpClient.GetReply">
  1340. <summary>
  1341. Retreives a reply from the server. Do not execute this method
  1342. unless you are sure that a reply has been sent, i.e., you
  1343. executed a command. Doing so will cause the code to hang
  1344. indefinitely waiting for a server reply that is never comming.
  1345. </summary>
  1346. <returns>FtpReply representing the response from the server</returns>
  1347. <example><code source="..\Examples\BeginGetReply.cs" lang="cs" /></example>
  1348. </member>
  1349. <member name="M:System.Net.FtpClient.FtpClient.Execute(System.String,System.Object[])">
  1350. <summary>
  1351. Executes a command
  1352. </summary>
  1353. <param name="command">The command to execute with optional format place holders</param>
  1354. <param name="args">Format parameters to the command</param>
  1355. <returns>The servers reply to the command</returns>
  1356. <example><code source="..\Examples\Execute.cs" lang="cs" /></example>
  1357. </member>
  1358. <member name="M:System.Net.FtpClient.FtpClient.Execute(System.String)">
  1359. <summary>
  1360. Executes a command
  1361. </summary>
  1362. <param name="command">The command to execute</param>
  1363. <returns>The servers reply to the command</returns>
  1364. <example><code source="..\Examples\Execute.cs" lang="cs" /></example>
  1365. </member>
  1366. <member name="M:System.Net.FtpClient.FtpClient.BeginExecute(System.String,System.AsyncCallback,System.Object)">
  1367. <summary>
  1368. Performs an asynchronouse execution of the specified command
  1369. </summary>
  1370. <param name="command">The command to execute</param>
  1371. <param name="callback">The AsyncCallback method</param>
  1372. <param name="state">State object</param>
  1373. <returns>IAsyncResult</returns>
  1374. <example><code source="..\Examples\BeginExecute.cs" lang="cs" /></example>
  1375. </member>
  1376. <member name="M:System.Net.FtpClient.FtpClient.EndExecute(System.IAsyncResult)">
  1377. <summary>
  1378. Ends an asynchronous command
  1379. </summary>
  1380. <param name="ar">IAsyncResult returned from BeginExecute</param>
  1381. <returns>FtpReply object (never null).</returns>
  1382. <example><code source="..\Examples\BeginExecute.cs" lang="cs" /></example>
  1383. </member>
  1384. <member name="M:System.Net.FtpClient.FtpClient.Connect">
  1385. <summary>
  1386. Connect to the server. Throws ObjectDisposedException if this object has been disposed.
  1387. </summary>
  1388. <example><code source="..\Examples\Connect.cs" lang="cs" /></example>
  1389. </member>
  1390. <member name="M:System.Net.FtpClient.FtpClient.Authenticate">
  1391. <summary>
  1392. Performs a login on the server. This method is overridable so
  1393. that the login procedure can be changed to support, for example,
  1394. a FTP proxy.
  1395. </summary>
  1396. </member>
  1397. <member name="M:System.Net.FtpClient.FtpClient.GetFeatures(System.Net.FtpClient.FtpReply)">
  1398. <summary>
  1399. Populates the capabilities flags based on capabilities
  1400. supported by this server. This method is overridable
  1401. so that new features can be supported
  1402. </summary>
  1403. <param name="reply">The reply object from the FEAT command. The InfoMessages property will
  1404. contain a list of the features the server supported delimited by a new line '\n' character.</param>
  1405. </member>
  1406. <member name="M:System.Net.FtpClient.FtpClient.BeginConnect(System.AsyncCallback,System.Object)">
  1407. <summary>
  1408. Initiates a connection to the server
  1409. </summary>
  1410. <param name="callback">AsyncCallback method</param>
  1411. <param name="state">State object</param>
  1412. <returns>IAsyncResult</returns>
  1413. <example><code source="..\Examples\BeginConnect.cs" lang="cs" /></example>
  1414. </member>
  1415. <member name="M:System.Net.FtpClient.FtpClient.EndConnect(System.IAsyncResult)">
  1416. <summary>
  1417. Ends an asynchronous connection attempt to the server
  1418. </summary>
  1419. <param name="ar">IAsyncResult returned from BeginConnect()</param>
  1420. <example><code source="..\Examples\BeginConnect.cs" lang="cs" /></example>
  1421. </member>
  1422. <member name="M:System.Net.FtpClient.FtpClient.FireValidateCertficate(System.Net.FtpClient.FtpSocketStream,System.Net.FtpClient.FtpSslValidationEventArgs)">
  1423. <summary>
  1424. Catches the socket stream ssl validation event and fires the event handlers
  1425. attached to this object for validating SSL certificates
  1426. </summary>
  1427. <param name="stream">The stream that fired the event</param>
  1428. <param name="e">The event args used to validate the certficate</param>
  1429. </member>
  1430. <member name="M:System.Net.FtpClient.FtpClient.Disconnect">
  1431. <summary>
  1432. Disconnect from the server
  1433. </summary>
  1434. </member>
  1435. <member name="M:System.Net.FtpClient.FtpClient.BeginDisconnect(System.AsyncCallback,System.Object)">
  1436. <summary>
  1437. Initiates a disconnection on the server
  1438. </summary>
  1439. <param name="callback">AsyncCallback method</param>
  1440. <param name="state">State object</param>
  1441. <returns>IAsyncResult</returns>
  1442. <example><code source="..\Examples\BeginDisconnect.cs" lang="cs" /></example>
  1443. </member>
  1444. <member name="M:System.Net.FtpClient.FtpClient.EndDisconnect(System.IAsyncResult)">
  1445. <summary>
  1446. Ends a call to BeginDisconnect
  1447. </summary>
  1448. <param name="ar">IAsyncResult returned from BeginDisconnect</param>
  1449. <example><code source="..\Examples\BeginConnect.cs" lang="cs" /></example>
  1450. </member>
  1451. <member name="M:System.Net.FtpClient.FtpClient.OpenPassiveDataStream(System.Net.FtpClient.FtpDataConnectionType,System.String,System.Int64)">
  1452. <summary>
  1453. Opens the specified type of passive data stream
  1454. </summary>
  1455. <param name="type">Type of passive data stream to open</param>
  1456. <param name="command">The command to execute that requires a data stream</param>
  1457. <param name="restart">Restart location in bytes for file transfer</param>
  1458. <returns>A data stream ready to be used</returns>
  1459. </member>
  1460. <member name="M:System.Net.FtpClient.FtpClient.OpenActiveDataStream(System.Net.FtpClient.FtpDataConnectionType,System.String,System.Int64)">
  1461. <summary>
  1462. Opens the specified type of active data stream
  1463. </summary>
  1464. <param name="type">Type of passive data stream to open</param>
  1465. <param name="command">The command to execute that requires a data stream</param>
  1466. <param name="restart">Restart location in bytes for file transfer</param>
  1467. <returns>A data stream ready to be used</returns>
  1468. </member>
  1469. <member name="M:System.Net.FtpClient.FtpClient.OpenDataStream(System.String,System.Int64)">
  1470. <summary>
  1471. Opens a data stream.
  1472. </summary>
  1473. <param name='command'>The command to execute that requires a data stream</param>
  1474. <param name="restart">Restart location in bytes for file transfer</param>
  1475. <returns>The data stream.</returns>
  1476. </member>
  1477. <member name="M:System.Net.FtpClient.FtpClient.CloseDataStream(System.Net.FtpClient.FtpDataStream)">
  1478. <summary>
  1479. Disconnects a data stream
  1480. </summary>
  1481. <param name="stream">The data stream to close</param>
  1482. </member>
  1483. <member name="M:System.Net.FtpClient.FtpClient.OpenRead(System.String)">
  1484. <summary>
  1485. Opens the specified file for reading
  1486. </summary>
  1487. <param name="path">The full or relative path of the file</param>
  1488. <returns>A stream for reading the file on the server</returns>
  1489. <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
  1490. </member>
  1491. <member name="M:System.Net.FtpClient.FtpClient.OpenRead(System.String,System.Net.FtpClient.FtpDataType)">
  1492. <summary>
  1493. Opens the specified file for reading
  1494. </summary>
  1495. <param name="path">The full or relative path of the file</param>
  1496. <param name="type">ASCII/Binary</param>
  1497. <returns>A stream for reading the file on the server</returns>
  1498. <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
  1499. </member>
  1500. <member name="M:System.Net.FtpClient.FtpClient.OpenRead(System.String,System.Int64)">
  1501. <summary>
  1502. Opens the specified file for reading
  1503. </summary>
  1504. <param name="path">The full or relative path of the file</param>
  1505. <param name="restart">Resume location</param>
  1506. <returns>A stream for reading the file on the server</returns>
  1507. <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
  1508. </member>
  1509. <member name="M:System.Net.FtpClient.FtpClient.OpenRead(System.String,System.Net.FtpClient.FtpDataType,System.Int64)">
  1510. <summary>
  1511. Opens the specified file for reading
  1512. </summary>
  1513. <param name="path">The full or relative path of the file</param>
  1514. <param name="type">ASCII/Binary</param>
  1515. <param name="restart">Resume location</param>
  1516. <returns>A stream for reading the file on the server</returns>
  1517. <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
  1518. </member>
  1519. <member name="M:System.Net.FtpClient.FtpClient.BeginOpenRead(System.String,System.AsyncCallback,System.Object)">
  1520. <summary>
  1521. Opens the specified file for reading
  1522. </summary>
  1523. <param name="path">The full or relative path of the file</param>
  1524. <param name="callback">Async Callback</param>
  1525. <param name="state">State object</param>
  1526. <returns>IAsyncResult</returns>
  1527. <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
  1528. </member>
  1529. <member name="M:System.Net.FtpClient.FtpClient.BeginOpenRead(System.String,System.Net.FtpClient.FtpDataType,System.AsyncCallback,System.Object)">
  1530. <summary>
  1531. Opens the specified file for reading
  1532. </summary>
  1533. <param name="path">The full or relative path of the file</param>
  1534. <param name="type">ASCII/Binary</param>
  1535. <param name="callback">Async Callback</param>
  1536. <param name="state">State object</param>
  1537. <returns>IAsyncResult</returns>
  1538. <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
  1539. </member>
  1540. <member name="M:System.Net.FtpClient.FtpClient.BeginOpenRead(System.String,System.Int64,System.AsyncCallback,System.Object)">
  1541. <summary>
  1542. Opens the specified file for reading
  1543. </summary>
  1544. <param name="path">The full or relative path of the file</param>
  1545. <param name="restart">Resume location</param>
  1546. <param name="callback">Async Callback</param>
  1547. <param name="state">State object</param>
  1548. <returns>IAsyncResult</returns>
  1549. <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
  1550. </member>
  1551. <member name="M:System.Net.FtpClient.FtpClient.BeginOpenRead(System.String,System.Net.FtpClient.FtpDataType,System.Int64,System.AsyncCallback,System.Object)">
  1552. <summary>
  1553. Opens the specified file for reading
  1554. </summary>
  1555. <param name="path">The full or relative path of the file</param>
  1556. <param name="type">ASCII/Binary</param>
  1557. <param name="restart">Resume location</param>
  1558. <param name="callback">Async Callback</param>
  1559. <param name="state">State object</param>
  1560. <returns>IAsyncResult</returns>
  1561. <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
  1562. </member>
  1563. <member name="M:System.Net.FtpClient.FtpClient.EndOpenRead(System.IAsyncResult)">
  1564. <summary>
  1565. Ends a call to BeginOpenRead()
  1566. </summary>
  1567. <param name="ar">IAsyncResult returned from BeginOpenRead()</param>
  1568. <returns>A readable stream</returns>
  1569. <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
  1570. </member>
  1571. <member name="M:System.Net.FtpClient.FtpClient.OpenWrite(System.String)">
  1572. <summary>
  1573. Opens the specified file for writing
  1574. </summary>
  1575. <param name="path">Full or relative path of the file</param>
  1576. <returns>A stream for writing to the file on the server</returns>
  1577. <example><code source="..\Examples\OpenWrite.cs" lang="cs" /></example>
  1578. </member>
  1579. <member name="M:System.Net.FtpClient.FtpClient.OpenWrite(System.String,System.Net.FtpClient.FtpDataType)">
  1580. <summary>
  1581. Opens the specified file for writing
  1582. </summary>
  1583. <param name="path">Full or relative path of the file</param>
  1584. <param name="type">ASCII/Binary</param>
  1585. <returns>A stream for writing to the file on the server</returns>
  1586. <example><code source="..\Examples\OpenWrite.cs" lang="cs" /></example>
  1587. </member>
  1588. <member name="M:System.Net.FtpClient.FtpClient.BeginOpenWrite(System.String,System.AsyncCallback,System.Object)">
  1589. <summary>
  1590. Opens the specified file for writing
  1591. </summary>
  1592. <param name="path">Full or relative path of the file</param>
  1593. <param name="callback">Async callback</param>
  1594. <param name="state">State object</param>
  1595. <returns>IAsyncResult</returns>
  1596. <example><code source="..\Examples\BeginOpenWrite.cs" lang="cs" /></example>
  1597. </member>
  1598. <member name="M:System.Net.FtpClient.FtpClient.BeginOpenWrite(System.String,System.Net.FtpClient.FtpDataType,System.AsyncCallback,System.Object)">
  1599. <summary>
  1600. Opens the specified file for writing
  1601. </summary>
  1602. <param name="path">Full or relative path of the file</param>
  1603. <param name="type">ASCII/Binary</param>
  1604. <param name="callback">Async callback</param>
  1605. <param name="state">State object</param>
  1606. <returns>IAsyncResult</returns>
  1607. <example><code source="..\Examples\BeginOpenWrite.cs" lang="cs" /></example>
  1608. </member>
  1609. <member name="M:System.Net.FtpClient.FtpClient.EndOpenWrite(System.IAsyncResult)">
  1610. <summary>
  1611. Ends a call to BeginOpenWrite()
  1612. </summary>
  1613. <param name="ar">IAsyncResult returned from BeginOpenWrite()</param>
  1614. <returns>A writable stream</returns>
  1615. <example><code source="..\Examples\BeginOpenWrite.cs" lang="cs" /></example>
  1616. </member>
  1617. <member name="M:System.Net.FtpClient.FtpClient.OpenAppend(System.String)">
  1618. <summary>
  1619. Opens the specified file to be appended to
  1620. </summary>
  1621. <param name="path">The full or relative path to the file to be opened</param>
  1622. <returns>A stream for writing to the file on the server</returns>
  1623. <example><code source="..\Examples\OpenAppend.cs" lang="cs" /></example>
  1624. </member>
  1625. <member name="M:System.Net.FtpClient.FtpClient.OpenAppend(System.String,System.Net.FtpClient.FtpDataType)">
  1626. <summary>
  1627. Opens the specified file to be appended to
  1628. </summary>
  1629. <param name="path">The full or relative path to the file to be opened</param>
  1630. <param name="type">ASCII/Binary</param>
  1631. <returns>A stream for writing to the file on the server</returns>
  1632. <example><code source="..\Examples\OpenAppend.cs" lang="cs" /></example>
  1633. </member>
  1634. <member name="M:System.Net.FtpClient.FtpClient.BeginOpenAppend(System.String,System.AsyncCallback,System.Object)">
  1635. <summary>
  1636. Opens the specified file for writing
  1637. </summary>
  1638. <param name="path">Full or relative path of the file</param>
  1639. <param name="callback">Async callback</param>
  1640. <param name="state">State object</param>
  1641. <returns>IAsyncResult</returns>
  1642. <example><code source="..\Examples\BeginOpenAppend.cs" lang="cs" /></example>
  1643. </member>
  1644. <member name="M:System.Net.FtpClient.FtpClient.BeginOpenAppend(System.String,System.Net.FtpClient.FtpDataType,System.AsyncCallback,System.Object)">
  1645. <summary>
  1646. Opens the specified file for writing
  1647. </summary>
  1648. <param name="path">Full or relative path of the file</param>
  1649. <param name="type">ASCII/Binary</param>
  1650. <param name="callback">Async callback</param>
  1651. <param name="state">State object</param>
  1652. <returns>IAsyncResult</returns>
  1653. <example><code source="..\Examples\BeginOpenAppend.cs" lang="cs" /></example>
  1654. </member>
  1655. <member name="M:System.Net.FtpClient.FtpClient.EndOpenAppend(System.IAsyncResult)">
  1656. <summary>
  1657. Ends a call to BeginOpenAppend()
  1658. </summary>
  1659. <param name="ar">IAsyncResult returned from BeginOpenWrite()</param>
  1660. <returns>A writable stream</returns>
  1661. <example><code source="..\Examples\BeginOpenAppend.cs" lang="cs" /></example>
  1662. </member>
  1663. <member name="M:System.Net.FtpClient.FtpClient.DereferenceLink(System.Net.FtpClient.FtpListItem)">
  1664. <summary>
  1665. Recursively dereferences a symbolic link. See the
  1666. MaximumDereferenceCount property for controlling
  1667. how deep this method will recurse before giving up.
  1668. </summary>
  1669. <param name="item">The symbolic link</param>
  1670. <returns>FtpListItem, null if the link can't be dereferenced</returns>
  1671. <example><code source="..\Examples\DereferenceLink.cs" lang="cs" /></example>
  1672. </member>
  1673. <member name="M:System.Net.FtpClient.FtpClient.DereferenceLink(System.Net.FtpClient.FtpListItem,System.Int32)">
  1674. <summary>
  1675. Recursively dereferences a symbolic link
  1676. </summary>
  1677. <param name="item">The symbolic link</param>
  1678. <param name="recMax">The maximum depth of recursion that can be performed before giving up.</param>
  1679. <returns>FtpListItem, null if the link can't be dereferenced</returns>
  1680. <example><code source="..\Examples\DereferenceLink.cs" lang="cs" /></example>
  1681. </member>
  1682. <member name="M:System.Net.FtpClient.FtpClient.DereferenceLink(System.Net.FtpClient.FtpListItem,System.Int32,System.Int32@)">
  1683. <summary>
  1684. Derefence a FtpListItem object
  1685. </summary>
  1686. <param name="item">The item to derefence</param>
  1687. <param name="recMax">Maximum recursive calls</param>
  1688. <param name="count">Counter</param>
  1689. <returns>FtpListItem, null if the link can't be dereferenced</returns>
  1690. <example><code source="..\Examples\DereferenceLink.cs" lang="cs" /></example>
  1691. </member>
  1692. <member name="M:System.Net.FtpClient.FtpClient.BeginDereferenceLink(System.Net.FtpClient.FtpListItem,System.Int32,System.AsyncCallback,System.Object)">
  1693. <summary>
  1694. Derefence a FtpListItem object asynchronously
  1695. </summary>
  1696. <param name="item">The item to derefence</param>
  1697. <param name="recMax">Maximum recursive calls</param>
  1698. <param name="callback">AsyncCallback</param>
  1699. <param name="state">State Object</param>
  1700. <returns>IAsyncResult</returns>
  1701. <example><code source="..\Examples\BeginDereferenceLink.cs" lang="cs" /></example>
  1702. </member>
  1703. <member name="M:System.Net.FtpClient.FtpClient.BeginDereferenceLink(System.Net.FtpClient.FtpListItem,System.AsyncCallback,System.Object)">
  1704. <summary>
  1705. Derefence a FtpListItem object asynchronously. See the
  1706. MaximumDereferenceCount property for controlling
  1707. how deep this method will recurse before giving up.
  1708. </summary>
  1709. <param name="item">The item to derefence</param>
  1710. <param name="callback">AsyncCallback</param>
  1711. <param name="state">State Object</param>
  1712. <returns>IAsyncResult</returns>
  1713. <example><code source="..\Examples\BeginDereferenceLink.cs" lang="cs" /></example>
  1714. </member>
  1715. <member name="M:System.Net.FtpClient.FtpClient.EndDereferenceLink(System.IAsyncResult)">
  1716. <summary>
  1717. Ends a call to BeginDereferenceLink
  1718. </summary>
  1719. <param name="ar">IAsyncResult</param>
  1720. <returns>FtpListItem, null if the link can't be dereferenced</returns>
  1721. <example><code source="..\Examples\BeginDereferenceLink.cs" lang="cs" /></example>
  1722. </member>
  1723. <member name="M:System.Net.FtpClient.FtpClient.GetObjectInfo(System.String)">
  1724. <summary>
  1725. Returns information about a file system object. You should check the Capabilities
  1726. flags for the FtpCapability.MLSD flag before calling this method. Failing to do
  1727. so will result in an InvalidOperationException being thrown when the server
  1728. does not support machine listings. Returns null if the server response can't
  1729. be parsed or the server returns a failure completion code. The error for a failure
  1730. is logged with FtpTrace. No exception is thrown on error because that would negate
  1731. the usefullness of this method for checking for the existence of an object.
  1732. </summary>
  1733. <param name="path">The path of the object to retrieve information about</param>
  1734. <returns>A FtpListItem object</returns>
  1735. </member>
  1736. <member name="M:System.Net.FtpClient.FtpClient.BeginGetObjectInfo(System.String,System.AsyncCallback,System.Object)">
  1737. <summary>
  1738. Returns information about a file system object. You should check the Capabilities
  1739. flags for the FtpCapability.MLSD flag before calling this method. Failing to do
  1740. so will result in an InvalidOperationException being thrown when the server
  1741. does not support machine listings. Returns null if the server response can't
  1742. be parsed or the server returns a failure completion code. The error for a failure
  1743. is logged with FtpTrace. No exception is thrown on error because that would negate
  1744. the usefullness of this method for checking for the existence of an object.
  1745. </summary>
  1746. <param name="path">Path of the item to retrieve information about</param>
  1747. <param name="callback">Async Callback</param>
  1748. <param name="state">State object</param>
  1749. <returns>IAsyncResult</returns>
  1750. </member>
  1751. <member name="M:System.Net.FtpClient.FtpClient.EndGetObjectInfo(System.IAsyncResult)">
  1752. <summary>
  1753. Ends a call to BeginGetObjectInfo
  1754. </summary>
  1755. <param name="ar">IAsyncResult returned from BeginGetObjectInfo</param>
  1756. <returns>FtpListItem if the command succeeded, null if there was a problem.</returns>
  1757. </member>
  1758. <member name="M:System.Net.FtpClient.FtpClient.GetListing">
  1759. <summary>
  1760. Gets a file listing from the server. Each FtpListItem object returned
  1761. contains information about the file that was able to be retrieved. If
  1762. a DateTime property is equal to DateTime.MinValue then it means the
  1763. date in question was not able to be retrieved. If the Size property
  1764. is equal to 0 then it means the size of the object could also not
  1765. be retrieved.
  1766. </summary>
  1767. <returns>An array of FtpListItem objects</returns>
  1768. <example><code source="..\Examples\GetListing.cs" lang="cs" /></example>
  1769. </member>
  1770. <member name="M:System.Net.FtpClient.FtpClient.GetListing(System.String)">
  1771. <summary>
  1772. Gets a file listing from the server. Each FtpListItem object returned
  1773. contains information about the file that was able to be retrieved. If
  1774. a DateTime property is equal to DateTime.MinValue then it means the
  1775. date in question was not able to be retrieved. If the Size property
  1776. is equal to 0 then it means the size of the object could also not
  1777. be retrieved.
  1778. </summary>
  1779. <param name="path">The path of the directory to list</param>
  1780. <returns>An array of FtpListItem objects</returns>
  1781. <example><code source="..\Examples\GetListing.cs" lang="cs" /></example>
  1782. </member>
  1783. <member name="M:System.Net.FtpClient.FtpClient.GetListing(System.String,System.Net.FtpClient.FtpListOption)">
  1784. <summary>
  1785. Gets a file listing from the server. Each FtpListItem object returned
  1786. contains information about the file that was able to be retrieved. If
  1787. a DateTime property is equal to DateTime.MinValue then it means the
  1788. date in question was not able to be retrieved. If the Size property
  1789. is equal to 0 then it means the size of the object could also not
  1790. be retrieved.
  1791. </summary>
  1792. <param name="path">The path of the directory to list</param>
  1793. <param name="options">Options that dictacte how a list is performed and what information is gathered.</param>
  1794. <returns>An array of FtpListItem objects</returns>
  1795. <example><code source="..\Examples\GetListing.cs" lang="cs" /></example>
  1796. </member>
  1797. <member name="M:System.Net.FtpClient.FtpClient.BeginGetListing(System.AsyncCallback,System.Object)">
  1798. <summary>
  1799. Gets a file listing from the server asynchronously
  1800. </summary>
  1801. <param name="callback">AsyncCallback method</param>
  1802. <param name="state">State object</param>
  1803. <returns>IAsyncResult</returns>
  1804. <example><code source="..\Examples\BeginGetListing.cs" lang="cs" /></example>
  1805. </member>
  1806. <member name="M:System.Net.FtpClient.FtpClient.BeginGetListing(System.String,System.AsyncCallback,System.Object)">
  1807. <summary>
  1808. Gets a file listing from the server asynchronously
  1809. </summary>
  1810. <param name="path">The path to list</param>
  1811. <param name="callback">AsyncCallback method</param>
  1812. <param name="state">State object</param>
  1813. <returns>IAsyncResult</returns>
  1814. <example><code source="..\Examples\BeginGetListing.cs" lang="cs" /></example>
  1815. </member>
  1816. <member name="M:System.Net.FtpClient.FtpClient.BeginGetListing(System.String,System.Net.FtpClient.FtpListOption,System.AsyncCallback,System.Object)">
  1817. <summary>
  1818. Gets a file listing from the server asynchronously
  1819. </summary>
  1820. <param name="path">The path to list</param>
  1821. <param name="options">Options that dictate how the list operation is performed</param>
  1822. <param name="callback">AsyncCallback method</param>
  1823. <param name="state">State object</param>
  1824. <returns>IAsyncResult</returns>
  1825. <example><code source="..\Examples\BeginGetListing.cs" lang="cs" /></example>
  1826. </member>
  1827. <member name="M:System.Net.FtpClient.FtpClient.EndGetListing(System.IAsyncResult)">
  1828. <summary>
  1829. Ends an asynchronous file listing
  1830. </summary>
  1831. <param name="ar">IAsyncResult return from BeginGetListing()</param>
  1832. <returns>An array of items retrieved in the listing</returns>
  1833. <example><code source="..\Examples\BeginGetListing.cs" lang="cs" /></example>
  1834. </member>
  1835. <member name="M:System.Net.FtpClient.FtpClient.GetNameListing">
  1836. <summary>
  1837. Returns a file/directory listing using the NLST command.
  1838. </summary>
  1839. <returns>A string array of file and directory names if any were returned.</returns>
  1840. </member>
  1841. <member name="M:System.Net.FtpClient.FtpClient.GetNameListing(System.String)">
  1842. <summary>
  1843. Returns a file/directory listing using the NLST command.
  1844. </summary>
  1845. <param name="path">The path of the directory to list</param>
  1846. <returns>A string array of file and directory names if any were returned.</returns>
  1847. <example><code source="..\Examples\GetNameListing.cs" lang="cs" /></example>
  1848. </member>
  1849. <member name="M:System.Net.FtpClient.FtpClient.BeginGetNameListing(System.String,System.AsyncCallback,System.Object)">
  1850. <summary>
  1851. Asynchronously gets a list of file and directory names for the specified path.
  1852. </summary>
  1853. <param name="path">The path of the directory to list</param>
  1854. <param name="callback">Async Callback</param>
  1855. <param name="state">State object</param>
  1856. <returns>IAsyncResult</returns>
  1857. <example><code source="..\Examples\BeginGetNameListing.cs" lang="cs" /></example>
  1858. </member>
  1859. <member name="M:System.Net.FtpClient.FtpClient.BeginGetNameListing(System.AsyncCallback,System.Object)">
  1860. <summary>
  1861. Asynchronously gets a list of file and directory names for the specified path.
  1862. </summary>
  1863. <param name="callback">Async Callback</param>
  1864. <param name="state">State object</param>
  1865. <returns>IAsyncResult</returns>
  1866. <example><code source="..\Examples\BeginGetNameListing.cs" lang="cs" /></example>
  1867. </member>
  1868. <member name="M:System.Net.FtpClient.FtpClient.EndGetNameListing(System.IAsyncResult)">
  1869. <summary>
  1870. Ends a call to BeginGetNameListing()
  1871. </summary>
  1872. <param name="ar">IAsyncResult object returned from BeginGetNameListing</param>
  1873. <returns>An array of file and directory names if any were returned.</returns>
  1874. <example><code source="..\Examples\BeginGetNameListing.cs" lang="cs" /></example>
  1875. </member>
  1876. <member name="M:System.Net.FtpClient.FtpClient.SetDataType(System.Net.FtpClient.FtpDataType)">
  1877. <summary>
  1878. Sets the data type of information sent over the data stream
  1879. </summary>
  1880. <param name="type">ASCII/Binary</param>
  1881. </member>
  1882. <member name="M:System.Net.FtpClient.FtpClient.BeginSetDataType(System.Net.FtpClient.FtpDataType,System.AsyncCallback,System.Object)">
  1883. <summary>
  1884. Asynchronously sets the data type on the server
  1885. </summary>
  1886. <param name="type">ASCII/Binary</param>
  1887. <param name="callback">Async callback</param>
  1888. <param name="state">State object</param>
  1889. <returns>IAsyncResult</returns>
  1890. </member>
  1891. <member name="M:System.Net.FtpClient.FtpClient.EndSetDataType(System.IAsyncResult)">
  1892. <summary>
  1893. Ends a call to BeginSetDataType()
  1894. </summary>
  1895. <param name="ar">IAsyncResult returned from BeginSetDataType()</param>
  1896. </member>
  1897. <member name="M:System.Net.FtpClient.FtpClient.SetWorkingDirectory(System.String)">
  1898. <summary>
  1899. Sets the work directory on the server
  1900. </summary>
  1901. <param name="path">The path of the directory to change to</param>
  1902. <example><code source="..\Examples\SetWorkingDirectory.cs" lang="cs" /></example>
  1903. </member>
  1904. <member name="M:System.Net.FtpClient.FtpClient.BeginSetWorkingDirectory(System.String,System.AsyncCallback,System.Object)">
  1905. <summary>
  1906. Asynchronously changes the working directory on the server
  1907. </summary>
  1908. <param name="path">The directory to change to</param>
  1909. <param name="callback">Async Callback</param>
  1910. <param name="state">State object</param>
  1911. <returns>IAsyncResult</returns>
  1912. <example><code source="..\Examples\BeginSetWorkingDirectory.cs" lang="cs" /></example>
  1913. </member>
  1914. <member name="M:System.Net.FtpClient.FtpClient.EndSetWorkingDirectory(System.IAsyncResult)">
  1915. <summary>
  1916. Ends asynchronous directory change
  1917. </summary>
  1918. <param name="ar">IAsyncResult returned from BeginSetWorkingDirectory</param>
  1919. <example><code source="..\Examples\BeginSetWorkingDirectory.cs" lang="cs" /></example>
  1920. </member>
  1921. <member name="M:System.Net.FtpClient.FtpClient.GetWorkingDirectory">
  1922. <summary>
  1923. 获取当前工作目录
  1924. </summary>
  1925. <returns>The current working directory, ./ if the response couldn't be parsed.</returns>
  1926. <example><code source="..\Examples\GetWorkingDirectory.cs" lang="cs" /></example>
  1927. </member>
  1928. <member name="M:System.Net.FtpClient.FtpClient.BeginGetWorkingDirectory(System.AsyncCallback,System.Object)">
  1929. <summary>
  1930. Asynchronously retrieves the working directory
  1931. </summary>
  1932. <param name="callback">Async callback</param>
  1933. <param name="state">State object</param>
  1934. <returns>IAsyncResult</returns>
  1935. <example><code source="..\Examples\BeginGetWorkingDirectory.cs" lang="cs" /></example>
  1936. </member>
  1937. <member name="M:System.Net.FtpClient.FtpClient.EndGetWorkingDirectory(System.IAsyncResult)">
  1938. <summary>
  1939. Ends an asynchronous call to retrieve the working directory
  1940. </summary>
  1941. <param name="ar">IAsyncResult returned from BeginGetWorkingDirectory</param>
  1942. <returns>The current working directory</returns>
  1943. <example><code source="..\Examples\BeginGetWorkingDirectory.cs" lang="cs" /></example>
  1944. </member>
  1945. <member name="M:System.Net.FtpClient.FtpClient.GetFileSize(System.String)">
  1946. <summary>
  1947. Gets the size of the file
  1948. </summary>
  1949. <param name="path">The full or relative path of the file</param>
  1950. <returns>-1 if the command fails, otherwise the file size</returns>
  1951. <example><code source="..\Examples\GetFileSize.cs" lang="cs" /></example>
  1952. </member>
  1953. <member name="M:System.Net.FtpClient.FtpClient.BeginGetFileSize(System.String,System.AsyncCallback,System.Object)">
  1954. <summary>
  1955. Asynchronously retrieve the size of the specified file
  1956. </summary>
  1957. <param name="path">The full or relative path of the file</param>
  1958. <param name="callback">Async callback</param>
  1959. <param name="state">State object</param>
  1960. <returns>IAsyncResult</returns>
  1961. <example><code source="..\Examples\BeginGetFileSize.cs" lang="cs" /></example>
  1962. </member>
  1963. <member name="M:System.Net.FtpClient.FtpClient.EndGetFileSize(System.IAsyncResult)">
  1964. <summary>
  1965. Ends a call to BeginGetFileSize()
  1966. </summary>
  1967. <param name="ar">IAsyncResult returned from BeginGetFileSize</param>
  1968. <returns>The size of the file, -1 if there was a problem.</returns>
  1969. <example><code source="..\Examples\BeginGetFileSize.cs" lang="cs" /></example>
  1970. </member>
  1971. <member name="M:System.Net.FtpClient.FtpClient.GetModifiedTime(System.String)">
  1972. <summary>
  1973. Gets the modified time of the file
  1974. </summary>
  1975. <param name="path">The full path to the file</param>
  1976. <returns>The modified time, DateTime.MinValue if there was a problem</returns>
  1977. <example><code source="..\Examples\GetModifiedTime.cs" lang="cs" /></example>
  1978. </member>
  1979. <member name="M:System.Net.FtpClient.FtpClient.BeginGetModifiedTime(System.String,System.AsyncCallback,System.Object)">
  1980. <summary>
  1981. Gets the modified time of the file
  1982. </summary>
  1983. <param name="path">The full path to the file</param>
  1984. <param name="callback">Async callback</param>
  1985. <param name="state">State object</param>
  1986. <returns>IAsyncResult</returns>
  1987. <example><code source="..\Examples\BeginGetModifiedTime.cs" lang="cs" /></example>
  1988. </member>
  1989. <member name="M:System.Net.FtpClient.FtpClient.EndGetModifiedTime(System.IAsyncResult)">
  1990. <summary>
  1991. Ends a call to BeginGetModifiedTime()
  1992. </summary>
  1993. <param name="ar">IAsyncResult returned from BeginGetModifiedTime()</param>
  1994. <returns>The modified time, DateTime.MinValue if there was a problem</returns>
  1995. <example><code source="..\Examples\BeginGetModifiedTime.cs" lang="cs" /></example>
  1996. </member>
  1997. <member name="M:System.Net.FtpClient.FtpClient.DeleteFile(System.String)">
  1998. <summary>
  1999. Deletes a file on the server
  2000. </summary>
  2001. <param name="path">The full or relative path to the file</param>
  2002. <example><code source="..\Examples\DeleteFile.cs" lang="cs" /></example>
  2003. </member>
  2004. <member name="M:System.Net.FtpClient.FtpClient.BeginDeleteFile(System.String,System.AsyncCallback,System.Object)">
  2005. <summary>
  2006. Asynchronously deletes a file from the server
  2007. </summary>
  2008. <param name="path">The full or relative path to the file</param>
  2009. <param name="callback">Async callback</param>
  2010. <param name="state">State object</param>
  2011. <returns>IAsyncResult</returns>
  2012. <example><code source="..\Examples\BeginDeleteFile.cs" lang="cs" /></example>
  2013. </member>
  2014. <member name="M:System.Net.FtpClient.FtpClient.EndDeleteFile(System.IAsyncResult)">
  2015. <summary>
  2016. Ends a call to BeginDeleteFile
  2017. </summary>
  2018. <param name="ar">IAsyncResult returned from BeginDeleteFile</param>
  2019. <example><code source="..\Examples\BeginDeleteFile.cs" lang="cs" /></example>
  2020. </member>
  2021. <member name="M:System.Net.FtpClient.FtpClient.DeleteDirectory(System.String)">
  2022. <summary>
  2023. Deletes the specified directory on the server.
  2024. </summary>
  2025. <param name="path">The full or relative path of the directory to delete</param>
  2026. <example><code source="..\Examples\DeleteDirectory.cs" lang="cs" /></example>
  2027. </member>
  2028. <member name="M:System.Net.FtpClient.FtpClient.DeleteDirectory(System.String,System.Boolean)">
  2029. <summary>
  2030. Delets the specified directory on the server
  2031. </summary>
  2032. <param name="path">The full or relative path of the directory to delete</param>
  2033. <param name="force">If the directory is not empty, remove its contents</param>
  2034. <example><code source="..\Examples\DeleteDirectory.cs" lang="cs" /></example>
  2035. </member>
  2036. <member name="M:System.Net.FtpClient.FtpClient.DeleteDirectory(System.String,System.Boolean,System.Net.FtpClient.FtpListOption)">
  2037. <summary>
  2038. Deletes the specified directory on the server
  2039. </summary>
  2040. <param name="path">The full or relative path of the directory to delete</param>
  2041. <param name="force">If the directory is not empty, remove its contents</param>
  2042. <param name="options">FtpListOptions for controlling how the directory
  2043. contents are retrieved with the force option is true. If you experience problems
  2044. the file listing can be fine tuned through this parameter.</param>
  2045. <example><code source="..\Examples\DeleteDirectory.cs" lang="cs" /></example>
  2046. </member>
  2047. <member name="M:System.Net.FtpClient.FtpClient.BeginDeleteDirectory(System.String,System.AsyncCallback,System.Object)">
  2048. <summary>
  2049. Asynchronously removes a directory from the server
  2050. </summary>
  2051. <param name="path">The full or relative path of the directory to delete</param>
  2052. <param name="callback">Async callback</param>
  2053. <param name="state">State object</param>
  2054. <returns>IAsyncResult</returns>
  2055. <example><code source="..\Examples\BeginDeleteDirectory.cs" lang="cs" /></example>
  2056. </member>
  2057. <member name="M:System.Net.FtpClient.FtpClient.BeginDeleteDirectory(System.String,System.Boolean,System.AsyncCallback,System.Object)">
  2058. <summary>
  2059. Asynchronously removes a directory from the server
  2060. </summary>
  2061. <param name="path">The full or relative path of the directory to delete</param>
  2062. <param name="force">If the directory is not empty, remove its contents</param>
  2063. <param name="callback">Async callback</param>
  2064. <param name="state">State object</param>
  2065. <returns>IAsyncResult</returns>
  2066. <example><code source="..\Examples\BeginDeleteDirectory.cs" lang="cs" /></example>
  2067. </member>
  2068. <member name="M:System.Net.FtpClient.FtpClient.BeginDeleteDirectory(System.String,System.Boolean,System.Net.FtpClient.FtpListOption,System.AsyncCallback,System.Object)">
  2069. <summary>
  2070. Asynchronously removes a directory from the server
  2071. </summary>
  2072. <param name="path">The full or relative path of the directory to delete</param>
  2073. <param name="force">If the directory is not empty, remove its contents</param>
  2074. <param name="options">FtpListOptions for controlling how the directory
  2075. contents are retrieved with the force option is true. If you experience problems
  2076. the file listing can be fine tuned through this parameter.</param>
  2077. <param name="callback">Async callback</param>
  2078. <param name="state">State object</param>
  2079. <returns>IAsyncResult</returns>
  2080. <example><code source="..\Examples\BeginDeleteDirectory.cs" lang="cs" /></example>
  2081. </member>
  2082. <member name="M:System.Net.FtpClient.FtpClient.EndDeleteDirectory(System.IAsyncResult)">
  2083. <summary>
  2084. Ends a call to BeginDeleteDirectory()
  2085. </summary>
  2086. <param name="ar">IAsyncResult returned from BeginDeleteDirectory</param>
  2087. <example><code source="..\Examples\BeginDeleteDirectory.cs" lang="cs" /></example>
  2088. </member>
  2089. <member name="M:System.Net.FtpClient.FtpClient.DirectoryExists(System.String)">
  2090. <summary>
  2091. Tests if the specified directory exists on the server. This
  2092. method works by trying to change the working directory to
  2093. the path specified. If it succeeds, the directory is changed
  2094. back to the old working directory and true is returned. False
  2095. is returned otherwise and since the CWD failed it is assumed
  2096. the working directory is still the same.
  2097. </summary>
  2098. <param name="path">The path of the directory</param>
  2099. <returns>True if it exists, false otherwise.</returns>
  2100. <example><code source="..\Examples\DirectoryExists.cs" lang="cs" /></example>
  2101. </member>
  2102. <member name="M:System.Net.FtpClient.FtpClient.BeginDirectoryExists(System.String,System.AsyncCallback,System.Object)">
  2103. <summary>
  2104. Checks if a directory exists on the server asynchronously.
  2105. </summary>
  2106. <returns>IAsyncResult</returns>
  2107. <param name='path'>The full or relative path of the directory to check for</param>
  2108. <param name='callback'>Async callback</param>
  2109. <param name='state'>State object</param>
  2110. <example><code source="..\Examples\BeginDirectoryExists.cs" lang="cs" /></example>
  2111. </member>
  2112. <member name="M:System.Net.FtpClient.FtpClient.EndDirectoryExists(System.IAsyncResult)">
  2113. <summary>
  2114. Ends a call to BeginDirectoryExists
  2115. </summary>
  2116. <param name="ar">IAsyncResult returned from BeginDirectoryExists</param>
  2117. <returns>True if the directory exists. False otherwise.</returns>
  2118. <example><code source="..\Examples\BeginDirectoryExists.cs" lang="cs" /></example>
  2119. </member>
  2120. <member name="M:System.Net.FtpClient.FtpClient.FileExists(System.String)">
  2121. <summary>
  2122. Checks if a file exsts on the server by taking a
  2123. file listing of the parent directory in the path
  2124. and comparing the results the path supplied.
  2125. </summary>
  2126. <param name="path">The full or relative path to the file</param>
  2127. <returns>True if the file exists</returns>
  2128. <example><code source="..\Examples\FileExists.cs" lang="cs" /></example>
  2129. </member>
  2130. <member name="M:System.Net.FtpClient.FtpClient.FileExists(System.String,System.Net.FtpClient.FtpListOption)">
  2131. <summary>
  2132. Checks if a file exsts on the server by taking a
  2133. file listing of the parent directory in the path
  2134. and comparing the results the path supplied.
  2135. </summary>
  2136. <param name="path">The full or relative path to the file</param>
  2137. <param name="options">Options for controling the file listing used to
  2138. determine if the file exists.</param>
  2139. <returns>True if the file exists</returns>
  2140. <example><code source="..\Examples\FileExists.cs" lang="cs" /></example>
  2141. </member>
  2142. <member name="M:System.Net.FtpClient.FtpClient.BeginFileExists(System.String,System.AsyncCallback,System.Object)">
  2143. <summary>
  2144. Checks if a file exsts on the server by taking a
  2145. file listing of the parent directory in the path
  2146. and comparing the results the path supplied.
  2147. </summary>
  2148. <param name="path">The full or relative path to the file</param>
  2149. <param name="callback">Async callback</param>
  2150. <param name="state">State object</param>
  2151. <returns>IAsyncResult</returns>
  2152. <example><code source="..\Examples\BeginFileExists.cs" lang="cs" /></example>
  2153. </member>
  2154. <member name="M:System.Net.FtpClient.FtpClient.BeginFileExists(System.String,System.Net.FtpClient.FtpListOption,System.AsyncCallback,System.Object)">
  2155. <summary>
  2156. Checks if a file exsts on the server by taking a
  2157. file listing of the parent directory in the path
  2158. and comparing the results the path supplied.
  2159. </summary>
  2160. <param name="path">The full or relative path to the file</param>
  2161. <param name="options">Options for controling the file listing used to
  2162. determine if the file exists.</param>
  2163. <param name="callback">Async callback</param>
  2164. <param name="state">State object</param>
  2165. <returns>IAsyncResult</returns>
  2166. <example><code source="..\Examples\BeginFileExists.cs" lang="cs" /></example>
  2167. </member>
  2168. <member name="M:System.Net.FtpClient.FtpClient.EndFileExists(System.IAsyncResult)">
  2169. <summary>
  2170. Ends a call to BeginFileExists
  2171. </summary>
  2172. <param name="ar">IAsyncResult returned from BeginFileExists</param>
  2173. <returns>True if the file exists</returns>
  2174. <example><code source="..\Examples\BeginFileExists.cs" lang="cs" /></example>
  2175. </member>
  2176. <member name="M:System.Net.FtpClient.FtpClient.CreateDirectory(System.String)">
  2177. <summary>
  2178. Creates a directory on the server. If the preceding
  2179. directories do not exist they are created.
  2180. </summary>
  2181. <param name="path">The full or relative path to the new directory</param>
  2182. <example><code source="..\Examples\CreateDirectory.cs" lang="cs" /></example>
  2183. </member>
  2184. <member name="M:System.Net.FtpClient.FtpClient.CreateDirectory(System.String,System.Boolean)">
  2185. <summary>
  2186. Creates a directory on the server
  2187. </summary>
  2188. <param name="path">The full or relative path to the directory to create</param>
  2189. <param name="force">Try to force all non-existant pieces of the path to be created</param>
  2190. <example><code source="..\Examples\CreateDirectory.cs" lang="cs" /></example>
  2191. </member>
  2192. <member name="M:System.Net.FtpClient.FtpClient.BeginCreateDirectory(System.String,System.AsyncCallback,System.Object)">
  2193. <summary>
  2194. Creates a directory asynchronously
  2195. </summary>
  2196. <param name="path">The full or relative path to the directory to create</param>
  2197. <param name="callback">Async callback</param>
  2198. <param name="state">State object</param>
  2199. <returns>IAsyncResult</returns>
  2200. <example><code source="..\Examples\BeginCreateDirectory.cs" lang="cs" /></example>
  2201. </member>
  2202. <member name="M:System.Net.FtpClient.FtpClient.BeginCreateDirectory(System.String,System.Boolean,System.AsyncCallback,System.Object)">
  2203. <summary>
  2204. Creates a directory asynchronously
  2205. </summary>
  2206. <param name="path">The full or relative path to the directory to create</param>
  2207. <param name="force">Try to create the whole path if the preceding directories do not exist</param>
  2208. <param name="callback">Async callback</param>
  2209. <param name="state">State object</param>
  2210. <returns>IAsyncResult</returns>
  2211. <example><code source="..\Examples\BeginCreateDirectory.cs" lang="cs" /></example>
  2212. </member>
  2213. <member name="M:System.Net.FtpClient.FtpClient.EndCreateDirectory(System.IAsyncResult)">
  2214. <summary>
  2215. Ends a call to BeginCreateDirectory
  2216. </summary>
  2217. <param name="ar">IAsyncResult returned from BeginCreateDirectory</param>
  2218. <example><code source="..\Examples\BeginCreateDirectory.cs" lang="cs" /></example>
  2219. </member>
  2220. <member name="M:System.Net.FtpClient.FtpClient.Rename(System.String,System.String)">
  2221. <summary>
  2222. Renames an object on the remote file system.
  2223. </summary>
  2224. <param name="path">The full or relative path to the object</param>
  2225. <param name="dest">The old or new full or relative path including the new name of the object</param>
  2226. <example><code source="..\Examples\Rename.cs" lang="cs" /></example>
  2227. </member>
  2228. <member name="M:System.Net.FtpClient.FtpClient.BeginRename(System.String,System.String,System.AsyncCallback,System.Object)">
  2229. <summary>
  2230. Asynchronously renames an object on the server
  2231. </summary>
  2232. <param name="path">The full or relative path to the object</param>
  2233. <param name="dest">The old or new full or relative path including the new name of the object</param>
  2234. <param name="callback">Async callback</param>
  2235. <param name="state">State object</param>
  2236. <returns>IAsyncResult</returns>
  2237. <example><code source="..\Examples\BeginRename.cs" lang="cs" /></example>
  2238. </member>
  2239. <member name="M:System.Net.FtpClient.FtpClient.EndRename(System.IAsyncResult)">
  2240. <summary>
  2241. Ends a call to BeginRename
  2242. </summary>
  2243. <param name="ar">IAsyncResult returned from BeginRename</param>
  2244. <example><code source="..\Examples\BeginRename.cs" lang="cs" /></example>
  2245. </member>
  2246. <member name="M:System.Net.FtpClient.FtpClient.GetHashAlgorithm">
  2247. <summary>
  2248. Gets the currently selected hash algorith for the HASH
  2249. command. This feature is experimental. See this link
  2250. for details:
  2251. http://tools.ietf.org/html/draft-bryan-ftpext-hash-02
  2252. </summary>
  2253. <returns>The FtpHashType flag or FtpHashType.NONE if there was a problem.</returns>
  2254. <example><code source="..\Examples\GetHashAlgorithm.cs" lang="cs" /></example>
  2255. </member>
  2256. <member name="M:System.Net.FtpClient.FtpClient.BeginGetHashAlgorithm(System.AsyncCallback,System.Object)">
  2257. <summary>
  2258. Asynchronously get the hash algorithm being used by the HASH command.
  2259. </summary>
  2260. <param name="callback">Async callback</param>
  2261. <param name="state">State object</param>
  2262. <returns>IAsyncResult</returns>
  2263. </member>
  2264. <member name="M:System.Net.FtpClient.FtpClient.EndGetHashAlgorithm(System.IAsyncResult)">
  2265. <summary>
  2266. Ends a call to BeginGetHashAlgorithm
  2267. </summary>
  2268. <param name="ar">IAsyncResult returned from BeginGetHashAlgorithm</param>
  2269. </member>
  2270. <member name="M:System.Net.FtpClient.FtpClient.SetHashAlgorithm(System.Net.FtpClient.FtpHashAlgorithm)">
  2271. <summary>
  2272. Tells the server which hash algorith to use
  2273. for the HASH command. If you specifiy an
  2274. algorithm not listed in FtpClient.HashTypes
  2275. a NotImplemented() exectpion will be thrown
  2276. so be sure to query that list of Flags before
  2277. selecting a hash algorithm. Support for the
  2278. HASH command is experimental. Please see
  2279. the following link for more details:
  2280. http://tools.ietf.org/html/draft-bryan-ftpext-hash-02
  2281. </summary>
  2282. <param name="type">Hash Algorithm</param>
  2283. <example><code source="..\Examples\SetHashAlgorithm.cs" lang="cs" /></example>
  2284. </member>
  2285. <member name="M:System.Net.FtpClient.FtpClient.BeginSetHashAlgorithm(System.Net.FtpClient.FtpHashAlgorithm,System.AsyncCallback,System.Object)">
  2286. <summary>
  2287. Asynchronously sets the hash algorithm type to be used with the HASH command.
  2288. </summary>
  2289. <param name="type">Hash algorithm to use</param>
  2290. <param name="callback">Async Callback</param>
  2291. <param name="state">State object</param>
  2292. <returns>IAsyncResult</returns>
  2293. </member>
  2294. <member name="M:System.Net.FtpClient.FtpClient.EndSetHashAlgorithm(System.IAsyncResult)">
  2295. <summary>
  2296. Ends an asynchronous call to BeginSetHashAlgorithm
  2297. </summary>
  2298. <param name="ar">IAsyncResult returned from BeginSetHashAlgorithm</param>
  2299. </member>
  2300. <member name="M:System.Net.FtpClient.FtpClient.GetHash(System.String)">
  2301. <summary>
  2302. Gets the hash of an object on the server using the
  2303. currently selected hash algorithm. Supported
  2304. algorithms, if any, are available in the HashAlgorithms
  2305. property. You should confirm that it's not equal
  2306. to FtpHashAlgorithm.NONE before calling this method
  2307. otherwise the server trigger a FtpCommandException()
  2308. due to a lack of support for the HASH command. You can
  2309. set the algorithm using the SetHashAlgorithm() method and
  2310. you can query the server for the current hash algorithm
  2311. using the GetHashAlgorithm() method.
  2312. This feature is experimental and based on the following draft:
  2313. http://tools.ietf.org/html/draft-bryan-ftpext-hash-02
  2314. </summary>
  2315. <param name="path">Full or relative path of the object to compute the hash for.</param>
  2316. <returns>The hash of the file.</returns>
  2317. <example><code source="..\Examples\GetHash.cs" lang="cs" /></example>
  2318. </member>
  2319. <member name="M:System.Net.FtpClient.FtpClient.BeginGetHash(System.String,System.AsyncCallback,System.Object)">
  2320. <summary>
  2321. Asynchronously retrieves the hash for the specified file
  2322. </summary>
  2323. <param name="path">The file you want the server to compute the hash for</param>
  2324. <param name="callback">AsyncCallback</param>
  2325. <param name="state">State object</param>
  2326. <returns>IAsyncResult</returns>
  2327. </member>
  2328. <member name="M:System.Net.FtpClient.FtpClient.EndGetHash(System.IAsyncResult)">
  2329. <summary>
  2330. Ends an asynchronous call to BeginGetHash
  2331. </summary>
  2332. <param name="ar">IAsyncResult returned from BeginGetHash</param>
  2333. </member>
  2334. <member name="M:System.Net.FtpClient.FtpClient.DisableUTF8">
  2335. <summary>
  2336. Disables UTF8 support and changes the Encoding property
  2337. back to ASCII. If the server returns an error when trying
  2338. to turn UTF8 off a FtpCommandException will be thrown.
  2339. </summary>
  2340. </member>
  2341. <member name="M:System.Net.FtpClient.FtpClient.Dispose">
  2342. <summary>
  2343. Disconnects from the server, releases resources held by this
  2344. object.
  2345. </summary>
  2346. </member>
  2347. <member name="M:System.Net.FtpClient.FtpClient.Finalize">
  2348. <summary>
  2349. Finalizer
  2350. </summary>
  2351. </member>
  2352. <member name="M:System.Net.FtpClient.FtpClient.#ctor">
  2353. <summary>
  2354. Creates a new isntance of FtpClient
  2355. </summary>
  2356. </member>
  2357. <member name="M:System.Net.FtpClient.FtpClient.Connect(System.Uri,System.Boolean)">
  2358. <summary>
  2359. Connects to the specified URI. If the path specified by the URI ends with a
  2360. / then the working directory is changed to the path specified.
  2361. </summary>
  2362. <param name="uri">The URI to parse</param>
  2363. <param name="checkcertificate">Indicates if a ssl certificate should be validated when using FTPS schemes</param>
  2364. <returns>FtpClient object</returns>
  2365. </member>
  2366. <member name="M:System.Net.FtpClient.FtpClient.Connect(System.Uri)">
  2367. <summary>
  2368. Connects to the specified URI. If the path specified by the URI ends with a
  2369. / then the working directory is changed to the path specified.
  2370. </summary>
  2371. <param name="uri">The URI to parse</param>
  2372. <returns>FtpClient object</returns>
  2373. </member>
  2374. <member name="M:System.Net.FtpClient.FtpClient.OpenRead(System.Uri,System.Boolean,System.Net.FtpClient.FtpDataType,System.Int64)">
  2375. <summary>
  2376. Opens a stream to the file specified by the URI
  2377. </summary>
  2378. <param name="uri">FTP/FTPS URI pointing at a file</param>
  2379. <param name="checkcertificate">Indicates if a ssl certificate should be validated when using FTPS schemes</param>
  2380. <param name="datatype">ASCII/Binary mode</param>
  2381. <param name="restart">Restart location</param>
  2382. <returns>Stream object</returns>
  2383. <example><code source="..\Examples\OpenReadURI.cs" lang="cs" /></example>
  2384. </member>
  2385. <member name="M:System.Net.FtpClient.FtpClient.OpenRead(System.Uri,System.Boolean,System.Net.FtpClient.FtpDataType)">
  2386. <summary>
  2387. Opens a stream to the file specified by the URI
  2388. </summary>
  2389. <param name="uri">FTP/FTPS URI pointing at a file</param>
  2390. <param name="checkcertificate">Indicates if a ssl certificate should be validated when using FTPS schemes</param>
  2391. <param name="datatype">ASCII/Binary mode</param>
  2392. <returns>Stream object</returns>
  2393. <example><code source="..\Examples\OpenReadURI.cs" lang="cs" /></example>
  2394. </member>
  2395. <member name="M:System.Net.FtpClient.FtpClient.OpenRead(System.Uri,System.Boolean)">
  2396. <summary>
  2397. Opens a stream to the file specified by the URI
  2398. </summary>
  2399. <param name="uri">FTP/FTPS URI pointing at a file</param>
  2400. <param name="checkcertificate">Indicates if a ssl certificate should be validated when using FTPS schemes</param>
  2401. <returns>Stream object</returns>
  2402. <example><code source="..\Examples\OpenReadURI.cs" lang="cs" /></example>
  2403. </member>
  2404. <member name="M:System.Net.FtpClient.FtpClient.OpenRead(System.Uri)">
  2405. <summary>
  2406. Opens a stream to the file specified by the URI
  2407. </summary>
  2408. <param name="uri">FTP/FTPS URI pointing at a file</param>
  2409. <returns>Stream object</returns>
  2410. <example><code source="..\Examples\OpenReadURI.cs" lang="cs" /></example>
  2411. </member>
  2412. <member name="M:System.Net.FtpClient.FtpClient.OpenWrite(System.Uri,System.Boolean,System.Net.FtpClient.FtpDataType)">
  2413. <summary>
  2414. Opens a stream to the file specified by the URI
  2415. </summary>
  2416. <param name="uri">FTP/FTPS URI pointing at a file</param>
  2417. <param name="checkcertificate">Indicates if a ssl certificate should be validated when using FTPS schemes</param>
  2418. <param name="datatype">ASCII/Binary mode</param>
  2419. <returns>Stream object</returns>
  2420. <example><code source="..\Examples\OpenWriteURI.cs" lang="cs" /></example>
  2421. </member>
  2422. <member name="M:System.Net.FtpClient.FtpClient.OpenWrite(System.Uri,System.Boolean)">
  2423. <summary>
  2424. Opens a stream to the file specified by the URI
  2425. </summary>
  2426. <param name="uri">FTP/FTPS URI pointing at a file</param>
  2427. <param name="checkcertificate">Indicates if a ssl certificate should be validated when using FTPS schemes</param>
  2428. <returns>Stream object</returns>
  2429. <example><code source="..\Examples\OpenWriteURI.cs" lang="cs" /></example>
  2430. </member>
  2431. <member name="M:System.Net.FtpClient.FtpClient.OpenWrite(System.Uri)">
  2432. <summary>
  2433. Opens a stream to the file specified by the URI
  2434. </summary>
  2435. <param name="uri">FTP/FTPS URI pointing at a file</param>
  2436. <returns>Stream object</returns>
  2437. <example><code source="..\Examples\OpenWriteURI.cs" lang="cs" /></example>
  2438. </member>
  2439. <member name="M:System.Net.FtpClient.FtpClient.OpenAppend(System.Uri,System.Boolean,System.Net.FtpClient.FtpDataType)">
  2440. <summary>
  2441. Opens a stream to the file specified by the URI
  2442. </summary>
  2443. <param name="uri">FTP/FTPS URI pointing at a file</param>
  2444. <param name="checkcertificate">Indicates if a ssl certificate should be validated when using FTPS schemes</param>
  2445. <param name="datatype">ASCII/Binary mode</param>
  2446. <returns>Stream object</returns>
  2447. <example><code source="..\Examples\OpenAppendURI.cs" lang="cs" /></example>
  2448. </member>
  2449. <member name="M:System.Net.FtpClient.FtpClient.OpenAppend(System.Uri,System.Boolean)">
  2450. <summary>
  2451. Opens a stream to the file specified by the URI
  2452. </summary>
  2453. <param name="uri">FTP/FTPS URI pointing at a file</param>
  2454. <param name="checkcertificate">Indicates if a ssl certificate should be validated when using FTPS schemes</param>
  2455. <returns>Stream object</returns>
  2456. <example><code source="..\Examples\OpenAppendURI.cs" lang="cs" /></example>
  2457. </member>
  2458. <member name="M:System.Net.FtpClient.FtpClient.OpenAppend(System.Uri)">
  2459. <summary>
  2460. Opens a stream to the file specified by the URI
  2461. </summary>
  2462. <param name="uri">FTP/FTPS URI pointing at a file</param>
  2463. <returns>Stream object</returns>
  2464. <example><code source="..\Examples\OpenAppendURI.cs" lang="cs" /></example>
  2465. </member>
  2466. <member name="P:System.Net.FtpClient.FtpClient.IsDisposed">
  2467. <summary>
  2468. Gets a value indicating if this object has already been disposed.
  2469. </summary>
  2470. </member>
  2471. <member name="P:System.Net.FtpClient.FtpClient.BaseStream">
  2472. <summary>
  2473. Gets the base stream for talking to the server via
  2474. the control connection.
  2475. </summary>
  2476. </member>
  2477. <member name="P:System.Net.FtpClient.FtpClient.InternetProtocolVersions">
  2478. <summary>
  2479. Flags specifying which versions of the internet protocol to
  2480. support when making a connection. All addresses returned during
  2481. name resolution are tried until a successful connection is made.
  2482. You can fine tune which versions of the internet protocol to use
  2483. by adding or removing flags here. I.e., setting this property
  2484. to FtpIpVersion.IPv4 will cause the connection process to
  2485. ignore IPv6 addresses. The default value is ANY version.
  2486. </summary>
  2487. </member>
  2488. <member name="P:System.Net.FtpClient.FtpClient.SocketPollInterval">
  2489. <summary>
  2490. Gets or sets the length of time in miliseconds
  2491. that must pass since the last socket activity
  2492. before calling Poll() on the socket to test for
  2493. connectivity. Setting this interval too low will
  2494. have a negative impact on perfomance. Setting this
  2495. interval to 0 disables Poll()'ing all together.
  2496. The default value is 15 seconds.
  2497. </summary>
  2498. </member>
  2499. <member name="P:System.Net.FtpClient.FtpClient.StaleDataCheck">
  2500. <summary>
  2501. Gets or sets a value indicating whether a test should be performed to
  2502. see if there is stale (unrequested data) sitting on the socket. In some
  2503. cases the control connection may time out but before the server closes
  2504. the connection it might send a 4xx response that was unexpected and
  2505. can cause synchronization errors with transactions. To avoid this
  2506. problem the Execute() method checks to see if there is any data
  2507. available on the socket before executing a command. On Azure hosting
  2508. platforms this check can cause an exception to be thrown. In order
  2509. to work around the exception you can set this property to false
  2510. which will skip the test entirely however doing so eliminates the
  2511. best effort attempt of detecting such scenarios. See this thread
  2512. for more details about the Azure problem:
  2513. https://netftp.codeplex.com/discussions/535879
  2514. </summary>
  2515. </member>
  2516. <member name="P:System.Net.FtpClient.FtpClient.IsConnected">
  2517. <summary>
  2518. Gets a value indicating if the connection is alive
  2519. </summary>
  2520. </member>
  2521. <member name="P:System.Net.FtpClient.FtpClient.EnableThreadSafeDataConnections">
  2522. <summary>
  2523. When this value is set to true (default) the control connection
  2524. is cloned and a new connection the server is established for the
  2525. data channel operation. This is a thread safe approach to make
  2526. asynchronous operations on a single control connection transparent
  2527. to the developer.
  2528. </summary>
  2529. </member>
  2530. <member name="P:System.Net.FtpClient.FtpClient.IsClone">
  2531. <summary>
  2532. Gets a value indicating if this control connection is a clone. This property
  2533. is used with data streams to determine if the connection should be closed
  2534. when the stream is closed. Servers typically only allow 1 data connection
  2535. per control connection. If you try to open multiple data connections this
  2536. object will be cloned for 2 or more resulting in N new connections to the
  2537. server.
  2538. </summary>
  2539. </member>
  2540. <member name="P:System.Net.FtpClient.FtpClient.Encoding">
  2541. <summary>
  2542. Gets or sets the text encoding being used when talking with the server. The default
  2543. value is Encoding.ASCII however upon connection, the client checks
  2544. for UTF8 support and if it's there this property is switched over to
  2545. Encoding.UTF8. Manually setting this value overrides automatic detection
  2546. based on the FEAT list; if you change this value it's always used
  2547. regardless of what the server advertises, if anything.
  2548. </summary>
  2549. </member>
  2550. <member name="P:System.Net.FtpClient.FtpClient.Host">
  2551. <summary>
  2552. The server to connect to
  2553. </summary>
  2554. </member>
  2555. <member name="P:System.Net.FtpClient.FtpClient.Port">
  2556. <summary>
  2557. The port to connect to. If this value is set to 0 (Default) the port used
  2558. will be determined by the type of SSL used or if no SSL is to be used it
  2559. will automatically connect to port 21.
  2560. </summary>
  2561. </member>
  2562. <member name="P:System.Net.FtpClient.FtpClient.Credentials">
  2563. <summary>
  2564. Credentials used for authentication
  2565. </summary>
  2566. </member>
  2567. <member name="P:System.Net.FtpClient.FtpClient.MaximumDereferenceCount">
  2568. <summary>
  2569. Gets or sets a value that controls the maximum depth
  2570. of recursion that DereferenceLink() will follow symbolic
  2571. links before giving up. You can also specify the value
  2572. to be used as one of the overloaded parameters to the
  2573. DereferenceLink() method. The default value is 20. Specifying
  2574. -1 here means inifinitly try to resolve a link. This is
  2575. not recommended for obvious reasons (stack overflow).
  2576. </summary>
  2577. </member>
  2578. <member name="P:System.Net.FtpClient.FtpClient.ClientCertificates">
  2579. <summary>
  2580. Client certificates to be used in SSL authentication process
  2581. </summary>
  2582. </member>
  2583. <member name="P:System.Net.FtpClient.FtpClient.DataConnectionType">
  2584. <summary>
  2585. 数据连接类型,默认为AutoPassive,它首先尝试与EPSV的连接,
  2586. 如果失败,然后在放弃之前尝试PASV。 如果您确切知道需要哪种连接,
  2587. 您可以通过在此处定义特定类型的被动或活动数据连接来略微提高性能。
  2588. Data connection type, default is AutoPassive which tries
  2589. a connection with EPSV first and if it fails then tries
  2590. PASV before giving up. If you know exactly which kind of
  2591. connection you need you can slightly increase performance
  2592. by defining a speicific type of passive or active data
  2593. connection here.
  2594. </summary>
  2595. </member>
  2596. <member name="P:System.Net.FtpClient.FtpClient.UngracefullDisconnection">
  2597. <summary>
  2598. Disconnect from the server without sending QUIT. This helps
  2599. work around IOExceptions caused by buggy connection resets
  2600. when closing the control connection.
  2601. </summary>
  2602. </member>
  2603. <member name="P:System.Net.FtpClient.FtpClient.ConnectTimeout">
  2604. <summary>
  2605. Gets or sets the length of time in miliseconds to wait for a connection
  2606. attempt to succeed before giving up. Default is 15000 (15 seconds).
  2607. </summary>
  2608. </member>
  2609. <member name="P:System.Net.FtpClient.FtpClient.ReadTimeout">
  2610. <summary>
  2611. Gets or sets the length of time wait in miliseconds for data to be
  2612. read from the underlying stream. The default value is 15000 (15 seconds).
  2613. </summary>
  2614. </member>
  2615. <member name="P:System.Net.FtpClient.FtpClient.DataConnectionConnectTimeout">
  2616. <summary>
  2617. Gets or sets the length of time in miliseconds for a data connection
  2618. to be established before giving up. Default is 15000 (15 seconds).
  2619. </summary>
  2620. </member>
  2621. <member name="P:System.Net.FtpClient.FtpClient.DataConnectionReadTimeout">
  2622. <summary>
  2623. Gets or sets the length of time in miliseconds the data channel
  2624. should wait for the server to send data. Default value is
  2625. 15000 (15 seconds).
  2626. </summary>
  2627. </member>
  2628. <member name="P:System.Net.FtpClient.FtpClient.SocketKeepAlive">
  2629. <summary>
  2630. Gets or sets a value indicating if SocketOption.KeepAlive should be set on
  2631. the underlying stream's socket. If the connection is alive, the option is
  2632. adjusted in real-time. The value is stored and the KeepAlive option is set
  2633. accordingly upon any new connections. The value set here is also applied to
  2634. all future data streams. It has no affect on cloned control connections or
  2635. data connections already in progress. The default value is false.
  2636. </summary>
  2637. </member>
  2638. <member name="P:System.Net.FtpClient.FtpClient.Capabilities">
  2639. <summary>
  2640. Gets the server capabilties represented by flags
  2641. </summary>
  2642. </member>
  2643. <member name="P:System.Net.FtpClient.FtpClient.HashAlgorithms">
  2644. <summary>
  2645. Get the hash types supported by the server, if any. This
  2646. is a recent extension to the protocol that is not fully
  2647. standardized and is not guarateed to work. See here for
  2648. more details:
  2649. http://tools.ietf.org/html/draft-bryan-ftpext-hash-02
  2650. </summary>
  2651. </member>
  2652. <member name="P:System.Net.FtpClient.FtpClient.EncryptionMode">
  2653. <summary>
  2654. 要使用的SSL类型,或无。 默认值为none。 显式是TLS,隐式是SSL。
  2655. Type of SSL to use, or none. Default is none. Explicit is TLS, Implicit is SSL.
  2656. </summary>
  2657. </member>
  2658. <member name="P:System.Net.FtpClient.FtpClient.DataConnectionEncryption">
  2659. <summary>
  2660. Indicates if data channel transfers should be encrypted. Only valid if EncryptionMode
  2661. property is not equal to FtpSslMode.None.
  2662. </summary>
  2663. </member>
  2664. <member name="P:System.Net.FtpClient.FtpClient.SslProtocols">
  2665. <summary>
  2666. Encryption protocols to use. Only valid if EncryptionMode property is not equal to FtpSslMode.None.
  2667. Default value is .NET Framework defaults from SslStream class.
  2668. </summary>
  2669. </member>
  2670. <member name="E:System.Net.FtpClient.FtpClient.ValidateCertificate">
  2671. <summary>
  2672. 触发事件以验证SSL证书。 如果未处理此事件,并且验证证书时出现错误,则连接将中止。
  2673. Event is fired to validate SSL certificates. If this event is
  2674. not handled and there are errors validating the certificate
  2675. the connection will be aborted.
  2676. </summary>
  2677. <example><code source="..\Examples\ValidateCertificate.cs" lang="cs" /></example>
  2678. </member>
  2679. <member name="P:System.Net.FtpClient.FtpClient.SystemType">
  2680. <summary>
  2681. Gets the type of system/server that we're
  2682. connected to.
  2683. </summary>
  2684. </member>
  2685. <member name="T:System.Net.FtpClient.FtpClient.FtpControlConnectionClone">
  2686. <summary>
  2687. Used internally to mark properties in the control connection that
  2688. should be cloned when opening a data connection.
  2689. </summary>
  2690. </member>
  2691. <member name="T:System.Net.FtpClient.FtpDataStream">
  2692. <summary>
  2693. Base class for data stream connections
  2694. </summary>
  2695. </member>
  2696. <member name="T:System.Net.FtpClient.FtpSocketStream">
  2697. <summary>
  2698. Stream class used for talking. Used by FtpClient, extended by FtpDataStream
  2699. </summary>
  2700. </member>
  2701. <member name="F:System.Net.FtpClient.FtpSocketStream.m_lastActivity">
  2702. <summary>
  2703. Used for tacking read/write activity on the socket
  2704. to determine if Poll() should be used to test for
  2705. socket conenctivity. The socket in this class will
  2706. not know it has been disconnected if the remote host
  2707. closes the connection first. Using Poll() avoids
  2708. the exception that would be thrown when trying to
  2709. read or write to the disconnected socket.
  2710. </summary>
  2711. </member>
  2712. <member name="M:System.Net.FtpClient.FtpSocketStream.OnValidateCertificate(System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors)">
  2713. <summary>
  2714. Fires the SSL certificate validation event
  2715. </summary>
  2716. <param name="certificate">Certificate being validated</param>
  2717. <param name="chain">Certificate chain</param>
  2718. <param name="errors">Policy errors if any</param>
  2719. <returns>True if it was accepted, false otherwise</returns>
  2720. </member>
  2721. <member name="M:System.Net.FtpClient.FtpSocketStream.Seek(System.Int64,System.IO.SeekOrigin)">
  2722. <summary>
  2723. Throws an InvalidOperationException
  2724. </summary>
  2725. <param name="offset">Ignored</param>
  2726. <param name="origin">Ignored</param>
  2727. <returns></returns>
  2728. </member>
  2729. <member name="M:System.Net.FtpClient.FtpSocketStream.SetLength(System.Int64)">
  2730. <summary>
  2731. Throws an InvalidOperationException
  2732. </summary>
  2733. <param name="value">Ignored</param>
  2734. </member>
  2735. <member name="M:System.Net.FtpClient.FtpSocketStream.Flush">
  2736. <summary>
  2737. Flushes the stream
  2738. </summary>
  2739. </member>
  2740. <member name="M:System.Net.FtpClient.FtpSocketStream.RawSocketRead(System.Byte[])">
  2741. <summary>
  2742. Bypass the stream and read directly off the socket.
  2743. </summary>
  2744. <param name="buffer">The buffer to read into</param>
  2745. <returns>The number of bytes read</returns>
  2746. </member>
  2747. <member name="M:System.Net.FtpClient.FtpSocketStream.Read(System.Byte[],System.Int32,System.Int32)">
  2748. <summary>
  2749. Reads data from the stream
  2750. </summary>
  2751. <param name="buffer">Buffer to read into</param>
  2752. <param name="offset">Where in the buffer to start</param>
  2753. <param name="count">Number of bytes to be read</param>
  2754. <returns></returns>
  2755. </member>
  2756. <member name="M:System.Net.FtpClient.FtpSocketStream.ReadLine(System.Text.Encoding)">
  2757. <summary>
  2758. Reads a line from the socket
  2759. </summary>
  2760. <returns>A line from the stream, null if there is nothing to read</returns>
  2761. </member>
  2762. <member name="M:System.Net.FtpClient.FtpSocketStream.Write(System.Byte[],System.Int32,System.Int32)">
  2763. <summary>
  2764. Writes data to the stream
  2765. </summary>
  2766. <param name="buffer">Buffer to write to stream</param>
  2767. <param name="offset">Where in the buffer to start</param>
  2768. <param name="count">Number of bytes to be read</param>
  2769. </member>
  2770. <member name="M:System.Net.FtpClient.FtpSocketStream.WriteLine(System.Text.Encoding,System.String)">
  2771. <summary>
  2772. Writes a line to the stream using the specified encoding
  2773. </summary>
  2774. <param name="encoding">Encoding used for writing the line</param>
  2775. <param name="buf">The data to write</param>
  2776. </member>
  2777. <member name="M:System.Net.FtpClient.FtpSocketStream.Dispose">
  2778. <summary>
  2779. Disposes the stream
  2780. </summary>
  2781. </member>
  2782. <member name="M:System.Net.FtpClient.FtpSocketStream.Close">
  2783. <summary>
  2784. Disconnects from server
  2785. </summary>
  2786. </member>
  2787. <member name="M:System.Net.FtpClient.FtpSocketStream.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Boolean)">
  2788. <summary>
  2789. Sets socket options on the underlying socket
  2790. </summary>
  2791. <param name="level">SocketOptionLevel</param>
  2792. <param name="name">SocketOptionName</param>
  2793. <param name="value">SocketOptionValue</param>
  2794. </member>
  2795. <member name="M:System.Net.FtpClient.FtpSocketStream.Connect(System.String,System.Int32,System.Net.FtpClient.FtpIpVersion)">
  2796. <summary>
  2797. Connect to the specified host
  2798. </summary>
  2799. <param name="host">The host to connect to</param>
  2800. <param name="port">The port to connect to</param>
  2801. <param name="ipVersions">Internet Protocol versions to support durring the connection phase</param>
  2802. </member>
  2803. <member name="M:System.Net.FtpClient.FtpSocketStream.ActivateEncryption(System.String)">
  2804. <summary>
  2805. Activates SSL on this stream using default protocols. Fires the ValidateCertificate event.
  2806. If this event is not handled and there are SslPolicyErrors present, the certificate will
  2807. not be accepted.
  2808. </summary>
  2809. <param name="targethost">The host to authenticate the certiciate against</param>
  2810. </member>
  2811. <member name="M:System.Net.FtpClient.FtpSocketStream.ActivateEncryption(System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection)">
  2812. <summary>
  2813. Activates SSL on this stream using default protocols. Fires the ValidateCertificate event.
  2814. If this event is not handled and there are SslPolicyErrors present, the certificate will
  2815. not be accepted.
  2816. </summary>
  2817. <param name="targethost">The host to authenticate the certiciate against</param>
  2818. <param name="clientCerts">A collection of client certificates to use when authenticating the SSL stream</param>
  2819. </member>
  2820. <member name="M:System.Net.FtpClient.FtpSocketStream.ActivateEncryption(System.String,System.Security.Cryptography.X509Certificates.X509CertificateCollection,System.Security.Authentication.SslProtocols)">
  2821. <summary>
  2822. Activates SSL on this stream using the specified protocols. Fires the ValidateCertificate event.
  2823. If this event is not handled and there are SslPolicyErrors present, the certificate will
  2824. not be accepted.
  2825. </summary>
  2826. <param name="targethost">The host to authenticate the certiciate against</param>
  2827. <param name="clientCerts">A collection of client certificates to use when authenticating the SSL stream</param>
  2828. <param name="sslProtocols">A bitwise parameter for supported encryption protocols.</param>
  2829. </member>
  2830. <member name="M:System.Net.FtpClient.FtpSocketStream.Listen(System.Net.IPAddress,System.Int32)">
  2831. <summary>
  2832. Instructs this stream to listen for connections on the specified address and port
  2833. </summary>
  2834. <param name="address">The address to listen on</param>
  2835. <param name="port">The port to listen on</param>
  2836. </member>
  2837. <member name="M:System.Net.FtpClient.FtpSocketStream.Accept">
  2838. <summary>
  2839. Accepts a connection from a listening socket
  2840. </summary>
  2841. </member>
  2842. <member name="M:System.Net.FtpClient.FtpSocketStream.BeginAccept(System.AsyncCallback,System.Object)">
  2843. <summary>
  2844. Asynchronously accepts a connection from a listening socket
  2845. </summary>
  2846. <param name="callback"></param>
  2847. <param name="state"></param>
  2848. <returns></returns>
  2849. </member>
  2850. <member name="M:System.Net.FtpClient.FtpSocketStream.EndAccept(System.IAsyncResult)">
  2851. <summary>
  2852. Completes a BeginAccept() operation
  2853. </summary>
  2854. <param name="ar">IAsyncResult returned from BeginAccept</param>
  2855. </member>
  2856. <member name="P:System.Net.FtpClient.FtpSocketStream.Socket">
  2857. <summary>
  2858. The socket used for talking
  2859. </summary>
  2860. </member>
  2861. <member name="P:System.Net.FtpClient.FtpSocketStream.SocketPollInterval">
  2862. <summary>
  2863. Gets or sets the length of time in miliseconds
  2864. that must pass since the last socket activity
  2865. before calling Poll() on the socket to test for
  2866. connectivity. Setting this interval too low will
  2867. have a negative impact on perfomance. Setting this
  2868. interval to 0 disables Poll()'ing all together.
  2869. The default value is 15 seconds.
  2870. </summary>
  2871. </member>
  2872. <member name="P:System.Net.FtpClient.FtpSocketStream.SocketDataAvailable">
  2873. <summary>
  2874. Gets the number of available bytes on the socket, 0 if the
  2875. socket has not been initalized. This property is used internally
  2876. by FtpClient in an effort to detect disconnections and gracefully
  2877. reconnect the control connection.
  2878. </summary>
  2879. </member>
  2880. <member name="P:System.Net.FtpClient.FtpSocketStream.IsConnected">
  2881. <summary>
  2882. Gets a value indicating if this socket stream is connected
  2883. </summary>
  2884. </member>
  2885. <member name="P:System.Net.FtpClient.FtpSocketStream.IsEncrypted">
  2886. <summary>
  2887. Gets a value indicating if encryption is being used
  2888. </summary>
  2889. </member>
  2890. <member name="P:System.Net.FtpClient.FtpSocketStream.NetworkStream">
  2891. <summary>
  2892. The non-encrypted stream
  2893. </summary>
  2894. </member>
  2895. <member name="P:System.Net.FtpClient.FtpSocketStream.SslStream">
  2896. <summary>
  2897. The encrypted stream
  2898. </summary>
  2899. </member>
  2900. <member name="P:System.Net.FtpClient.FtpSocketStream.BaseStream">
  2901. <summary>
  2902. Underlying stream, could be a NetworkStream or SslStream
  2903. </summary>
  2904. </member>
  2905. <member name="P:System.Net.FtpClient.FtpSocketStream.CanRead">
  2906. <summary>
  2907. Gets a value indicating if this stream can be read
  2908. </summary>
  2909. </member>
  2910. <member name="P:System.Net.FtpClient.FtpSocketStream.CanSeek">
  2911. <summary>
  2912. Gets a value indicating if this stream if seekable
  2913. </summary>
  2914. </member>
  2915. <member name="P:System.Net.FtpClient.FtpSocketStream.CanWrite">
  2916. <summary>
  2917. Gets a value indicating if this stream can be written to
  2918. </summary>
  2919. </member>
  2920. <member name="P:System.Net.FtpClient.FtpSocketStream.Length">
  2921. <summary>
  2922. Gets the length of the stream
  2923. </summary>
  2924. </member>
  2925. <member name="P:System.Net.FtpClient.FtpSocketStream.Position">
  2926. <summary>
  2927. Gets the current position of the stream. Trying to
  2928. set this property throws an InvalidOperationException()
  2929. </summary>
  2930. </member>
  2931. <member name="E:System.Net.FtpClient.FtpSocketStream.ValidateCertificate">
  2932. <summary>
  2933. Event is fired when a SSL certificate needs to be validated
  2934. </summary>
  2935. </member>
  2936. <member name="P:System.Net.FtpClient.FtpSocketStream.ReadTimeout">
  2937. <summary>
  2938. Gets or sets the amount of time to wait for a read operation to complete. Default
  2939. value is Timeout.Infinite.
  2940. </summary>
  2941. </member>
  2942. <member name="P:System.Net.FtpClient.FtpSocketStream.ConnectTimeout">
  2943. <summary>
  2944. Gets or sets the length of time miliseconds to wait
  2945. for a connection succeed before giving up. The default
  2946. is 30000 (30 seconds).
  2947. </summary>
  2948. </member>
  2949. <member name="P:System.Net.FtpClient.FtpSocketStream.LocalEndPoint">
  2950. <summary>
  2951. Gets the local end point of the socket
  2952. </summary>
  2953. </member>
  2954. <member name="P:System.Net.FtpClient.FtpSocketStream.RemoteEndPoint">
  2955. <summary>
  2956. Gets the remote end point of the socket
  2957. </summary>
  2958. </member>
  2959. <member name="M:System.Net.FtpClient.FtpDataStream.Read(System.Byte[],System.Int32,System.Int32)">
  2960. <summary>
  2961. Reads data off the stream
  2962. </summary>
  2963. <param name="buffer">The buffer to read into</param>
  2964. <param name="offset">Where to start in the buffer</param>
  2965. <param name="count">Number of bytes to read</param>
  2966. <returns>The number of bytes read</returns>
  2967. </member>
  2968. <member name="M:System.Net.FtpClient.FtpDataStream.Write(System.Byte[],System.Int32,System.Int32)">
  2969. <summary>
  2970. Writes data to the stream
  2971. </summary>
  2972. <param name="buffer">The buffer to write to the stream</param>
  2973. <param name="offset">Where to start in the buffer</param>
  2974. <param name="count">The number of bytes to write to the buffer</param>
  2975. </member>
  2976. <member name="M:System.Net.FtpClient.FtpDataStream.SetLength(System.Int64)">
  2977. <summary>
  2978. Sets the length of this stream
  2979. </summary>
  2980. <param name="value">Value to apply to the Length property</param>
  2981. </member>
  2982. <member name="M:System.Net.FtpClient.FtpDataStream.SetPosition(System.Int64)">
  2983. <summary>
  2984. Sets the position of the stream. Inteneded to be used
  2985. internally by FtpControlConnection.
  2986. </summary>
  2987. <param name="pos">The position</param>
  2988. </member>
  2989. <member name="M:System.Net.FtpClient.FtpDataStream.Dispose(System.Boolean)">
  2990. <summary>
  2991. Disconnects (if necessary) and releases associated resources
  2992. </summary>
  2993. <param name="disposing">Disposing</param>
  2994. </member>
  2995. <member name="M:System.Net.FtpClient.FtpDataStream.Close">
  2996. <summary>
  2997. Closes the connection and reads the server's reply
  2998. </summary>
  2999. </member>
  3000. <member name="M:System.Net.FtpClient.FtpDataStream.#ctor(System.Net.FtpClient.FtpClient)">
  3001. <summary>
  3002. Creates a new data stream object
  3003. </summary>
  3004. <param name="conn">The control connection to be used for carrying out this operation</param>
  3005. </member>
  3006. <member name="M:System.Net.FtpClient.FtpDataStream.Finalize">
  3007. <summary>
  3008. Finalizer
  3009. </summary>
  3010. </member>
  3011. <member name="P:System.Net.FtpClient.FtpDataStream.CommandStatus">
  3012. <summary>
  3013. Gets the status of the command that was used to open
  3014. this data channel
  3015. </summary>
  3016. </member>
  3017. <member name="P:System.Net.FtpClient.FtpDataStream.ControlConnection">
  3018. <summary>
  3019. Gets or sets the control connection for this data stream. Setting
  3020. the control connection causes the object to be clonded and a new
  3021. connection is made to the server to carry out the task. This ensures
  3022. that multiple streams can be opened simultainously.
  3023. </summary>
  3024. </member>
  3025. <member name="P:System.Net.FtpClient.FtpDataStream.Length">
  3026. <summary>
  3027. Gets or sets the length of the stream. Only valid for file transfers
  3028. and only valid on servers that support the Size command.
  3029. </summary>
  3030. </member>
  3031. <member name="P:System.Net.FtpClient.FtpDataStream.Position">
  3032. <summary>
  3033. Gets or sets the position of the stream
  3034. </summary>
  3035. </member>
  3036. <member name="T:System.Net.FtpClient.FtpEncryptionMode">
  3037. <summary>
  3038. 定义要使用的加密类型
  3039. </summary>
  3040. </member>
  3041. <member name="F:System.Net.FtpClient.FtpEncryptionMode.None">
  3042. <summary>
  3043. 纯文本.
  3044. </summary>
  3045. </member>
  3046. <member name="F:System.Net.FtpClient.FtpEncryptionMode.Implicit">
  3047. <summary>
  3048. 从连接开始使用加密,端口990
  3049. Encryption is used from the start of the connection, port 990
  3050. </summary>
  3051. </member>
  3052. <member name="F:System.Net.FtpClient.FtpEncryptionMode.Explicit">
  3053. <summary>
  3054. 连接以纯文本开始,并在服务器问候后立即使用AUTH命令启用加密。
  3055. Connection starts in plain text and encryption is enabled
  3056. with the AUTH command immediately after the server greeting.
  3057. </summary>
  3058. </member>
  3059. <member name="T:System.Net.FtpClient.FtpResponseType">
  3060. <summary>
  3061. 服务器响应的响应类型
  3062. The type of response the server responded with
  3063. </summary>
  3064. </member>
  3065. <member name="F:System.Net.FtpClient.FtpResponseType.None">
  3066. <summary>
  3067. No response
  3068. </summary>
  3069. </member>
  3070. <member name="F:System.Net.FtpClient.FtpResponseType.PositivePreliminary">
  3071. <summary>
  3072. Success
  3073. </summary>
  3074. </member>
  3075. <member name="F:System.Net.FtpClient.FtpResponseType.PositiveCompletion">
  3076. <summary>
  3077. Successs
  3078. </summary>
  3079. </member>
  3080. <member name="F:System.Net.FtpClient.FtpResponseType.PositiveIntermediate">
  3081. <summary>
  3082. Succcess
  3083. </summary>
  3084. </member>
  3085. <member name="F:System.Net.FtpClient.FtpResponseType.TransientNegativeCompletion">
  3086. <summary>
  3087. Temporary failure
  3088. </summary>
  3089. </member>
  3090. <member name="F:System.Net.FtpClient.FtpResponseType.PermanentNegativeCompletion">
  3091. <summary>
  3092. Permanent failure
  3093. </summary>
  3094. </member>
  3095. <member name="T:System.Net.FtpClient.FtpCapability">
  3096. <summary>
  3097. Server features
  3098. </summary>
  3099. </member>
  3100. <member name="F:System.Net.FtpClient.FtpCapability.NONE">
  3101. <summary>
  3102. This server said it doesn't support anything!
  3103. </summary>
  3104. </member>
  3105. <member name="F:System.Net.FtpClient.FtpCapability.MLSD">
  3106. <summary>
  3107. Supports the MLST command
  3108. </summary>
  3109. </member>
  3110. <member name="F:System.Net.FtpClient.FtpCapability.SIZE">
  3111. <summary>
  3112. Supports the SIZE command
  3113. </summary>
  3114. </member>
  3115. <member name="F:System.Net.FtpClient.FtpCapability.MDTM">
  3116. <summary>
  3117. Supports the MDTM command
  3118. </summary>
  3119. </member>
  3120. <member name="F:System.Net.FtpClient.FtpCapability.REST">
  3121. <summary>
  3122. Supports download/upload stream resumes
  3123. </summary>
  3124. </member>
  3125. <member name="F:System.Net.FtpClient.FtpCapability.UTF8">
  3126. <summary>
  3127. Supports UTF8
  3128. </summary>
  3129. </member>
  3130. <member name="F:System.Net.FtpClient.FtpCapability.PRET">
  3131. <summary>
  3132. PRET Command used in distributed ftp server software DrFTPD
  3133. </summary>
  3134. </member>
  3135. <member name="F:System.Net.FtpClient.FtpCapability.MFMT">
  3136. <summary>
  3137. Server supports the MFMT command for setting the
  3138. modifid date of an object on the server
  3139. </summary>
  3140. </member>
  3141. <member name="F:System.Net.FtpClient.FtpCapability.MFCT">
  3142. <summary>
  3143. Server supports the MFCT command for setting the
  3144. created date of an object on the server
  3145. </summary>
  3146. </member>
  3147. <member name="F:System.Net.FtpClient.FtpCapability.MFF">
  3148. <summary>
  3149. Server supports the MFF command for setting certain facts
  3150. about file sytem objects. If you need this command, it would
  3151. probably be handy to query FEAT your self and have a look at
  3152. the FtpReply.InfoMessages property to see which facts the server
  3153. allows you to modify.
  3154. </summary>
  3155. </member>
  3156. <member name="F:System.Net.FtpClient.FtpCapability.STAT">
  3157. <summary>
  3158. Server supports the STAT command
  3159. </summary>
  3160. </member>
  3161. <member name="F:System.Net.FtpClient.FtpCapability.HASH">
  3162. <summary>
  3163. Support for the HASH command
  3164. </summary>
  3165. </member>
  3166. <member name="F:System.Net.FtpClient.FtpCapability.MD5">
  3167. <summary>
  3168. Support for the non-standard MD5 command
  3169. </summary>
  3170. </member>
  3171. <member name="F:System.Net.FtpClient.FtpCapability.XMD5">
  3172. <summary>
  3173. Support for the non-standard XMD5 command
  3174. </summary>
  3175. </member>
  3176. <member name="F:System.Net.FtpClient.FtpCapability.XCRC">
  3177. <summary>
  3178. Support for the non-standard XCRC command
  3179. </summary>
  3180. </member>
  3181. <member name="F:System.Net.FtpClient.FtpCapability.XSHA1">
  3182. <summary>
  3183. Support for the non-standard XSHA1 command
  3184. </summary>
  3185. </member>
  3186. <member name="F:System.Net.FtpClient.FtpCapability.XSHA256">
  3187. <summary>
  3188. Support for the non-standard XSHA256 command
  3189. </summary>
  3190. </member>
  3191. <member name="F:System.Net.FtpClient.FtpCapability.XSHA512">
  3192. <summary>
  3193. Support for the non-standard XSHA512 command
  3194. </summary>
  3195. </member>
  3196. <member name="T:System.Net.FtpClient.FtpHashAlgorithm">
  3197. <summary>
  3198. Different types of hashing algorithms for computing checksums.
  3199. </summary>
  3200. </member>
  3201. <member name="F:System.Net.FtpClient.FtpHashAlgorithm.NONE">
  3202. <summary>
  3203. HASH command is not supported
  3204. </summary>
  3205. </member>
  3206. <member name="F:System.Net.FtpClient.FtpHashAlgorithm.SHA1">
  3207. <summary>
  3208. SHA-1
  3209. </summary>
  3210. </member>
  3211. <member name="F:System.Net.FtpClient.FtpHashAlgorithm.SHA256">
  3212. <summary>
  3213. SHA-256
  3214. </summary>
  3215. </member>
  3216. <member name="F:System.Net.FtpClient.FtpHashAlgorithm.SHA512">
  3217. <summary>
  3218. SHA-512
  3219. </summary>
  3220. </member>
  3221. <member name="F:System.Net.FtpClient.FtpHashAlgorithm.MD5">
  3222. <summary>
  3223. MD5
  3224. </summary>
  3225. </member>
  3226. <member name="F:System.Net.FtpClient.FtpHashAlgorithm.CRC">
  3227. <summary>
  3228. CRC
  3229. </summary>
  3230. </member>
  3231. <member name="T:System.Net.FtpClient.FtpIpVersion">
  3232. <summary>
  3233. IP Versions to allow when connecting
  3234. to a server.
  3235. </summary>
  3236. </member>
  3237. <member name="F:System.Net.FtpClient.FtpIpVersion.IPv4">
  3238. <summary>
  3239. Internet Protocol Version 4
  3240. </summary>
  3241. </member>
  3242. <member name="F:System.Net.FtpClient.FtpIpVersion.IPv6">
  3243. <summary>
  3244. Internet Protocol Version 6
  3245. </summary>
  3246. </member>
  3247. <member name="F:System.Net.FtpClient.FtpIpVersion.ANY">
  3248. <summary>
  3249. Allow any supported version
  3250. </summary>
  3251. </member>
  3252. <member name="T:System.Net.FtpClient.FtpDataConnectionType">
  3253. <summary>
  3254. 数据连接类型
  3255. Data connection type
  3256. </summary>
  3257. </member>
  3258. <member name="F:System.Net.FtpClient.FtpDataConnectionType.AutoPassive">
  3259. <summary>
  3260. 这种类型的数据连接的尝试使用EPSV命令
  3261. 如果服务器不支持EPSV它属于回放弃,除非你是通过IPv6连接之前
  3262. PASV命令
  3263. 在这种情况下,不支持PASV命令。
  3264. </summary>
  3265. </member>
  3266. <member name="F:System.Net.FtpClient.FtpDataConnectionType.PASV">
  3267. <summary>
  3268. 被动数据连接。 EPSV是一个更好的
  3269. 如果支持选项。被动连接
  3270. 连接到由服务器dicated的IP地址
  3271. 其可以是或可以不是由客户端可访问的
  3272. 例如NAT设备后面的服务器可能
  3273. 其本地网络上得到的IP地址,该地址
  3274. 是不可访问的客户端。请注意,IPv6的
  3275. 不支持这种类型的数据连接。 如果你
  3276. 要求PASV并通过IPv6 EPSV连接会
  3277. 自动在它的位置被使用。
  3278. </summary>
  3279. </member>
  3280. <member name="F:System.Net.FtpClient.FtpDataConnectionType.PASVEX">
  3281. <summary>
  3282. 同PASV除由服务器提供的主机被忽略
  3283. 和数据conncetion是到同一个地址时,该控制
  3284. 连接被连接到。这在情景如在
  3285. 服务器在提供私人/不可路由的网络地址
  3286. PASV响应。这是功能上等同于EPSV除了一些
  3287. 服务器可能无法实现EPSV命令。请注意,IPv6的
  3288. 不支持这种类型的数据连接。 如果你
  3289. 要求PASV并通过IPv6 EPSV连接会
  3290. 自动在它的位置被使用。
  3291. </summary>
  3292. </member>
  3293. <member name="F:System.Net.FtpClient.FtpDataConnectionType.EPSV">
  3294. <summary>
  3295. 被动扩展的数据连接,推荐。 作品
  3296. 相同,除了与服务器的PASV连接
  3297. 没有规定以连接到一个IP地址,而不是
  3298. 被动连接去使用相同的地址
  3299. 在控制连接。这种类型的数据连接的
  3300. 支持IPv4和IPv6。
  3301. </summary>
  3302. </member>
  3303. <member name="F:System.Net.FtpClient.FtpDataConnectionType.AutoActive">
  3304. <summary>
  3305. 这种类型的数据连接的尝试使用EPRT命令
  3306. 如果服务器不支持EPRT它属于回放弃,除非你是通过IPv6连接之前
  3307. PORT命令
  3308. 在这种情况下不支持PORT命令。
  3309. </summary>
  3310. </member>
  3311. <member name="F:System.Net.FtpClient.FtpDataConnectionType.PORT">
  3312. <summary>
  3313. 有效的数据连接,不推荐,除非
  3314. 你有使用这种类型的具体原因。
  3315. 创建客户端上的监听套接字其中
  3316. 需要在客户端系统上的防火墙例外
  3317. 连接到时以及客户端网络
  3318. 客户端的网络之外的服务器。 此外
  3319. 使用的接口的IP地址,连接到
  3320. 服务器是服务器被告知连接到地址
  3321. ,如果后面的NAT设备,可能无法访问
  3322. 服务器。这种类型的数据连接的不支持
  3323. 通过了IPv6。如果指定端口,并通过IPv6连接
  3324. EPRT将自动替代使用。
  3325. </summary>
  3326. </member>
  3327. <member name="F:System.Net.FtpClient.FtpDataConnectionType.EPRT">
  3328. <summary>
  3329. 扩展有效的数据连接,不推荐
  3330. 除非你有使用此特定的原因
  3331. 类型。创建客户端上的监听套接字
  3332. 这需要在客户端防火墙例外
  3333. 连接到时以及客户端网络
  3334. 客户端的网络之外的服务器。服务器
  3335. 连接到IP地址它看到客户正在添加
  3336. 而来。这种类型的数据连接的支持IPv4和IPv6。
  3337. </summary>
  3338. </member>
  3339. <member name="T:System.Net.FtpClient.FtpDataType">
  3340. <summary>
  3341. 数据传输类型
  3342. Type of data transfer to do
  3343. </summary>
  3344. </member>
  3345. <member name="F:System.Net.FtpClient.FtpDataType.ASCII">
  3346. <summary>
  3347. ASCII transfer
  3348. </summary>
  3349. </member>
  3350. <member name="F:System.Net.FtpClient.FtpDataType.Binary">
  3351. <summary>
  3352. Binary transfer
  3353. </summary>
  3354. </member>
  3355. <member name="T:System.Net.FtpClient.FtpFileSystemObjectType">
  3356. <summary>
  3357. Type of file system of object
  3358. </summary>
  3359. </member>
  3360. <member name="F:System.Net.FtpClient.FtpFileSystemObjectType.File">
  3361. <summary>
  3362. A file
  3363. </summary>
  3364. </member>
  3365. <member name="F:System.Net.FtpClient.FtpFileSystemObjectType.Directory">
  3366. <summary>
  3367. A directory
  3368. </summary>
  3369. </member>
  3370. <member name="F:System.Net.FtpClient.FtpFileSystemObjectType.Link">
  3371. <summary>
  3372. A symbolic link
  3373. </summary>
  3374. </member>
  3375. <member name="T:System.Net.FtpClient.FtpPermission">
  3376. <summary>
  3377. Types of file permissions
  3378. </summary>
  3379. </member>
  3380. <member name="F:System.Net.FtpClient.FtpPermission.None">
  3381. <summary>
  3382. No access
  3383. </summary>
  3384. </member>
  3385. <member name="F:System.Net.FtpClient.FtpPermission.Execute">
  3386. <summary>
  3387. Executable
  3388. </summary>
  3389. </member>
  3390. <member name="F:System.Net.FtpClient.FtpPermission.Write">
  3391. <summary>
  3392. Writeable
  3393. </summary>
  3394. </member>
  3395. <member name="F:System.Net.FtpClient.FtpPermission.Read">
  3396. <summary>
  3397. Readable
  3398. </summary>
  3399. </member>
  3400. <member name="T:System.Net.FtpClient.FtpSpecialPermissions">
  3401. <summary>
  3402. Types of special UNIX permissions
  3403. </summary>
  3404. </member>
  3405. <member name="F:System.Net.FtpClient.FtpSpecialPermissions.None">
  3406. <summary>
  3407. No special permissions are set
  3408. </summary>
  3409. </member>
  3410. <member name="F:System.Net.FtpClient.FtpSpecialPermissions.Sticky">
  3411. <summary>
  3412. Sticky bit is set
  3413. </summary>
  3414. </member>
  3415. <member name="F:System.Net.FtpClient.FtpSpecialPermissions.SetGroupID">
  3416. <summary>
  3417. SGID bit is set
  3418. </summary>
  3419. </member>
  3420. <member name="F:System.Net.FtpClient.FtpSpecialPermissions.SetUserID">
  3421. <summary>
  3422. SUID bit is set
  3423. </summary>
  3424. </member>
  3425. <member name="T:System.Net.FtpClient.FtpListOption">
  3426. <summary>
  3427. Flags that can dicate how a file listing is performed
  3428. </summary>
  3429. </member>
  3430. <member name="F:System.Net.FtpClient.FtpListOption.Modify">
  3431. <summary>
  3432. Load the modify date using MDTM when it could not
  3433. be parsed from the server listing. This only pertains
  3434. to servers that do not implement the MLSD command.
  3435. </summary>
  3436. </member>
  3437. <member name="F:System.Net.FtpClient.FtpListOption.Size">
  3438. <summary>
  3439. Load the file size using the SIZE command when it
  3440. could not be parsed from the server listing. This
  3441. only pertains to servers that do not support the
  3442. MLSD command.
  3443. </summary>
  3444. </member>
  3445. <member name="F:System.Net.FtpClient.FtpListOption.SizeModify">
  3446. <summary>
  3447. Combines the Modify and Size flags
  3448. </summary>
  3449. </member>
  3450. <member name="F:System.Net.FtpClient.FtpListOption.AllFiles">
  3451. <summary>
  3452. Show hidden/dot files. This only pertains to servers
  3453. that do not support the MLSD command. This option
  3454. makes use the non standard -a parameter to LIST to
  3455. tell the server to show hidden files. Since it's a
  3456. non-standard option it may not always work. MLSD listings
  3457. have no such option and whether or not a hidden file is
  3458. shown is at the discretion of the server.
  3459. </summary>
  3460. </member>
  3461. <member name="F:System.Net.FtpClient.FtpListOption.ForceList">
  3462. <summary>
  3463. Force the use of the NLST command even if MLSD
  3464. is supported by the server
  3465. </summary>
  3466. </member>
  3467. <member name="F:System.Net.FtpClient.FtpListOption.NameList">
  3468. <summary>
  3469. Use the NLST command instead of LIST for a reliable file listing
  3470. </summary>
  3471. </member>
  3472. <member name="F:System.Net.FtpClient.FtpListOption.ForceNameList">
  3473. <summary>
  3474. Combines the ForceList and NameList flags
  3475. </summary>
  3476. </member>
  3477. <member name="F:System.Net.FtpClient.FtpListOption.DerefLinks">
  3478. <summary>
  3479. Try to dereference symbolic links
  3480. </summary>
  3481. </member>
  3482. <member name="F:System.Net.FtpClient.FtpListOption.UseLS">
  3483. <summary>
  3484. Sets the ForceList flag and uses `LS' instead of `LIST' as the
  3485. command for getting a directory listing. This option overrides
  3486. ForceNameList and ignores the AllFiles flag.
  3487. </summary>
  3488. </member>
  3489. <member name="F:System.Net.FtpClient.FtpListOption.Recursive">
  3490. <summary>
  3491. Adds the -r option to the list command. Some servers may not
  3492. support this feature.
  3493. </summary>
  3494. </member>
  3495. <member name="F:System.Net.FtpClient.FtpListOption.NoPath">
  3496. <summary>
  3497. Do not retrieve path when no path is supplied to GetListing(),
  3498. instead just execute LIST with no path argument.
  3499. </summary>
  3500. </member>
  3501. <member name="T:System.Net.FtpClient.FtpException">
  3502. <summary>
  3503. FTP related error
  3504. </summary>
  3505. </member>
  3506. <member name="M:System.Net.FtpClient.FtpException.#ctor(System.String)">
  3507. <summary>
  3508. Initializes the exception object
  3509. </summary>
  3510. <param name="message">The error message</param>
  3511. </member>
  3512. <member name="T:System.Net.FtpClient.FtpCommandException">
  3513. <summary>
  3514. Exception triggered on command failures
  3515. </summary>
  3516. </member>
  3517. <member name="M:System.Net.FtpClient.FtpCommandException.#ctor(System.String,System.String)">
  3518. <summary>
  3519. Initalizes a new instance of a FtpResponseException
  3520. </summary>
  3521. <param name="code">Status code</param>
  3522. <param name="message">Associated message</param>
  3523. </member>
  3524. <member name="M:System.Net.FtpClient.FtpCommandException.#ctor(System.Net.FtpClient.FtpReply)">
  3525. <summary>
  3526. Initalizes a new instance of a FtpResponseException
  3527. </summary>
  3528. <param name="reply">The FtpReply to build the exception from</param>
  3529. </member>
  3530. <member name="P:System.Net.FtpClient.FtpCommandException.CompletionCode">
  3531. <summary>
  3532. Gets the completion code associated with the response
  3533. </summary>
  3534. </member>
  3535. <member name="P:System.Net.FtpClient.FtpCommandException.ResponseType">
  3536. <summary>
  3537. The type of response received from the last command executed
  3538. </summary>
  3539. </member>
  3540. <member name="T:System.Net.FtpClient.FtpSecurityNotAvailableException">
  3541. <summary>
  3542. Exception is thrown when encryption could not be negotiated by the server
  3543. </summary>
  3544. </member>
  3545. <member name="M:System.Net.FtpClient.FtpSecurityNotAvailableException.#ctor">
  3546. <summary>
  3547. Default constructor
  3548. </summary>
  3549. </member>
  3550. <member name="M:System.Net.FtpClient.FtpSecurityNotAvailableException.#ctor(System.String)">
  3551. <summary>
  3552. Custom error message
  3553. </summary>
  3554. <param name="message">Error message</param>
  3555. </member>
  3556. <member name="T:System.Net.FtpClient.FtpExtensions">
  3557. <summary>
  3558. Extension methods related to FTP tasks
  3559. </summary>
  3560. </member>
  3561. <member name="M:System.Net.FtpClient.FtpExtensions.GetFtpPath(System.String)">
  3562. <summary>
  3563. Converts the specified path into a valid FTP file system path
  3564. </summary>
  3565. <param name="path">The file system path</param>
  3566. <returns>A path formatted for FTP</returns>
  3567. </member>
  3568. <member name="M:System.Net.FtpClient.FtpExtensions.GetFtpPath(System.String,System.String[])">
  3569. <summary>
  3570. Creates a valid FTP path by appending the specified segments to this string
  3571. </summary>
  3572. <param name="path">This string</param>
  3573. <param name="segments">The path segments to append</param>
  3574. <returns>A valid FTP path</returns>
  3575. </member>
  3576. <member name="M:System.Net.FtpClient.FtpExtensions.GetFtpDirectoryName(System.String)">
  3577. <summary>
  3578. Gets the directory name of a path formatted for a FTP server
  3579. </summary>
  3580. <param name="path">The path</param>
  3581. <returns>The parent directory path</returns>
  3582. </member>
  3583. <member name="M:System.Net.FtpClient.FtpExtensions.GetFtpFileName(System.String)">
  3584. <summary>
  3585. Gets the file name from the path
  3586. </summary>
  3587. <param name="path">The full path to the file</param>
  3588. <returns>The file name</returns>
  3589. </member>
  3590. <member name="M:System.Net.FtpClient.FtpExtensions.GetFtpDate(System.String,System.Globalization.DateTimeStyles)">
  3591. <summary>
  3592. 尝试将字符串FTP数据表示转换成一个日期时间对象
  3593. Tries to convert the string FTP date representation into a date time object
  3594. </summary>
  3595. <param name="date">The date</param>
  3596. <param name="style">UTC/Local Time</param>
  3597. <returns>代表日期的日期时间对象,DateTime.MinValue如果有问题 A date time object representing the date, DateTime.MinValue if there was a problem</returns>
  3598. </member>
  3599. <member name="T:System.Net.FtpClient.FtpHash">
  3600. <summary>
  3601. Represents a computed hash of an object
  3602. on the FTP server. See the following link
  3603. for more information:
  3604. http://tools.ietf.org/html/draft-bryan-ftpext-hash-02
  3605. </summary>
  3606. </member>
  3607. <member name="M:System.Net.FtpClient.FtpHash.Verify(System.String)">
  3608. <summary>
  3609. Computes the hash for the specified file and compares
  3610. it to the value in this object. CRC hashes are not supported
  3611. because there is no built-in support in the .net framework and
  3612. a CRC implementation exceeds the scope of this project. If you
  3613. attempt to Verify() a CRC hash a NotImplemented() exception will
  3614. be thrown.
  3615. </summary>
  3616. <param name="file">The file to compute the hash for</param>
  3617. <returns>True if the computed hash matches what's stored in this object.</returns>
  3618. </member>
  3619. <member name="M:System.Net.FtpClient.FtpHash.Verify(System.IO.Stream)">
  3620. <summary>
  3621. Computes the hash for the specified stream and compares
  3622. it to the value in this object. CRC hashes are not supported
  3623. because there is no built-in support in the .net framework and
  3624. a CRC implementation exceeds the scope of this project. If you
  3625. attempt to Verify() a CRC hash a NotImplemented() exception will
  3626. be thrown.
  3627. </summary>
  3628. <param name="istream">The stream to compute the hash for</param>
  3629. <returns>True if the computed hash matches what's stored in this object.</returns>
  3630. </member>
  3631. <member name="M:System.Net.FtpClient.FtpHash.#ctor">
  3632. <summary>
  3633. Creates an empty instance.
  3634. </summary>
  3635. </member>
  3636. <member name="P:System.Net.FtpClient.FtpHash.Algorithm">
  3637. <summary>
  3638. Gets the algorithm that was used to compute the hash
  3639. </summary>
  3640. </member>
  3641. <member name="P:System.Net.FtpClient.FtpHash.Value">
  3642. <summary>
  3643. Gets the computed hash returned by the server
  3644. </summary>
  3645. </member>
  3646. <member name="P:System.Net.FtpClient.FtpHash.IsValid">
  3647. <summary>
  3648. Gets a value indicating if this object represents a
  3649. valid hash response from the server.
  3650. </summary>
  3651. </member>
  3652. <member name="T:System.Net.FtpClient.FtpListItem">
  3653. <summary>
  3654. Represents a file system object on the server
  3655. </summary>
  3656. <example><code source="..\Examples\CustomParser.cs" lang="cs" /></example>
  3657. </member>
  3658. <member name="T:System.Net.FtpClient.IFtpListItem">
  3659. <summary>
  3660. Represents a file system object on the server
  3661. </summary>
  3662. <example><code source="..\Examples\CustomParser.cs" lang="cs" /></example>
  3663. </member>
  3664. <member name="M:System.Net.FtpClient.IFtpListItem.ToString">
  3665. <summary>
  3666. Returns a string representation of this object and its properties
  3667. </summary>
  3668. <returns>A string value</returns>
  3669. </member>
  3670. <member name="P:System.Net.FtpClient.IFtpListItem.Type">
  3671. <summary>
  3672. Gets the type of file system object. This property can be
  3673. set however this functionality is intended to be done by
  3674. custom parsers.
  3675. </summary>
  3676. </member>
  3677. <member name="P:System.Net.FtpClient.IFtpListItem.FullName">
  3678. <summary>
  3679. Gets the full path name to the object. This property can be
  3680. set however this functionality is intended to be done by
  3681. custom parsers.
  3682. </summary>
  3683. </member>
  3684. <member name="P:System.Net.FtpClient.IFtpListItem.Name">
  3685. <summary>
  3686. Gets the name of the object. This property can be
  3687. set however this functionality is intended to be done by
  3688. custom parsers.
  3689. </summary>
  3690. </member>
  3691. <member name="P:System.Net.FtpClient.IFtpListItem.LinkTarget">
  3692. <summary>
  3693. Gets the target a symbolic link points to. This property can be
  3694. set however this functionality is intended to be done by
  3695. custom parsers.
  3696. </summary>
  3697. </member>
  3698. <member name="P:System.Net.FtpClient.IFtpListItem.LinkObject">
  3699. <summary>
  3700. Gets the object the LinkTarget points to. This property is null unless pass the
  3701. FtpListOption.DerefLink flag in which case GetListing() will try to resolve
  3702. the target itself.
  3703. </summary>
  3704. </member>
  3705. <member name="P:System.Net.FtpClient.IFtpListItem.Modified">
  3706. <summary>
  3707. Gets the last write time of the object. This property can be
  3708. set however this functionality is intended to be done by
  3709. custom parsers.
  3710. </summary>
  3711. </member>
  3712. <member name="P:System.Net.FtpClient.IFtpListItem.Created">
  3713. <summary>
  3714. Gets the created date of the object. This property can be
  3715. set however this functionality is intended to be done by
  3716. custom parsers.
  3717. </summary>
  3718. </member>
  3719. <member name="P:System.Net.FtpClient.IFtpListItem.Size">
  3720. <summary>
  3721. Gets the size of the object. This property can be
  3722. set however this functionality is intended to be done by
  3723. custom parsers.
  3724. </summary>
  3725. </member>
  3726. <member name="P:System.Net.FtpClient.IFtpListItem.SpecialPermissions">
  3727. <summary>
  3728. Gets special UNIX permissions such as Stiky, SUID and SGID. This property can be
  3729. set however this functionality is intended to be done by
  3730. custom parsers.
  3731. </summary>
  3732. </member>
  3733. <member name="P:System.Net.FtpClient.IFtpListItem.OwnerPermissions">
  3734. <summary>
  3735. Gets the owner permissions. This property can be
  3736. set however this functionality is intended to be done by
  3737. custom parsers.
  3738. </summary>
  3739. </member>
  3740. <member name="P:System.Net.FtpClient.IFtpListItem.GroupPermissions">
  3741. <summary>
  3742. Gets the group permissions. This property can be
  3743. set however this functionality is intended to be done by
  3744. custom parsers.
  3745. </summary>
  3746. </member>
  3747. <member name="P:System.Net.FtpClient.IFtpListItem.OthersPermissions">
  3748. <summary>
  3749. Gets the others permissions. This property can be
  3750. set however this functionality is intended to be done by
  3751. custom parsers.
  3752. </summary>
  3753. </member>
  3754. <member name="P:System.Net.FtpClient.IFtpListItem.Input">
  3755. <summary>
  3756. Gets the input string that was parsed to generate the
  3757. values in this object. This property can be
  3758. set however this functionality is intended to be done by
  3759. custom parsers.
  3760. </summary>
  3761. </member>
  3762. <member name="M:System.Net.FtpClient.FtpListItem.ToString">
  3763. <summary>
  3764. Returns a string representation of this object and its properties
  3765. </summary>
  3766. <returns>A string value</returns>
  3767. </member>
  3768. <member name="M:System.Net.FtpClient.FtpListItem.Parse(System.String,System.String,System.Net.FtpClient.FtpCapability)">
  3769. <summary>
  3770. Parses a line from a file listing using the first successful match in the Parsers collection.
  3771. </summary>
  3772. <param name="path">The source path of the file listing</param>
  3773. <param name="buf">A line from the file listing</param>
  3774. <param name="capabilities">Server capabilities</param>
  3775. <returns>A FtpListItem object representing the parsed line, null if the line was
  3776. unable to be parsed. If you have encountered an unsupported list type add a parser
  3777. to the public static Parsers collection of FtpListItem.</returns>
  3778. </member>
  3779. <member name="F:System.Net.FtpClient.FtpListItem.m_parserLock">
  3780. <summary>
  3781. Used for synchronizing access to the Parsers collection
  3782. </summary>
  3783. </member>
  3784. <member name="M:System.Net.FtpClient.FtpListItem.InitParsers">
  3785. <summary>
  3786. Initalizes the default list of parsers
  3787. </summary>
  3788. </member>
  3789. <member name="M:System.Net.FtpClient.FtpListItem.AddParser(System.Net.FtpClient.FtpListItem.Parser)">
  3790. <summary>
  3791. Adds a custom parser
  3792. </summary>
  3793. <param name="parser">The parser delegate to add</param>
  3794. <example><code source="..\Examples\CustomParser.cs" lang="cs" /></example>
  3795. </member>
  3796. <member name="M:System.Net.FtpClient.FtpListItem.ClearParsers">
  3797. <summary>
  3798. Removes all parser delegates
  3799. </summary>
  3800. </member>
  3801. <member name="M:System.Net.FtpClient.FtpListItem.RemoveParser(System.Net.FtpClient.FtpListItem.Parser)">
  3802. <summary>
  3803. Removes the specified parser
  3804. </summary>
  3805. <param name="parser">The parser delegate to remove</param>
  3806. </member>
  3807. <member name="M:System.Net.FtpClient.FtpListItem.ParseMachineList(System.String,System.Net.FtpClient.FtpCapability)">
  3808. <summary>
  3809. Parses MLS* format listings
  3810. </summary>
  3811. <param name="buf">A line from the listing</param>
  3812. <param name="capabilities">Server capabilities</param>
  3813. <returns>FtpListItem if the item is able to be parsed</returns>
  3814. </member>
  3815. <member name="M:System.Net.FtpClient.FtpListItem.ParseUnixList(System.String,System.Net.FtpClient.FtpCapability)">
  3816. <summary>
  3817. Parses LIST format listings
  3818. </summary>
  3819. <param name="buf">A line from the listing</param>
  3820. <param name="capabilities">Server capabilities</param>
  3821. <returns>FtpListItem if the item is able to be parsed</returns>
  3822. </member>
  3823. <member name="M:System.Net.FtpClient.FtpListItem.ParseDosList(System.String,System.Net.FtpClient.FtpCapability)">
  3824. <summary>
  3825. Parses IIS DOS format listings
  3826. </summary>
  3827. <param name="buf">A line from the listing</param>
  3828. <param name="capabilities">Server capabilities</param>
  3829. <returns>FtpListItem if the item is able to be parsed</returns>
  3830. </member>
  3831. <member name="P:System.Net.FtpClient.FtpListItem.Type">
  3832. <summary>
  3833. Gets the type of file system object. This property can be
  3834. set however this functionality is intended to be done by
  3835. custom parsers.
  3836. </summary>
  3837. </member>
  3838. <member name="P:System.Net.FtpClient.FtpListItem.FullName">
  3839. <summary>
  3840. Gets the full path name to the object. This property can be
  3841. set however this functionality is intended to be done by
  3842. custom parsers.
  3843. </summary>
  3844. </member>
  3845. <member name="P:System.Net.FtpClient.FtpListItem.Name">
  3846. <summary>
  3847. Gets the name of the object. This property can be
  3848. set however this functionality is intended to be done by
  3849. custom parsers.
  3850. </summary>
  3851. </member>
  3852. <member name="P:System.Net.FtpClient.FtpListItem.LinkTarget">
  3853. <summary>
  3854. Gets the target a symbolic link points to. This property can be
  3855. set however this functionality is intended to be done by
  3856. custom parsers.
  3857. </summary>
  3858. </member>
  3859. <member name="P:System.Net.FtpClient.FtpListItem.LinkObject">
  3860. <summary>
  3861. Gets the object the LinkTarget points to. This property is null unless pass the
  3862. FtpListOption.DerefLink flag in which case GetListing() will try to resolve
  3863. the target itself.
  3864. </summary>
  3865. </member>
  3866. <member name="P:System.Net.FtpClient.FtpListItem.Modified">
  3867. <summary>
  3868. Gets the last write time of the object. This property can be
  3869. set however this functionality is intended to be done by
  3870. custom parsers.
  3871. </summary>
  3872. </member>
  3873. <member name="P:System.Net.FtpClient.FtpListItem.Created">
  3874. <summary>
  3875. Gets the created date of the object. This property can be
  3876. set however this functionality is intended to be done by
  3877. custom parsers.
  3878. </summary>
  3879. </member>
  3880. <member name="P:System.Net.FtpClient.FtpListItem.Size">
  3881. <summary>
  3882. Gets the size of the object. This property can be
  3883. set however this functionality is intended to be done by
  3884. custom parsers.
  3885. </summary>
  3886. </member>
  3887. <member name="P:System.Net.FtpClient.FtpListItem.SpecialPermissions">
  3888. <summary>
  3889. Gets special UNIX permissions such as Stiky, SUID and SGID. This property can be
  3890. set however this functionality is intended to be done by
  3891. custom parsers.
  3892. </summary>
  3893. </member>
  3894. <member name="P:System.Net.FtpClient.FtpListItem.OwnerPermissions">
  3895. <summary>
  3896. Gets the owner permissions. This property can be
  3897. set however this functionality is intended to be done by
  3898. custom parsers.
  3899. </summary>
  3900. </member>
  3901. <member name="P:System.Net.FtpClient.FtpListItem.GroupPermissions">
  3902. <summary>
  3903. Gets the group permissions. This property can be
  3904. set however this functionality is intended to be done by
  3905. custom parsers.
  3906. </summary>
  3907. </member>
  3908. <member name="P:System.Net.FtpClient.FtpListItem.OthersPermissions">
  3909. <summary>
  3910. Gets the others permissions. This property can be
  3911. set however this functionality is intended to be done by
  3912. custom parsers.
  3913. </summary>
  3914. </member>
  3915. <member name="P:System.Net.FtpClient.FtpListItem.Input">
  3916. <summary>
  3917. Gets the input string that was parsed to generate the
  3918. values in this object. This property can be
  3919. set however this functionality is intended to be done by
  3920. custom parsers.
  3921. </summary>
  3922. </member>
  3923. <member name="P:System.Net.FtpClient.FtpListItem.Parsers">
  3924. <summary>
  3925. Collection of parsers. Each parser object contains
  3926. a regex string that uses named groups, i.e., (?&lt;group_name&gt;foobar).
  3927. The support group names are modify for last write time, size for the
  3928. size and name for the name of the file system object. Each group name is
  3929. optional, if they are present then those values are retrieved from a
  3930. successful match. In addition, each parser contains a Type property
  3931. which gets set in the FtpListItem object to distinguish between different
  3932. types of objects.
  3933. </summary>
  3934. </member>
  3935. <member name="T:System.Net.FtpClient.FtpListItem.Parser">
  3936. <summary>
  3937. Ftp listing line parser
  3938. </summary>
  3939. <param name="line">The line from the listing</param>
  3940. <param name="capabilities">The server capabilities</param>
  3941. <returns>FtpListItem if the line can be parsed, null otherwise</returns>
  3942. </member>
  3943. <member name="T:System.Net.FtpClient.FtpReply">
  3944. <summary>
  3945. Represents a reply to an event on the server
  3946. </summary>
  3947. </member>
  3948. <member name="T:System.Net.FtpClient.IFtpReply">
  3949. <summary>
  3950. Represents a reply to an event on the server
  3951. </summary>
  3952. </member>
  3953. <member name="P:System.Net.FtpClient.IFtpReply.Type">
  3954. <summary>
  3955. The type of response received from the last command executed
  3956. </summary>
  3957. </member>
  3958. <member name="P:System.Net.FtpClient.IFtpReply.Code">
  3959. <summary>
  3960. The status code of the response
  3961. </summary>
  3962. </member>
  3963. <member name="P:System.Net.FtpClient.IFtpReply.Message">
  3964. <summary>
  3965. The message, if any, that the server sent with the response
  3966. </summary>
  3967. </member>
  3968. <member name="P:System.Net.FtpClient.IFtpReply.InfoMessages">
  3969. <summary>
  3970. Informational messages sent from the server
  3971. </summary>
  3972. </member>
  3973. <member name="P:System.Net.FtpClient.IFtpReply.Success">
  3974. <summary>
  3975. General success or failure of the last command executed
  3976. </summary>
  3977. </member>
  3978. <member name="P:System.Net.FtpClient.IFtpReply.ErrorMessage">
  3979. <summary>
  3980. Gets the error message including any informational output
  3981. that was sent by the server. Sometimes the final response
  3982. line doesn't contain anything informative as to what was going
  3983. on with the server. Instead it may send information messages so
  3984. in an effort to give as meaningful as a response as possible
  3985. the informational messages will be included in the error.
  3986. </summary>
  3987. </member>
  3988. <member name="P:System.Net.FtpClient.FtpReply.Type">
  3989. <summary>
  3990. The type of response received from the last command executed
  3991. </summary>
  3992. </member>
  3993. <member name="P:System.Net.FtpClient.FtpReply.Code">
  3994. <summary>
  3995. The status code of the response
  3996. </summary>
  3997. </member>
  3998. <member name="P:System.Net.FtpClient.FtpReply.Message">
  3999. <summary>
  4000. The message, if any, that the server sent with the response
  4001. </summary>
  4002. </member>
  4003. <member name="P:System.Net.FtpClient.FtpReply.InfoMessages">
  4004. <summary>
  4005. Informational messages sent from the server
  4006. </summary>
  4007. </member>
  4008. <member name="P:System.Net.FtpClient.FtpReply.Success">
  4009. <summary>
  4010. General success or failure of the last command executed
  4011. </summary>
  4012. </member>
  4013. <member name="P:System.Net.FtpClient.FtpReply.ErrorMessage">
  4014. <summary>
  4015. Gets the error message including any informational output
  4016. that was sent by the server. Sometimes the final response
  4017. line doesn't contain anything informative as to what was going
  4018. on with the server. Instead it may send information messages so
  4019. in an effort to give as meaningful as a response as possible
  4020. the informational messages will be included in the error.
  4021. </summary>
  4022. </member>
  4023. <member name="T:System.Net.FtpClient.FtpSocketStreamSslValidation">
  4024. <summary>
  4025. Event fired if a bad SSL certificate is encountered. This even is used internally; if you
  4026. don't have a specific reason for using it you are probably looking for FtpSslValidation.
  4027. </summary>
  4028. <param name="stream"></param>
  4029. <param name="e"></param>
  4030. </member>
  4031. <member name="T:System.Net.FtpClient.FtpSslValidationEventArgs">
  4032. <summary>
  4033. Event args for the FtpSslValidationError delegate
  4034. </summary>
  4035. </member>
  4036. <member name="P:System.Net.FtpClient.FtpSslValidationEventArgs.Certificate">
  4037. <summary>
  4038. The certificate to be validated
  4039. </summary>
  4040. </member>
  4041. <member name="P:System.Net.FtpClient.FtpSslValidationEventArgs.Chain">
  4042. <summary>
  4043. The certificate chain
  4044. </summary>
  4045. </member>
  4046. <member name="P:System.Net.FtpClient.FtpSslValidationEventArgs.PolicyErrors">
  4047. <summary>
  4048. Validation errors, if any.
  4049. </summary>
  4050. </member>
  4051. <member name="P:System.Net.FtpClient.FtpSslValidationEventArgs.Accept">
  4052. <summary>
  4053. Gets or sets a value indicating if this certificate should be accepted. The default
  4054. value is false. If the certificate is not accepted, an AuthenticationException will
  4055. be thrown.
  4056. </summary>
  4057. </member>
  4058. <member name="T:System.Net.FtpClient.FtpTrace">
  4059. <summary>
  4060. Used for transaction logging and debug information.
  4061. </summary>
  4062. <example>The following example illustrates how to assist in debugging
  4063. System.Net.FtpClient by getting a transaction log from the server.
  4064. <code source="..\Examples\Debug.cs" lang="cs" />
  4065. </example>
  4066. </member>
  4067. <member name="M:System.Net.FtpClient.FtpTrace.AddListener(System.Diagnostics.TraceListener)">
  4068. <summary>
  4069. Add a TraceListner to the collection. You can use one of the predefined
  4070. TraceListeners in the System.Diagnostics namespace, such as ConsoleTraceListener
  4071. for logging to the console, or you can write your own deriving from
  4072. System.Diagnostics.TraceListener.
  4073. </summary>
  4074. <param name="listener">The TraceListener to add to the collection</param>
  4075. </member>
  4076. <member name="M:System.Net.FtpClient.FtpTrace.RemoveListener(System.Diagnostics.TraceListener)">
  4077. <summary>
  4078. Remove the specified TraceListener from the collection
  4079. </summary>
  4080. <param name="listener">The TraceListener to remove from the collection.</param>
  4081. </member>
  4082. <member name="M:System.Net.FtpClient.FtpTrace.Write(System.String,System.Object[])">
  4083. <summary>
  4084. Write to the TraceListeners.
  4085. </summary>
  4086. <param name="message">The message to write</param>
  4087. <param name="args">Optional variables if using a format string similar to string.Format()</param>
  4088. </member>
  4089. <member name="M:System.Net.FtpClient.FtpTrace.Write(System.String)">
  4090. <summary>
  4091. Write to the TraceListeners
  4092. </summary>
  4093. <param name="message">The message to write</param>
  4094. </member>
  4095. <member name="M:System.Net.FtpClient.FtpTrace.WriteLine(System.String,System.Object[])">
  4096. <summary>
  4097. Write to the TraceListeners.
  4098. </summary>
  4099. <param name="message">The message to write</param>
  4100. <param name="args">Optional variables if using a format string similar to string.Format()</param>
  4101. </member>
  4102. <member name="M:System.Net.FtpClient.FtpTrace.WriteLine(System.String)">
  4103. <summary>
  4104. Write to the TraceListeners
  4105. </summary>
  4106. <param name="message">The message to write</param>
  4107. </member>
  4108. <member name="P:System.Net.FtpClient.FtpTrace.FlushOnWrite">
  4109. <summary>
  4110. Gets or sets whether the trace listeners should be flushed or not
  4111. after writing to them. Default value is false.
  4112. </summary>
  4113. </member>
  4114. <member name="T:System.Net.FtpClient.Extensions.XCRC">
  4115. <summary>
  4116. Implementation of the non-standard XCRC command
  4117. </summary>
  4118. </member>
  4119. <member name="M:System.Net.FtpClient.Extensions.XCRC.GetXCRC(System.Net.FtpClient.FtpClient,System.String)">
  4120. <summary>
  4121. Get the CRC value of the specified file. This is a non-standard extension of the protocol
  4122. and may throw a FtpCommandException if the server does not support it.
  4123. </summary>
  4124. <param name="client">FtpClient object</param>
  4125. <param name="path">The path of the file you'd like the server to compute the CRC value for.</param>
  4126. <returns>The response from the server, typically the CRC value. FtpCommandException thrown on error</returns>
  4127. </member>
  4128. <member name="M:System.Net.FtpClient.Extensions.XCRC.BeginGetXCRC(System.Net.FtpClient.FtpClient,System.String,System.AsyncCallback,System.Object)">
  4129. <summary>
  4130. Asynchronusly retrieve a CRC hash. The XCRC command is non-standard
  4131. and not guaranteed to work.
  4132. </summary>
  4133. <param name="client">FtpClient Object</param>
  4134. <param name="path">Full or relative path to remote file</param>
  4135. <param name="callback">AsyncCallback</param>
  4136. <param name="state">State Object</param>
  4137. <returns>IAsyncResult</returns>
  4138. </member>
  4139. <member name="M:System.Net.FtpClient.Extensions.XCRC.EndGetXCRC(System.IAsyncResult)">
  4140. <summary>
  4141. Ends an asynchronous call to BeginGetXCRC()
  4142. </summary>
  4143. <param name="ar">IAsyncResult returned from BeginGetXCRC()</param>
  4144. <returns>The CRC hash of the specified file.</returns>
  4145. </member>
  4146. <member name="T:System.Net.FtpClient.Extensions.XMD5">
  4147. <summary>
  4148. Implementation of non-standard XMD5 command.
  4149. </summary>
  4150. </member>
  4151. <member name="M:System.Net.FtpClient.Extensions.XMD5.GetXMD5(System.Net.FtpClient.FtpClient,System.String)">
  4152. <summary>
  4153. Gets the MD5 hash of the specified file using XMD5. This is a non-standard extension
  4154. to the protocol and may or may not work. A FtpCommandException will be
  4155. thrown if the command fails.
  4156. </summary>
  4157. <param name="client">FtpClient Object</param>
  4158. <param name="path">Full or relative path to remote file</param>
  4159. <returns>Server response, presumably the MD5 hash.</returns>
  4160. </member>
  4161. <member name="M:System.Net.FtpClient.Extensions.XMD5.BeginGetXMD5(System.Net.FtpClient.FtpClient,System.String,System.AsyncCallback,System.Object)">
  4162. <summary>
  4163. Asynchronusly retrieve a MD5 hash. The XMD5 command is non-standard
  4164. and not guaranteed to work.
  4165. </summary>
  4166. <param name="client">FtpClient Object</param>
  4167. <param name="path">Full or relative path to remote file</param>
  4168. <param name="callback">AsyncCallback</param>
  4169. <param name="state">State Object</param>
  4170. <returns>IAsyncResult</returns>
  4171. </member>
  4172. <member name="M:System.Net.FtpClient.Extensions.XMD5.EndGetXMD5(System.IAsyncResult)">
  4173. <summary>
  4174. Ends an asynchronous call to BeginGetXMD5()
  4175. </summary>
  4176. <param name="ar">IAsyncResult returned from BeginGetXMD5()</param>
  4177. <returns>The MD5 hash of the specified file.</returns>
  4178. </member>
  4179. <member name="T:System.Net.FtpClient.Extensions.XSHA1">
  4180. <summary>
  4181. Implementation of the non-standard XSHA1 command
  4182. </summary>
  4183. </member>
  4184. <member name="M:System.Net.FtpClient.Extensions.XSHA1.GetXSHA1(System.Net.FtpClient.FtpClient,System.String)">
  4185. <summary>
  4186. Gets the SHA-1 hash of the specified file using XSHA1. This is a non-standard extension
  4187. to the protocol and may or may not work. A FtpCommandException will be
  4188. thrown if the command fails.
  4189. </summary>
  4190. <param name="client">FtpClient Object</param>
  4191. <param name="path">Full or relative path to remote file</param>
  4192. <returns>Server response, presumably the SHA-1 hash.</returns>
  4193. </member>
  4194. <member name="M:System.Net.FtpClient.Extensions.XSHA1.BeginGetXSHA1(System.Net.FtpClient.FtpClient,System.String,System.AsyncCallback,System.Object)">
  4195. <summary>
  4196. Asynchronusly retrieve a SHA1 hash. The XSHA1 command is non-standard
  4197. and not guaranteed to work.
  4198. </summary>
  4199. <param name="client">FtpClient Object</param>
  4200. <param name="path">Full or relative path to remote file</param>
  4201. <param name="callback">AsyncCallback</param>
  4202. <param name="state">State Object</param>
  4203. <returns>IAsyncResult</returns>
  4204. </member>
  4205. <member name="M:System.Net.FtpClient.Extensions.XSHA1.EndGetXSHA1(System.IAsyncResult)">
  4206. <summary>
  4207. Ends an asynchronous call to BeginGetXSHA1()
  4208. </summary>
  4209. <param name="ar">IAsyncResult returned from BeginGetXSHA1()</param>
  4210. <returns>The SHA-1 hash of the specified file.</returns>
  4211. </member>
  4212. <member name="T:System.Net.FtpClient.Extensions.XSHA256">
  4213. <summary>
  4214. Implementation of the non-standard XSHA256 command
  4215. </summary>
  4216. </member>
  4217. <member name="M:System.Net.FtpClient.Extensions.XSHA256.GetXSHA256(System.Net.FtpClient.FtpClient,System.String)">
  4218. <summary>
  4219. Gets the SHA-256 hash of the specified file using XSHA256. This is a non-standard extension
  4220. to the protocol and may or may not work. A FtpCommandException will be
  4221. thrown if the command fails.
  4222. </summary>
  4223. <param name="client">FtpClient Object</param>
  4224. <param name="path">Full or relative path to remote file</param>
  4225. <returns>Server response, presumably the SHA-256 hash.</returns>
  4226. </member>
  4227. <member name="M:System.Net.FtpClient.Extensions.XSHA256.BeginGetXSHA256(System.Net.FtpClient.FtpClient,System.String,System.AsyncCallback,System.Object)">
  4228. <summary>
  4229. Asynchronusly retrieve a SHA256 hash. The XSHA256 command is non-standard
  4230. and not guaranteed to work.
  4231. </summary>
  4232. <param name="client">FtpClient Object</param>
  4233. <param name="path">Full or relative path to remote file</param>
  4234. <param name="callback">AsyncCallback</param>
  4235. <param name="state">State Object</param>
  4236. <returns>IAsyncResult</returns>
  4237. </member>
  4238. <member name="M:System.Net.FtpClient.Extensions.XSHA256.EndGetXSHA256(System.IAsyncResult)">
  4239. <summary>
  4240. Ends an asynchronous call to BeginGetXSHA256()
  4241. </summary>
  4242. <param name="ar">IAsyncResult returned from BeginGetXSHA256()</param>
  4243. <returns>The SHA-256 hash of the specified file.</returns>
  4244. </member>
  4245. <member name="T:System.Net.FtpClient.Extensions.XSHA512">
  4246. <summary>
  4247. Implementation of the non-standard XSHA512 command
  4248. </summary>
  4249. </member>
  4250. <member name="M:System.Net.FtpClient.Extensions.XSHA512.GetXSHA512(System.Net.FtpClient.FtpClient,System.String)">
  4251. <summary>
  4252. Gets the SHA-512 hash of the specified file using XSHA512. This is a non-standard extension
  4253. to the protocol and may or may not work. A FtpCommandException will be
  4254. thrown if the command fails.
  4255. </summary>
  4256. <param name="client">FtpClient Object</param>
  4257. <param name="path">Full or relative path to remote file</param>
  4258. <returns>Server response, presumably the SHA-512 hash.</returns>
  4259. </member>
  4260. <member name="M:System.Net.FtpClient.Extensions.XSHA512.BeginGetXSHA512(System.Net.FtpClient.FtpClient,System.String,System.AsyncCallback,System.Object)">
  4261. <summary>
  4262. Asynchronusly retrieve a SHA512 hash. The XSHA512 command is non-standard
  4263. and not guaranteed to work.
  4264. </summary>
  4265. <param name="client">FtpClient Object</param>
  4266. <param name="path">Full or relative path to remote file</param>
  4267. <param name="callback">AsyncCallback</param>
  4268. <param name="state">State Object</param>
  4269. <returns>IAsyncResult</returns>
  4270. </member>
  4271. <member name="M:System.Net.FtpClient.Extensions.XSHA512.EndGetXSHA512(System.IAsyncResult)">
  4272. <summary>
  4273. Ends an asynchronous call to BeginGetXSHA512()
  4274. </summary>
  4275. <param name="ar">IAsyncResult returned from BeginGetXSHA512()</param>
  4276. <returns>The SHA-512 hash of the specified file.</returns>
  4277. </member>
  4278. </members>
  4279. </doc>